Implement nozzle reheating on timeout via display

- Raise nozzle timeout to 10 minutes
- Use continue button as reheat trigger
- Manage nozzle_timed_out variable via display
- Add PausedByNozzleTimeout flag to enter correct routine on display
- Bump version to 1.4.3

Marlin/AnycubicTFT.h

@@ -58,6 +58,7 @@ public:
   char TFTstate=ANYCUBIC_TFT_STATE_IDLE;
   bool PausedByRunout=false;
   bool PausedByFilamentChange=false;
+  bool PausedByNozzleTimeout=false;
 
 private:
   char TFTcmdbuffer[TFTBUFSIZE][TFT_MAX_CMD_SIZE];
@@ -100,6 +101,7 @@ private:
   void HandleSpecialMenu();
   void FilamentChangePause();
   void FilamentChangeResume();
+  void ReheatNozzle();
 
   char     SelectedDirectory[30];
   uint8_t  SpecialMenu=false;
@@ -107,7 +109,8 @@ private:
 #if ENABLED(ANYCUBIC_FILAMENT_RUNOUT_SENSOR)
   char FilamentTestStatus=false;
   char FilamentTestLastStatus=false;
-  long FilamentRunoutCounter=0;
+  bool FilamentSetMillis=true;
+
 #endif
 };
 

Marlin/Configuration.h

@@ -81,10 +81,10 @@
 // User-specified version info of this build to display in [Pronterface, etc] terminal window during
 // startup. Implementation of an idea by Prof Braino to inform user that any changes made to this
 // build by the user have been successfully uploaded into firmware.
-#define STRING_CONFIG_H_AUTHOR "(davidramiro, for Anycubic i3 Mega)" // Who made the changes.
+#define STRING_CONFIG_H_AUTHOR "(davidramiro)" // Who made the changes.
 #define SHOW_BOOTSCREEN
-#define STRING_SPLASH_LINE1 SHORT_BUILD_VERSION // will be shown during bootup in line 1
-#define STRING_SPLASH_LINE2 WEBSITE_URL         // will be shown during bootup in line 2
+#define STRING_SPLASH_LINE1 SHORT_BUILD_VERSION   // will be shown during bootup in line 1
+#define STRING_SPLASH_LINE2 CUSTOM_BUILD_VERSION  // will be shown during bootup in line 2
 
 /**
  * *** VENDORS PLEASE READ ***

Marlin/Configuration_adv.h

@@ -1009,7 +1009,7 @@
   #define FILAMENT_UNLOAD_DELAY             5000  // (ms) Delay for the filament to cool after retract.
   #define FILAMENT_UNLOAD_PURGE_LENGTH         8  // (mm) An unretract is done, then this length is purged.
 
-  #define PAUSE_PARK_NOZZLE_TIMEOUT          300  // (seconds) Time limit before the nozzle is turned off for safety.
+  #define PAUSE_PARK_NOZZLE_TIMEOUT          600  // (seconds) Time limit before the nozzle is turned off for safety.
   #define FILAMENT_CHANGE_ALERT_BEEPS         10  // Number of alert beeps to play when a response is needed.
   #define PAUSE_PARK_NO_STEPPER_TIMEOUT           // Enable for XYZ steppers to stay powered on during filament change.
 

Marlin/Marlin.h

@@ -271,6 +271,9 @@ FORCE_INLINE bool all_axes_known() { return (axis_known_position & xyz_bits) ==
 
 extern volatile bool wait_for_heatup;
 
+// Making sure this flag can be cleared by the Anycubic display
+extern volatile bool nozzle_timed_out;
+
 #if HAS_RESUME_CONTINUE
   extern volatile bool wait_for_user;
 #endif

Marlin/Marlin_main.cpp

@@ -519,6 +519,9 @@ static bool relative_mode; // = false;
 // For M109 and M190, this flag may be cleared (by M108) to exit the wait loop
 volatile bool wait_for_heatup = true;
 
+// Making sure this flag can be cleared by the Anycubic display
+volatile bool nozzle_timed_out = false;
+
 // For M0/M1, this flag may be cleared (by M108) to exit the wait-for-user loop
 #if HAS_RESUME_CONTINUE
   volatile bool wait_for_user; // = false;
@@ -7213,7 +7216,11 @@ inline void gcode_M17() {
    * Used by M125 and M600
    */
   static void wait_for_filament_reload(const int8_t max_beep_count=0) {
-    bool nozzle_timed_out = false;
+    nozzle_timed_out = false;
+    nozzle_timed_out = false;
+    #ifdef ANYCUBIC_TFT_MODEL
+      AnycubicTFT.PausedByNozzleTimeout = false;
+    #endif
 
     #if ENABLED(ULTIPANEL)
       lcd_advanced_pause_show_message(ADVANCED_PAUSE_MESSAGE_INSERT);
@@ -7246,6 +7253,14 @@ inline void gcode_M17() {
           nozzle_timed_out |= thermalManager.is_heater_idle(e);
 
       if (nozzle_timed_out) {
+
+        #ifdef ANYCUBIC_TFT_MODEL
+          AnycubicTFT.PausedByNozzleTimeout=true;
+          #ifdef ANYCUBIC_TFT_DEBUG
+            SERIAL_ECHOLNPGM("DEBUG: Nozzle timeout flag set");
+          #endif
+        #endif
+
         #if ENABLED(ULTIPANEL)
           lcd_advanced_pause_show_message(ADVANCED_PAUSE_MESSAGE_CLICK_TO_HEAT_NOZZLE);
         #endif
@@ -7287,6 +7302,9 @@ inline void gcode_M17() {
 
         wait_for_user = true; // Wait for user to load filament
         nozzle_timed_out = false;
+        #ifdef ANYCUBIC_TFT_DEBUG
+          AnycubicTFT.PausedByNozzleTimeout = false;
+        #endif
 
         #if HAS_BUZZER
           filament_change_beep(max_beep_count, true);
@@ -7320,7 +7338,11 @@ inline void gcode_M17() {
     if (!did_pause_print) return;
 
     // Re-enable the heaters if they timed out
-    bool nozzle_timed_out = false;
+    nozzle_timed_out = false;
+    #ifdef ANYCUBIC_TFT_MODEL
+      AnycubicTFT.PausedByNozzleTimeout = false;
+    #endif
+
     HOTEND_LOOP() {
       nozzle_timed_out |= thermalManager.is_heater_idle(e);
       thermalManager.reset_heater_idle_timer(e);
@@ -8508,7 +8530,7 @@ inline void gcode_M109() {
     #ifdef ANYCUBIC_TFT_MODEL
       AnycubicTFT.CommandScan();
     #endif
-    
+
     #if TEMP_RESIDENCY_TIME > 0
 
       const float temp_diff = ABS(target_temp - temp);
@@ -8547,11 +8569,11 @@ inline void gcode_M109() {
   #ifdef ANYCUBIC_TFT_MODEL
   AnycubicTFT.HeatingDone();
   #endif
-  
+
   #if DISABLED(BUSY_WHILE_HEATING)
     KEEPALIVE_STATE(IN_HANDLER);
   #endif
-  
+
   // flush the serial buffer after heating to prevent lockup by m105
   SERIAL_FLUSH();
 
@@ -8665,11 +8687,11 @@ inline void gcode_M109() {
           }
         }
       #endif
-      
+
       #ifdef ANYCUBIC_TFT_MODEL
       AnycubicTFT.CommandScan();
       #endif
-      
+
       #if TEMP_BED_RESIDENCY_TIME > 0
 
         const float temp_diff = ABS(target_temp - temp);
@@ -8697,16 +8719,16 @@ inline void gcode_M109() {
       }
 
     } while (wait_for_heatup && TEMP_BED_CONDITIONS);
-    
+
     #ifdef ANYCUBIC_TFT_MODEL
     AnycubicTFT.BedHeatingDone();
     #endif
-    
+
     if (wait_for_heatup) lcd_reset_status();
     #if DISABLED(BUSY_WHILE_HEATING)
       KEEPALIVE_STATE(IN_HANDLER);
     #endif
-    
+
      // flush the serial buffer after heating to prevent lockup by m105
      SERIAL_FLUSH();
   }
@@ -8904,7 +8926,7 @@ inline void gcode_M111() {
     #if ENABLED(ULTIPANEL)
       lcd_reset_status();
     #endif
-    
+
     #ifdef ANYCUBIC_TFT_MODEL
     AnycubicTFT.CommandScan();
     #endif
@@ -8940,7 +8962,7 @@ inline void gcode_M81() {
   #if ENABLED(ULTIPANEL)
     LCD_MESSAGEPGM(MACHINE_NAME " " MSG_OFF ".");
   #endif
-  
+
   #ifdef ANYCUBIC_TFT_MODEL
   AnycubicTFT.CommandScan();
   #endif
@@ -10992,12 +11014,23 @@ inline void gcode_M502() {
    *  Default values are used for omitted arguments.
    */
   inline void gcode_M600() {
+
     #ifdef SDSUPPORT
-        if ((AnycubicTFT.TFTstate==ANYCUBIC_TFT_STATE_SDPRINT)){
-        AnycubicTFT.TFTstate=ANYCUBIC_TFT_STATE_SDPAUSE_REQ;
-        AnycubicTFT.PausedByFilamentChange=true;
-        }
+      if (card.sdprinting) { // are we printing from sd?
+        #ifdef ANYCUBIC_TFT_DEBUG
+            SERIAL_ECHOLNPGM("DEBUG: Enter M600 TFTstate routine");
+        #endif
+        AnycubicTFT.TFTstate=ANYCUBIC_TFT_STATE_SDPAUSE_REQ; // enter correct display state to show resume button
+        #ifdef ANYCUBIC_TFT_DEBUG
+            SERIAL_ECHOLNPGM("DEBUG: Set TFTstate to SDPAUSE_REQ");
+        #endif
+        AnycubicTFT.PausedByFilamentChange=true; // set flag to ensure correct resume routine gets executed
+        #ifdef ANYCUBIC_TFT_DEBUG
+            SERIAL_ECHOLNPGM("DEBUG: Set filament change flag");
+        #endif
+      }
     #endif
+
     point_t park_point = NOZZLE_PARK_POINT;
 
     if (get_target_extruder_from_command(600)) return;
@@ -14746,7 +14779,7 @@ void manage_inactivity(const bool ignore_stepper_queue/*=false*/) {
   #if ENABLED(FILAMENT_RUNOUT_SENSOR)
     runout.run();
   #endif
-  
+
   #if ENABLED(ANYCUBIC_TFT_MODEL) && ENABLED(ANYCUBIC_FILAMENT_RUNOUT_SENSOR)
   AnycubicTFT.FilamentRunout();
   #endif
@@ -14954,7 +14987,7 @@ void idle(
 #ifdef ANYCUBIC_TFT_MODEL
   AnycubicTFT.CommandScan();
 #endif
-  
+
   lcd_update();
 
   host_keepalive();
@@ -15011,7 +15044,7 @@ void kill(const char* lcd_msg) {
   #else
     UNUSED(lcd_msg);
   #endif
-  
+
   #ifdef ANYCUBIC_TFT_MODEL
     // Kill AnycubicTFT
     AnycubicTFT.KillTFT();
@@ -15106,7 +15139,7 @@ void setup() {
   MYSERIAL0.begin(BAUDRATE);
   SERIAL_PROTOCOLLNPGM("start");
   SERIAL_ECHO_START();
-  
+
   #ifdef ANYCUBIC_TFT_MODEL
     // Setup AnycubicTFT
     AnycubicTFT.Setup();
@@ -15132,6 +15165,9 @@ void setup() {
   SERIAL_ECHOPGM(MSG_MARLIN);
   SERIAL_CHAR(' ');
   SERIAL_ECHOLNPGM(SHORT_BUILD_VERSION);
+  SERIAL_ECHOPGM(MSG_MARLIN_AI3M);
+  SERIAL_CHAR(' ');
+  SERIAL_ECHOLNPGM(CUSTOM_BUILD_VERSION);
   SERIAL_EOL();
 
   #if defined(STRING_DISTRIBUTION_DATE) && defined(STRING_CONFIG_H_AUTHOR)

Marlin/Version.h

@@ -37,18 +37,24 @@
    */
   #define SHORT_BUILD_VERSION "1.1.9"
 
+  /**
+   * Defines the version of the Marlin-AI3M build. Not to be confused with
+   * Marlin's own build number, e.g. 1.1.9.
+   */
+  #define CUSTOM_BUILD_VERSION "v1.4.3"
+
   /**
    * Verbose version identifier which should contain a reference to the location
    * from where the binary was downloaded or the source code was compiled.
    */
-  #define DETAILED_BUILD_VERSION SHORT_BUILD_VERSION " (Github, davidramiro)"
+  #define DETAILED_BUILD_VERSION SHORT_BUILD_VERSION "(Github, davidramiro)"
 
   /**
    * The STRING_DISTRIBUTION_DATE represents when the binary file was built,
    * here we define this default string as the date where the latest release
    * version was tagged.
    */
-  #define STRING_DISTRIBUTION_DATE "2019-02-18"
+  #define STRING_DISTRIBUTION_DATE "2019-03-06"
 
   /**
    * Required minimum Configuration.h and Configuration_adv.h file versions.
@@ -78,7 +84,7 @@
    * has a distinct Github fork— the Source Code URL should just be the main
    * Marlin repository.
    */
-  #define SOURCE_CODE_URL "https://github.com/MarlinFirmware/Marlin"
+  #define SOURCE_CODE_URL "https://github.com/davidramiro/Marlin-AI3M"
 
   /**
    * Default generic printer UUID.

Marlin/language.h

@@ -137,7 +137,8 @@
 #define MSG_INVALID_EXTRUDER                "Invalid extruder"
 #define MSG_INVALID_SOLENOID                "Invalid solenoid"
 #define MSG_ERR_NO_THERMISTORS              "No thermistors - no temperature"
-#define MSG_M115_REPORT                     "FIRMWARE_NAME:Marlin " DETAILED_BUILD_VERSION " SOURCE_CODE_URL:" SOURCE_CODE_URL " PROTOCOL_VERSION:" PROTOCOL_VERSION " MACHINE_TYPE:" MACHINE_NAME " EXTRUDER_COUNT:" STRINGIFY(EXTRUDERS) " UUID:" MACHINE_UUID
+#define MSG_M115_REPORT                     "FIRMWARE_NAME:Marlin " DETAILED_BUILD_VERSION " MARLIN-AI3M_VERSION:" CUSTOM_BUILD_VERSION " SOURCE_CODE_URL:" SOURCE_CODE_URL " PROTOCOL_VERSION:" PROTOCOL_VERSION " MACHINE_TYPE:" MACHINE_NAME " EXTRUDER_COUNT:" STRINGIFY(EXTRUDERS) " UUID:" MACHINE_UUID
+#define MSG_MARLIN_AI3M                     "Marlin-AI3M"
 #define MSG_COUNT_X                         " Count X:"
 #define MSG_COUNT_A                         " Count A:"
 #define MSG_ERR_KILLED                      "Printer halted. kill() called!"

README.md

@@ -9,25 +9,23 @@ Feel free to discuss issues and work with me further optimizing this firmware!
 I am running this version on an i3 Mega Ultrabase V3 (for distinction of the different versions, check [this Thingiverse thread](https://www.thingiverse.com/groups/anycubic-i3-mega/forums/general/topic:27064)).
 Basically, this should work on every Ultrabase version that has two Z-axis endstops.
 
-The new Mega-S should work too, but you will need to enter those two commands to make the new extruder work:
-```
-M92 E384
-M500
-```
-Afterwards, calibration is highly recommended as per the instructions on the [Wiki](https://github.com/davidramiro/Marlin-AI3M/wiki/Extruder-Calibration/).
+The new **Mega-S** should work too, but you will need to enter two additional commands after flashing the firmware, mentioned in the instructions below.
+
+Looking for a **BLtouch firmware**? Head [this way](https://github.com/MNieddu91/Marlin-AI3M-BLTouch)! Mounting and configuration instructions are included.
 
 Note: This is just a firmware, not magic. A big part of print quality still depends on your slicer settings and mechanical condition of your machine.
 
 #### Make sure to take a look at the [Wiki](https://github.com/davidramiro/Marlin-AI3M/wiki/), especially the [FAQ](https://github.com/davidramiro/Marlin-AI3M/wiki/Frequently-Asked-Questions).
 
+A German translation of the instructions can be found [here](https://kore.cc/i3mega/download/marlin-ai3m_german.pdf).
 
 ## Known issues:
 
-- **Cura users: Please turn off jerk and acceleration control in your print settings (not visible by default, select advanced visibility to unlock them). Cura's high default jerk and acceleration might cause shifted layers if you use TMC2208.**
+- Power outage support is not included
 - Estimated print times from your slicer might be slightly off.
 - Special characters on any file or folders name on the SD card will cause the file menu to freeze. Simply replace or remove every special character (Chinese, Arabic, Russian, accents, German & Scandinavian umlauts, ...) from the name. Symbols like dashes or underscores are no problem.
 **Important note: On the SD card that comes with the printer there is a folder with Chinese characters in it by default. Please rename or remove it.**
-- Cancelling prints via display is buggy sometimes, simply reboot the printer when the menu shows an error. Protip: Switch to OctoPrint.
+- Cancelling prints after pausing may show an error. Simply resume the print before canceling. Protip: Switch to OctoPrint.
 
 
 ## Why use this?
@@ -40,7 +38,7 @@ While the i3 Mega is a great printer for its price and produces fantastic result
 - Even better print quality by adding Linear Advance, S-Curve Acceleration and some tweaks on jerk and acceleration.
 - Thermal runaway protection: Reducing fire risk by detecting a faulty or misaligned thermistor.
 - Very loud stock stepper motor drivers, easily replaced by Watterott or FYSETC TMC2208. To do that, you'd usually have to flip the connectors on the board, this is not necessary using this firmware.
-- No need to slice and upload custom bed leveling tests, simply start one with a simple G26 command.
+- No need to slice and upload custom bed leveling tests, test it with a single GCode command
 - Easily start an auto PID tune or mesh bed leveling via the special menu (insert SD card, select special menu and press the round arrow)
 - Filament change feature enabled: Switch colors/material mid print with `M600` (instructions below)
 
@@ -52,10 +50,10 @@ I provided three different precompiled hex files: One for no modifications on th
 
 - Download the precompiled firmware here: [Releases](https://github.com/davidramiro/Marlin-AI3M/releases)
 - Choose the correct hex file:
-- For TMC2208 with connectors in original orientation, use `Marlin-AI3M-XXXXXX-TMC2208.hex`
-- If you use TMC2208 and already reversed your connectors, use `Marlin-AI3M-XXXXXX-TMC2208_reversed.hex`
-- If you use a newer version of the TMC2208 that doesn't require the connector to be reversed (TMC2208 "v2.0" written on the PCB, chip on the top side), please also use `Marlin-AI3M-XXXXXX-TMC2208_reversed.hex`.
-- If you use the original stepper motor drivers, use `Marlin-AI3M-XXXXXX-stock_drivers.hex`.
+- For TMC2208 with connectors in original orientation, use `Marlin-AI3M-vx.x.x-TMC2208.hex`
+- If you use TMC2208 and already reversed your connectors, use `Marlin-AI3M-vx.x.x-TMC2208_reversed.hex`
+- If you use a newer version of the TMC2208 that doesn't require the connector to be reversed (TMC2208 "v2.0" written on the PCB, chip on the top side), please also use `Marlin-AI3M-vx.x.x-TMC2208_reversed.hex`.
+- If you use the original stepper motor drivers, use `Marlin-AI3M-vx.x.x-stock_drivers.hex`.
 
 ### Or compile it yourself:
 
@@ -75,6 +73,11 @@ I provided three different precompiled hex files: One for no modifications on th
 - `M502` - load hard coded default values
 - `M500` - save them to EEPROM
 
+**If you are using this on a Mega-S, those two additional commands are necessary:**
+- `M92 E384` - set correct steps for the new extruder
+- `M500` - save them
+- I highly recommend calibrating the extruder.
+
 #### Calibration and other instructions have been moved to the [Wiki](https://github.com/davidramiro/Marlin-AI3M/wiki/Calibration).
 
 
@@ -169,6 +172,7 @@ G26 C H200 P25 R25
 #### Configuration:
 - Send `M603 L0 U0` to use manual loading & unloading.
 - Send `M603 L538 U555` to use automatic loading & unloading
+  - The `L` and `U` paramters define the load and unload length in mm. The values above work well on a stock setup, if you modded your extruder, bowden tube or hotend, you might need to adjust those.
 - Save with `M500`
 
 #### Filament change process (manual loading):
@@ -178,6 +182,9 @@ G26 C H200 P25 R25
   - Place `M600` in your GCode at the desired layer or send it via terminal
   - Alternatively: Use `FilamentChange Pause` in the Special Menu
 - The nozzle will park and your printer will beep
+  - For safety reasons, the printer will turn off the hotend after 10 minutes. If you see the temperature being under the target:
+    - SD printing: Click `CONTINUE` **(only once!)** on the screen and wait for the hotend to heat up again.
+    - USB printing: Send `M108` and wait for the hotend to heat up again.
 - Remove the filament from the bowden tube
 - Insert the new filament right up to the nozzle, just until a bit of plastic oozes out
 - Remove the excess filament from the nozzle with tweezers
@@ -195,6 +202,9 @@ G26 C H200 P25 R25
   - Alternatively: Use `FilamentChange Pause` in the Special Menu
 - The nozzle will park
 - The printer will remove the filament right up to the extruder and beep when finished
+  - For safety reasons, the printer will turn off the hotend after 10 minutes. If you see the temperature being under the target:
+    - SD printing: Click `CONTINUE` **(only once!)** on the screen and wait for the hotend to heat up again.
+    - USB printing: Send `M108` and wait for the hotend to heat up again.
 - Insert the new filament just up to the end of the bowden fitting, as shown here:
 
 ![Load Filament][m600 load]
@@ -228,7 +238,7 @@ After flashing the new version, issue a `M502` and `M500`. After that, enter eve
 
 ## Detailed changes:
 
-- Thermal runaway protection enabled and tweaked
+- Thermal runaway protection thresholds tweaked
 - Manual mesh bed leveling enabled ([check this link](https://github.com/MarlinFirmware/Marlin/wiki/Manual-Mesh-Bed-Leveling) to learn more about it)
 - Heatbed PID mode enabled
 - TMC2208 configured in standalone mode
@@ -240,6 +250,8 @@ After flashing the new version, issue a `M502` and `M500`. After that, enter eve
 - Minor tweaks on default jerk and acceleration
 - Printcounter enabled (`M78`)
 - `M600` filament change feature enabled
+- Screen resume for `M600` implemented
+- Filament runout, stop and pause behaviour tweaked
 
 
 ## Changes by [derhopp](https://github.com/derhopp/):