aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Voinea <voinea.dragos.alexandru@gmail.com>2023-03-16 13:11:34 +0100
committerKevinOConnor <kevin@koconnor.net>2023-03-20 10:58:25 -0400
commit73f4c6cd0077310ca748c13f5a7e223989cfe92d (patch)
treefafa055e589ccb4c1aa4a10ede746d5af92386a6 /docs
parent0469710a69b36960442ae1b067c6631b696d4dd1 (diff)
downloadkutter-73f4c6cd0077310ca748c13f5a7e223989cfe92d.tar.gz
kutter-73f4c6cd0077310ca748c13f5a7e223989cfe92d.tar.xz
kutter-73f4c6cd0077310ca748c13f5a7e223989cfe92d.zip
tmc: SET_TMC_FIELD VELOCITY
Ability to specify `VELOCITY` as a parameter for SET_TMC_FIELD. Useful for configuring at runtime the TSTEP based fields of the driver. Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/G-Codes.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 48b074e6..b28f8ab6 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -1236,13 +1236,16 @@ if StealthChop2 is used, the stepper must be held at standstill for >130ms so
that the driver executes the AT#1 calibration.
#### SET_TMC_FIELD
-`SET_TMC_FIELD STEPPER=<name> FIELD=<field> VALUE=<value>`: This will
-alter the value of the specified register field of the TMC driver.
+`SET_TMC_FIELD STEPPER=<name> FIELD=<field> VALUE=<value> VELOCITY=<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.
+A VELOCITY can also be specified instead of a VALUE. This velocity is
+converted to the 20bit TSTEP based value representation. Only use the VELOCITY
+argument for fields that represent velocities.
### [toolhead]