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

void	on_client_disconnect () override

float	get_setup_priority () const override

void	start () override

void	stop () override

bool	is_active () const

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)

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

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

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

bool	is_failed ()

bool	is_ready ()

virtual bool	can_proceed ()

bool	status_has_warning ()

bool	status_has_error ()

void	status_set_warning ()

void	status_set_error ()

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

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

Public Member Functions inherited from esphome::esp32_ble_server::BLEServiceComponent
virtual void	on_client_connect ()

Protected Member Functions
void	set_state_ (improv::State state)

void	set_error_ (improv::Error error)

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

void	process_incoming_data_ ()

void	on_wifi_connect_timeout_ ()

bool	check_identify_ ()

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

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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

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

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

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

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

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

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

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

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

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

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_

std::vector< uint8_t >	incoming_data_

wifi::WiFiAP	connecting_sta_

std::shared_ptr< BLEService >	service_

BLECharacteristic *	status_

BLECharacteristic *	error_

BLECharacteristic *	rpc_

BLECharacteristic *	rpc_response_

BLECharacteristic *	capabilities_

binary_sensor::BinarySensor *	authorizer_ {nullptr}

output::BinaryOutput *	status_indicator_ {nullptr}

improv::State	state_ {improv::STATE_STOPPED}

improv::Error	error_state_ {improv::ERROR_NONE}

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Detailed Description

Definition at line 23 of file esp32_improv_component.h.

Constructor & Destructor Documentation

◆ ESP32ImprovComponent()

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

Definition at line 16 of file esp32_improv_component.cpp.

Member Function Documentation

◆ check_identify_()

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

protected

Definition at line 152 of file esp32_improv_component.cpp.

◆ dump_config()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 214 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 212 of file esp32_improv_component.cpp.

◆ is_active()

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

inline

Definition at line 35 of file esp32_improv_component.h.

◆ loop()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 59 of file esp32_improv_component.cpp.

◆ on_client_disconnect()

void esphome::esp32_improv::ESP32ImprovComponent::on_client_disconnect ( )

overridevirtual

Reimplemented from esphome::esp32_ble_server::BLEServiceComponent.

Definition at line 282 of file esp32_improv_component.cpp.

◆ on_wifi_connect_timeout_()

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

protected

Definition at line 273 of file esp32_improv_component.cpp.

◆ process_incoming_data_()

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

protected

Definition at line 220 of file esp32_improv_component.cpp.

◆ send_response_()

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

protected

Definition at line 191 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 40 of file esp32_improv_component.h.

◆ set_authorizer()

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

inline

Definition at line 37 of file esp32_improv_component.h.

◆ set_error_()

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

protected

Definition at line 179 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 39 of file esp32_improv_component.h.

◆ set_state_()

void esphome::esp32_improv::ESP32ImprovComponent::set_state_ ( improv::State state )

protected

Definition at line 168 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 38 of file esp32_improv_component.h.

◆ setup()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file esp32_improv_component.cpp.

◆ setup_characteristics()

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

Definition at line 23 of file esp32_improv_component.cpp.

◆ start()

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

overridevirtual

Reimplemented from esphome::esp32_ble_server::BLEServiceComponent.

Definition at line 197 of file esp32_improv_component.cpp.

◆ stop()

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

overridevirtual

Reimplemented from esphome::esp32_ble_server::BLEServiceComponent.

Definition at line 205 of file esp32_improv_component.cpp.

Field Documentation

◆ authorized_duration_

uint32_t esphome::esp32_improv::ESP32ImprovComponent::authorized_duration_

protected

Definition at line 49 of file esp32_improv_component.h.

◆ authorized_start_

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

protected

Definition at line 48 of file esp32_improv_component.h.

◆ authorizer_

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

protected

Definition at line 61 of file esp32_improv_component.h.

◆ capabilities_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::capabilities_

protected

Definition at line 59 of file esp32_improv_component.h.

◆ connecting_sta_

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

protected

Definition at line 52 of file esp32_improv_component.h.

◆ error_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::error_

protected

Definition at line 56 of file esp32_improv_component.h.

◆ error_state_

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

protected

Definition at line 65 of file esp32_improv_component.h.

◆ identify_duration_

uint32_t esphome::esp32_improv::ESP32ImprovComponent::identify_duration_

protected

Definition at line 47 of file esp32_improv_component.h.

◆ identify_start_

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

protected

Definition at line 46 of file esp32_improv_component.h.

◆ incoming_data_

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

protected

Definition at line 51 of file esp32_improv_component.h.

◆ rpc_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::rpc_

protected

Definition at line 57 of file esp32_improv_component.h.

◆ rpc_response_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::rpc_response_

protected

Definition at line 58 of file esp32_improv_component.h.

◆ service_

std::shared_ptr<BLEService> esphome::esp32_improv::ESP32ImprovComponent::service_

protected

Definition at line 54 of file esp32_improv_component.h.

◆ setup_complete_

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

protected

Definition at line 44 of file esp32_improv_component.h.

◆ should_start_

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

protected

Definition at line 43 of file esp32_improv_component.h.

◆ state_

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

protected

Definition at line 64 of file esp32_improv_component.h.

◆ status_

BLECharacteristic* esphome::esp32_improv::ESP32ImprovComponent::status_

protected

Definition at line 55 of file esp32_improv_component.h.

◆ status_indicator_

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

protected

Definition at line 62 of file esp32_improv_component.h.

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

/opt/build/esphome/esphome/components/esp32_improv/esp32_improv_component.h
/opt/build/esphome/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

◆ check_identify_()

◆ dump_config()

◆ get_setup_priority()

◆ is_active()

◆ loop()

◆ on_client_disconnect()

◆ on_wifi_connect_timeout_()

◆ process_incoming_data_()

◆ send_response_()

◆ set_authorized_duration()

◆ set_authorizer()

◆ set_error_()

◆ set_identify_duration()

◆ set_state_()

◆ set_status_indicator()

◆ setup()

◆ setup_characteristics()

◆ start()

◆ stop()

Field Documentation

◆ authorized_duration_

◆ authorized_start_

◆ authorizer_

◆ capabilities_

◆ connecting_sta_

◆ error_

◆ error_state_

◆ identify_duration_

◆ identify_start_

◆ incoming_data_

◆ rpc_

◆ rpc_response_

◆ service_

◆ setup_complete_

◆ should_start_

◆ state_

◆ status_

◆ status_indicator_