#include <improv_serial_component.h>

Inheritance diagram for esphome::improv_serial::ImprovSerialComponent:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

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
bool	parse_improv_serial_byte_ (uint8_t byte)

bool	parse_improv_payload_ (improv::ImprovCommand &command)

void	set_state_ (improv::State state)

void	send_current_state_ (improv::State state)

void	set_error_ (improv::Error error)

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

void	on_wifi_connect_timeout_ ()

std::vector< uint8_t >	build_rpc_settings_response_ (improv::Command command)

std::vector< uint8_t >	build_version_info_ ()

optional< uint8_t >	read_byte_ ()

void	write_data_ (const uint8_t *data=nullptr, size_t size=0)

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
uint8_t	tx_header_ [TX_BUFFER_SIZE]

uart_port_t	uart_num_

Stream *	hw_serial_ {nullptr}

std::vector< uint8_t >	rx_buffer_

uint32_t	last_read_byte_ {0}

wifi::WiFiAP	connecting_sta_

improv::State	state_ {improv::STATE_AUTHORIZED}

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 47 of file improv_serial_component.h.

Member Function Documentation

◆ build_rpc_settings_response_()

std::vector< uint8_t > esphome::improv_serial::ImprovSerialComponent::build_rpc_settings_response_ ( improv::Command command )

protected

Definition at line 180 of file improv_serial_component.cpp.

◆ build_version_info_()

std::vector< uint8_t > esphome::improv_serial::ImprovSerialComponent::build_version_info_ ( )

protected

Definition at line 208 of file improv_serial_component.cpp.

◆ dump_config()

void esphome::improv_serial::ImprovSerialComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file improv_serial_component.cpp.

◆ get_setup_priority()

float esphome::improv_serial::ImprovSerialComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 53 of file improv_serial_component.h.

◆ loop()

void esphome::improv_serial::ImprovSerialComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 32 of file improv_serial_component.cpp.

◆ on_wifi_connect_timeout_()

void esphome::improv_serial::ImprovSerialComponent::on_wifi_connect_timeout_ ( )

protected

Definition at line 339 of file improv_serial_component.cpp.

◆ parse_improv_payload_()

bool esphome::improv_serial::ImprovSerialComponent::parse_improv_payload_ ( improv::ImprovCommand & command )

protected

Definition at line 232 of file improv_serial_component.cpp.

◆ parse_improv_serial_byte_()

bool esphome::improv_serial::ImprovSerialComponent::parse_improv_serial_byte_ ( uint8_t byte )

protected

Definition at line 218 of file improv_serial_component.cpp.

◆ read_byte_()

optional< uint8_t > esphome::improv_serial::ImprovSerialComponent::read_byte_ ( )

protected

Definition at line 66 of file improv_serial_component.cpp.

◆ send_current_state_()

void esphome::improv_serial::ImprovSerialComponent::send_current_state_ ( improv::State state )

protected

Definition at line 322 of file improv_serial_component.cpp.

◆ send_response_()

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

protected

Definition at line 334 of file improv_serial_component.cpp.

◆ set_error_()

void esphome::improv_serial::ImprovSerialComponent::set_error_ ( improv::Error error )

protected

Definition at line 328 of file improv_serial_component.cpp.

◆ set_state_()

void esphome::improv_serial::ImprovSerialComponent::set_state_ ( improv::State state )

protected

Definition at line 317 of file improv_serial_component.cpp.

◆ setup()

void esphome::improv_serial::ImprovSerialComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file improv_serial_component.cpp.

◆ write_data_()

void esphome::improv_serial::ImprovSerialComponent::write_data_	(	const uint8_t *	data = nullptr,
		size_t	size = 0 )

protected

Definition at line 113 of file improv_serial_component.cpp.

Field Documentation

◆ connecting_sta_

wifi::WiFiAP esphome::improv_serial::ImprovSerialComponent::connecting_sta_

protected

Definition at line 94 of file improv_serial_component.h.

◆ hw_serial_

Stream* esphome::improv_serial::ImprovSerialComponent::hw_serial_ {nullptr}

protected

Definition at line 89 of file improv_serial_component.h.

◆ last_read_byte_

uint32_t esphome::improv_serial::ImprovSerialComponent::last_read_byte_ {0}

protected

Definition at line 93 of file improv_serial_component.h.

◆ rx_buffer_

std::vector<uint8_t> esphome::improv_serial::ImprovSerialComponent::rx_buffer_

protected

Definition at line 92 of file improv_serial_component.h.

◆ state_

improv::State esphome::improv_serial::ImprovSerialComponent::state_ {improv::STATE_AUTHORIZED}

protected

Definition at line 95 of file improv_serial_component.h.

◆ tx_header_

uint8_t esphome::improv_serial::ImprovSerialComponent::tx_header_[TX_BUFFER_SIZE]

protected

Initial value:

= {
      'I',                    
      'M',                    
      'P',                    
      'R',                    
      'O',                    
      'V',                    
      IMPROV_SERIAL_VERSION,  
      0,                      
      0,                      
      0,                      
      0,                      
      '\n',
  }

Definition at line 71 of file improv_serial_component.h.

◆ uart_num_

uart_port_t esphome::improv_serial::ImprovSerialComponent::uart_num_

protected

Definition at line 87 of file improv_serial_component.h.

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

esphome/components/improv_serial/improv_serial_component.h
esphome/components/improv_serial/improv_serial_component.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ build_rpc_settings_response_()

◆ build_version_info_()

◆ dump_config()

◆ get_setup_priority()

◆ loop()

◆ on_wifi_connect_timeout_()

◆ parse_improv_payload_()

◆ parse_improv_serial_byte_()

◆ read_byte_()

◆ send_current_state_()

◆ send_response_()

◆ set_error_()

◆ set_state_()

◆ setup()

◆ write_data_()

Field Documentation

◆ connecting_sta_

◆ hw_serial_

◆ last_read_byte_

◆ rx_buffer_

◆ state_

◆ tx_header_

◆ uart_num_