aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-10-24 20:03:42 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-10-27 12:13:38 -0400
commit86fee2d517861546c7ba78cc1b59b83c2738ace4 (patch)
tree8b8df969438bd345fbbfbc79961c15df785f2a0d /docs
parent627c1c5d2a9d655d52960a17be7acff928d7ada2 (diff)
downloadkutter-86fee2d517861546c7ba78cc1b59b83c2738ace4.tar.gz
kutter-86fee2d517861546c7ba78cc1b59b83c2738ace4.tar.xz
kutter-86fee2d517861546c7ba78cc1b59b83c2738ace4.zip
tmc: Track requested hold_current so SET_TMC_CURRENT doesn't reduce it
The code automatically reduces the hold_current so that it is no greater than the run_current. However, this could lead to confusing behavior if one reduced and then increased the run_current via SET_TMC_CURRENT commands. To avoid that, this change adds support for tracking the requested hold_current - thus changes to run_current don't subtly alter the hold_current. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Reference.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index b8dd356e..fa5b6c76 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -2760,8 +2760,8 @@ run_current:
# during stepper movement. This parameter must be provided.
#hold_current:
# The amount of current (in amps RMS) to configure the driver to use
-# when the stepper is not moving. The default is to use the same
-# value as run_current.
+# when the stepper is not moving. The default is to not reduce the
+# current.
#sense_resistor: 0.110
# The resistance (in ohms) of the motor sense resistor. The default
# is 0.110 ohms.