safe_mode.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/component.h"
#include "esphome/core/defines.h"
#include "esphome/core/helpers.h"
#include "esphome/core/preferences.h"
 
namespace esphome {
namespace safe_mode {
 
class SafeModeComponent : public Component {
 public:
  bool should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_time, uint32_t boot_is_good_after);
 
  void set_safe_mode_pending(const bool &pending);
  bool get_safe_mode_pending();
 
  void dump_config() override;
  float get_setup_priority() const override;
  void loop() override;
 
  void clean_rtc();
 
  void on_safe_shutdown() override;
 
  void add_on_safe_mode_callback(std::function<void()> &&callback) {
    this->safe_mode_callback_.add(std::move(callback));
  }
 
 protected:
  void write_rtc_(uint32_t val);
  uint32_t read_rtc_();
 
  bool boot_successful_{false};                   
  uint32_t safe_mode_boot_is_good_after_{60000};  
  uint32_t safe_mode_enable_time_{60000};         
  uint32_t safe_mode_rtc_value_{0};
  uint32_t safe_mode_start_time_{0};  
  uint8_t safe_mode_num_attempts_{0};
  ESPPreferenceObject rtc_;
  CallbackManager<void()> safe_mode_callback_{};
 
  static const uint32_t ENTER_SAFE_MODE_MAGIC =
      0x5afe5afe;  
};
 
}  // namespace safe_mode
}  // namespace esphome