[GPIO] Added “Wake on Button Press” functionality.

src/_P001_Switch.ino

@@ -11,6 +11,19 @@
 
 # include "src/PluginStructs/P001_data_struct.h"
 
+# ifdef ESP32
+#  include "esp_sleep.h"
+#  if defined(CONFIG_IDF_TARGET_ESP32) || \
+  defined(CONFIG_IDF_TARGET_ESP32S2) ||   \
+  defined(CONFIG_IDF_TARGET_ESP32S3)
+#   include "driver/rtc_io.h"
+#  endif // if defined(CONFIG_IDF_TARGET_ESP32) || defined(CONFIG_IDF_TARGET_ESP32S2) || defined(CONFIG_IDF_TARGET_ESP32S3)
+void setupGpioWakeup(uint8_t pin,
+                     bool    wakeOnLow = true); // if ever needed we can also add support for wakeOnHigh, but for now
+                                                // when using a switch/button, the wakeup will be triggered by the pin going low (active
+                                                // low)
+# endif // ifdef ESP32
+
 // #######################################################################################################
 // #################################### Plugin 001: Input Switch #########################################
 // #######################################################################################################
@@ -125,6 +138,14 @@ boolean Plugin_001(uint8_t function, struct EventStruct *event, String& string)
         P001_LP_MIN_INT,
         P001_SAFE_BTN);
 
+        # ifdef ESP32
+
+      if (esp_sleep_is_valid_wakeup_gpio((gpio_num_t)CONFIG_PIN1)) {
+        addFormCheckBox(F("Wake from sleep"), F("sw_wake"), P001_WAKE_BTN);
+        addFormNote(F("Make sure to enable the internal pull-up resistor or add an external pull-up resistor!"));
+      }
+# endif // ifdef ESP32
+
       # if FEATURE_MQTT_DISCOVER && FEATURE_MQTT_DEVICECLASS
 
       if (switchtype != PLUGIN_001_TYPE_DIMMER) {
@@ -160,6 +181,13 @@ boolean Plugin_001(uint8_t function, struct EventStruct *event, String& string)
         P001_LP_MIN_INT,
         P001_SAFE_BTN);
 
+      # ifdef ESP32
+
+      if (esp_sleep_is_valid_wakeup_gpio((gpio_num_t)CONFIG_PIN1)) {
+        P001_WAKE_BTN = isFormItemChecked(F("sw_wake"));
+      }
+      # endif // ifdef ESP32
+
       # if FEATURE_MQTT_DISCOVER && FEATURE_MQTT_DEVICECLASS
       P001_MQTT_DEVICECLASS = getFormItemInt(F("devcls"));
       # endif // if FEATURE_MQTT_DISCOVER && FEATURE_MQTT_DEVICECLASS
@@ -190,10 +218,34 @@ boolean Plugin_001(uint8_t function, struct EventStruct *event, String& string)
 
     case PLUGIN_INIT:
     {
+
       // apply INIT only if PORT is in range. Do not start INIT if port not set in the device page.
       if (validGpio(CONFIG_PIN1))
       {
         success = initPluginTaskData(event->TaskIndex, new (std::nothrow) P001_data_struct(event));
+
+      # ifdef ESP32
+
+        // https://docs.espressif.com/projects/esp-idf/en/stable/esp32s3/api-reference/system/sleep_modes.html#external-wakeup-ext0
+         #  if defined(CONFIG_IDF_TARGET_ESP32) || \
+        defined(CONFIG_IDF_TARGET_ESP32S2) ||      \
+        defined(CONFIG_IDF_TARGET_ESP32S3)
+
+        // this would need adaption if we ever want to support wakeOnHigh as well
+        // if (wakeOnLow) {
+        rtc_gpio_pullup_dis((gpio_num_t)CONFIG_PIN1);
+
+        // } else {
+        //   rtc_gpio_pulldown_dis(gpio);
+        // }
+        rtc_gpio_deinit((gpio_num_t)CONFIG_PIN1);
+         #  endif // if defined(CONFIG_IDF_TARGET_ESP32) || defined(CONFIG_IDF_TARGET_ESP32S2) || defined(CONFIG_IDF_TARGET_ESP32S3)
+
+        if (P001_WAKE_BTN) {
+          setupGpioWakeup(CONFIG_PIN1, true);
+        }
+        # endif // ifdef ESP32
+
       }
       break;
     }
@@ -248,4 +300,44 @@ boolean Plugin_001(uint8_t function, struct EventStruct *event, String& string)
   return success;
 }
 
+# ifdef ESP32
+
+void setupGpioWakeup(uint8_t pin, bool wakeOnLow) {
+  gpio_num_t gpio = static_cast<gpio_num_t>(pin);
+
+  pinMode(pin, wakeOnLow ? INPUT_PULLUP : INPUT_PULLDOWN);
+
+  if (esp_sleep_is_valid_wakeup_gpio(gpio)) {
+  #  if defined(CONFIG_IDF_TARGET_ESP32) || \
+    defined(CONFIG_IDF_TARGET_ESP32S2) ||   \
+    defined(CONFIG_IDF_TARGET_ESP32S3)
+
+    // Configure RTC pull resistors
+    if (wakeOnLow) {
+      rtc_gpio_pullup_en(gpio);
+    } else {
+      rtc_gpio_pulldown_en(gpio);
+    }
+
+    esp_sleep_enable_ext0_wakeup(gpio, wakeOnLow ? 0 : 1);
+
+  #  elif defined(CONFIG_IDF_TARGET_ESP32C2) || \
+    defined(CONFIG_IDF_TARGET_ESP32C3) ||       \
+    defined(CONFIG_IDF_TARGET_ESP32C6)
+
+    uint64_t mask = 1ULL << gpio;
+
+    esp_deep_sleep_enable_gpio_wakeup(
+      mask,
+      wakeOnLow ? ESP_GPIO_WAKEUP_GPIO_LOW : ESP_GPIO_WAKEUP_GPIO_HIGH
+      );
+
+  #  else // if defined(CONFIG_IDF_TARGET_ESP32) || defined(CONFIG_IDF_TARGET_ESP32S2) || defined(CONFIG_IDF_TARGET_ESP32S3)
+    #   warning "Unknown ESP32 target — GPIO wakeup not configured"
+  #  endif // if defined(CONFIG_IDF_TARGET_ESP32) || defined(CONFIG_IDF_TARGET_ESP32S2) || defined(CONFIG_IDF_TARGET_ESP32S3)
+  }
+}
+
+# endif // ifdef ESP32
+
 #endif // USES_P001

src/src/Helpers/_Plugin_Helper_GPIO.cpp

@@ -18,7 +18,8 @@ GPIO_plugin_helper_data_t::GPIO_plugin_helper_data_t(
   bool       safeButton,
   bool       sendBootState,
   uint8_t    switchType,
-  uint8_t    dimmerValue) :
+  uint8_t    dimmerValue,
+  bool       wakeButton) :
   _portStatus_key(createKey(pluginNumber, pin)),
   _debounceInterval_ms(debounceInterval_ms),
   _doubleClickMaxInterval_ms(doubleClickMaxInterval_ms),
@@ -32,6 +33,7 @@ GPIO_plugin_helper_data_t::GPIO_plugin_helper_data_t(
   _switchType(switchType),
   _dimmerValue(dimmerValue),
   _safeButton(safeButton),
+  _wakeButton(false),
   _sendBootState(sendBootState),
   _longpressFired(false)
 {

src/src/Helpers/_Plugin_Helper_GPIO.h

@@ -32,7 +32,8 @@ struct GPIO_plugin_helper_data_t {
     bool       safeButton,
     bool       sendBootState,
     uint8_t    switchType  = SWITCH_TYPE_NORMAL_SWITCH,
-    uint8_t    dimmerValue = 0);
+    uint8_t    dimmerValue = 0,
+    bool       wakeButton = false);
 
   ~GPIO_plugin_helper_data_t();
 
@@ -66,6 +67,7 @@ struct GPIO_plugin_helper_data_t {
   const uint8_t    _dimmerValue;
   const bool       _safeButton;
   const bool       _sendBootState;
+  const bool       _wakeButton;
   bool             _longpressFired;
 };
 

src/src/PluginStructs/P001_data_struct.cpp

@@ -32,7 +32,8 @@ P001_data_struct::P001_data_struct(struct EventStruct *event) :
     P001_SAFE_BTN != 0,
     P001_BOOTSTATE,
     (P001_getSwitchType(event) == PLUGIN_001_TYPE_DIMMER) ? SWITCH_TYPE_DIMMER : P001_BUTTON_TYPE,
-    P001_DIMMER_VALUE)
+    P001_DIMMER_VALUE,
+    P001_WAKE_BTN)
 {
   uint8_t pinModeValue = PIN_MODE_INPUT;
 

src/src/PluginStructs/P001_data_struct.h

@@ -49,6 +49,7 @@
 # define P001_LONGPRESS        PCONFIG(5)
 # define P001_LP_MIN_INT       PCONFIG_FLOAT(2)
 # define P001_SAFE_BTN         PCONFIG_FLOAT(3)
+# define P001_WAKE_BTN         PCONFIG_FLOAT(7)
 
 # if FEATURE_MQTT_DISCOVER && FEATURE_MQTT_DEVICECLASS
 #  define P001_MQTT_DEVICECLASS   PCONFIG(6)