diff options
author | Arksine <9563098+Arksine@users.noreply.github.com> | 2021-04-04 15:27:43 -0400 |
---|---|---|
committer | KevinOConnor <kevin@koconnor.net> | 2021-04-10 11:16:07 -0400 |
commit | a93d09cdf4a715bc8952c12bdaac35e696986c3a (patch) | |
tree | 1fb8541127319baca33b398f81faacd6178080aa /docs/Bed_Mesh.md | |
parent | 60372fd0cf58a61dc3ced5efca0ba9b9c43fcb27 (diff) | |
download | kutter-a93d09cdf4a715bc8952c12bdaac35e696986c3a.tar.gz kutter-a93d09cdf4a715bc8952c12bdaac35e696986c3a.tar.xz kutter-a93d09cdf4a715bc8952c12bdaac35e696986c3a.zip |
docs: document bed mesh "faulty_regions"
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
Diffstat (limited to 'docs/Bed_Mesh.md')
-rw-r--r-- | docs/Bed_Mesh.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/Bed_Mesh.md b/docs/Bed_Mesh.md index 397fbfab..a36f9244 100644 --- a/docs/Bed_Mesh.md +++ b/docs/Bed_Mesh.md @@ -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. + + + ## Bed Mesh Gcodes ### Calibration |