aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authoryochiwarez <yochiwarez@gmail.com>2024-10-23 01:12:46 +0100
committerKevinOConnor <kevin@koconnor.net>2024-11-12 22:10:04 -0500
commit38bf6f2693816be08df43fac722dbcfea21238bc (patch)
treef0590aa2ff9a15fcfe69a65d667766b72f7ba3a2 /docs/G-Codes.md
parent4f3a7fd227ce89dfffdd2b7fc205db410b9a24d5 (diff)
downloadkutter-38bf6f2693816be08df43fac722dbcfea21238bc.tar.gz
kutter-38bf6f2693816be08df43fac722dbcfea21238bc.tar.xz
kutter-38bf6f2693816be08df43fac722dbcfea21238bc.zip
axis_twist_compensation: AXIS_TWIST_COMPENSATION new parameter AUTO for autocalibration
This commit adds automatic calculation support for compensating X and Y axis twist in the axis_twist_compensation module. Signed-off-by: Jorge Apaza Merma <yochiwarez@gmail.com>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 0eb09325..7c90417c 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -146,9 +146,19 @@ The following commands are available when the
section](Config_Reference.md#axis_twist_compensation) is enabled.
#### AXIS_TWIST_COMPENSATION_CALIBRATE
-`AXIS_TWIST_COMPENSATION_CALIBRATE [SAMPLE_COUNT=<value>] [AXIS=<X or Y, default X>]`: Initiates the X or Y
-twist calibration wizard. `SAMPLE_COUNT` specifies the number of points along
-the X or Y axis to calibrate at and defaults to 3.
+`AXIS_TWIST_COMPENSATION_CALIBRATE [AXIS=<X|Y>] [AUTO=<True|False>]
+[SAMPLE_COUNT=<value>]`
+
+Calibrates axis twist compensation by specifying the target axis or
+enabling automatic calibration.
+
+- **AXIS:** Define the axis (`X` or `Y`) for which the twist compensation
+will be calibrated. If not specified, the axis defaults to `'X'`.
+
+- **AUTO:** Enables automatic calibration mode. When `AUTO=True`, the
+calibration will run for both the X and Y axes. In this mode, `AXIS`
+cannot be specified. If both `AXIS` and `AUTO` are provided, an error
+will be raised.
### [bed_mesh]