#include <esp32_improv_component.h>

Inheritance diagram for esphome::esp32_improv::ESP32ImprovComponent:

Public Member Functions
	ESP32ImprovComponent ()

void	dump_config () override

void	loop () override

void	setup () override

void	setup_characteristics ()

float	get_setup_priority () const override

void	start ()

void	stop ()

bool	is_active () const

bool	should_start () const

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

void	set_authorizer (binary_sensor::BinarySensor *authorizer)

void	set_status_indicator (output::BinaryOutput *status_indicator)

void	set_identify_duration (uint32_t identify_duration)

void	set_authorized_duration (uint32_t authorized_duration)

void	set_wifi_timeout (uint32_t wifi_timeout)

uint32_t	get_wifi_timeout () const

improv::State	get_improv_state () const

improv::Error	get_improv_error_state () const

Public Member Functions inherited from esphome::Component
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)

Public Member Functions inherited from esphome::improv_base::ImprovBase
void	set_next_url (const char *next_url)

Protected Member Functions
void	set_status_indicator_state_ (bool state)

void	update_advertising_type_ ()

void	set_state_ (improv::State state, bool update_advertising=true)

void	set_error_ (improv::Error error)

improv::State	get_initial_state_ () const

void	send_response_ (std::vector< uint8_t > &&response)

void	process_incoming_data_ ()

void	on_wifi_connect_timeout_ ()

void	check_wifi_connection_ ()

bool	check_identify_ ()

void	advertise_service_data_ ()

const char *	state_to_string_ (improv::State state)

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 Member Functions inherited from esphome::improv_base::ImprovBase
size_t	get_formatted_next_url_ (char *buffer, size_t buffer_size)
	Format next_url_ into buffer, replacing placeholders. Returns length written.

Protected Attributes
bool	should_start_ {false}

bool	setup_complete_ {false}

uint32_t	identify_start_ {0}

uint32_t	identify_duration_

uint32_t	authorized_start_ {0}

uint32_t	authorized_duration_

uint32_t	wifi_timeout_ {}

std::vector< uint8_t >	incoming_data_

wifi::WiFiAP	connecting_sta_

BLEService *	service_ {nullptr}

BLECharacteristic *	status_ {nullptr}

BLECharacteristic *	error_ {nullptr}

BLECharacteristic *	rpc_ {nullptr}

BLECharacteristic *	rpc_response_ {nullptr}

BLECharacteristic *	capabilities_ {nullptr}

binary_sensor::BinarySensor *	authorizer_ {nullptr}

output::BinaryOutput *	status_indicator_ {nullptr}

improv::State	state_ {improv::STATE_STOPPED}

improv::Error	error_state_ {improv::ERROR_NONE}

CallbackManager< void(improv::State, improv::Error)>	state_callback_ {}

bool	status_indicator_state_ {false}

uint32_t	last_name_adv_time_ {0}

bool	advertising_device_name_ {false}

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_

Protected Attributes inherited from esphome::improv_base::ImprovBase
const char *	next_url_ {nullptr}

Detailed Description

Definition at line 35 of file esp32_improv_component.h.

Constructor & Destructor Documentation

◆ ESP32ImprovComponent()

esphome::esp32_improv::ESP32ImprovComponent::ESP32ImprovComponent ( )

Definition at line 33 of file esp32_improv_component.cpp.

Member Function Documentation

◆ add_on_state_callback()

template<typename F >

void esphome::esp32_improv::ESP32ImprovComponent::add_on_state_callback ( F && callback )

inline

Definition at line 50 of file esp32_improv_component.h.

◆ advertise_service_data_()

void esphome::esp32_improv::ESP32ImprovComponent::advertise_service_data_ ( )

protected

Definition at line 475 of file esp32_improv_component.cpp.

◆ check_identify_()

bool esphome::esp32_improv::ESP32ImprovComponent::check_identify_ ( )

protected

Definition at line 227 of file esp32_improv_component.cpp.

◆ check_wifi_connection_()

void esphome::esp32_improv::ESP32ImprovComponent::check_wifi_connection_ ( )

protected

Definition at line 423 of file esp32_improv_component.cpp.

◆ dump_config()

void esphome::esp32_improv::ESP32ImprovComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 327 of file esp32_improv_component.cpp.

◆ get_improv_error_state()

improv::Error esphome::esp32_improv::ESP32ImprovComponent::get_improv_error_state ( ) const

inline

Definition at line 67 of file esp32_improv_component.h.

◆ get_improv_state()

improv::State esphome::esp32_improv::ESP32ImprovComponent::get_improv_state ( ) const

inline

Definition at line 66 of file esp32_improv_component.h.

◆ get_initial_state_()

improv::State esphome::esp32_improv::ESP32ImprovComponent::get_initial_state_ ( ) const

protected

Definition at line 519 of file esp32_improv_component.cpp.

◆ get_setup_priority()

float esphome::esp32_improv::ESP32ImprovComponent::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 325 of file esp32_improv_component.cpp.

◆ get_wifi_timeout()

uint32_t esphome::esp32_improv::ESP32ImprovComponent::get_wifi_timeout ( ) const

inline

Definition at line 64 of file esp32_improv_component.h.

◆ is_active()

bool esphome::esp32_improv::ESP32ImprovComponent::is_active ( ) const

inline

Definition at line 46 of file esp32_improv_component.h.

◆ loop()

void esphome::esp32_improv::ESP32ImprovComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 99 of file esp32_improv_component.cpp.

◆ on_wifi_connect_timeout_()

void esphome::esp32_improv::ESP32ImprovComponent::on_wifi_connect_timeout_ ( )

protected

Definition at line 412 of file esp32_improv_component.cpp.

◆ process_incoming_data_()

void esphome::esp32_improv::ESP32ImprovComponent::process_incoming_data_ ( )

protected

Definition at line 337 of file esp32_improv_component.cpp.

◆ send_response_()

void esphome::esp32_improv::ESP32ImprovComponent::send_response_ ( std::vector< uint8_t > && response )

protected

Definition at line 288 of file esp32_improv_component.cpp.

◆ set_authorized_duration()

void esphome::esp32_improv::ESP32ImprovComponent::set_authorized_duration ( uint32_t authorized_duration )

inline

Definition at line 61 of file esp32_improv_component.h.

◆ set_authorizer()

void esphome::esp32_improv::ESP32ImprovComponent::set_authorizer ( binary_sensor::BinarySensor * authorizer )

inline

Definition at line 55 of file esp32_improv_component.h.

◆ set_error_()

void esphome::esp32_improv::ESP32ImprovComponent::set_error_ ( improv::Error error )

protected

Definition at line 272 of file esp32_improv_component.cpp.

◆ set_identify_duration()

void esphome::esp32_improv::ESP32ImprovComponent::set_identify_duration ( uint32_t identify_duration )

inline

Definition at line 60 of file esp32_improv_component.h.

◆ set_state_()

void esphome::esp32_improv::ESP32ImprovComponent::set_state_	(	improv::State	state,
		bool	update_advertising = true )

protected

Definition at line 239 of file esp32_improv_component.cpp.

◆ set_status_indicator()

void esphome::esp32_improv::ESP32ImprovComponent::set_status_indicator ( output::BinaryOutput * status_indicator )

inline

Definition at line 58 of file esp32_improv_component.h.

◆ set_status_indicator_state_()

void esphome::esp32_improv::ESP32ImprovComponent::set_status_indicator_state_ ( bool state )

protected

Definition at line 193 of file esp32_improv_component.cpp.

◆ set_wifi_timeout()

void esphome::esp32_improv::ESP32ImprovComponent::set_wifi_timeout ( uint32_t wifi_timeout )

inline

Definition at line 63 of file esp32_improv_component.h.

◆ setup()

void esphome::esp32_improv::ESP32ImprovComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 35 of file esp32_improv_component.cpp.

◆ setup_characteristics()

void esphome::esp32_improv::ESP32ImprovComponent::setup_characteristics ( )

Definition at line 61 of file esp32_improv_component.cpp.

◆ should_start()

bool esphome::esp32_improv::ESP32ImprovComponent::should_start ( ) const

inline

Definition at line 47 of file esp32_improv_component.h.

◆ start()

void esphome::esp32_improv::ESP32ImprovComponent::start ( )

Definition at line 294 of file esp32_improv_component.cpp.

◆ state_to_string_()

const char * esphome::esp32_improv::ESP32ImprovComponent::state_to_string_ ( improv::State state )

protected

Definition at line 209 of file esp32_improv_component.cpp.

◆ stop()

void esphome::esp32_improv::ESP32ImprovComponent::stop ( )

Definition at line 312 of file esp32_improv_component.cpp.

◆ update_advertising_type_()

void esphome::esp32_improv::ESP32ImprovComponent::update_advertising_type_ ( )

protected

Definition at line 494 of file esp32_improv_component.cpp.

Field Documentation

◆ advertising_device_name_

bool esphome::esp32_improv::ESP32ImprovComponent::advertising_device_name_ {false}

protected

Definition at line 105 of file esp32_improv_component.h.

◆ authorized_duration_

uint32_t esphome::esp32_improv::ESP32ImprovComponent::authorized_duration_

protected

Definition at line 76 of file esp32_improv_component.h.

◆ authorized_start_

uint32_t esphome::esp32_improv::ESP32ImprovComponent::authorized_start_ {0}

protected

Definition at line 75 of file esp32_improv_component.h.

◆ authorizer_

binary_sensor::BinarySensor* esphome::esp32_improv::ESP32ImprovComponent::authorizer_ {nullptr}

protected

Definition at line 91 of file esp32_improv_component.h.

◆ capabilities_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::capabilities_ {nullptr}

protected

Definition at line 88 of file esp32_improv_component.h.

◆ connecting_sta_

wifi::WiFiAP esphome::esp32_improv::ESP32ImprovComponent::connecting_sta_

protected

Definition at line 81 of file esp32_improv_component.h.

◆ error_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::error_ {nullptr}

protected

Definition at line 85 of file esp32_improv_component.h.

◆ error_state_

improv::Error esphome::esp32_improv::ESP32ImprovComponent::error_state_ {improv::ERROR_NONE}

protected

Definition at line 98 of file esp32_improv_component.h.

◆ identify_duration_

uint32_t esphome::esp32_improv::ESP32ImprovComponent::identify_duration_

protected

Definition at line 74 of file esp32_improv_component.h.

◆ identify_start_

uint32_t esphome::esp32_improv::ESP32ImprovComponent::identify_start_ {0}

protected

Definition at line 73 of file esp32_improv_component.h.

◆ incoming_data_

std::vector<uint8_t> esphome::esp32_improv::ESP32ImprovComponent::incoming_data_

protected

Definition at line 80 of file esp32_improv_component.h.

◆ last_name_adv_time_

uint32_t esphome::esp32_improv::ESP32ImprovComponent::last_name_adv_time_ {0}

protected

Definition at line 104 of file esp32_improv_component.h.

◆ rpc_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::rpc_ {nullptr}

protected

Definition at line 86 of file esp32_improv_component.h.

◆ rpc_response_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::rpc_response_ {nullptr}

protected

Definition at line 87 of file esp32_improv_component.h.

◆ service_

BLEService* esphome::esp32_improv::ESP32ImprovComponent::service_ {nullptr}

protected

Definition at line 83 of file esp32_improv_component.h.

◆ setup_complete_

bool esphome::esp32_improv::ESP32ImprovComponent::setup_complete_ {false}

protected

Definition at line 71 of file esp32_improv_component.h.

◆ should_start_

bool esphome::esp32_improv::ESP32ImprovComponent::should_start_ {false}

protected

Definition at line 70 of file esp32_improv_component.h.

◆ state_

improv::State esphome::esp32_improv::ESP32ImprovComponent::state_ {improv::STATE_STOPPED}

protected

Definition at line 97 of file esp32_improv_component.h.

◆ state_callback_

CallbackManager<void(improv::State, improv::Error)> esphome::esp32_improv::ESP32ImprovComponent::state_callback_ {}

protected

Definition at line 100 of file esp32_improv_component.h.

◆ status_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::status_ {nullptr}

protected

Definition at line 84 of file esp32_improv_component.h.

◆ status_indicator_

output::BinaryOutput* esphome::esp32_improv::ESP32ImprovComponent::status_indicator_ {nullptr}

protected

Definition at line 94 of file esp32_improv_component.h.

◆ status_indicator_state_

bool esphome::esp32_improv::ESP32ImprovComponent::status_indicator_state_ {false}

protected

Definition at line 103 of file esp32_improv_component.h.

◆ wifi_timeout_

uint32_t esphome::esp32_improv::ESP32ImprovComponent::wifi_timeout_ {}

protected

Definition at line 78 of file esp32_improv_component.h.

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

esphome/components/esp32_improv/esp32_improv_component.h
esphome/components/esp32_improv/esp32_improv_component.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ESP32ImprovComponent()

Member Function Documentation

◆ add_on_state_callback()

◆ advertise_service_data_()

◆ check_identify_()

◆ check_wifi_connection_()

◆ dump_config()

◆ get_improv_error_state()

◆ get_improv_state()

◆ get_initial_state_()

◆ get_setup_priority()

◆ get_wifi_timeout()

◆ is_active()

◆ loop()

◆ on_wifi_connect_timeout_()

◆ process_incoming_data_()

◆ send_response_()

◆ set_authorized_duration()

◆ set_authorizer()

◆ set_error_()

◆ set_identify_duration()

◆ set_state_()

◆ set_status_indicator()

◆ set_status_indicator_state_()

◆ set_wifi_timeout()

◆ setup()

◆ setup_characteristics()

◆ should_start()

◆ start()

◆ state_to_string_()

◆ stop()

◆ update_advertising_type_()

Field Documentation

◆ advertising_device_name_

◆ authorized_duration_

◆ authorized_start_

◆ authorizer_

◆ capabilities_

◆ connecting_sta_

◆ error_

◆ error_state_

◆ identify_duration_

◆ identify_start_

◆ incoming_data_

◆ last_name_adv_time_

◆ rpc_

◆ rpc_response_

◆ service_

◆ setup_complete_

◆ should_start_

◆ state_

◆ state_callback_

◆ status_

◆ status_indicator_

◆ status_indicator_state_

◆ wifi_timeout_