aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorFlorian Heilmann <Florian.Heilmann@gmx.net>2019-03-05 19:04:59 +0000
committerKevinOConnor <kevin@koconnor.net>2019-03-08 11:04:14 -0500
commit789379e95baea33b6b9bae889332b7286b6a227e (patch)
tree0e6c31cb6afc0940327ba9eb3c7fd39e158036a1 /docs/G-Codes.md
parent8e17df5d781d00e3aac3aa66a287e05cda185608 (diff)
downloadkutter-789379e95baea33b6b9bae889332b7286b6a227e.tar.gz
kutter-789379e95baea33b6b9bae889332b7286b6a227e.tar.xz
kutter-789379e95baea33b6b9bae889332b7286b6a227e.zip
tmc2660: Add INIT_TMC and SET_TMC_FIELD gcodes
Signed-off-by: Florian Heilmann <Florian.Heilmann@gmx.net>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 6a004cf2..a3d41cd3 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -290,15 +290,26 @@ section is enabled:
carriage. It is typically invoked from the activate_gcode and
deactivate_gcode fields in a multiple extruder configuration.
-## TMC2130 and TMC2208
+## TMC2130, TMC2660 and TMC2208
-The following command is available when the "tmc2130" or "tmc2208"
-config section is enabled:
+The following command is available when the "tmc2130", "tmc2660"
+or "tmc2208" config section is enabled:
- `DUMP_TMC STEPPER=<name>`: This command will read the TMC driver
registers and report their values.
- `INIT_TMC STEPPER=<name>`: This command will intitialize the TMC
registers. Needed to re-enable the driver if power to the chip is
turned off then back on.
+The following commands are additionally available when the "tmc2660"
+config section is enabled:
+- `SET_TMC_CURRENT STEPPER=<name> CURRENT=<current>`: This will adjust
+ the run_current of the TMC driver.
+- `SET_TMC_FIELD STEPPER=<name> FIELD=<field> VALUE=<value>`: This will
+ alter the value of the specified register field of the TMC driver.
+ This command is intended for low-level diagnostics and debugging only because
+ changing the fields during run-time can lead to undesired and potentially
+ dangerous behavior of your printer. Permanent changes should be made using
+ the printer configuration file instead. No sanity checks are performed for the
+ given values.
## Endstop adjustments by stepper phase