From d60217728103f0b18de6df179bd365105670a5b8 Mon Sep 17 00:00:00 2001 From: Yifei Ding Date: Sat, 23 Oct 2021 11:27:48 -0700 Subject: [PATCH] docs: Correct TMC_Drivers Title Nesting Signed-off-by: Yifei Ding --- docs/TMC_Drivers.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/TMC_Drivers.md b/docs/TMC_Drivers.md index db7910b9..981c2ba7 100644 --- a/docs/TMC_Drivers.md +++ b/docs/TMC_Drivers.md @@ -167,7 +167,7 @@ homing. See the [config reference](Config_Reference.md#tmc-stepper-driver-configuration) for all the available options. -### Find highest sensitivity that successfully homes +#### Find highest sensitivity that successfully homes Place the carriage near the center of the rail. Use the SET_TMC_FIELD command to set the highest sensitivity. For tmc2209: @@ -425,14 +425,16 @@ state. Some common errors and tips for diagnosing them: -**TMC reports error: ... ot=1(OvertempError!)"**: This indicates the -motor driver disabled itself because it became too hot. Typical +#### TMC reports error: ... ot=1(OvertempError!)" + +This indicates the motor driver disabled itself because it became too hot. Typical solutions are to decrease the stepper motor current, increase cooling on the stepper motor driver, and/or increase cooling on the stepper motor. -**TMC reports error: ... ShortToGND** OR **LowSideShort**: This -indicates the driver has disabled itself because it detected very high +#### TMC reports error: ... ShortToGND** OR **LowSideShort + +This indicates the driver has disabled itself because it detected very high current passing through the driver. This may indicate a loose or shorted wire to the stepper motor or within the stepper motor itself. @@ -443,13 +445,15 @@ current through the motor and trigger its own over-current detection.) To test this, disable stealthchop mode and check if the errors continue to occur. -**TMC reports error: ... reset=1(Reset)** OR **CS_ACTUAL=0(Reset?)** -OR **SE=0(Reset?)**: This indicates that the driver has reset itself +#### TMC reports error: ... reset=1(Reset)** OR **CS_ACTUAL=0(Reset?)**OR **SE=0(Reset?) + +This indicates that the driver has reset itself mid-print. This may be due to voltage or wiring issues. -**TMC reports error: ... uv_cp=1(Undervoltage!)**: This indicates the -driver has detected a low-voltage event and has disabled itself. This -may be due to wiring or power supply issues. +#### TMC reports error: ... uv_cp=1(Undervoltage!) + +This indicates the driver has detected a low-voltage event and has +disabled itself. This may be due to wiring or power supply issues. It's also possible that a **TMC reports error** shutdown occurs due to SPI errors that prevent communication with the driver (on tmc2130,