docs: update Bed Mesh documentation
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
parent
1ad4c0fd6e
commit
8fe18f27a9
|
@ -261,13 +261,18 @@ fade_target: 0
|
||||||
mesh is used, however it may be desirable to manually adjust the fade target
|
mesh is used, however it may be desirable to manually adjust the fade target
|
||||||
if one wants to print on a specific portion of the bed.
|
if one wants to print on a specific portion of the bed.
|
||||||
|
|
||||||
### The Relative Reference Index
|
### Configuring the zero reference position
|
||||||
|
|
||||||
Most probes are susceptible to drift, ie: inaccuracies in probing introduced by
|
Many probes are susceptible to "drift", ie: inaccuracies in probing introduced
|
||||||
heat or interference. This can make calculating the probe's z-offset
|
by heat or interference. This can make calculating the probe's z-offset
|
||||||
challenging, particularly at different bed temperatures. As such, some printers
|
challenging, particularly at different bed temperatures. As such, some
|
||||||
use an endstop for homing the Z axis, and a probe for calibrating the mesh.
|
printers use an endstop for homing the Z axis and a probe for calibrating the
|
||||||
These printers can benefit from configuring the relative reference index.
|
mesh. In this configuration it is possible offset the mesh so that the (X, Y)
|
||||||
|
`reference position` applies zero adjustment. The `reference postion` should
|
||||||
|
be the location on the bed where a
|
||||||
|
[Z_ENDSTOP_CALIBRATE](./Manual_Level#calibrating-a-z-endstop)
|
||||||
|
paper test is performed. The bed_mesh module provides the
|
||||||
|
`zero_reference_position` option for specifying this coordinate:
|
||||||
|
|
||||||
```
|
```
|
||||||
[bed_mesh]
|
[bed_mesh]
|
||||||
|
@ -275,23 +280,45 @@ speed: 120
|
||||||
horizontal_move_z: 5
|
horizontal_move_z: 5
|
||||||
mesh_min: 35, 6
|
mesh_min: 35, 6
|
||||||
mesh_max: 240, 198
|
mesh_max: 240, 198
|
||||||
|
zero_reference_position: 125, 110
|
||||||
probe_count: 5, 3
|
probe_count: 5, 3
|
||||||
relative_reference_index: 7
|
```
|
||||||
|
- `zero_reference_position: `\
|
||||||
|
_Default Value: None (disabled)_\
|
||||||
|
The `zero_reference_position` expects an (X, Y) coordinate matching that
|
||||||
|
of the `reference position` described above. If the coordinate lies within
|
||||||
|
the mesh then the mesh will be offset so the reference position applies zero
|
||||||
|
adjustment. If the coordinate lies outside of the mesh then the coordinate
|
||||||
|
will be probed after calibration, with the resulting z-value used as the
|
||||||
|
z-offset. Note that this coordinate must NOT be in a location specified as
|
||||||
|
a `faulty_region` if a probe is necessary.
|
||||||
|
|
||||||
|
#### The deprecated relative_reference_index
|
||||||
|
|
||||||
|
Existing configurations using the `relative_reference_index` option must be
|
||||||
|
updated to use the `zero_reference_position`. The response to the
|
||||||
|
[BED_MESH_OUTPUT PGP=1](#output) gcode command will include the (X, Y)
|
||||||
|
coordinate associated with the index; this position may be used as the value for
|
||||||
|
the `zero_reference_position`. The output will look similar to the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
// bed_mesh: generated points
|
||||||
|
// Index | Tool Adjusted | Probe
|
||||||
|
// 0 | (1.0, 1.0) | (24.0, 6.0)
|
||||||
|
// 1 | (36.7, 1.0) | (59.7, 6.0)
|
||||||
|
// 2 | (72.3, 1.0) | (95.3, 6.0)
|
||||||
|
// 3 | (108.0, 1.0) | (131.0, 6.0)
|
||||||
|
... (additional generated points)
|
||||||
|
// bed_mesh: relative_reference_index 24 is (131.5, 108.0)
|
||||||
```
|
```
|
||||||
|
|
||||||
- `relative_reference_index: 7`\
|
_Note: The above output is also printed in `klippy.log` during initialization._
|
||||||
_Default Value: None (disabled)_\
|
|
||||||
When the probed points are generated they are each assigned an index. You
|
Using the example above we see that the `relative_reference_index` is
|
||||||
can look up this index in klippy.log or by using BED_MESH_OUTPUT (see the
|
printed along with its coordinate. Thus the `zero_reference_position`
|
||||||
section on Bed Mesh GCodes below for more information). If you assign an
|
is `131.5, 108`.
|
||||||
index to the `relative_reference_index` option, the value probed at this
|
|
||||||
coordinate will replace the probe's z_offset. This effectively makes
|
|
||||||
this coordinate the "zero" reference for the mesh.
|
|
||||||
|
|
||||||
When using the relative reference index, you should choose the index nearest
|
|
||||||
to the spot on the bed where Z endstop calibration was done. Note that
|
|
||||||
when looking up the index using the log or BED_MESH_OUTPUT, you should use
|
|
||||||
the coordinates listed under the "Probe" header to find the correct index.
|
|
||||||
|
|
||||||
### Faulty Regions
|
### Faulty Regions
|
||||||
|
|
||||||
|
@ -371,12 +398,12 @@ following parameters are available:
|
||||||
- `MESH_ORIGIN`
|
- `MESH_ORIGIN`
|
||||||
- `ROUND_PROBE_COUNT`
|
- `ROUND_PROBE_COUNT`
|
||||||
- All beds:
|
- All beds:
|
||||||
- `RELATIVE_REFERENCE_INDEX`
|
|
||||||
- `ALGORITHM`
|
- `ALGORITHM`
|
||||||
|
|
||||||
See the configuration documentation above for details on how each parameter
|
See the configuration documentation above for details on how each parameter
|
||||||
applies to the mesh.
|
applies to the mesh.
|
||||||
|
|
||||||
|
|
||||||
### Profiles
|
### Profiles
|
||||||
|
|
||||||
`BED_MESH_PROFILE SAVE=<name> LOAD=<name> REMOVE=<name>`
|
`BED_MESH_PROFILE SAVE=<name> LOAD=<name> REMOVE=<name>`
|
||||||
|
|
|
@ -966,10 +966,18 @@ Visual Examples:
|
||||||
# be applied to change the amount of slope interpolated. Larger
|
# be applied to change the amount of slope interpolated. Larger
|
||||||
# numbers will increase the amount of slope, which results in more
|
# numbers will increase the amount of slope, which results in more
|
||||||
# curvature in the mesh. Default is .2.
|
# curvature in the mesh. Default is .2.
|
||||||
|
#zero_reference_position:
|
||||||
|
# An optional X,Y coordinate that specifies the location on the bed
|
||||||
|
# where Z = 0. When this option is specified the mesh will be offset
|
||||||
|
# so that zero Z adjustment occurs at this location. The default is
|
||||||
|
# no zero reference.
|
||||||
#relative_reference_index:
|
#relative_reference_index:
|
||||||
# A point index in the mesh to reference all z values to. Enabling
|
# **DEPRECATED, use the "zero_reference_position" option**
|
||||||
# this parameter produces a mesh relative to the probed z position
|
# The legacy option superceded by the "zero reference position".
|
||||||
# at the provided index.
|
# Rather than a coordinate this option takes an integer "index" that
|
||||||
|
# refers to the location of one of the generated points. It is recommended
|
||||||
|
# to use the "zero_reference_position" instead of this option for new
|
||||||
|
# configurations. The default is no relative reference index.
|
||||||
#faulty_region_1_min:
|
#faulty_region_1_min:
|
||||||
#faulty_region_1_max:
|
#faulty_region_1_max:
|
||||||
# Optional points that define a faulty region. See docs/Bed_Mesh.md
|
# Optional points that define a faulty region. See docs/Bed_Mesh.md
|
||||||
|
|
Loading…
Reference in New Issue