mirror of
https://github.com/esphome/esphome.git
synced 2024-11-10 09:17:46 +01:00
Support different run duration for non-timer wakeup (#2861)
This commit is contained in:
parent
e5cc19de43
commit
2253d4bc16
7 changed files with 166 additions and 5 deletions
|
@ -41,15 +41,30 @@ EXT1_WAKEUP_MODES = {
|
||||||
"ALL_LOW": esp_sleep_ext1_wakeup_mode_t.ESP_EXT1_WAKEUP_ALL_LOW,
|
"ALL_LOW": esp_sleep_ext1_wakeup_mode_t.ESP_EXT1_WAKEUP_ALL_LOW,
|
||||||
"ANY_HIGH": esp_sleep_ext1_wakeup_mode_t.ESP_EXT1_WAKEUP_ANY_HIGH,
|
"ANY_HIGH": esp_sleep_ext1_wakeup_mode_t.ESP_EXT1_WAKEUP_ANY_HIGH,
|
||||||
}
|
}
|
||||||
|
WakeupCauseToRunDuration = deep_sleep_ns.struct("WakeupCauseToRunDuration")
|
||||||
|
|
||||||
CONF_WAKEUP_PIN_MODE = "wakeup_pin_mode"
|
CONF_WAKEUP_PIN_MODE = "wakeup_pin_mode"
|
||||||
CONF_ESP32_EXT1_WAKEUP = "esp32_ext1_wakeup"
|
CONF_ESP32_EXT1_WAKEUP = "esp32_ext1_wakeup"
|
||||||
CONF_TOUCH_WAKEUP = "touch_wakeup"
|
CONF_TOUCH_WAKEUP = "touch_wakeup"
|
||||||
|
CONF_DEFAULT = "default"
|
||||||
|
CONF_GPIO_WAKEUP_REASON = "gpio_wakeup_reason"
|
||||||
|
CONF_TOUCH_WAKEUP_REASON = "touch_wakeup_reason"
|
||||||
|
|
||||||
|
WAKEUP_CAUSES_SCHEMA = cv.Schema(
|
||||||
|
{
|
||||||
|
cv.Required(CONF_DEFAULT): cv.positive_time_period_milliseconds,
|
||||||
|
cv.Optional(CONF_TOUCH_WAKEUP_REASON): cv.positive_time_period_milliseconds,
|
||||||
|
cv.Optional(CONF_GPIO_WAKEUP_REASON): cv.positive_time_period_milliseconds,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
CONFIG_SCHEMA = cv.Schema(
|
CONFIG_SCHEMA = cv.Schema(
|
||||||
{
|
{
|
||||||
cv.GenerateID(): cv.declare_id(DeepSleepComponent),
|
cv.GenerateID(): cv.declare_id(DeepSleepComponent),
|
||||||
cv.Optional(CONF_RUN_DURATION): cv.positive_time_period_milliseconds,
|
cv.Optional(CONF_RUN_DURATION): cv.Any(
|
||||||
|
cv.All(cv.only_on_esp32, WAKEUP_CAUSES_SCHEMA),
|
||||||
|
cv.positive_time_period_milliseconds,
|
||||||
|
),
|
||||||
cv.Optional(CONF_SLEEP_DURATION): cv.positive_time_period_milliseconds,
|
cv.Optional(CONF_SLEEP_DURATION): cv.positive_time_period_milliseconds,
|
||||||
cv.Optional(CONF_WAKEUP_PIN): cv.All(
|
cv.Optional(CONF_WAKEUP_PIN): cv.All(
|
||||||
cv.only_on_esp32, pins.internal_gpio_input_pin_schema, validate_pin_number
|
cv.only_on_esp32, pins.internal_gpio_input_pin_schema, validate_pin_number
|
||||||
|
@ -85,7 +100,28 @@ async def to_code(config):
|
||||||
if CONF_WAKEUP_PIN_MODE in config:
|
if CONF_WAKEUP_PIN_MODE in config:
|
||||||
cg.add(var.set_wakeup_pin_mode(config[CONF_WAKEUP_PIN_MODE]))
|
cg.add(var.set_wakeup_pin_mode(config[CONF_WAKEUP_PIN_MODE]))
|
||||||
if CONF_RUN_DURATION in config:
|
if CONF_RUN_DURATION in config:
|
||||||
|
run_duration_config = config[CONF_RUN_DURATION]
|
||||||
|
if not isinstance(run_duration_config, dict):
|
||||||
cg.add(var.set_run_duration(config[CONF_RUN_DURATION]))
|
cg.add(var.set_run_duration(config[CONF_RUN_DURATION]))
|
||||||
|
else:
|
||||||
|
default_run_duration = run_duration_config[CONF_DEFAULT]
|
||||||
|
wakeup_cause_to_run_duration = cg.StructInitializer(
|
||||||
|
WakeupCauseToRunDuration,
|
||||||
|
("default_cause", default_run_duration),
|
||||||
|
(
|
||||||
|
"touch_cause",
|
||||||
|
run_duration_config.get(
|
||||||
|
CONF_TOUCH_WAKEUP_REASON, default_run_duration
|
||||||
|
),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
"gpio_cause",
|
||||||
|
run_duration_config.get(
|
||||||
|
CONF_GPIO_WAKEUP_REASON, default_run_duration
|
||||||
|
),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
cg.add(var.set_run_duration(wakeup_cause_to_run_duration))
|
||||||
|
|
||||||
if CONF_ESP32_EXT1_WAKEUP in config:
|
if CONF_ESP32_EXT1_WAKEUP in config:
|
||||||
conf = config[CONF_ESP32_EXT1_WAKEUP]
|
conf = config[CONF_ESP32_EXT1_WAKEUP]
|
||||||
|
|
|
@ -13,12 +13,35 @@ static const char *const TAG = "deep_sleep";
|
||||||
|
|
||||||
bool global_has_deep_sleep = false; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
bool global_has_deep_sleep = false; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
||||||
|
|
||||||
|
optional<uint32_t> DeepSleepComponent::get_run_duration_() const {
|
||||||
|
#ifdef USE_ESP32
|
||||||
|
if (this->wakeup_cause_to_run_duration_.has_value()) {
|
||||||
|
esp_sleep_wakeup_cause_t wakeup_cause = esp_sleep_get_wakeup_cause();
|
||||||
|
switch (wakeup_cause) {
|
||||||
|
case ESP_SLEEP_WAKEUP_EXT0:
|
||||||
|
case ESP_SLEEP_WAKEUP_EXT1:
|
||||||
|
return this->wakeup_cause_to_run_duration_->gpio_cause;
|
||||||
|
case ESP_SLEEP_WAKEUP_TOUCHPAD:
|
||||||
|
return this->wakeup_cause_to_run_duration_->touch_cause;
|
||||||
|
default:
|
||||||
|
return this->wakeup_cause_to_run_duration_->default_cause;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
return this->run_duration_;
|
||||||
|
}
|
||||||
|
|
||||||
void DeepSleepComponent::setup() {
|
void DeepSleepComponent::setup() {
|
||||||
ESP_LOGCONFIG(TAG, "Setting up Deep Sleep...");
|
ESP_LOGCONFIG(TAG, "Setting up Deep Sleep...");
|
||||||
global_has_deep_sleep = true;
|
global_has_deep_sleep = true;
|
||||||
|
|
||||||
if (this->run_duration_.has_value())
|
const optional<uint32_t> run_duration = get_run_duration_();
|
||||||
this->set_timeout(*this->run_duration_, [this]() { this->begin_sleep(); });
|
if (run_duration.has_value()) {
|
||||||
|
ESP_LOGI(TAG, "Scheduling Deep Sleep to start in %u ms", *run_duration);
|
||||||
|
this->set_timeout(*run_duration, [this]() { this->begin_sleep(); });
|
||||||
|
} else {
|
||||||
|
ESP_LOGD(TAG, "Not scheduling Deep Sleep, as no run duration is configured.");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
void DeepSleepComponent::dump_config() {
|
void DeepSleepComponent::dump_config() {
|
||||||
ESP_LOGCONFIG(TAG, "Setting up Deep Sleep...");
|
ESP_LOGCONFIG(TAG, "Setting up Deep Sleep...");
|
||||||
|
@ -33,6 +56,11 @@ void DeepSleepComponent::dump_config() {
|
||||||
if (wakeup_pin_ != nullptr) {
|
if (wakeup_pin_ != nullptr) {
|
||||||
LOG_PIN(" Wakeup Pin: ", this->wakeup_pin_);
|
LOG_PIN(" Wakeup Pin: ", this->wakeup_pin_);
|
||||||
}
|
}
|
||||||
|
if (this->wakeup_cause_to_run_duration_.has_value()) {
|
||||||
|
ESP_LOGCONFIG(TAG, " Default Wakeup Run Duration: %u ms", this->wakeup_cause_to_run_duration_->default_cause);
|
||||||
|
ESP_LOGCONFIG(TAG, " Touch Wakeup Run Duration: %u ms", this->wakeup_cause_to_run_duration_->touch_cause);
|
||||||
|
ESP_LOGCONFIG(TAG, " GPIO Wakeup Run Duration: %u ms", this->wakeup_cause_to_run_duration_->gpio_cause);
|
||||||
|
}
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
void DeepSleepComponent::loop() {
|
void DeepSleepComponent::loop() {
|
||||||
|
@ -49,6 +77,9 @@ void DeepSleepComponent::set_wakeup_pin_mode(WakeupPinMode wakeup_pin_mode) {
|
||||||
}
|
}
|
||||||
void DeepSleepComponent::set_ext1_wakeup(Ext1Wakeup ext1_wakeup) { this->ext1_wakeup_ = ext1_wakeup; }
|
void DeepSleepComponent::set_ext1_wakeup(Ext1Wakeup ext1_wakeup) { this->ext1_wakeup_ = ext1_wakeup; }
|
||||||
void DeepSleepComponent::set_touch_wakeup(bool touch_wakeup) { this->touch_wakeup_ = touch_wakeup; }
|
void DeepSleepComponent::set_touch_wakeup(bool touch_wakeup) { this->touch_wakeup_ = touch_wakeup; }
|
||||||
|
void DeepSleepComponent::set_run_duration(WakeupCauseToRunDuration wakeup_cause_to_run_duration) {
|
||||||
|
wakeup_cause_to_run_duration_ = wakeup_cause_to_run_duration;
|
||||||
|
}
|
||||||
#endif
|
#endif
|
||||||
void DeepSleepComponent::set_run_duration(uint32_t time_ms) { this->run_duration_ = time_ms; }
|
void DeepSleepComponent::set_run_duration(uint32_t time_ms) { this->run_duration_ = time_ms; }
|
||||||
void DeepSleepComponent::begin_sleep(bool manual) {
|
void DeepSleepComponent::begin_sleep(bool manual) {
|
||||||
|
|
|
@ -32,6 +32,15 @@ struct Ext1Wakeup {
|
||||||
esp_sleep_ext1_wakeup_mode_t wakeup_mode;
|
esp_sleep_ext1_wakeup_mode_t wakeup_mode;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
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
|
#endif
|
||||||
|
|
||||||
template<typename... Ts> class EnterDeepSleepAction;
|
template<typename... Ts> class EnterDeepSleepAction;
|
||||||
|
@ -59,6 +68,11 @@ class DeepSleepComponent : public Component {
|
||||||
void set_ext1_wakeup(Ext1Wakeup ext1_wakeup);
|
void set_ext1_wakeup(Ext1Wakeup ext1_wakeup);
|
||||||
|
|
||||||
void set_touch_wakeup(bool touch_wakeup);
|
void set_touch_wakeup(bool touch_wakeup);
|
||||||
|
|
||||||
|
// 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
|
#endif
|
||||||
/// Set a duration in ms for how long the code should run before entering deep sleep mode.
|
/// Set a duration in ms for how long the code should run before entering deep sleep mode.
|
||||||
void set_run_duration(uint32_t time_ms);
|
void set_run_duration(uint32_t time_ms);
|
||||||
|
@ -75,12 +89,17 @@ class DeepSleepComponent : public Component {
|
||||||
void prevent_deep_sleep();
|
void prevent_deep_sleep();
|
||||||
|
|
||||||
protected:
|
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;
|
||||||
|
|
||||||
optional<uint64_t> sleep_duration_;
|
optional<uint64_t> sleep_duration_;
|
||||||
#ifdef USE_ESP32
|
#ifdef USE_ESP32
|
||||||
InternalGPIOPin *wakeup_pin_;
|
InternalGPIOPin *wakeup_pin_;
|
||||||
WakeupPinMode wakeup_pin_mode_{WAKEUP_PIN_MODE_IGNORE};
|
WakeupPinMode wakeup_pin_mode_{WAKEUP_PIN_MODE_IGNORE};
|
||||||
optional<Ext1Wakeup> ext1_wakeup_;
|
optional<Ext1Wakeup> ext1_wakeup_;
|
||||||
optional<bool> touch_wakeup_;
|
optional<bool> touch_wakeup_;
|
||||||
|
optional<WakeupCauseToRunDuration> wakeup_cause_to_run_duration_;
|
||||||
#endif
|
#endif
|
||||||
optional<uint32_t> run_duration_;
|
optional<uint32_t> run_duration_;
|
||||||
bool next_enter_deep_sleep_{false};
|
bool next_enter_deep_sleep_{false};
|
||||||
|
|
52
tests/component_tests/deep_sleep/test_deep_sleep.py
Normal file
52
tests/component_tests/deep_sleep/test_deep_sleep.py
Normal file
|
@ -0,0 +1,52 @@
|
||||||
|
"""Tests for the deep sleep component."""
|
||||||
|
|
||||||
|
|
||||||
|
def test_deep_sleep_setup(generate_main):
|
||||||
|
"""
|
||||||
|
When the deep sleep is set in the yaml file, it should be registered in main
|
||||||
|
"""
|
||||||
|
main_cpp = generate_main(
|
||||||
|
"tests/component_tests/deep_sleep/test_deep_sleep1.yaml"
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "deepsleep = new deep_sleep::DeepSleepComponent();" in main_cpp
|
||||||
|
assert "App.register_component(deepsleep);" in main_cpp
|
||||||
|
|
||||||
|
|
||||||
|
def test_deep_sleep_sleep_duration(generate_main):
|
||||||
|
"""
|
||||||
|
When deep sleep is configured with sleep duration, it should be set.
|
||||||
|
"""
|
||||||
|
main_cpp = generate_main(
|
||||||
|
"tests/component_tests/deep_sleep/test_deep_sleep1.yaml"
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "deepsleep->set_sleep_duration(60000);" in main_cpp
|
||||||
|
|
||||||
|
|
||||||
|
def test_deep_sleep_run_duration_simple(generate_main):
|
||||||
|
"""
|
||||||
|
When deep sleep is configured with run duration, it should be set.
|
||||||
|
"""
|
||||||
|
main_cpp = generate_main(
|
||||||
|
"tests/component_tests/deep_sleep/test_deep_sleep1.yaml"
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "deepsleep->set_run_duration(10000);" in main_cpp
|
||||||
|
|
||||||
|
|
||||||
|
def test_deep_sleep_run_duration_dictionary(generate_main):
|
||||||
|
"""
|
||||||
|
When deep sleep is configured with dictionary run duration, it should be set.
|
||||||
|
"""
|
||||||
|
main_cpp = generate_main(
|
||||||
|
"tests/component_tests/deep_sleep/test_deep_sleep2.yaml"
|
||||||
|
)
|
||||||
|
|
||||||
|
assert (
|
||||||
|
"deepsleep->set_run_duration(deep_sleep::WakeupCauseToRunDuration{\n"
|
||||||
|
" .default_cause = 10000,\n"
|
||||||
|
" .touch_cause = 10000,\n"
|
||||||
|
" .gpio_cause = 30000,\n"
|
||||||
|
"});"
|
||||||
|
) in main_cpp
|
9
tests/component_tests/deep_sleep/test_deep_sleep1.yaml
Normal file
9
tests/component_tests/deep_sleep/test_deep_sleep1.yaml
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
esphome:
|
||||||
|
name: test
|
||||||
|
platform: ESP32
|
||||||
|
board: nodemcu-32s
|
||||||
|
|
||||||
|
deep_sleep:
|
||||||
|
id: deepsleep
|
||||||
|
sleep_duration: 1min
|
||||||
|
run_duration: 10s
|
11
tests/component_tests/deep_sleep/test_deep_sleep2.yaml
Normal file
11
tests/component_tests/deep_sleep/test_deep_sleep2.yaml
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
esphome:
|
||||||
|
name: test
|
||||||
|
platform: ESP32
|
||||||
|
board: nodemcu-32s
|
||||||
|
|
||||||
|
deep_sleep:
|
||||||
|
id: deepsleep
|
||||||
|
sleep_duration: 1min
|
||||||
|
run_duration:
|
||||||
|
default: 10s
|
||||||
|
gpio_wakeup_reason: 30s
|
|
@ -55,7 +55,10 @@ logger:
|
||||||
level: DEBUG
|
level: DEBUG
|
||||||
|
|
||||||
deep_sleep:
|
deep_sleep:
|
||||||
run_duration: 20s
|
run_duration:
|
||||||
|
default: 20s
|
||||||
|
gpio_wakeup_reason: 10s
|
||||||
|
touch_wakeup_reason: 15s
|
||||||
sleep_duration: 50s
|
sleep_duration: 50s
|
||||||
wakeup_pin: GPIO39
|
wakeup_pin: GPIO39
|
||||||
wakeup_pin_mode: INVERT_WAKEUP
|
wakeup_pin_mode: INVERT_WAKEUP
|
||||||
|
|
Loading…
Reference in a new issue