aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2025-02-15 13:54:13 -0500
committerKevin O'Connor <kevin@koconnor.net>2025-02-15 13:55:19 -0500
commita90110d9bab2ae1bf878fd0974fa3d8f128a38f8 (patch)
tree7e4f8a082271cff82d9400dbcb8931cf34f21dea
parente24ea3652cace049f84759b6aac9397703f2b347 (diff)
downloadkutter-a90110d9bab2ae1bf878fd0974fa3d8f128a38f8.tar.gz
kutter-a90110d9bab2ae1bf878fd0974fa3d8f128a38f8.tar.xz
kutter-a90110d9bab2ae1bf878fd0974fa3d8f128a38f8.zip
docs: Note stealthchop_threshold doesn't impact sensorless homing
Reported by @paulfertser. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
-rw-r--r--docs/Config_Reference.md20
-rw-r--r--docs/TMC_Drivers.md4
2 files changed, 16 insertions, 8 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 7a1f3b81..1489670e 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -3456,8 +3456,9 @@ run_current:
#stealthchop_threshold: 0
# The velocity (in mm/s) to set the "stealthChop" threshold to. When
# set, "stealthChop" mode will be enabled if the stepper motor
-# velocity is below this value. The default is 0, which disables
-# "stealthChop" mode.
+# velocity is below this value. Note that the "sensorless homing"
+# code may temporarily override this setting during homing
+# operations. The default is 0, which disables "stealthChop" mode.
#coolstep_threshold:
# The velocity (in mm/s) to set the TMC driver internal "CoolStep"
# threshold to. If set, the coolstep feature will be enabled when
@@ -3569,8 +3570,9 @@ run_current:
#stealthchop_threshold: 0
# The velocity (in mm/s) to set the "stealthChop" threshold to. When
# set, "stealthChop" mode will be enabled if the stepper motor
-# velocity is below this value. The default is 0, which disables
-# "stealthChop" mode.
+# velocity is below this value. Note that the "sensorless homing"
+# code may temporarily override this setting during homing
+# operations. The default is 0, which disables "stealthChop" mode.
#driver_MULTISTEP_FILT: True
#driver_IHOLDDELAY: 8
#driver_TPOWERDOWN: 20
@@ -3772,8 +3774,9 @@ run_current:
#stealthchop_threshold: 0
# The velocity (in mm/s) to set the "stealthChop" threshold to. When
# set, "stealthChop" mode will be enabled if the stepper motor
-# velocity is below this value. The default is 0, which disables
-# "stealthChop" mode.
+# velocity is below this value. Note that the "sensorless homing"
+# code may temporarily override this setting during homing
+# operations. The default is 0, which disables "stealthChop" mode.
#coolstep_threshold:
# The velocity (in mm/s) to set the TMC driver internal "CoolStep"
# threshold to. If set, the coolstep feature will be enabled when
@@ -3906,8 +3909,9 @@ run_current:
#stealthchop_threshold: 0
# The velocity (in mm/s) to set the "stealthChop" threshold to. When
# set, "stealthChop" mode will be enabled if the stepper motor
-# velocity is below this value. The default is 0, which disables
-# "stealthChop" mode.
+# velocity is below this value. Note that the "sensorless homing"
+# code may temporarily override this setting during homing
+# operations. The default is 0, which disables "stealthChop" mode.
#coolstep_threshold:
# The velocity (in mm/s) to set the TMC driver internal "CoolStep"
# threshold to. If set, the coolstep feature will be enabled when
diff --git a/docs/TMC_Drivers.md b/docs/TMC_Drivers.md
index d2a7eaa3..6326e339 100644
--- a/docs/TMC_Drivers.md
+++ b/docs/TMC_Drivers.md
@@ -83,6 +83,10 @@ setting `stealthchop_threshold` to 999999). Unfortunately, the drivers
often produce poor and confusing results if the mode changes while the
motor is at a non-zero velocity.
+Note that the `stealthchop_threshold` config option does not impact
+sensorless homing as Klipper automatically switches the TMC driver to
+an appropriate mode during sensorless homing operations.
+
## TMC interpolate setting introduces small position deviation
The TMC driver `interpolate` setting may reduce the audible noise of