#include <factory_reset.h>

Inheritance diagram for esphome::factory_reset::FactoryResetComponent:

Public Member Functions
	FactoryResetComponent (uint8_t required_count, uint32_t max_interval)

void	dump_config () override

void	setup () override

void	add_increment_callback (std::function< void(uint8_t, uint8_t)> &&callback)

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_error (const char *message=nullptr)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages.

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
	~FactoryResetComponent ()=default

void	save_ (uint8_t count)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

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

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

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

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
ESPPreferenceObject	flash_ {}

uint8_t	required_count_

uint32_t	max_interval_

CallbackManager< void(uint8_t, uint8_t)>	increment_callback_ {}

Protected Attributes inherited from esphome::Component
const char *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

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

Detailed Description

Definition at line 14 of file factory_reset.h.

Constructor & Destructor Documentation

◆ FactoryResetComponent()

esphome::factory_reset::FactoryResetComponent::FactoryResetComponent	(	uint8_t	required_count,
		uint32_t	max_interval )

inline

Definition at line 16 of file factory_reset.h.

◆ ~FactoryResetComponent()

esphome::factory_reset::FactoryResetComponent::~FactoryResetComponent ( )

protecteddefault

Member Function Documentation

◆ add_increment_callback()

void esphome::factory_reset::FactoryResetComponent::add_increment_callback ( std::function< void(uint8_t, uint8_t)> && callback )

inline

Definition at line 21 of file factory_reset.h.

◆ dump_config()

void esphome::factory_reset::FactoryResetComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 31 of file factory_reset.cpp.

◆ save_()

void esphome::factory_reset::FactoryResetComponent::save_ ( uint8_t count )

protected

Definition at line 42 of file factory_reset.cpp.

◆ setup()

void esphome::factory_reset::FactoryResetComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 48 of file factory_reset.cpp.

Field Documentation

◆ flash_

ESPPreferenceObject esphome::factory_reset::FactoryResetComponent::flash_ {}

protected

Definition at line 28 of file factory_reset.h.

◆ increment_callback_

CallbackManager<void(uint8_t, uint8_t)> esphome::factory_reset::FactoryResetComponent::increment_callback_ {}

protected

Definition at line 31 of file factory_reset.h.

◆ max_interval_

uint32_t esphome::factory_reset::FactoryResetComponent::max_interval_

protected

Definition at line 30 of file factory_reset.h.

◆ required_count_

uint8_t esphome::factory_reset::FactoryResetComponent::required_count_

protected

Definition at line 29 of file factory_reset.h.

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

esphome/components/factory_reset/factory_reset.h
esphome/components/factory_reset/factory_reset.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FactoryResetComponent()

◆ ~FactoryResetComponent()

Member Function Documentation

◆ add_increment_callback()

◆ dump_config()

◆ save_()

◆ setup()

Field Documentation

◆ flash_

◆ increment_callback_

◆ max_interval_

◆ required_count_