ESPHome 2025.9.0-dev
Loading...
Searching...
No Matches
deep_sleep_component.cpp
Go to the documentation of this file.
3#include "esphome/core/log.h"
4
5namespace esphome {
6namespace deep_sleep {
7
8static const char *const TAG = "deep_sleep";
9// 5 seconds for deep sleep to ensure clean disconnect from Home Assistant
10static const uint32_t TEARDOWN_TIMEOUT_DEEP_SLEEP_MS = 5000;
11
12bool global_has_deep_sleep = false; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
13
16
17 const optional<uint32_t> run_duration = get_run_duration_();
18 if (run_duration.has_value()) {
19 ESP_LOGI(TAG, "Scheduling in %" PRIu32 " ms", *run_duration);
20 this->set_timeout(*run_duration, [this]() { this->begin_sleep(); });
21 } else {
22 ESP_LOGD(TAG, "Not scheduling; no run duration configured");
23 }
24}
25
27 ESP_LOGCONFIG(TAG, "Deep sleep:");
28 if (this->sleep_duration_.has_value()) {
29 uint32_t duration = *this->sleep_duration_ / 1000;
30 ESP_LOGCONFIG(TAG, " Sleep Duration: %" PRIu32 " ms", duration);
31 }
32 if (this->run_duration_.has_value()) {
33 ESP_LOGCONFIG(TAG, " Run Duration: %" PRIu32 " ms", *this->run_duration_);
34 }
36}
37
39 if (this->next_enter_deep_sleep_)
40 this->begin_sleep();
41}
42
44 return -100.0f; // run after everything else is ready
45}
46
47void DeepSleepComponent::set_sleep_duration(uint32_t time_ms) { this->sleep_duration_ = uint64_t(time_ms) * 1000; }
48
49void DeepSleepComponent::set_run_duration(uint32_t time_ms) { this->run_duration_ = time_ms; }
50
52 if (this->prevent_ && !manual) {
53 this->next_enter_deep_sleep_ = true;
54 return;
55 }
56
57 if (!this->prepare_to_sleep_()) {
58 return;
59 }
60
61 ESP_LOGI(TAG, "Beginning sleep");
62 if (this->sleep_duration_.has_value()) {
63 ESP_LOGI(TAG, "Sleeping for %" PRId64 "us", *this->sleep_duration_);
64 }
66 // It's critical to teardown components cleanly for deep sleep to ensure
67 // Home Assistant sees a clean disconnect instead of marking the device unavailable
68 App.teardown_components(TEARDOWN_TIMEOUT_DEEP_SLEEP_MS);
70
71 this->deep_sleep_();
72}
73
75
77
79
80} // namespace deep_sleep
81} // namespace esphome
void teardown_components(uint32_t timeout_ms)
Teardown all components with a timeout.
void set_timeout(const std::string &name, uint32_t timeout, std::function< void()> &&f)
Set a timeout function with a unique name.
void set_run_duration(WakeupCauseToRunDuration wakeup_cause_to_run_duration)
optional< uint32_t > get_run_duration_() const
void begin_sleep(bool manual=false)
Helper to enter deep sleep mode.
void set_sleep_duration(uint32_t time_ms)
Set the duration in ms the component should sleep once it's in deep sleep mode.
bool has_value() const
Definition optional.h:92
uint8_t duration
Definition msa3xx.h:0
const float LATE
For components that should be initialized at the very end of the setup process.
Definition component.cpp:59
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7
Application App
Global storage of Application pointer - only one Application can exist.