docs: Limiting max_smoothing for input shaper autocalibration

Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
This commit is contained in:
Dmitry Butyugin 2020-12-19 22:36:37 +01:00 committed by KevinOConnor
parent 1b1a97e8bd
commit ab93ee9293
6 changed files with 108 additions and 22 deletions

View file

@ -739,13 +739,17 @@ is enabled (also see the
"YYYYMMDD_HHMMSS" format.
- `SHAPER_CALIBRATE [AXIS=<axis>] [NAME=<name>]
[FREQ_START=<min_freq>] [FREQ_END=<max_freq>]
[HZ_PER_SEC=<hz_per_sec>]`: Similarly to `TEST_RESONANCES`, runs the
resonance test as configured, and tries to find the optimal
parameters for the input shaper for the requested axis (or both X
and Y axes if `AXIS` parameter is unset). The results of the tuning
are printed to the console, and the frequency responses and the
different input shapers values are written to a CSV file(s)
`/tmp/calibration_data_<axis>_<name>.csv`. Unless specified, NAME
[HZ_PER_SEC=<hz_per_sec>] [MAX_SMOOTHING=<max_smoothing>]`:
Similarly to `TEST_RESONANCES`, runs the resonance test as configured,
and tries to find the optimal parameters for the input shaper for the
requested axis (or both X and Y axes if `AXIS` parameter is unset).
If `MAX_SMOOTHING` is unset, its value is taken from `[resonance_tester]`
section, with the default being unset. See the
[Max smoothing](Measuring_Resonances.md#max-smoothing) of the measuring
resonances guide for more information on the use of this feature.
The results of the tuning are printed to the console, and the frequency
responses and the different input shapers values are written to a CSV
file(s) `/tmp/calibration_data_<axis>_<name>.csv`. Unless specified, NAME
defaults to the current time in "YYYYMMDD_HHMMSS" format. Note that
the suggested input shaper parameters can be persisted in the config
by issuing `SAVE_CONFIG` command.