Deploying to gh-pages from @ Klipper3d/klipper@109aab9dc0 🚀

Config_Reference.html

@@ -8669,15 +8669,16 @@ adc2:
 #   1.50 for cal_dia1 and 2.00 for cal_dia2.
 #raw_dia1: 9500
 #raw_dia2: 10500
-#   The raw calibration values for the sensors. The default is 9500
-#   for raw_dia1 and 10500 for raw_dia2.
+#   The raw calibration values for the sensors. The values must be
+#   different. The default is 9500 for raw_dia1 and 10500 for raw_dia2.
 #default_nominal_filament_diameter: 1.75
 #   The nominal filament diameter. This parameter must be provided.
 #max_difference: 0.200
 #   Maximum allowed filament diameter difference in millimeters (mm).
 #   If difference between nominal filament diameter and sensor output
 #   is more than +- max_difference, extrusion multiplier is set back
-#   to %100. The default is 0.200.
+#   to 100%. Must be less than default_nominal_filament_diameter.
+#   The default is 0.200.
 #measurement_delay: 70
 #   The distance from sensor to the melting chamber/hot-end in
 #   millimeters (mm). The filament between the sensor and the hot-end
@@ -8688,6 +8689,10 @@ adc2:
 #enable: False
 #   Sensor enabled or disabled after power on. The default is to
 #   disable.
+#enable_flow_compensation: True
+#   Flow compensation enabled or disabled. If set to False, the sensor
+#   will not modify the extrusion multiplier and will only trigger
+#   runout events. The default is True.
 #measurement_interval: 10
 #   The approximate distance (in mm) between sensor readings. The
 #   default is 10mm.

G-Codes.html

@@ -5568,16 +5568,19 @@ or <a href="Config_Reference.html#hall_filament_width_sensor">hall filament widt
 is enabled (also see <a href="TSL1401CL_Filament_Width_Sensor.html">TSLl401CL Filament Width Sensor</a>
 and <a href="Hall_Filament_Width_Sensor.html">Hall Filament Width Sensor</a>):</p>
 <h4 id="query_filament_width">QUERY_FILAMENT_WIDTH<a class="headerlink" href="#query_filament_width" title="Permanent link">&para;</a></h4>
-<p><code>QUERY_FILAMENT_WIDTH</code>: Return the current measured filament width.</p>
+<p><code>QUERY_FILAMENT_WIDTH</code>: Return the current measured filament width, the
+state of the width sensor, the state of the filament sensor and the state
+of flow compensation.</p>
 <h4 id="reset_filament_width_sensor">RESET_FILAMENT_WIDTH_SENSOR<a class="headerlink" href="#reset_filament_width_sensor" title="Permanent link">&para;</a></h4>
 <p><code>RESET_FILAMENT_WIDTH_SENSOR</code>: Clear all sensor readings. Helpful
-after filament change.</p>
+after filament change. Resets flow rate to 100%.</p>
 <h4 id="disable_filament_width_sensor">DISABLE_FILAMENT_WIDTH_SENSOR<a class="headerlink" href="#disable_filament_width_sensor" title="Permanent link">&para;</a></h4>
 <p><code>DISABLE_FILAMENT_WIDTH_SENSOR</code>: Turn off the filament width sensor
-and stop using it for flow control.</p>
+and stop using it for flow compensation. Resets flow rate to 100%.</p>
 <h4 id="enable_filament_width_sensor">ENABLE_FILAMENT_WIDTH_SENSOR<a class="headerlink" href="#enable_filament_width_sensor" title="Permanent link">&para;</a></h4>
-<p><code>ENABLE_FILAMENT_WIDTH_SENSOR</code>: Turn on the filament width sensor and
-start using it for flow control.</p>
+<p><code>ENABLE_FILAMENT_WIDTH_SENSOR [FLOW_COMPENSATION=[0|1]</code>: Turn on the filament
+width sensor and enable or disable flow compensation. If <code>FLOW_COMPENSATION</code>
+is not specified, the current flow compensation state is preserved.</p>
 <h4 id="query_raw_filament_width">QUERY_RAW_FILAMENT_WIDTH<a class="headerlink" href="#query_raw_filament_width" title="Permanent link">&para;</a></h4>
 <p><code>QUERY_RAW_FILAMENT_WIDTH</code>: Return the current ADC channel readings
 and RAW sensor value for calibration points.</p>

Hall_Filament_Width_Sensor.html

@@ -1319,6 +1319,13 @@
     How to enable sensor
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#use-as-a-runout-switch-only" class="md-nav__link">
+    Use as a runout switch only
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -1438,6 +1445,13 @@
     How to enable sensor
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#use-as-a-runout-switch-only" class="md-nav__link">
+    Use as a runout switch only
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -1513,6 +1527,20 @@ command in terminal.</p>
 <p>By default, the sensor is disabled at power-on.</p>
 <p>To enable the sensor, issue <strong>ENABLE_FILAMENT_WIDTH_SENSOR</strong> command or
 set the <code>enable</code> parameter to <code>true</code>.</p>
+<h2 id="use-as-a-runout-switch-only">Use as a runout switch only<a class="headerlink" href="#use-as-a-runout-switch-only" title="Permanent link">&para;</a></h2>
+<p>By default, the sensor measures filament diameter and adjusts the extrusion multiplier
+to compensate for variations.</p>
+<p>If you want to use the sensor as a runout switch only, set the <code>enable_flow_compensation</code>
+config parameter to <code>false</code>. In this mode, the sensor will only trigger runout
+events when filament is not detected, it will not modify the extrusion multiplier.</p>
+<p>This is useful for printers where the filament sensor is not accurate enough for
+flow compensation but can reliably detect filament runout, or when printing with
+flexible filaments which have unstable diameter characteristics.</p>
+<p>Issue <strong>ENABLE_FILAMENT_WIDTH_SENSOR FLOW_COMPENSATION=1</strong> to enable flow compensation
+or <strong>ENABLE_FILAMENT_WIDTH_SENSOR FLOW_COMPENSATION=0</strong> to disable it.</p>
+<p>Note that disabling filament width compensation automatically resets the extrusion
+multiplier to 100%.</p>
+<p><strong>QUERY_FILAMENT_WIDTH</strong> includes the current state of flow compensation in its output.</p>
 <h2 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">&para;</a></h2>
 <p>By default, diameter logging is disabled at power-on.</p>
 <p>Issue <strong>ENABLE_FILAMENT_WIDTH_LOG</strong> command to start logging and issue

Status_Reference.html

@@ -2358,7 +2358,9 @@ object:</p>
 <li>all items from
   <a href="Status_Reference.html#filament_switch_sensor">filament_switch_sensor</a></li>
 <li><code>is_active</code>: Returns True if the sensor is currently active.</li>
-<li><code>Diameter</code>: The last reading from the sensor in mm.</li>
+<li><code>flow_compensation_enabled</code>: Returns True if flow compensation is enabled.</li>
+<li><code>Diameter</code>: Returns the last width reading in mm if the sensor is active or
+  the nominal filament diameter if it is not.</li>
 <li><code>Raw</code>: The last raw ADC reading from the sensor.</li>
 </ul>
 <h2 id="heater">heater<a class="headerlink" href="#heater" title="Permanent link">&para;</a></h2>