SafeModeComponent provides a safe way to recover from repeated boot failures. More...

#include <safe_mode.h>

Inheritance diagram for esphome::safe_mode::SafeModeComponent:

Public Member Functions
bool	should_enter_safe_mode (uint8_t num_attempts, uint32_t enable_time, uint32_t boot_is_good_after, bool in_flash)

void	set_safe_mode_pending (const bool &pending)
	Set to true if the next startup will enter safe mode.

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	mark_successful ()

template<typename F >
void	add_on_safe_mode_callback (F &&callback)

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Member Functions
void	write_rtc_ (uint32_t val)

uint32_t	read_rtc_ ()

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
uint32_t	safe_mode_boot_is_good_after_ {60000}
	The amount of time after which the boot is considered successful.

uint32_t	safe_mode_enable_time_ {60000}
	The time safe mode should remain active for.

uint32_t	safe_mode_rtc_value_ {0}

uint32_t	safe_mode_start_time_ {0}
	stores when safe mode was enabled

esp_ota_img_states_t	ota_state_ {ESP_OTA_IMG_UNDEFINED}

bool	boot_successful_ {false}
	set to true after boot is considered successful

uint8_t	safe_mode_num_attempts_ {0}

bool	app_ota_possible_ {true}

ESPPreferenceObject	rtc_

StaticCallbackManager< ESPHOME_SAFE_MODE_CALLBACK_COUNT, void()>	safe_mode_callback_ {}

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Static Protected Attributes
static const uint32_t	ENTER_SAFE_MODE_MAGIC
	a magic number to indicate that safe mode should be entered on next boot

Detailed Description

SafeModeComponent provides a safe way to recover from repeated boot failures.

Definition at line 18 of file safe_mode.h.

Member Function Documentation

◆ add_on_safe_mode_callback()

template<typename F >

void esphome::safe_mode::SafeModeComponent::add_on_safe_mode_callback ( F && callback )

inline

Definition at line 37 of file safe_mode.h.

◆ clean_rtc()

void esphome::safe_mode::SafeModeComponent::clean_rtc ( )

Definition at line 257 of file safe_mode.cpp.

◆ dump_config()

void esphome::safe_mode::SafeModeComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 57 of file safe_mode.cpp.

◆ get_safe_mode_pending()

bool esphome::safe_mode::SafeModeComponent::get_safe_mode_pending ( )

Definition at line 161 of file safe_mode.cpp.

◆ get_setup_priority()

float esphome::safe_mode::SafeModeComponent::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 118 of file safe_mode.cpp.

◆ loop()

void esphome::safe_mode::SafeModeComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 138 of file safe_mode.cpp.

◆ mark_successful()

void esphome::safe_mode::SafeModeComponent::mark_successful ( )

Definition at line 120 of file safe_mode.cpp.

◆ on_safe_shutdown()

void esphome::safe_mode::SafeModeComponent::on_safe_shutdown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 266 of file safe_mode.cpp.

◆ read_rtc_()

uint32_t esphome::safe_mode::SafeModeComponent::read_rtc_ ( )

protected

Definition at line 250 of file safe_mode.cpp.

◆ set_safe_mode_pending()

void esphome::safe_mode::SafeModeComponent::set_safe_mode_pending ( const bool & pending )

Set to true if the next startup will enter safe mode.

Definition at line 147 of file safe_mode.cpp.

◆ should_enter_safe_mode()

bool esphome::safe_mode::SafeModeComponent::should_enter_safe_mode	(	uint8_t	num_attempts,
		uint32_t	enable_time,
		uint32_t	boot_is_good_after,
		bool	in_flash )

Definition at line 165 of file safe_mode.cpp.

◆ write_rtc_()

void esphome::safe_mode::SafeModeComponent::write_rtc_ ( uint32_t val )

protected

Definition at line 245 of file safe_mode.cpp.

Field Documentation

◆ app_ota_possible_

bool esphome::safe_mode::SafeModeComponent::app_ota_possible_ {true}

protected

Definition at line 58 of file safe_mode.h.

◆ boot_successful_

bool esphome::safe_mode::SafeModeComponent::boot_successful_ {false}

protected

set to true after boot is considered successful

Definition at line 55 of file safe_mode.h.

◆ ENTER_SAFE_MODE_MAGIC

const uint32_t esphome::safe_mode::SafeModeComponent::ENTER_SAFE_MODE_MAGIC

staticprotected

Initial value:

=

0x5afe5afe

a magic number to indicate that safe mode should be entered on next boot

Definition at line 66 of file safe_mode.h.

◆ ota_state_

esp_ota_img_states_t esphome::safe_mode::SafeModeComponent::ota_state_ {ESP_OTA_IMG_UNDEFINED}

protected

Definition at line 52 of file safe_mode.h.

◆ rtc_

ESPPreferenceObject esphome::safe_mode::SafeModeComponent::rtc_

protected

Definition at line 61 of file safe_mode.h.

◆ safe_mode_boot_is_good_after_

uint32_t esphome::safe_mode::SafeModeComponent::safe_mode_boot_is_good_after_ {60000}

protected

The amount of time after which the boot is considered successful.

Definition at line 47 of file safe_mode.h.

◆ safe_mode_callback_

StaticCallbackManager<ESPHOME_SAFE_MODE_CALLBACK_COUNT, void()> esphome::safe_mode::SafeModeComponent::safe_mode_callback_ {}

protected

Definition at line 63 of file safe_mode.h.

◆ safe_mode_enable_time_

uint32_t esphome::safe_mode::SafeModeComponent::safe_mode_enable_time_ {60000}

protected

The time safe mode should remain active for.

Definition at line 48 of file safe_mode.h.

◆ safe_mode_num_attempts_

uint8_t esphome::safe_mode::SafeModeComponent::safe_mode_num_attempts_ {0}

protected

Definition at line 56 of file safe_mode.h.

◆ safe_mode_rtc_value_

uint32_t esphome::safe_mode::SafeModeComponent::safe_mode_rtc_value_ {0}

protected

Definition at line 49 of file safe_mode.h.

◆ safe_mode_start_time_

uint32_t esphome::safe_mode::SafeModeComponent::safe_mode_start_time_ {0}

protected

stores when safe mode was enabled

Definition at line 50 of file safe_mode.h.

The documentation for this class was generated from the following files:

esphome/components/safe_mode/safe_mode.h
esphome/components/safe_mode/safe_mode.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ add_on_safe_mode_callback()

◆ clean_rtc()

◆ dump_config()

◆ get_safe_mode_pending()

◆ get_setup_priority()

◆ loop()

◆ mark_successful()

◆ on_safe_shutdown()

◆ read_rtc_()

◆ set_safe_mode_pending()

◆ should_enter_safe_mode()

◆ write_rtc_()

Field Documentation

◆ app_ota_possible_

◆ boot_successful_

◆ ENTER_SAFE_MODE_MAGIC

◆ ota_state_

◆ rtc_

◆ safe_mode_boot_is_good_after_

◆ safe_mode_callback_

◆ safe_mode_enable_time_

◆ safe_mode_num_attempts_

◆ safe_mode_rtc_value_

◆ safe_mode_start_time_