aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorPhilippe Daouadi <philippe@ud2.org>2023-08-01 19:08:53 +0200
committerGitHub <noreply@github.com>2023-08-01 13:08:53 -0400
commit039daecb4fde7d37b255eec1308abb5ba41a9ba9 (patch)
tree1e04d78b7b818ab712d2469fbf101026f77f97a8 /docs/Config_Reference.md
parent36be1cfc5109355fb50cececedee936905fc6c7d (diff)
downloadkutter-039daecb4fde7d37b255eec1308abb5ba41a9ba9.tar.gz
kutter-039daecb4fde7d37b255eec1308abb5ba41a9ba9.tar.xz
kutter-039daecb4fde7d37b255eec1308abb5ba41a9ba9.zip
axis_twist_compensation: Add X twist compensation module (#6149)
Implements AxisTwistCompensation, and Calibrater Supports calibration of z-offsets caused by x gantry twist Modify PrinterProbe._probe function to check if the probed z value should be adjusted based on axis_twist_compensation's configuration Add documentation for [axis_twist_compensation] module Signed-off-by: Jeremy Tan <jeremytkw98@gmail.com>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index b64b9cf1..4e3a9dde 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -1959,6 +1959,35 @@ z_offset:
# See the "probe" section for more information on the parameters above.
```
+### [axis_twist_compensation]
+
+A tool to compensate for inaccurate probe readings due to twist in X gantry. See
+the [Axis Twist Compensation Guide](Axis_Twist_Compensation.md) for more
+detailed information regarding symptoms, configuration and setup.
+
+```
+[axis_twist_compensation]
+#speed: 50
+# The speed (in mm/s) of non-probing moves during the calibration.
+# The default is 50.
+#horizontal_move_z: 5
+# The height (in mm) that the head should be commanded to move to
+# just prior to starting a probe operation. The default is 5.
+calibrate_start_x: 20
+# Defines the minimum X coordinate of the calibration
+# This should be the X coordinate that positions the nozzle at the starting
+# calibration position. This parameter must be provided.
+calibrate_end_x: 200
+# Defines the maximum X coordinate of the calibration
+# This should be the X coordinate that positions the nozzle at the ending
+# calibration position. This parameter must be provided.
+calibrate_y: 112.5
+# Defines the Y coordinate of the calibration
+# This should be the Y coordinate that positions the nozzle during the
+# calibration process. This parameter must be provided and is recommended to
+# be near the center of the bed
+```
+
## Additional stepper motors and extruders
### [stepper_z1]