From 79106638a8296f8adc999a9981f34561159f7907 Mon Sep 17 00:00:00 2001 From: Scott Lahteine <sourcetree@thinkyhead.com> Date: Fri, 8 May 2015 22:50:08 -0700 Subject: [PATCH] Fix documentation of heating sanity check --- Marlin/Configuration_adv.h | 13 ++++++++----- Marlin/configurator/config/Configuration_adv.h | 13 ++++++++----- .../Felix/Configuration_adv.h | 13 ++++++++----- .../Hephestos/Configuration_adv.h | 13 ++++++++----- .../K8200/Configuration_adv.h | 13 ++++++++----- .../SCARA/Configuration_adv.h | 13 ++++++++----- .../WITBOX/Configuration_adv.h | 13 ++++++++----- .../delta/biv2.5/Configuration_adv.h | 13 ++++++++----- .../delta/generic/Configuration_adv.h | 13 ++++++++----- .../delta/kossel_mini/Configuration_adv.h | 13 ++++++++----- .../makibox/Configuration_adv.h | 13 ++++++++----- .../tvrrug/Round2/Configuration_adv.h | 13 ++++++++----- 12 files changed, 96 insertions(+), 60 deletions(-) diff --git a/Marlin/Configuration_adv.h b/Marlin/Configuration_adv.h index f2a4d0be2a..b40615524b 100644 --- a/Marlin/Configuration_adv.h +++ b/Marlin/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/configurator/config/Configuration_adv.h b/Marlin/configurator/config/Configuration_adv.h index f2a4d0be2a..b40615524b 100644 --- a/Marlin/configurator/config/Configuration_adv.h +++ b/Marlin/configurator/config/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/Felix/Configuration_adv.h b/Marlin/example_configurations/Felix/Configuration_adv.h index 8d1b3ceafe..9384ed5536 100644 --- a/Marlin/example_configurations/Felix/Configuration_adv.h +++ b/Marlin/example_configurations/Felix/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/Hephestos/Configuration_adv.h b/Marlin/example_configurations/Hephestos/Configuration_adv.h index 71e9530107..58159fe362 100644 --- a/Marlin/example_configurations/Hephestos/Configuration_adv.h +++ b/Marlin/example_configurations/Hephestos/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/K8200/Configuration_adv.h b/Marlin/example_configurations/K8200/Configuration_adv.h index 8d1b3ceafe..9384ed5536 100644 --- a/Marlin/example_configurations/K8200/Configuration_adv.h +++ b/Marlin/example_configurations/K8200/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/SCARA/Configuration_adv.h b/Marlin/example_configurations/SCARA/Configuration_adv.h index 380c4816b6..146e7fab14 100644 --- a/Marlin/example_configurations/SCARA/Configuration_adv.h +++ b/Marlin/example_configurations/SCARA/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 3000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/WITBOX/Configuration_adv.h b/Marlin/example_configurations/WITBOX/Configuration_adv.h index d167e5c839..a4d8f65f91 100644 --- a/Marlin/example_configurations/WITBOX/Configuration_adv.h +++ b/Marlin/example_configurations/WITBOX/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/delta/biv2.5/Configuration_adv.h b/Marlin/example_configurations/delta/biv2.5/Configuration_adv.h index ff7cdecb78..0807c999bf 100644 --- a/Marlin/example_configurations/delta/biv2.5/Configuration_adv.h +++ b/Marlin/example_configurations/delta/biv2.5/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/delta/generic/Configuration_adv.h b/Marlin/example_configurations/delta/generic/Configuration_adv.h index 3566cb6edc..9f1fda4a43 100644 --- a/Marlin/example_configurations/delta/generic/Configuration_adv.h +++ b/Marlin/example_configurations/delta/generic/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h index d1b0f89985..b36e8a0f38 100644 --- a/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/makibox/Configuration_adv.h b/Marlin/example_configurations/makibox/Configuration_adv.h index 99a61a1b5f..411985f799 100644 --- a/Marlin/example_configurations/makibox/Configuration_adv.h +++ b/Marlin/example_configurations/makibox/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds diff --git a/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h b/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h index 636b81d2d2..572fdb6bf5 100644 --- a/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h +++ b/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h @@ -14,11 +14,14 @@ #endif #define BED_CHECK_INTERVAL 5000 //ms between checks in bang-bang control -//// Heating sanity check: -// This waits for the watch period in milliseconds whenever an M104 or M109 increases the target temperature -// If the temperature has not increased at the end of that period, the target temperature is set to zero. -// It can be reset with another M104/M109. This check is also only triggered if the target temperature and -// the current temperature differ by at least 2x WATCH_TEMP_INCREASE +/** + * Heating Sanity Check + * + * Whenever an M104 or M109 increases the target temperature this will wait for WATCH_TEMP_PERIOD milliseconds, + * and if the temperature hasn't increased by WATCH_TEMP_INCREASE degrees, the machine is halted, requiring a + * hard reset. This test restarts with any M104/M109, but only if the current temperature is below the target + * by at least 2 * WATCH_TEMP_INCREASE degrees celsius. + */ #define WATCH_TEMP_PERIOD 16000 // 16 seconds #define WATCH_TEMP_INCREASE 4 // Heat up at least 4 degrees in 16 seconds -- GitLab