1
0
mirror of https://github.com/esphome/esphome.git synced 2026-02-08 00:31:58 +00:00

[factory_reset] Optimize memory by storing interval as uint16_t seconds (#12462)

This commit is contained in:
J. Nick Koston
2025-12-17 09:29:51 -07:00
committed by GitHub
parent 9928ab09cf
commit bf6a03d1cf
3 changed files with 16 additions and 18 deletions

View File

@@ -50,7 +50,9 @@ CONFIG_SCHEMA = cv.All(
cv.GenerateID(): cv.declare_id(FactoryResetComponent),
cv.Optional(CONF_MAX_DELAY, default="10s"): cv.All(
cv.positive_time_period_seconds,
cv.Range(min=cv.TimePeriod(milliseconds=1000)),
cv.Range(
min=cv.TimePeriod(seconds=1), max=cv.TimePeriod(seconds=65535)
),
),
cv.Optional(CONF_RESETS_REQUIRED): cv.positive_not_null_int,
cv.Optional(CONF_ON_INCREMENT): validate_automation(
@@ -82,7 +84,7 @@ async def to_code(config):
var = cg.new_Pvariable(
config[CONF_ID],
reset_count,
config[CONF_MAX_DELAY].total_milliseconds,
config[CONF_MAX_DELAY].total_seconds,
)
await cg.register_component(var, config)
for conf in config.get(CONF_ON_INCREMENT, []):

View File

@@ -8,8 +8,7 @@
#if !defined(USE_RP2040) && !defined(USE_HOST)
namespace esphome {
namespace factory_reset {
namespace esphome::factory_reset {
static const char *const TAG = "factory_reset";
static const uint32_t POWER_CYCLES_KEY = 0xFA5C0DE;
@@ -33,10 +32,10 @@ void FactoryResetComponent::dump_config() {
this->flash_.load(&count);
ESP_LOGCONFIG(TAG, "Factory Reset by Reset:");
ESP_LOGCONFIG(TAG,
" Max interval between resets %" PRIu32 " seconds\n"
" Max interval between resets: %u seconds\n"
" Current count: %u\n"
" Factory reset after %u resets",
this->max_interval_ / 1000, count, this->required_count_);
this->max_interval_, count, this->required_count_);
}
void FactoryResetComponent::save_(uint8_t count) {
@@ -61,8 +60,8 @@ void FactoryResetComponent::setup() {
}
this->save_(count);
ESP_LOGD(TAG, "Power on reset detected, incremented count to %u", count);
this->set_timeout(this->max_interval_, [this]() {
ESP_LOGD(TAG, "No reset in the last %" PRIu32 " seconds, resetting count", this->max_interval_ / 1000);
this->set_timeout(static_cast<uint32_t>(this->max_interval_) * 1000, [this]() {
ESP_LOGD(TAG, "No reset in the last %u seconds, resetting count", this->max_interval_);
this->save_(0); // reset count
});
} else {
@@ -70,7 +69,6 @@ void FactoryResetComponent::setup() {
}
}
} // namespace factory_reset
} // namespace esphome
} // namespace esphome::factory_reset
#endif // !defined(USE_RP2040) && !defined(USE_HOST)

View File

@@ -9,12 +9,11 @@
#include <esp_system.h>
#endif
namespace esphome {
namespace factory_reset {
namespace esphome::factory_reset {
class FactoryResetComponent : public Component {
public:
FactoryResetComponent(uint8_t required_count, uint32_t max_interval)
: required_count_(required_count), max_interval_(max_interval) {}
FactoryResetComponent(uint8_t required_count, uint16_t max_interval)
: max_interval_(max_interval), required_count_(required_count) {}
void dump_config() override;
void setup() override;
@@ -26,9 +25,9 @@ class FactoryResetComponent : public Component {
~FactoryResetComponent() = default;
void save_(uint8_t count);
ESPPreferenceObject flash_{}; // saves the number of fast power cycles
uint8_t required_count_; // The number of boot attempts before fast boot is enabled
uint32_t max_interval_; // max interval between power cycles
CallbackManager<void(uint8_t, uint8_t)> increment_callback_{};
uint16_t max_interval_; // max interval between power cycles in seconds
uint8_t required_count_; // The number of boot attempts before fast boot is enabled
};
class FastBootTrigger : public Trigger<uint8_t, uint8_t> {
@@ -37,7 +36,6 @@ class FastBootTrigger : public Trigger<uint8_t, uint8_t> {
parent->add_increment_callback([this](uint8_t current, uint8_t target) { this->trigger(current, target); });
}
};
} // namespace factory_reset
} // namespace esphome
} // namespace esphome::factory_reset
#endif // !defined(USE_RP2040) && !defined(USE_HOST)