docs: document bed mesh "faulty_regions"

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2021-04-04 15:27:43 -04:00 committed by KevinOConnor
parent 60372fd0cf
commit a93d09cdf4
3 changed files with 58 additions and 0 deletions

View File

@ -291,6 +291,56 @@ 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
It is possible for some areas of a bed to report inaccurate results when
probing due to a "fault" at specific locations. The best example of this
are beds with series of integrated magnets used to retain removable steel
sheets. The magnetic field at and around these magnets may cause an inductive
probe to trigger at a distance higher or lower than it would otherwise,
resulting in a mesh that does not accurately represent the surface at these
locations. **Note: This should not be confused with probe location bias, which
produces inaccurate results across the entire bed.**
The `faulty_region` options may be configured to compensate for this affect.
If a generated point lies within a faulty region bed mesh will attempt to
probe up to 4 points at the boundaries of this region. These probed values
will be averaged and inserted in the mesh as the Z value at the generated
(X, Y) coordinate.
```
[bed_mesh]
speed: 120
horizontal_move_z: 5
mesh_min: 35,6
mesh_max: 240, 198
probe_count: 5,3
faulty_region_1_min: 130.0, 0.0
faulty_region_1_max: 145.0, 40.0
faulty_region_2_min: 225.0, 0.0
faulty_region_2_max: 250.0, 25.0
faulty_region_3_min: 165.0, 95.0
faulty_region_3_max: 205.0, 110.0
faulty_region_4_min: 30.0, 170.0
faulty_region_4_max: 45.0, 210.0
```
- `faulty_region_{1...99}_min`\
`faulty_region_{1..99}_max`\
_Default Value: None (disabled)_\
Faulty Regions are defined in a way similar to that of mesh itself, where
minimum and maximum (X, Y) coordinates must be specified for each region.
A faulty region may extend outside of a mesh, however the alternate points
generated will always be within the mesh boundary. No two regions may
overlap.
The image below illustrates how replacement points are generated when
a generated point lies within a faulty region. The regions shown match those
in the sample config above. The replacement points and their coordinates
are identified in green.
![bedmesh_interpolated](img/bedmesh_faulty_regions.svg)
## Bed Mesh Gcodes
### Calibration

View File

@ -802,6 +802,11 @@ Visual Examples:
# A point index in the mesh to reference all z values to. Enabling
# this parameter produces a mesh relative to the probed z position
# at the provided index.
#faulty_region_1_min:
#faulty_region_1_max:
# Optional points that define a faulty region. See docs/Bed_Mesh.md
# for details on faulty regions. Up to 99 faulty regions may be added.
# By default no faulty regions are set.
```
## [bed_tilt]

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 33 KiB