#include <provisioning.h>

Inheritance diagram for esphome::provisioning::ProvisioningManager:

Public Member Functions
	ProvisioningManager ()

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

void	set_timeout (uint32_t timeout)

uint8_t	register_source ()

void	set_source_provisioned (uint8_t source, bool provisioned)

bool	is_provisioned () const

bool	window_pending () const

bool	closed () const

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

Trigger *	get_timeout_trigger ()

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 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.

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)

Static Public Attributes
static constexpr uint8_t	MAX_SOURCES = 32

Protected Member Functions
void	close_window_ ()

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
Trigger	timeout_trigger_

LazyCallbackManager< void()>	closed_callback_

uint32_t	timeout_ {0}

uint32_t	registered_mask_ {0}

uint32_t	provisioned_mask_ {0}

uint8_t	source_count_ {0}

bool	closed_ {false}

uint8_t	network_source_ {0}

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_

Detailed Description

Definition at line 29 of file provisioning.h.

Constructor & Destructor Documentation

◆ ProvisioningManager()

esphome::provisioning::ProvisioningManager::ProvisioningManager ( )

Definition at line 18 of file provisioning.cpp.

Member Function Documentation

◆ add_on_closed_callback()

template<typename F >

void esphome::provisioning::ProvisioningManager::add_on_closed_callback ( F && callback )

inline

Definition at line 71 of file provisioning.h.

◆ close_window_()

void esphome::provisioning::ProvisioningManager::close_window_ ( )

protected

Definition at line 74 of file provisioning.cpp.

◆ closed()

bool esphome::provisioning::ProvisioningManager::closed ( ) const

inline

Definition at line 66 of file provisioning.h.

◆ dump_config()

void esphome::provisioning::ProvisioningManager::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 83 of file provisioning.cpp.

◆ get_setup_priority()

float esphome::provisioning::ProvisioningManager::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 38 of file provisioning.h.

◆ get_timeout_trigger()

Trigger * esphome::provisioning::ProvisioningManager::get_timeout_trigger ( )

inline

Definition at line 74 of file provisioning.h.

◆ is_provisioned()

bool esphome::provisioning::ProvisioningManager::is_provisioned ( ) const

inline

Definition at line 59 of file provisioning.h.

◆ loop()

void esphome::provisioning::ProvisioningManager::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 41 of file provisioning.cpp.

◆ register_source()

uint8_t esphome::provisioning::ProvisioningManager::register_source ( )

Definition at line 28 of file provisioning.cpp.

◆ set_source_provisioned()

void esphome::provisioning::ProvisioningManager::set_source_provisioned	(	uint8_t	source,
		bool	provisioned )

inline

Definition at line 46 of file provisioning.h.

◆ set_timeout()

void esphome::provisioning::ProvisioningManager::set_timeout ( uint32_t timeout )

inline

Definition at line 40 of file provisioning.h.

◆ window_pending()

bool esphome::provisioning::ProvisioningManager::window_pending ( ) const

inline

Definition at line 64 of file provisioning.h.

Field Documentation

◆ closed_

bool esphome::provisioning::ProvisioningManager::closed_ {false}

protected

Definition at line 85 of file provisioning.h.

◆ closed_callback_

LazyCallbackManager<void()> esphome::provisioning::ProvisioningManager::closed_callback_

protected

Definition at line 80 of file provisioning.h.

◆ MAX_SOURCES

uint8_t esphome::provisioning::ProvisioningManager::MAX_SOURCES = 32

staticconstexpr

Definition at line 32 of file provisioning.h.

◆ network_source_

uint8_t esphome::provisioning::ProvisioningManager::network_source_ {0}

protected

Definition at line 89 of file provisioning.h.

◆ provisioned_mask_

uint32_t esphome::provisioning::ProvisioningManager::provisioned_mask_ {0}

protected

Definition at line 83 of file provisioning.h.

◆ registered_mask_

uint32_t esphome::provisioning::ProvisioningManager::registered_mask_ {0}

protected

Definition at line 82 of file provisioning.h.

◆ source_count_

uint8_t esphome::provisioning::ProvisioningManager::source_count_ {0}

protected

Definition at line 84 of file provisioning.h.

◆ timeout_

uint32_t esphome::provisioning::ProvisioningManager::timeout_ {0}

protected

Definition at line 81 of file provisioning.h.

◆ timeout_trigger_

Trigger esphome::provisioning::ProvisioningManager::timeout_trigger_

protected

Definition at line 79 of file provisioning.h.

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

esphome/components/provisioning/provisioning.h
esphome/components/provisioning/provisioning.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProvisioningManager()

Member Function Documentation

◆ add_on_closed_callback()

◆ close_window_()

◆ closed()

◆ dump_config()

◆ get_setup_priority()

◆ get_timeout_trigger()

◆ is_provisioned()

◆ loop()

◆ register_source()

◆ set_source_provisioned()

◆ set_timeout()

◆ window_pending()

Field Documentation

◆ closed_

◆ closed_callback_

◆ MAX_SOURCES

◆ network_source_

◆ provisioned_mask_

◆ registered_mask_

◆ source_count_

◆ timeout_

◆ timeout_trigger_