From 9552f5e54608a005da336c47c7574a6172af60c5 Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Sun, 28 Nov 2021 20:17:51 -0500 Subject: docs: Recommend that hold_current not be specified Changing motor current may itself introduce unwanted motor movement. As such, document that specifying a hold_current is not recommended. Signed-off-by: Kevin O'Connor --- docs/Config_Reference.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'docs/Config_Reference.md') diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index 36302664..75a9de52 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -2773,8 +2773,9 @@ 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 not reduce the -# current. +# when the stepper is not moving. Setting a hold_current is not +# recommended (see TMC_Drivers.md for details). 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. @@ -2839,8 +2840,9 @@ 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. Setting a hold_current is not +# recommended (see TMC_Drivers.md for details). 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. @@ -3022,8 +3024,9 @@ 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. Setting a hold_current is not +# recommended (see TMC_Drivers.md for details). The default is to +# not reduce the current. #sense_resistor: 0.075 # The resistance (in ohms) of the motor sense resistor. The default # is 0.075 ohms. -- cgit v1.2.3-70-g09d2