Update documentation of ThermalStop()

This commit is contained in:
Yuri D'Elia 2022-08-21 15:21:26 +02:00
parent b672be90b2
commit 7cd888cd0a

View file

@ -9960,17 +9960,12 @@ void UnconditionalStop()
} }
// Emergency stop used by overtemp functions which allows recovery // Emergency stop used by overtemp functions which allows recovery
// WARNING: This function is called *continuously* during a thermal failure.
// //
// This function is called *continuously* during a thermal failure. // This either pauses (for thermal model errors) or stops *without recovery* depending on
// // "allow_pause". If pause is allowed, this forces a printer-initiated instantanenous pause (just
// In addition to stopping the print, this prevents subsequent G[0-3] commands to be // like an LCD pause) that bypasses the host pausing functionality. In this state the printer is
// processed via USB (using "Stopped") until the print is resumed via M999 or // kept in busy state and *must* be recovered from the LCD.
// manually started from scratch with the LCD.
//
// Note that the current instruction is completely discarded, so resuming from Stop()
// will introduce either over/under extrusion on the current segment, and will not
// survive a power panic. Switching Stop() to use the pause machinery instead (with
// the addition of disabling the headers) could allow true recovery in the future.
void ThermalStop(bool allow_pause) void ThermalStop(bool allow_pause)
{ {
if(Stopped == false) { if(Stopped == false) {