config: Update verify_heater description

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>

1 files changed, 26 insertions, 17 deletions

diff --git a/config/example-extras.cfg b/config/example-extras.cfg
index ed574b6d..3f371fdd 100644
--- a/config/example-extras.cfg
+++ b/config/example-extras.cfg
@@ -389,25 +389,34 @@
 # automatically enabled for each heater that is configured on the
 # printer. Use verify_heater sections to change the default settings.
 #[verify_heater heater_config_name]
-#heating_gain: 2
-#   The minimum temperature (in Celsius) that the heater must increase
-#   by when approaching a new target temperature. The default is 2.
+#max_error: 120
+#   The maximum "cumulative temperature error" before raising an
+#   error. Smaller values result in stricter checking and larger
+#   values allow for more time before an error is reported.
+#   Specifically, the temperature is inspected once a second and if it
+#   is close to the target temperature then an internal "error
+#   counter" is reset; otherwise, if the temperature is below the
+#   target range then the counter is increased by the amount the
+#   reported temperature differs from that range. Should the counter
+#   exceed this "max_error" then an error is raised. The default is
+#   120.
 #check_gain_time:
-#   The amount of time (in seconds) that the heating_gain must be met
-#   in before an error is raised. The default is 20 seconds for
-#   extruders and 60 seconds for heater_bed.
+#   This controls heater verification during initial heating.  Smaller
+#   values result in stricter checking and larger values allow for
+#   more time before an error is reported. Specifically, during
+#   initial heating, as long as the heater increases in temperature
+#   within this time frame (specified in seconds) then the internal
+#   "error counter" is reset. The default is 20 seconds for extruders
+#   and 60 seconds for heater_bed.
 #hysteresis: 5
-#   The difference between the target temperature and the current
-#   temperature for the heater to be considered within range of the
-#   target temperature. The default is 5.
-#max_error: 120
-#   The maximum temperature difference a heater that falls outside the
-#   target temperature range may accumulate before an error is
-#   raised. For example, if the target temperature is 200, the
-#   hysteresis is 5, the max_error is 120, and the temperature is
-#   reported at 185 degrees for 12 seconds then an error would be
-#   raised (or 24 seconds at 190, or 120 seconds at 194, etc.). The
-#   default is 120.
+#   The maximum temperature difference (in Celsius) to a target
+#   temperature that is considered in range of the target. This
+#   controls the max_error range check. It is rare to customize this
+#   value. The default is 5.
+#heating_gain: 2
+#   The minimum temperature (in Celsius) that the heater must increase
+#   by during the check_gain_time check. It is rare to customize this
+#   value. The default is 2.
 
 
 # Idle timeout. An idle timeout is automatically enabled - add an