aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2018-04-20 19:58:37 -0400
committerKevin O'Connor <kevin@koconnor.net>2018-04-20 20:04:41 -0400
commit6d03dee104531cc174b8ed8a0886768956bade31 (patch)
treeba54b1c8cfb0641d0e16269dcf910ab86f88c7bc /docs/G-Codes.md
parent93262919ed44417cad076a4fe0b63a455a0b052a (diff)
downloadkutter-6d03dee104531cc174b8ed8a0886768956bade31.tar.gz
kutter-6d03dee104531cc174b8ed8a0886768956bade31.tar.xz
kutter-6d03dee104531cc174b8ed8a0886768956bade31.zip
gcode: Add a SET_GCODE_OFFSET command
The M206 command is confusing (it uses negative offsets) and isn't very flexible. Add a new SET_GCODE_OFFSET command to make it easier to add virtual offsets to gcode commands. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 37a72717..716ff47a 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -25,7 +25,6 @@ Klipper supports the following standard G-Code commands:
- Emergency stop: `M112`
- Get current position: `M114`
- Get firmware version: `M115`
-- Set home offset: `M206 [X<pos>] [Y<pos>] [Z<pos>]`
For further details on the above commands see the
[RepRap G-Code documentation](http://reprap.org/wiki/G-code).
@@ -64,6 +63,16 @@ The following standard commands are supported:
verify that an endstop is working correctly.
- `GET_POSITION`: Return information on the current location of the
toolhead.
+- `SET_GCODE_OFFSET [X=<pos>|X_ADJUST=<adjust>]
+ [Y=<pos>|Y_ADJUST=<adjust>] [Z=<pos>|Z_ADJUST=<adjust>]`: Set a
+ positional offset to apply to future G-Code commands. This is
+ commonly used to virtually change the Z bed offset or to set nozzle
+ XY offsets when switching extruders. For example, if
+ "SET_GCODE_OFFSET Z=0.2" is sent, then future G-Code moves will
+ have 0.2mm added to their Z height. If the X_ADJUST style parameters
+ are used, then the adjustment will be added to any existing offset
+ (eg, "SET_GCODE_OFFSET Z=-0.2" followed by "SET_GCODE_OFFSET
+ Z_ADJUST=0.3" would result in a total Z offset of 0.1).
- `PID_CALIBRATE HEATER=<config_name> TARGET=<temperature>
[WRITE_FILE=1]`: Perform a PID calibration test. The specified
heater will be enabled until the specified target temperature is