From 3ac636b33e0dd770d2608d9a7c05c267f1b12149 Mon Sep 17 00:00:00 2001 From: Arksine Date: Thu, 10 Sep 2020 08:50:40 -0400 Subject: [PATCH] docs: document additions to BED_MESH_CALIBRATE Signed-off-by: Eric Callahan --- docs/Bed_Mesh.md | 25 ++++++++++++++++++++++++- docs/G-Codes.md | 3 ++- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/Bed_Mesh.md b/docs/Bed_Mesh.md index c33063be..397fbfab 100644 --- a/docs/Bed_Mesh.md +++ b/docs/Bed_Mesh.md @@ -295,13 +295,30 @@ the coordinates listed under the "Probe" header to find the correct index. ### Calibration -`BED_MESH_CALIBRATE METHOD=[manual | automatic]`\ +`BED_MESH_CALIBRATE METHOD=[manual | automatic] [=] + [=]`\ _Default Method: automatic if a probe is detected, otherwise manual_ Initiates the probing procedure for Bed Mesh Calibration. If `METHOD=manual` is selected then manual probing will occur. When switching between automatic and manual probing the generated mesh points will automatically be adjusted. +It is possible to specify mesh parameters to modify the probed area. The +following parameters are available: +- Rectangular beds (cartesian): + - `MESH_MIN` + - `MESH_MAX` + - `PROBE_COUNT` +- Round beds (delta): + - `MESH_RADIUS` + - `MESH_ORIGIN` + - `ROUND_PROBE_COUNT` +- All beds: + - `RELATIVE_REFERNCE_INDEX` + - `ALGORITHM` +See the configuration documentation above for details on how each parameter +applies to the mesh. + ### Profiles `BED_MESH_PROFILE SAVE=name LOAD=name REMOVE=name` @@ -357,3 +374,9 @@ set, the generated probed points will be output to the terminal: The "Tool Adjusted" points refer to the nozzle location for each point, and the "Probe" points refer to the probe location. Note that when manually probing the "Probe" points will refer to both the tool and nozzle locations. + +### Clear Mesh State + +`BED_MESH_CLEAR` + +This gcode may be used to clear the internal mesh state. diff --git a/docs/G-Codes.md b/docs/G-Codes.md index 628d8a3c..68e65911 100644 --- a/docs/G-Codes.md +++ b/docs/G-Codes.md @@ -382,7 +382,8 @@ section is enabled: The following commands are available when the "bed_mesh" config section is enabled: -- `BED_MESH_CALIBRATE [METHOD=manual] [=]`: +- `BED_MESH_CALIBRATE [METHOD=manual] [=] + [=]`: 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