aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorAlex Voinea <voinea.dragos.alexandru@gmail.com>2024-05-14 22:21:58 +0200
committerKevinOConnor <kevin@koconnor.net>2024-05-14 18:21:24 -0400
commit5249d955bb0a4ee131cc3def5d9d53d61e2d4334 (patch)
tree0360209248e6c5a0e8b1cb83e529bf6c859188e2 /docs/Config_Reference.md
parent0f3f29101ca49e913354811430d43776f13bcdbb (diff)
downloadkutter-5249d955bb0a4ee131cc3def5d9d53d61e2d4334.tar.gz
kutter-5249d955bb0a4ee131cc3def5d9d53d61e2d4334.tar.xz
kutter-5249d955bb0a4ee131cc3def5d9d53d61e2d4334.zip
tmc: Implement coolstep_threshold for drivers that support it
Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index ee09bf2c..d48715d8 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -3317,6 +3317,13 @@ run_current:
# set, "stealthChop" mode will be enabled if the stepper motor
# velocity is below this value. The default is 0, which disables
# "stealthChop" mode.
+#coolstep_threshold:
+# The velocity (in mm/s) to set the TMC driver internal "CoolStep"
+# threshold to. When set, the coolstep feature will be enabled if
+# the stepper motor velocity is near or above this value. Important
+# - if coolstep_threshold is set and "sensorless homing" is used,
+# then one must ensure that the homing speed is above the coolstep
+# threshold! The default is to not enable the coolstep feature.
#driver_MSLUT0: 2863314260
#driver_MSLUT1: 1251300522
#driver_MSLUT2: 608774441
@@ -3456,6 +3463,13 @@ run_current:
#sense_resistor: 0.110
#stealthchop_threshold: 0
# See the "tmc2208" section for the definition of these parameters.
+#coolstep_threshold:
+# The velocity (in mm/s) to set the TMC driver internal "CoolStep"
+# threshold to. When set, the coolstep feature will be enabled if
+# the stepper motor velocity is near or above this value. Important
+# - if coolstep_threshold is set and "sensorless homing" is used,
+# then one must ensure that the homing speed is above the coolstep
+# threshold! The default is to not enable the coolstep feature.
#uart_address:
# The address of the TMC2209 chip for UART messages (an integer
# between 0 and 3). This is typically used when multiple TMC2209
@@ -3614,6 +3628,13 @@ run_current:
# set, "stealthChop" mode will be enabled if the stepper motor
# velocity is below this value. The default is 0, which disables
# "stealthChop" mode.
+#coolstep_threshold:
+# The velocity (in mm/s) to set the TMC driver internal "CoolStep"
+# threshold to. When set, the coolstep feature will be enabled if
+# the stepper motor velocity is near or above this value. Important
+# - if coolstep_threshold is set and "sensorless homing" is used,
+# then one must ensure that the homing speed is above the coolstep
+# threshold! The default is to not enable the coolstep feature.
#driver_MSLUT0: 2863314260
#driver_MSLUT1: 1251300522
#driver_MSLUT2: 608774441
@@ -3735,6 +3756,13 @@ run_current:
# set, "stealthChop" mode will be enabled if the stepper motor
# velocity is below this value. The default is 0, which disables
# "stealthChop" mode.
+#coolstep_threshold:
+# The velocity (in mm/s) to set the TMC driver internal "CoolStep"
+# threshold to. When set, the coolstep feature will be enabled if
+# the stepper motor velocity is near or above this value. Important
+# - if coolstep_threshold is set and "sensorless homing" is used,
+# then one must ensure that the homing speed is above the coolstep
+# threshold! The default is to not enable the coolstep feature.
#driver_MSLUT0: 2863314260
#driver_MSLUT1: 1251300522
#driver_MSLUT2: 608774441