aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authoramblidex <47804843+amblidex@users.noreply.github.com>2019-03-22 18:37:03 -0600
committerKevinOConnor <kevin@koconnor.net>2019-03-22 20:37:03 -0400
commit0980b7e4ec4c950d8db91cd0b80de5f871b27caf (patch)
treea7a235f94ad9a65e554aae350e8956a4f2e70dee /docs/G-Codes.md
parent7a344acde8d43bbcc8a9ac151d24cc2e3b8d3369 (diff)
downloadkutter-0980b7e4ec4c950d8db91cd0b80de5f871b27caf.tar.gz
kutter-0980b7e4ec4c950d8db91cd0b80de5f871b27caf.tar.xz
kutter-0980b7e4ec4c950d8db91cd0b80de5f871b27caf.zip
tmc2130: add SET_TMC_CURRENT and SET_TMC_FIELD commands (#1419)
Signed-off-by: Frank Kang <amblidex@outlook.com>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 993770d0..f100d07c 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -302,17 +302,16 @@ section is enabled:
## TMC2130, TMC2660 and TMC2208
-The following command is available when the "tmc2130", "tmc2660"
+The following commands are 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_CURRENT STEPPER=<name> CURRENT=<amps> HOLDCURRENT=<amps>`:
+ This will adjust the run and hold currents of the TMC driver.
+ HOLDCURRENT is applicable only to the tmc2130 and tmc2208.
- `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