Deploying to gh-pages from @ Klipper3d/klipper@9a77d8859b 🚀
This commit is contained in:
@@ -688,10 +688,23 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#the-relative-reference-index" class="md-nav__link">
|
||||
The Relative Reference Index
|
||||
<a href="#configuring-the-zero-reference-position" class="md-nav__link">
|
||||
Configuring the zero reference position
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Configuring the zero reference position">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#the-deprecated-relative_reference_index" class="md-nav__link">
|
||||
The deprecated relative_reference_index
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1469,10 +1482,23 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#the-relative-reference-index" class="md-nav__link">
|
||||
The Relative Reference Index
|
||||
<a href="#configuring-the-zero-reference-position" class="md-nav__link">
|
||||
Configuring the zero reference position
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Configuring the zero reference position">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#the-deprecated-relative_reference_index" class="md-nav__link">
|
||||
The deprecated relative_reference_index
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1818,35 +1844,57 @@ fade_target: 0
|
||||
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.</li>
|
||||
</ul>
|
||||
<h3 id="the-relative-reference-index">The Relative Reference Index<a class="headerlink" href="#the-relative-reference-index" title="Permanent link">¶</a></h3>
|
||||
<p>Most probes are susceptible to drift, ie: inaccuracies in probing introduced by
|
||||
heat or interference. This can make calculating the probe's z-offset
|
||||
challenging, particularly at different bed temperatures. As such, some printers
|
||||
use an endstop for homing the Z axis, and a probe for calibrating the mesh.
|
||||
These printers can benefit from configuring the relative reference index.</p>
|
||||
<h3 id="configuring-the-zero-reference-position">Configuring the zero reference position<a class="headerlink" href="#configuring-the-zero-reference-position" title="Permanent link">¶</a></h3>
|
||||
<p>Many probes are susceptible to "drift", ie: inaccuracies in probing introduced
|
||||
by heat or interference. This can make calculating the probe's z-offset
|
||||
challenging, particularly at different bed temperatures. As such, some
|
||||
printers use an endstop for homing the Z axis and a probe for calibrating the
|
||||
mesh. In this configuration it is possible offset the mesh so that the (X, Y)
|
||||
<code>reference position</code> applies zero adjustment. The <code>reference postion</code> should
|
||||
be the location on the bed where a
|
||||
<a href="./Manual_Level#calibrating-a-z-endstop">Z_ENDSTOP_CALIBRATE</a>
|
||||
paper test is performed. The bed_mesh module provides the
|
||||
<code>zero_reference_position</code> option for specifying this coordinate:</p>
|
||||
<div class="highlight"><pre><span></span><code>[bed_mesh]
|
||||
speed: 120
|
||||
horizontal_move_z: 5
|
||||
mesh_min: 35, 6
|
||||
mesh_max: 240, 198
|
||||
zero_reference_position: 125, 110
|
||||
probe_count: 5, 3
|
||||
relative_reference_index: 7
|
||||
</code></pre></div>
|
||||
|
||||
<ul>
|
||||
<li><code>relative_reference_index: 7</code><br>
|
||||
<li><code>zero_reference_position:</code><br>
|
||||
<em>Default Value: None (disabled)</em><br>
|
||||
When the probed points are generated they are each assigned an index. You
|
||||
can look up this index in klippy.log or by using BED_MESH_OUTPUT (see the
|
||||
section on Bed Mesh GCodes below for more information). If you assign an
|
||||
index to the <code>relative_reference_index</code> 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.</li>
|
||||
The <code>zero_reference_position</code> expects an (X, Y) coordinate matching that
|
||||
of the <code>reference position</code> 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 <code>faulty_region</code> if a probe is necessary.</li>
|
||||
</ul>
|
||||
<p>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.</p>
|
||||
<h4 id="the-deprecated-relative_reference_index">The deprecated relative_reference_index<a class="headerlink" href="#the-deprecated-relative_reference_index" title="Permanent link">¶</a></h4>
|
||||
<p>Existing configurations using the <code>relative_reference_index</code> option must be
|
||||
updated to use the <code>zero_reference_position</code>. The response to the
|
||||
<a href="#output">BED_MESH_OUTPUT PGP=1</a> gcode command will include the (X, Y)
|
||||
coordinate associated with the index; this position may be used as the value for
|
||||
the <code>zero_reference_position</code>. The output will look similar to the following:</p>
|
||||
<div class="highlight"><pre><span></span><code>// 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)
|
||||
</code></pre></div>
|
||||
|
||||
<p><em>Note: The above output is also printed in <code>klippy.log</code> during initialization.</em></p>
|
||||
<p>Using the example above we see that the <code>relative_reference_index</code> is
|
||||
printed along with its coordinate. Thus the <code>zero_reference_position</code>
|
||||
is <code>131.5, 108</code>.</p>
|
||||
<h3 id="faulty-regions">Faulty Regions<a class="headerlink" href="#faulty-regions" title="Permanent link">¶</a></h3>
|
||||
<p>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
|
||||
@@ -1919,7 +1967,6 @@ following parameters are available:</p>
|
||||
</ul>
|
||||
</li>
|
||||
<li>All beds:<ul>
|
||||
<li><code>RELATIVE_REFERENCE_INDEX</code></li>
|
||||
<li><code>ALGORITHM</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
Reference in New Issue
Block a user