3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document additions to BED_MESH_CALIBRATE 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-09-10 08:50:40 -04:00 committed by KevinOConnor
parent 7ba1a2a749
commit 3ac636b33e
2 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/Bed_Mesh.md
View File

@ -295,13 +295,30 @@ the coordinates listed under the "Probe" header to find the correct index.
### Calibration ### Calibration
`BED_MESH_CALIBRATE METHOD=[manual | automatic]`\ `BED_MESH_CALIBRATE METHOD=[manual | automatic] [<probe_parameter>=<value>]
[<mesh_parameter>=<value>]`\
_Default Method: automatic if a probe is detected, otherwise manual_ _Default Method: automatic if a probe is detected, otherwise manual_
Initiates the probing procedure for Bed Mesh Calibration. If `METHOD=manual` Initiates the probing procedure for Bed Mesh Calibration. If `METHOD=manual`
is selected then manual probing will occur. When switching between automatic is selected then manual probing will occur. When switching between automatic
and manual probing the generated mesh points will automatically be adjusted. 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 ### Profiles
`BED_MESH_PROFILE SAVE=name LOAD=name REMOVE=name` `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 "Tool Adjusted" points refer to the nozzle location for each point, and
the "Probe" points refer to the probe location. Note that when manually 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. 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.

3
docs/G-Codes.md
View File

@ -382,7 +382,8 @@ section is enabled:
The following commands are available when the "bed_mesh" config The following commands are available when the "bed_mesh" config
section is enabled: section is enabled:
- `BED_MESH_CALIBRATE [METHOD=manual] [<probe_parameter>=<value>]`: - `BED_MESH_CALIBRATE [METHOD=manual] [<probe_parameter>=<value>]
[<mesh_parameter>=<value>]`:
This command probes the bed using generated points specified by the This command probes the bed using generated points specified by the
parameters in the config. After probing, a mesh is generated and parameters in the config. After probing, a mesh is generated and
z-movement is adjusted according to the mesh. See the PROBE command z-movement is adjusted according to the mesh. See the PROBE command