♻️ Consolidate PSU_CONTROL (#22304)

Marlin/src/MarlinCore.cpp

@@ -236,6 +236,10 @@
   #include "feature/stepper_driver_safety.h"
 #endif
 
+#if ENABLED(PSU_CONTROL)
+  #include "feature/power.h"
+#endif
+
 PGMSTR(M112_KILL_STR, "M112 Shutdown");
 
 MarlinState marlin_state = MF_INITIALIZING;
@@ -883,7 +887,7 @@ void minkill(const bool steppers_off/*=false*/) {
   // Power off all steppers (for M112) or just the E steppers
   steppers_off ? disable_all_steppers() : disable_e_steppers();
 
-  TERN_(PSU_CONTROL, PSU_OFF());
+  TERN_(PSU_CONTROL, powerManager.power_off());
 
   TERN_(HAS_SUICIDE, suicide());
 
@@ -1189,8 +1193,7 @@ void setup() {
 
   #if ENABLED(PSU_CONTROL)
     SETUP_LOG("PSU_CONTROL");
-    powersupply_on = ENABLED(PSU_DEFAULT_OFF);
+    powerManager.init();
-    if (ENABLED(PSU_DEFAULT_OFF)) PSU_OFF(); else PSU_ON();
   #endif
 
   #if ENABLED(POWER_LOSS_RECOVERY)

Marlin/src/MarlinCore.h

@@ -81,25 +81,6 @@ extern bool wait_for_heatup;
   void wait_for_user_response(millis_t ms=0, const bool no_sleep=false);
 #endif
 
-#if ENABLED(PSU_CONTROL)
-  extern bool powersupply_on;
-  #define PSU_PIN_ON()  do{ OUT_WRITE(PS_ON_PIN,  PSU_ACTIVE_STATE); powersupply_on = true;  }while(0)
-  #define PSU_PIN_OFF() do{ OUT_WRITE(PS_ON_PIN, !PSU_ACTIVE_STATE); powersupply_on = false; }while(0)
-  #if ENABLED(AUTO_POWER_CONTROL)
-    #define PSU_ON()       powerManager.power_on()
-    #define PSU_OFF()      powerManager.power_off()
-    #define PSU_OFF_SOON() powerManager.power_off_soon()
-  #else
-    #define PSU_ON()     PSU_PIN_ON()
-    #if ENABLED(PS_OFF_SOUND)
-      #define PSU_OFF()  do{ BUZZ(1000, 659); PSU_PIN_OFF(); }while(0)
-    #else
-      #define PSU_OFF()  PSU_PIN_OFF()
-    #endif
-    #define PSU_OFF_SOON PSU_OFF
-  #endif
-#endif
-
 bool pin_is_protected(const pin_t pin);
 
 #if HAS_SUICIDE

Marlin/src/feature/power.cpp

@@ -26,10 +26,7 @@
 
 #include "../inc/MarlinConfig.h"
 
-#if ENABLED(AUTO_POWER_CONTROL)
-
 #include "power.h"
-#include "../module/temperature.h"
 #include "../module/stepper/indirection.h"
 #include "../MarlinCore.h"
 
@@ -41,15 +38,85 @@
   #include "../gcode/gcode.h"
 #endif
 
-#if BOTH(USE_CONTROLLER_FAN, AUTO_POWER_CONTROLLERFAN)
+Power powerManager;
+bool Power::psu_on;
+
+#if ENABLED(AUTO_POWER_CONTROL)
+  #include "../module/temperature.h"
+
+  #if BOTH(USE_CONTROLLER_FAN, AUTO_POWER_CONTROLLERFAN)
     #include "controllerfan.h"
+  #endif
+
+  millis_t Power::lastPowerOn;
 #endif
 
-Power powerManager;
+/**
+ * Initialize pins & state for the power manager.
+ *
+ */
+void Power::init(){
+  psu_on = ENABLED(PSU_DEFAULT_OFF);              // Set opposite state to get full power_off/on
+  TERN(PSU_DEFAULT_OFF, power_off(), power_on());
+}
 
-millis_t Power::lastPowerOn;
+/**
+ * Power on if the power is currently off.
+ * Restores stepper drivers and processes any PSU_POWERUP_GCODE.
+ *
+ */
+void Power::power_on() {
+  #if ENABLED(AUTO_POWER_CONTROL)
+    const millis_t now = millis();
+    lastPowerOn = now + !now;
+  #endif
 
-bool Power::is_power_needed() {
+  if (psu_on) return;
+
+  OUT_WRITE(PS_ON_PIN, PSU_ACTIVE_STATE);
+  psu_on = true;
+  safe_delay(PSU_POWERUP_DELAY);
+  restore_stepper_drivers();
+  TERN_(HAS_TRINAMIC_CONFIG, safe_delay(PSU_POWERUP_DELAY));
+
+  #ifdef PSU_POWERUP_GCODE
+    GcodeSuite::process_subcommands_now_P(PSTR(PSU_POWERUP_GCODE));
+  #endif
+}
+
+/**
+ * Power off if the power is currently on.
+ * Processes any PSU_POWEROFF_GCODE and makes a PS_OFF_SOUND if enabled.
+ *
+ */
+void Power::power_off() {
+  if (!psu_on) return;
+
+  #ifdef PSU_POWEROFF_GCODE
+    GcodeSuite::process_subcommands_now_P(PSTR(PSU_POWEROFF_GCODE));
+  #endif
+
+  #if ENABLED(PS_OFF_SOUND)
+    BUZZ(1000, 659);
+  #endif
+
+  OUT_WRITE(PS_ON_PIN, !PSU_ACTIVE_STATE);
+  psu_on = false;
+}
+
+
+#if ENABLED(AUTO_POWER_CONTROL)
+
+  #ifndef POWER_TIMEOUT
+    #define POWER_TIMEOUT 0
+  #endif
+
+  /**
+   * Check all conditions that would signal power needing to be on.
+   *
+   * @returns bool  if power is needed
+   */
+  bool Power::is_power_needed() {
 
     if (printJobOngoing() || printingIsPaused()) return true;
 
@@ -107,17 +174,18 @@ bool Power::is_power_needed() {
     #endif
 
     return false;
-}
+  }
 
-#ifndef POWER_TIMEOUT
+  /**
-  #define POWER_TIMEOUT 0
+   * Check if we should power off automatically (POWER_TIMEOUT elapsed, !is_power_needed).
-#endif
+   *
-
+   * @param pause  pause the 'timer'
-void Power::check(const bool pause) {
+   */
-  static bool _pause = false;
+  void Power::check(const bool pause) {
     static millis_t nextPowerCheck = 0;
     const millis_t now = millis();
     #if POWER_TIMEOUT > 0
+      static bool _pause = false;
       if (pause != _pause) {
         lastPowerOn = now + !now;
         _pause = pause;
@@ -131,43 +199,18 @@ void Power::check(const bool pause) {
       else if (!lastPowerOn || (POWER_TIMEOUT > 0 && ELAPSED(now, lastPowerOn + SEC_TO_MS(POWER_TIMEOUT))))
         power_off();
     }
-}
-
-void Power::power_on() {
-  const millis_t now = millis();
-  lastPowerOn = now + !now;
-  if (!powersupply_on) {
-    PSU_PIN_ON();
-    safe_delay(PSU_POWERUP_DELAY);
-    restore_stepper_drivers();
-    TERN_(HAS_TRINAMIC_CONFIG, safe_delay(PSU_POWERUP_DELAY));
-    #ifdef PSU_POWERUP_GCODE
-      GcodeSuite::process_subcommands_now_P(PSTR(PSU_POWERUP_GCODE));
-    #endif
   }
-}
 
-void Power::power_off() {
+  #if POWER_OFF_DELAY > 0
-  if (powersupply_on) {
-    #ifdef PSU_POWEROFF_GCODE
-      GcodeSuite::process_subcommands_now_P(PSTR(PSU_POWEROFF_GCODE));
-    #endif
 
-    #if ENABLED(PS_OFF_SOUND)
+    /**
-      BUZZ(1000, 659);
+     * Power off with a delay. Power off is triggered by check() after the delay.
-    #endif
+     *
-
+     */
-    PSU_PIN_OFF();
+    void Power::power_off_soon() {
-  }
-}
-
-void Power::power_off_soon() {
-  #if POWER_OFF_DELAY
       lastPowerOn = millis() - SEC_TO_MS(POWER_TIMEOUT) + SEC_TO_MS(POWER_OFF_DELAY);
-    //if (!lastPowerOn) ++lastPowerOn;
+    }
-  #else
+
-    power_off();
   #endif
-}
 
 #endif // AUTO_POWER_CONTROL

Marlin/src/feature/power.h

@@ -25,17 +25,32 @@
  * power.h - power control
  */
 
-#include "../core/millis_t.h"
+#if ENABLED(AUTO_POWER_CONTROL)
+  #include "../core/millis_t.h"
+#endif
 
 class Power {
   public:
-    static void check(const bool pause);
+    static bool psu_on;
+
+    static void init();
     static void power_on();
     static void power_off();
+
+  #if ENABLED(AUTO_POWER_CONTROL) && POWER_OFF_DELAY > 0
     static void power_off_soon();
+  #else
+    static inline void power_off_soon() { power_off(); }
+  #endif
+
+  #if ENABLED(AUTO_POWER_CONTROL)
+    static void check(const bool pause);
+
     private:
       static millis_t lastPowerOn;
       static bool is_power_needed();
+
+  #endif
 };
 
 extern Power powerManager;

Marlin/src/gcode/control/M80_M81.cpp

@@ -29,25 +29,17 @@
 
 #include "../../inc/MarlinConfig.h"
 
+#if ENABLED(PSU_CONTROL)
+  #include "../queue.h"
+  #include "../../feature/power.h"
+#endif
+
 #if HAS_SUICIDE
   #include "../../MarlinCore.h"
 #endif
 
 #if ENABLED(PSU_CONTROL)
 
-  #if ENABLED(AUTO_POWER_CONTROL)
-    #include "../../feature/power.h"
-  #else
-    void restore_stepper_drivers();
-  #endif
-
-  // Could be moved to a feature, but this is all the data
-  bool powersupply_on;
-
-  #if HAS_TRINAMIC_CONFIG
-    #include "../../feature/tmc_util.h"
-  #endif
-
   /**
    * M80   : Turn on the Power Supply
    * M80 S : Report the current state and exit
@@ -56,11 +48,11 @@
 
     // S: Report the current power supply state and exit
     if (parser.seen('S')) {
-      SERIAL_ECHOPGM_P(powersupply_on ? PSTR("PS:1\n") : PSTR("PS:0\n"));
+      SERIAL_ECHOPGM_P(powerManager.psu_on ? PSTR("PS:1\n") : PSTR("PS:0\n"));
       return;
     }
 
-    PSU_ON();
+    powerManager.power_on();
 
     /**
      * If you have a switch on suicide pin, this is useful
@@ -71,12 +63,6 @@
       OUT_WRITE(SUICIDE_PIN, !SUICIDE_PIN_INVERTING);
     #endif
 
-    #if DISABLED(AUTO_POWER_CONTROL)
-      safe_delay(PSU_POWERUP_DELAY);
-      restore_stepper_drivers();
-      TERN_(HAS_TRINAMIC_CONFIG, safe_delay(PSU_POWERUP_DELAY));
-    #endif
-
     TERN_(HAS_LCD_MENU, ui.reset_status());
   }
 
@@ -106,7 +92,7 @@ void GcodeSuite::M81() {
   #if HAS_SUICIDE
     suicide();
   #elif ENABLED(PSU_CONTROL)
-    PSU_OFF_SOON();
+    powerManager.power_off_soon();
   #endif
 
   LCD_MESSAGEPGM_P(PSTR(MACHINE_NAME " " STR_OFF "."));

Marlin/src/lcd/marlinui.cpp

@@ -158,6 +158,10 @@ constexpr uint8_t epps = ENCODER_PULSES_PER_STEP;
     #include "../feature/power_monitor.h"
   #endif
 
+  #if ENABLED(PSU_CONTROL) && defined(LED_BACKLIGHT_TIMEOUT)
+    #include "../feature/power.h"
+  #endif
+
   #if HAS_ENCODER_ACTION
     volatile uint8_t MarlinUI::buttons;
     #if HAS_SLOW_BUTTONS
@@ -826,8 +830,8 @@ constexpr uint8_t epps = ENCODER_PULSES_PER_STEP;
     static uint16_t max_display_update_time = 0;
     millis_t ms = millis();
 
-    #ifdef LED_BACKLIGHT_TIMEOUT
+    #if ENABLED(PSU_CONTROL) && defined(LED_BACKLIGHT_TIMEOUT)
-      leds.update_timeout(powersupply_on);
+      leds.update_timeout(powerManager.psu_on);
     #endif
 
     #if HAS_LCD_MENU
@@ -976,8 +980,8 @@ constexpr uint8_t epps = ENCODER_PULSES_PER_STEP;
 
           refresh(LCDVIEW_REDRAW_NOW);
 
-          #ifdef LED_BACKLIGHT_TIMEOUT
+          #if ENABLED(PSU_CONTROL) && defined(LED_BACKLIGHT_TIMEOUT)
-            if (!powersupply_on) leds.reset_timeout(ms);
+            if (!powerManager.psu_on) leds.reset_timeout(ms);
           #endif
         }
 

Marlin/src/lcd/menu/menu_led.cpp

@@ -30,6 +30,10 @@
 
 #include "menu_item.h"
 
+#if ENABLED(PSU_CONTROL)
+  #include "../../feature/power.h"
+#endif
+
 #if ENABLED(LED_CONTROL_MENU)
   #include "../../feature/leds/leds.h"
 
@@ -125,12 +129,7 @@ void menu_led() {
   BACK_ITEM(MSG_MAIN);
 
   #if ENABLED(LED_CONTROL_MENU)
-    #if ENABLED(PSU_CONTROL)
+    if (TERN1(PSU_CONTROL, powerManager.psu_on)) {
-      extern bool powersupply_on;
-    #else
-      constexpr bool powersupply_on = true;
-    #endif
-    if (powersupply_on) {
       editable.state = leds.lights_on;
       EDIT_ITEM(bool, MSG_LEDS, &editable.state, leds.toggle);
     }

Marlin/src/lcd/menu/menu_main.cpp

@@ -35,6 +35,10 @@
 #include "../../module/stepper.h"
 #include "../../sd/cardreader.h"
 
+#if ENABLED(PSU_CONTROL)
+  #include "../../feature/power.h"
+#endif
+
 #if HAS_GAMES && DISABLED(LCD_INFO_MENU)
   #include "game/game.h"
 #endif
@@ -385,7 +389,7 @@ void menu_main() {
   // Switch power on/off
   //
   #if ENABLED(PSU_CONTROL)
-    if (powersupply_on)
+    if (powerManager.psu_on)
       #if ENABLED(PS_OFF_CONFIRM)
         CONFIRM_ITEM(MSG_SWITCH_PS_OFF,
           MSG_YES, MSG_NO,

Marlin/src/module/stepper/indirection.h

@@ -44,7 +44,7 @@
   #include "trinamic.h"
 #endif
 
-void restore_stepper_drivers();  // Called by PSU_ON
+void restore_stepper_drivers();  // Called by powerManager.power_on()
 void reset_stepper_drivers();    // Called by settings.load / settings.reset
 
 // X Stepper

ini/features.ini

@@ -128,7 +128,7 @@ HAS_PRUSA_MMU1                         = src_filter=+<src/feature/mmu/mmu.cpp>
 HAS_PRUSA_MMU2                         = src_filter=+<src/feature/mmu/mmu2.cpp> +<src/gcode/feature/prusa_MMU2>
 PASSWORD_FEATURE                       = src_filter=+<src/feature/password> +<src/gcode/feature/password>
 ADVANCED_PAUSE_FEATURE                 = src_filter=+<src/feature/pause.cpp> +<src/gcode/feature/pause/M600.cpp> +<src/gcode/feature/pause/M603.cpp>
-AUTO_POWER_CONTROL                     = src_filter=+<src/feature/power.cpp>
+PSU_CONTROL                            = src_filter=+<src/feature/power.cpp>
 HAS_POWER_MONITOR                      = src_filter=+<src/feature/power_monitor.cpp> +<src/gcode/feature/power_monitor>
 POWER_LOSS_RECOVERY                    = src_filter=+<src/feature/powerloss.cpp> +<src/gcode/feature/powerloss>
 PROBE_TEMP_COMPENSATION                = src_filter=+<src/feature/probe_temp_comp.cpp> +<src/gcode/calibrate/G76_M192_M871.cpp>