Deploying to gh-pages from @ Klipper3d/klipper@4db1bf8ac6 🚀

Config_Changes.html

@@ -1412,6 +1412,17 @@ are not backwards compatible. It is a good idea to review this
 document when upgrading the Klipper software.</p>
 <p>All dates in this document are approximate.</p>
 <h2 id="changes">Changes<a class="headerlink" href="#changes" title="Permanent link">&para;</a></h2>
+<p>20260318: The <code>[probe_eddy_current]</code> config options <code>speed</code>,
+<code>lift_speed</code>, <code>samples</code>, <code>sample_retract_dist</code>, <code>samples_result</code>,
+<code>samples_tolerance</code>, and <code>samples_tolerance_retries</code> no longer apply
+to probe commands using <code>METHOD=scan</code>, <code>METHOD=rapid_scan</code>, nor
+<code>METHOD=tap</code>. To use different settings, supply the equivalent
+<code>PROBE_SPEED</code>, <code>LIFT_SPEED</code>, <code>SAMPLES</code>, <code>SAMPLE_RETRACT_DIST</code>,
+<code>SAMPLES_RESULT</code>, <code>SAMPLES_TOLERANCE</code>, or <code>SAMPLES_TOLERANCE_RETRIES</code>
+parameter with the probe command.</p>
+<p>20260318: The <code>[probe_eddy_current]</code> config option <code>z_offset</code> has been
+renamed to <code>descend_z</code>. Using the old name is deprecated and it will
+be removed in the near future.</p>
 <p>20260214: The <code>MANUAL_STEPPER</code> G-Code command <code>STOP_ON_ENDSTOP</code>
 parameter has changed. See the
 <a href="G-Codes.html#manual_stepper">MANUAL_STEPPER</a> documentation for

Config_Reference.html

@@ -5962,32 +5962,44 @@ z_offset:
 #   The distance (in mm) between the bed and the nozzle when the probe
 #   triggers. This parameter must be provided.
 #speed: 5.0
-#   Speed (in mm/s) of the Z axis when probing. The default is 5mm/s.
+#   Speed (in mm/s) of the Z axis when probing. It may be possible to
+#   change this value at runtime via a "PROBE_SPEED" command
+#   parameter. The default is 5mm/s.
 #samples: 1
 #   The number of times to probe each point. The probed z-values will
-#   be averaged. The default is to probe 1 time.
+#   be averaged. It may be possible to change this value at runtime
+#   via a "SAMPLES" command parameter. The default is to probe 1 time.
 #sample_retract_dist: 2.0
 #   The distance (in mm) to lift the toolhead between each sample (if
-#   sampling more than once). The default is 2mm.
+#   sampling more than once). It may be possible to change this value
+#   at runtime via a "SAMPLE_RETRACT_DIST" command parameter. The
+#   default is 2mm.
 #lift_speed:
 #   Speed (in mm/s) of the Z axis when lifting the probe between
-#   samples. The default is to use the same value as the 'speed'
-#   parameter.
+#   samples. It may be possible to change this value at runtime via a
+#   "LIFT_SPEED" command parameter. The default is to use the same
+#   value as the 'speed' parameter.
 #samples_result: average
 #   The calculation method when sampling more than once - either
-#   "median" or "average". The default is average.
+#   "median" or "average". It may be possible to change this value at
+#   runtime via a "SAMPLES_RESULT" command parameter. The default is
+#   average.
 #samples_tolerance: 0.100
 #   The maximum Z distance (in mm) that a sample may differ from other
 #   samples. If this tolerance is exceeded then either an error is
 #   reported or the attempt is restarted (see
-#   samples_tolerance_retries). The default is 0.100mm.
+#   samples_tolerance_retries). It may be possible to change this
+#   value at runtime via a "SAMPLES_TOLERANCE" command parameter. The
+#   default is 0.100mm.
 #samples_tolerance_retries: 0
 #   The number of times to retry if a sample is found that exceeds
 #   samples_tolerance. On a retry, all current samples are discarded
 #   and the probe attempt is restarted. If a valid set of samples are
 #   not obtained in the given number of retries then an error is
-#   reported. The default is zero which causes an error to be reported
-#   on the first sample that exceeds samples_tolerance.
+#   reported. It may be possible to change this value at runtime via a
+#   "SAMPLES_TOLERANCE_RETRIES" command parameter. The default is zero
+#   which causes an error to be reported on the first sample that
+#   exceeds samples_tolerance.
 #activate_gcode:
 #   A list of G-Code commands to execute prior to each probe attempt.
 #   See docs/Command_Templates.md for G-Code format. This may be
@@ -6121,7 +6133,7 @@ sensor_type: ldc1612
 #intb_pin:
 #   MCU gpio pin connected to the ldc1612 sensor's INTB pin (if
 #   available). The default is to not use the INTB pin.
-#z_offset:
+#descend_z:
 #   The nominal distance (in mm) between the nozzle and bed that a
 #   probing attempt should stop at. This parameter must be provided.
 #i2c_address:
@@ -6134,6 +6146,8 @@ sensor_type: ldc1612
 #   settings" section for a description of the above parameters.
 #x_offset:
 #y_offset:
+#   The distance (in mm) between the probe and the nozzle along the
+#   x and y axes. The default is 0.
 #speed:
 #lift_speed:
 #samples:
@@ -6141,7 +6155,10 @@ sensor_type: ldc1612
 #samples_result:
 #samples_tolerance:
 #samples_tolerance_retries:
-#   See the "probe" section for information on these parameters.
+#   See the "probe" section for information on these parameters. Note
+#   that the settings here apply only to regular probe commands. These
+#   settings do not have an effect if using a probe "METHOD" of
+#   "scan", "rapid_scan", or "tap".
 #tap_threshold:
 #   Noise cutoff/stop trigger threshold (in Hz). Specify this value to
 #   enable support for "METHOD=tap" probe commands. See Eddy_Probe.md
@@ -6152,6 +6169,12 @@ sensor_type: ldc1612
 #   the bed. If this value is specified then one may override its
 #   value at run-time using the "TAP_THRESHOLD" parameter on probe
 #   commands. The default is to not enable support for "tap" probing.
+#tap_z_offset: 0.0
+#   The Z height (in mm) of the nozzle relative to the bed at the
+#   contact point detected during "tap" probing. Nominally this would
+#   be 0.0 to indicate the contact point has zero distance, but one
+#   may set this to account for backlash, thermal expansion, a
+#   systemic probing bias, or similar. The default is zero.
 </code></pre></div>
 
 <h3 id="axis_twist_compensation">[axis_twist_compensation]<a class="headerlink" href="#axis_twist_compensation" title="Permanent link">&para;</a></h3>

Eddy_Probe.html

@@ -1460,7 +1460,7 @@ Look at the <a href="Eddy_Probe.html#homing-correction-macros">homing correction
 for further details.</p>
 <p>Start by declaring a
 <a href="Config_Reference.html#probe_eddy_current">probe_eddy_current config section</a>
-in the printer.cfg file. It is recommended to set the <code>z_offset</code> to
+in the printer.cfg file. It is recommended to set <code>descend_z</code> to
 0.5mm. It is typical for the sensor to require an <code>x_offset</code> and
 <code>y_offset</code>. If these values are not known, one should estimate the
 values during initial calibration.</p>
@@ -1488,11 +1488,11 @@ sensor to Z positions. This will take a couple of minutes. After the
 tool completes it will output the sensor performance data:</p>
 <div class="highlight"><pre><span></span><code>probe_eddy_current: noise 0.000642mm, MAD_Hz=11.314 in 2525 queries
 Total frequency range: 45000.012 Hz
-z_offset: 0.250 # noise 0.000200mm, MAD_Hz=11.000
-z_offset: 0.530 # noise 0.000300mm, MAD_Hz=12.000
-z_offset: 1.010 # noise 0.000400mm, MAD_Hz=14.000
-z_offset: 2.010 # noise 0.000600mm, MAD_Hz=12.000
-z_offset: 3.010 # noise 0.000700mm, MAD_Hz=9.000
+z: 0.250 # noise 0.000200mm, MAD_Hz=11.000
+z: 0.530 # noise 0.000300mm, MAD_Hz=12.000
+z: 1.010 # noise 0.000400mm, MAD_Hz=14.000
+z: 2.010 # noise 0.000600mm, MAD_Hz=12.000
+z: 3.010 # noise 0.000700mm, MAD_Hz=9.000
 </code></pre></div>
 
 <p>issue a <code>SAVE_CONFIG</code> command to save the results to
@@ -1550,14 +1550,6 @@ it is required to calibrate the stop threshold for your machine.
 Practically, it ensures that the Eddy's output data absolute value
 change per second (velocity) is high enough - higher than the noise level,
 and that upon collision it always decreases by at least this value.</p>
-<div class="highlight"><pre><span></span><code>[probe_eddy_current my_probe]
-# eddy probe configuration...
-# Recommended starting values for the tap
-#samples: 3
-#samples_tolerance: 0.025
-#samples_tolerance_retries: 3
-</code></pre></div>
-
 <p>Before setting it to any other value, it is necessary to install <code>scipy</code>:</p>
 <div class="highlight"><pre><span></span><code>~/klippy-env/bin/pip<span class="w"> </span>install<span class="w"> </span>scipy
 </code></pre></div>
@@ -1597,7 +1589,7 @@ because of the noise.</li>
 calibration routine output:</p>
 <div class="highlight"><pre><span></span><code>probe_eddy_current: noise 0.000642mm, MAD_Hz=11.314
 ...
-z_offset: 1.010 # noise 0.000400mm, MAD_Hz=14.000
+z: 1.010 # noise 0.000400mm, MAD_Hz=14.000
 </code></pre></div>
 
 <p>The estimation will be:</p>

G-Codes.html

@@ -5972,6 +5972,13 @@ additional parameters if a <code>[probe_eddy_current]</code> section is defined:
   specified in the <code>[probe_eddy_current]</code> config section when probing
   using <code>METHOD=tap</code>.</li>
 </ul>
+<p>The <code>Z_OFFSET_APPLY_PROBE</code> command is also extended to support a
+<code>METHOD=tap</code> parameter. When no METHOD parameter is provided, the
+<code>Z_OFFSET_APPLY_PROBE</code> command alters the probe calibration to apply
+the current Z G-Code offset to future <code>scan</code>, <code>rapid_scan</code>, and
+default probes. If <code>METHOD=tap</code> is specified then the command instead
+applies the change to <code>tap_z_offset</code> so that future <code>tap</code> probes are
+updated to use the current Z G-Code offset.</p>
 <h4 id="probe_eddy_current_calibrate">PROBE_EDDY_CURRENT_CALIBRATE<a class="headerlink" href="#probe_eddy_current_calibrate" title="Permanent link">&para;</a></h4>
 <p><code>PROBE_EDDY_CURRENT_CALIBRATE CHIP=&lt;config_name&gt;</code>: This starts a tool
 that calibrates the sensor resonance frequencies to corresponding Z