deep_sleep_component.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/automation.h"
#include "esphome/core/component.h"
#include "esphome/core/hal.h"
#include "esphome/core/helpers.h"
#ifdef USE_ESP32
#include <esp_sleep.h>
#endif
 
#ifdef USE_TIME
#include "esphome/components/time/real_time_clock.h"
#include "esphome/core/time.h"
#endif
 
#include <cinttypes>
 
namespace esphome::deep_sleep {
 
#if defined(USE_ESP32) || defined(USE_BK72XX)
 
enum WakeupPinMode {
  WAKEUP_PIN_MODE_IGNORE = 0,  
  WAKEUP_PIN_MODE_KEEP_AWAKE,  
 
  WAKEUP_PIN_MODE_INVERT_WAKEUP,
};
#endif
 
#if defined(USE_BK72XX)
struct WakeUpPinItem {
  InternalGPIOPin *wakeup_pin;
  WakeupPinMode wakeup_pin_mode;
  bool wakeup_level;
};
#endif  // USE_BK72XX
 
#ifdef USE_ESP32
#if defined(USE_ESP32) && !defined(USE_ESP32_VARIANT_ESP32C2) && !defined(USE_ESP32_VARIANT_ESP32C3)
struct Ext1Wakeup {
  uint64_t mask;
  esp_sleep_ext1_wakeup_mode_t wakeup_mode;
};
#endif
 
struct WakeupCauseToRunDuration {
  // Run duration if woken up by timer or any other reason besides those below.
  uint32_t default_cause;
  // Run duration if woken up by touch pads.
  uint32_t touch_cause;
  // Run duration if woken up by GPIO pins.
  uint32_t gpio_cause;
};
 
#endif  // USE_ESP32
 
#ifdef USE_DEEP_SLEEP_ON_WAKE
 
enum WakeupCause : uint8_t {
  WAKEUP_CAUSE_NONE = 0,
  WAKEUP_CAUSE_UNKNOWN,
  WAKEUP_CAUSE_TIMER,
  WAKEUP_CAUSE_GPIO,
  WAKEUP_CAUSE_TOUCH,
};
 
WakeupCause get_wakeup_cause();
 
inline constexpr float ON_WAKE_TRIGGER_SETUP_PRIORITY = 700.0f;
 
class WakeTrigger : public Trigger<WakeupCause>, public Component {
 public:
  void setup() override {
    const WakeupCause cause = get_wakeup_cause();
    if (cause != WAKEUP_CAUSE_NONE) {
      this->trigger(cause);
    }
  }
  float get_setup_priority() const override { return ON_WAKE_TRIGGER_SETUP_PRIORITY; }
};
 
#if defined(USE_ESP32) && !defined(USE_ESP32_VARIANT_ESP32C2) && !defined(USE_ESP32_VARIANT_ESP32C3)
class Ext1WakeTrigger : public Trigger<>, public Component {
 public:
  explicit Ext1WakeTrigger(uint8_t pin) : pin_(pin) {}
  void setup() override {
    if (esp_sleep_get_wakeup_cause() == ESP_SLEEP_WAKEUP_EXT1 &&
        (esp_sleep_get_ext1_wakeup_status() & (1ULL << this->pin_))) {
      this->trigger();
    }
  }
  float get_setup_priority() const override { return ON_WAKE_TRIGGER_SETUP_PRIORITY; }
 
 protected:
  uint8_t pin_;
};
#endif
 
#endif  // USE_DEEP_SLEEP_ON_WAKE
 
template<typename... Ts> class EnterDeepSleepAction;
 
template<typename... Ts> class PreventDeepSleepAction;
 
class DeepSleepComponent final : public Component {
 public:
  void set_sleep_duration(uint32_t time_ms);
#if defined(USE_ESP32)
  void set_wakeup_pin(InternalGPIOPin *pin) { this->wakeup_pin_ = pin; }
 
  void set_wakeup_pin_mode(WakeupPinMode wakeup_pin_mode);
#endif  // USE_ESP32
 
#if defined(USE_BK72XX)
  void init_wakeup_pins(size_t capacity) { this->wakeup_pins_.init(capacity); }
  void add_wakeup_pin(InternalGPIOPin *wakeup_pin, WakeupPinMode wakeup_pin_mode) {
    this->wakeup_pins_.emplace_back(WakeUpPinItem{wakeup_pin, wakeup_pin_mode, !wakeup_pin->is_inverted()});
  }
#endif  // USE_BK72XX
 
#if defined(USE_ESP32)
#if !defined(USE_ESP32_VARIANT_ESP32C2) && !defined(USE_ESP32_VARIANT_ESP32C3)
  void set_ext1_wakeup(Ext1Wakeup ext1_wakeup);
#endif
 
#if !defined(USE_ESP32_VARIANT_ESP32C2) && !defined(USE_ESP32_VARIANT_ESP32C3) && \
    !defined(USE_ESP32_VARIANT_ESP32C5) && !defined(USE_ESP32_VARIANT_ESP32C6) && \
    !defined(USE_ESP32_VARIANT_ESP32C61) && !defined(USE_ESP32_VARIANT_ESP32H2)
  void set_touch_wakeup(bool touch_wakeup);
#endif
 
  // Set the duration in ms for how long the code should run before entering
  // deep sleep mode, according to the cause the ESP32 has woken.
  void set_run_duration(WakeupCauseToRunDuration wakeup_cause_to_run_duration);
#endif  // USE_ESP32
 
  void set_run_duration(uint32_t time_ms);
 
  void setup() override;
  void dump_config() override;
  void loop() override;
  float get_setup_priority() const override;
 
  void begin_sleep(bool manual = false);
 
  void prevent_deep_sleep();
  void allow_deep_sleep();
 
 protected:
  // Returns nullopt if no run duration is set. Otherwise, returns the run
  // duration before entering deep sleep.
  optional<uint32_t> get_run_duration_() const;
 
  void dump_config_platform_();
  bool prepare_to_sleep_();
  void deep_sleep_();
  void schedule_sleep_();
  bool should_teardown_();
 
#ifdef USE_BK72XX
  bool pin_prevents_sleep_(WakeUpPinItem &pin_item) const;
  bool get_real_pin_state_(InternalGPIOPin &pin) const { return (pin.digital_read() ^ pin.is_inverted()); }
#endif  // USE_BK72XX
 
  optional<uint64_t> sleep_duration_;
 
#ifdef USE_BK72XX
  FixedVector<WakeUpPinItem> wakeup_pins_;
#endif  // USE_BK72XX
 
#ifdef USE_ESP32
  InternalGPIOPin *wakeup_pin_{nullptr};
  WakeupPinMode wakeup_pin_mode_{WAKEUP_PIN_MODE_IGNORE};
 
#if !defined(USE_ESP32_VARIANT_ESP32C2) && !defined(USE_ESP32_VARIANT_ESP32C3)
  optional<Ext1Wakeup> ext1_wakeup_;
#endif
 
  optional<bool> touch_wakeup_;
 
  optional<WakeupCauseToRunDuration> wakeup_cause_to_run_duration_;
#endif  // USE_ESP32
 
  optional<uint32_t> run_duration_;
  bool next_enter_deep_sleep_{false};
  bool prevent_{false};
};
 
extern bool global_has_deep_sleep;  // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
 
template<typename... Ts> class EnterDeepSleepAction final : public Action<Ts...> {
 public:
  EnterDeepSleepAction(DeepSleepComponent *deep_sleep) : deep_sleep_(deep_sleep) {}
  TEMPLATABLE_VALUE(uint32_t, sleep_duration);
 
#ifdef USE_TIME
  void set_until(uint8_t hour, uint8_t minute, uint8_t second) {
    this->hour_ = hour;
    this->minute_ = minute;
    this->second_ = second;
  }
 
  void set_time(time::RealTimeClock *time) { this->time_ = time; }
#endif
 
  void play(const Ts &...x) override {
    if (this->sleep_duration_.has_value()) {
      this->deep_sleep_->set_sleep_duration(this->sleep_duration_.value(x...));
    }
#ifdef USE_TIME
 
    if (this->hour_.has_value()) {
      auto time = this->time_->now();
      const uint32_t timestamp_now = time.timestamp;
 
      bool after_time = false;
      if (time.hour > this->hour_) {
        after_time = true;
      } else {
        if (time.hour == this->hour_) {
          if (time.minute > this->minute_) {
            after_time = true;
          } else {
            if (time.minute == this->minute_) {
              if (time.second > this->second_) {
                after_time = true;
              }
            }
          }
        }
      }
 
      time.hour = *this->hour_;
      time.minute = *this->minute_;
      time.second = *this->second_;
      time.recalc_timestamp_utc();
 
      time_t timestamp = time.timestamp;  // timestamp in local time zone
 
      if (after_time)
        timestamp += 60 * 60 * 24;
 
      int32_t offset = ESPTime::timezone_offset();
      timestamp -= offset;  // Change timestamp to utc
      const uint32_t ms_left = (timestamp - timestamp_now) * 1000;
      this->deep_sleep_->set_sleep_duration(ms_left);
    }
#endif
    this->deep_sleep_->begin_sleep(true);
  }
 
 protected:
  DeepSleepComponent *deep_sleep_;
#ifdef USE_TIME
  optional<uint8_t> hour_;
  optional<uint8_t> minute_;
  optional<uint8_t> second_;
 
  time::RealTimeClock *time_;
#endif
};
 
template<typename... Ts>
class PreventDeepSleepAction final : public Action<Ts...>, public Parented<DeepSleepComponent> {
 public:
  void play(const Ts &...x) override { this->parent_->prevent_deep_sleep(); }
};
 
template<typename... Ts> class AllowDeepSleepAction final : public Action<Ts...>, public Parented<DeepSleepComponent> {
 public:
  void play(const Ts &...x) override { this->parent_->allow_deep_sleep(); }
};
 
}  // namespace esphome::deep_sleep