diff options
author | Eric Callahan <arksine.code@gmail.com> | 2023-04-29 16:39:42 -0400 |
---|---|---|
committer | KevinOConnor <kevin@koconnor.net> | 2023-06-20 11:48:17 -0400 |
commit | 8fe18f27a94df0a9d394824a3e648ee7f8fc280a (patch) | |
tree | bdf917e700cbbbb87749fbbf4829992a9ae16395 /docs/Config_Reference.md | |
parent | 1ad4c0fd6e2501dd635dbf2648c70c997612378f (diff) | |
download | kutter-8fe18f27a94df0a9d394824a3e648ee7f8fc280a.tar.gz kutter-8fe18f27a94df0a9d394824a3e648ee7f8fc280a.tar.xz kutter-8fe18f27a94df0a9d394824a3e648ee7f8fc280a.zip |
docs: update Bed Mesh documentation
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r-- | docs/Config_Reference.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index 1cc0bc8f..fa770408 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -966,10 +966,18 @@ Visual Examples: # be applied to change the amount of slope interpolated. Larger # numbers will increase the amount of slope, which results in more # 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: -# 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. +# **DEPRECATED, use the "zero_reference_position" option** +# The legacy option superceded by the "zero reference position". +# 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_max: # Optional points that define a faulty region. See docs/Bed_Mesh.md |