aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorArksine <arksine.code@gmail.com>2018-08-10 20:27:21 -0400
committerKevinOConnor <kevin@koconnor.net>2018-08-17 09:22:55 -0400
commit868a1f951b3dc3dc87910ad2ba20c941ec3e2986 (patch)
tree7005f2a5554a3480ea97097272cf870b7fc91ed7 /docs/G-Codes.md
parentf337fb1802c0e78deb01941665c8387ff4bbbff8 (diff)
downloadkutter-868a1f951b3dc3dc87910ad2ba20c941ec3e2986.tar.gz
kutter-868a1f951b3dc3dc87910ad2ba20c941ec3e2986.tar.xz
kutter-868a1f951b3dc3dc87910ad2ba20c941ec3e2986.zip
docs: Add Mesh Bed Leveling to G-Codes.md
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 8ca4440c..500d6300 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -158,6 +158,25 @@ section is enabled:
command to move to the next probing point during a
BED_TILT_CALIBRATE operation.
+## Mesh Bed Leveling
+
+The following commands are available when the "bed_mesh" config
+section is enabled:
+- `BED_MESH_CALIBRATE`: 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.
+- `BED_MESH_OUTPUT`: This command outputs the current probed z values
+ and current mesh values to the terminal.
+- `BED_MESH_MAP`: This command probes the bed in a similar fashion
+ to BED_MESH_CALIBRATE, however no mesh is generated. Instead,
+ the probed z values are serialized to json and output to the
+ terminal. This allows octoprint plugins to easily capture the
+ data and generate maps approximating the bed's surface. Note
+ that although no mesh is generated, any currently stored mesh
+ will be cleared as the process rehomes the printer.
+- `BED_MESH_CLEAR`: This command clears the mesh and removes all
+ z adjustment. It is recommended to put this in your end-gcode.
+
## Z Tilt
The following commands are available when the "z_tilt" config section