aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorLasse Dalegaard <dalegaard@gmail.com>2022-08-29 21:10:02 +0200
committerKevinOConnor <kevin@koconnor.net>2023-03-14 21:01:40 -0400
commitca6e5fe5147c8b5a76b9665b81d5efb806f316c7 (patch)
tree22c535a307b89c9083fe37ad9a513564401d01fc /docs
parent5a69d0f8571a4045d3c87e95fce083920241e63c (diff)
downloadkutter-ca6e5fe5147c8b5a76b9665b81d5efb806f316c7.tar.gz
kutter-ca6e5fe5147c8b5a76b9665b81d5efb806f316c7.tar.xz
kutter-ca6e5fe5147c8b5a76b9665b81d5efb806f316c7.zip
probe: Allow overriding horizontal_move_z on gcode
Signed-off-by: Lasse Dalegaard <dalegaard@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/G-Codes.md77
1 files changed, 41 insertions, 36 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 7f5c6b08..48b074e6 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -146,14 +146,15 @@ The following commands are available when the
(also see the [bed mesh guide](Bed_Mesh.md)).
#### BED_MESH_CALIBRATE
-`BED_MESH_CALIBRATE [METHOD=manual] [<probe_parameter>=<value>]
-[<mesh_parameter>=<value>]`: This command probes the bed using
-generated points specified by the parameters in the config. After
-probing, a mesh is generated and z-movement is adjusted according to
-the mesh. See the PROBE command for details on the optional probe
-parameters. If METHOD=manual is specified then the manual probing tool
-is activated - see the MANUAL_PROBE command above for details on the
-additional commands available while this tool is active.
+`BED_MESH_CALIBRATE [METHOD=manual] [HORIZONTAL_MOVE_Z=<value>]
+[<probe_parameter>=<value>] [<mesh_parameter>=<value>]`: This command probes
+the bed using generated points specified by the parameters in the config. After
+probing, a mesh is generated and z-movement is adjusted according to the mesh.
+See the PROBE command for details on the optional probe parameters. If
+METHOD=manual is specified then the manual probing tool is activated - see the
+MANUAL_PROBE command above for details on the additional commands available
+while this tool is active. The optional `HORIZONTAL_MOVE_Z` value overrides the
+`horizontal_move_z` option specified in the config file.
#### BED_MESH_OUTPUT
`BED_MESH_OUTPUT PGP=[<0:1>]`: This command outputs the current probed
@@ -207,13 +208,14 @@ The following commands are available when the
[bed_tilt config section](Config_Reference.md#bed_tilt) is enabled.
#### BED_TILT_CALIBRATE
-`BED_TILT_CALIBRATE [METHOD=manual] [<probe_parameter>=<value>]`: This
-command will probe the points specified in the config and then
-recommend updated x and y tilt adjustments. See the PROBE command for
-details on the optional probe parameters. If METHOD=manual is
-specified then the manual probing tool is activated - see the
-MANUAL_PROBE command above for details on the additional commands
-available while this tool is active.
+`BED_TILT_CALIBRATE [METHOD=manual] [HORIZONTAL_MOVE_Z=<value>]
+[<probe_parameter>=<value>]`: This command will probe the points specified in
+the config and then recommend updated x and y tilt adjustments. See the PROBE
+command for details on the optional probe parameters. If METHOD=manual is
+specified then the manual probing tool is activated - see the MANUAL_PROBE
+command above for details on the additional commands available while this tool
+is active. The optional `HORIZONTAL_MOVE_Z` value overrides the
+`horizontal_move_z` option specified in the config file.
### [bltouch]
@@ -262,13 +264,14 @@ The following commands are available when the
is enabled (also see the [delta calibrate guide](Delta_Calibrate.md)).
#### DELTA_CALIBRATE
-`DELTA_CALIBRATE [METHOD=manual] [<probe_parameter>=<value>]`: This
-command will probe seven points on the bed and recommend updated
-endstop positions, tower angles, and radius. See the PROBE command for
-details on the optional probe parameters. If METHOD=manual is
-specified then the manual probing tool is activated - see the
-MANUAL_PROBE command above for details on the additional commands
-available while this tool is active.
+`DELTA_CALIBRATE [METHOD=manual] [HORIZONTAL_MOVE_Z=<value>]
+[<probe_parameter>=<value>]`: This command will probe seven points on the bed
+and recommend updated endstop positions, tower angles, and radius. See the
+PROBE command for details on the optional probe parameters. If METHOD=manual is
+specified then the manual probing tool is activated - see the MANUAL_PROBE
+command above for details on the additional commands available while this tool
+is active. The optional `HORIZONTAL_MOVE_Z` value overrides the
+`horizontal_move_z` option specified in the config file.
#### DELTA_ANALYZE
`DELTA_ANALYZE`: This command is used during enhanced delta
@@ -1078,16 +1081,17 @@ is enabled (also see the
#### SCREWS_TILT_CALCULATE
`SCREWS_TILT_CALCULATE [DIRECTION=CW|CCW] [MAX_DEVIATION=<value>]
-[<probe_parameter>=<value>]`: This command will invoke the bed screws
-adjustment tool. It will command the nozzle to different locations (as
-defined in the config file) probing the z height and calculate the
-number of knob turns to adjust the bed level. If DIRECTION is
-specified, the knob turns will all be in the same direction, clockwise
-(CW) or counterclockwise (CCW). See the PROBE command for details on
-the optional probe parameters. IMPORTANT: You MUST always do a G28
-before using this command. If MAX_DEVIATION is specified, the command
-will raise a gcode error if any difference in the screw height
-relative to the base screw height is greater than the value provided.
+[HORIZONTAL_MOVE_Z=<value>] [<probe_parameter>=<value>]`: This command will
+invoke the bed screws adjustment tool. It will command the nozzle to different
+locations (as defined in the config file) probing the z height and calculate
+the number of knob turns to adjust the bed level. If DIRECTION is specified,
+the knob turns will all be in the same direction, clockwise (CW) or
+counterclockwise (CCW). See the PROBE command for details on the optional probe
+parameters. IMPORTANT: You MUST always do a G28 before using this command. If
+MAX_DEVIATION is specified, the command will raise a gcode error if any
+difference in the screw height relative to the base screw height is greater
+than the value provided. The optional `HORIZONTAL_MOVE_Z` value overrides the
+`horizontal_move_z` option specified in the config file.
### [sdcard_loop]
@@ -1329,7 +1333,8 @@ The following commands are available when the
[z_tilt config section](Config_Reference.md#z_tilt) is enabled.
#### Z_TILT_ADJUST
-`Z_TILT_ADJUST [<probe_parameter>=<value>]`: This command will probe
-the points specified in the config and then make independent
-adjustments to each Z stepper to compensate for tilt. See the PROBE
-command for details on the optional probe parameters.
+`Z_TILT_ADJUST [HORIZONTAL_MOVE_Z=<value>] [<probe_parameter>=<value>]`: This
+command will probe the points specified in the config and then make independent
+adjustments to each Z stepper to compensate for tilt. See the PROBE command for
+details on the optional probe parameters. The optional `HORIZONTAL_MOVE_Z`
+value overrides the `horizontal_move_z` option specified in the config file.