aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorDennis Marttinen <38858901+twelho@users.noreply.github.com>2025-01-10 15:41:09 +0000
committerGitHub <noreply@github.com>2025-01-10 10:41:09 -0500
commit7083879700800710c624c0bf08220215ba5f4a83 (patch)
tree03595e28aca8238f9f8e727ba6e1d43aed52b2e6 /docs/G-Codes.md
parent9ca71d8608f4a6013c3453ffa9e75c3739078712 (diff)
downloadkutter-7083879700800710c624c0bf08220215ba5f4a83.tar.gz
kutter-7083879700800710c624c0bf08220215ba5f4a83.tar.xz
kutter-7083879700800710c624c0bf08220215ba5f4a83.zip
force_move: Implement CLEAR for SET_KINEMATIC_POSITION (#6262)
`CLEAR` clears the homing status (resets the axis limits) without turning off the motors. This is particularly useful when implementing safe Z homing in `[homing_override]` on printers with multiple independent Z steppers (where `FORCE_MOVE` can't be used). Signed-off-by: Dennis Marttinen <twelho@welho.tech>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md21
1 files changed, 12 insertions, 9 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index d44017de..ff6182fa 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -585,15 +585,18 @@ state; issue a G28 afterwards to reset the kinematics. This command is
intended for low-level diagnostics and debugging.
#### SET_KINEMATIC_POSITION
-`SET_KINEMATIC_POSITION [X=<value>] [Y=<value>] [Z=<value>]`: Force
-the low-level kinematic code to believe the toolhead is at the given
-cartesian position. This is a diagnostic and debugging command; use
-SET_GCODE_OFFSET and/or G92 for regular axis transformations. If an
-axis is not specified then it will default to the position that the
-head was last commanded to. Setting an incorrect or invalid position
-may lead to internal software errors. This command may invalidate
-future boundary checks; issue a G28 afterwards to reset the
-kinematics.
+`SET_KINEMATIC_POSITION [X=<value>] [Y=<value>] [Z=<value>]
+[CLEAR=<[X][Y][Z]>]`: Force the low-level kinematic code to believe the
+toolhead is at the given cartesian position. This is a diagnostic and
+debugging command; use SET_GCODE_OFFSET and/or G92 for regular axis
+transformations. If an axis is not specified then it will default to the
+position that the head was last commanded to. Setting an incorrect or
+invalid position may lead to internal software errors. Use the CLEAR
+parameter to forget the homing state for the given axes. Note that CLEAR
+will not override the previous functionality; if an axis is not specified
+to CLEAR it will have its kinematic position set as per above. This
+command may invalidate future boundary checks; issue a G28 afterwards to
+reset the kinematics.
### [gcode]