aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDmitry Butyugin <dmbutyugin@google.com>2020-07-06 02:54:38 +0200
committerGitHub <noreply@github.com>2020-07-05 20:54:38 -0400
commit4bdc11a8b3843b73079a2c8dfc8d8c0928c29662 (patch)
treee75986fe8573bda848f60f94af2b43f8c3553779 /docs
parent09a3d018a895ac7ea80ada4c16a212b795375c26 (diff)
downloadkutter-4bdc11a8b3843b73079a2c8dfc8d8c0928c29662.tar.gz
kutter-4bdc11a8b3843b73079a2c8dfc8d8c0928c29662.tar.xz
kutter-4bdc11a8b3843b73079a2c8dfc8d8c0928c29662.zip
input_shaper: Initial support of input shaping (#3032)
Input shaping can help to reduce printer vibrations due to resonances and eliminate or reduce ghosting in prints. Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/G-Codes.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 3b939ec9..3c91ee63 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -596,3 +596,18 @@ been enabled:
delay duration for the identified [delayed_gcode] and starts the timer
for gcode execution. A value of 0 will cancel a pending delayed gcode
from executing.
+
+## Resonance compensation
+
+The following command is enabled if an [input_shaper] config section has
+been enabled:
+ - `SET_INPUT_SHAPER [SHAPER_FREQ_X=<shaper_freq_x>]
+ [SHAPER_FREQ_Y=<shaper_freq_y>] [DAMPING_RATIO_X=<damping_ratio_x>]
+ [DAMPING_RATIO_Y=<damping_ratio_y>] [SHAPER_TYPE=<shaper>]
+ [SHAPER_TYPE_X=<shaper_type_x>] [SHAPER_TYPE_Y=<shaper_type_y>]`: Modify
+ input shaper parameters. Note that SHAPER_TYPE parameter resets input shaper
+ for both X and Y axes even if different shaper types have been configured
+ in [input_shaper] section. SHAPER_TYPE cannot be used together with either
+ of SHAPER_TYPE_X and SHAPER_TYPE_Y parameters. See
+ [example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
+ for more details on each of these parameters.