aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Measuring_Resonances.md
diff options
context:
space:
mode:
authorDmitry Butyugin <dmbutyugin@google.com>2024-02-08 03:06:48 +0100
committerKevinOConnor <kevin@koconnor.net>2024-02-16 19:20:56 -0500
commit72b301a2859c3f7ed26d802dd52fc495eef6c353 (patch)
tree9c1986502927dc4c8f9056e90de5a63bee7a9507 /docs/Measuring_Resonances.md
parent4f00f2199174eca1b022fe4b8f7f3aaedfd90b6f (diff)
downloadkutter-72b301a2859c3f7ed26d802dd52fc495eef6c353.tar.gz
kutter-72b301a2859c3f7ed26d802dd52fc495eef6c353.tar.xz
kutter-72b301a2859c3f7ed26d802dd52fc495eef6c353.zip
scripts: Added shaper tuning parameters to calibrate_shaper script
The added parameters include square_corner_velocity, shaper frequencies to optimize, input shapers to test, input shaper damping ratio and damping ratios to test. All these options can be useful for fine-tuning the input shapers when the default suggestions generated by the tuning script are not optimal. Also the `SHAPER_CALIBRATE` command was modified to pass some of these parameters to the shaper tuning routine. Specifically, square corner velocity and the maximum tested frequency are used to adjust shaper tuning and maximum acceleration recommendations. Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
Diffstat (limited to 'docs/Measuring_Resonances.md')
-rw-r--r--docs/Measuring_Resonances.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/Measuring_Resonances.md b/docs/Measuring_Resonances.md
index 79f7de0f..d1d99894 100644
--- a/docs/Measuring_Resonances.md
+++ b/docs/Measuring_Resonances.md
@@ -662,6 +662,19 @@ The same notice applies to the input shaper
`max_accel` value after the auto-calibration, and the suggested acceleration
limits will not be applied automatically.
+Keep in mind that the maximum acceleration without too much smoothing depends
+on the `square_corner_velocity`. The general recommendation is not to change
+it from its default value 5.0, and this is the value used by default by the
+`calibrate_shaper.py` script. If you did change it though, you should inform
+the script about it by passing `--square_corner_velocity=...` parameter, e.g.
+```
+~/klipper/scripts/calibrate_shaper.py /tmp/resonances_x_*.csv -o /tmp/shaper_calibrate_x.png --square_corner_velocity=10.0
+```
+so that it can calculate the maximum acceleration recommendations correctly.
+Note that the `SHAPER_CALIBRATE` command already takes the configured
+`square_corner_velocity` parameter into account, and there is no need
+to specify it explicitly.
+
If you are doing a shaper re-calibration and the reported smoothing for the
suggested shaper configuration is almost the same as what you got during the
previous calibration, this step can be skipped.