ESPHome  2022.6.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::improv_serial::ImprovSerialComponent Class Reference

#include <improv_serial_component.h>

Inheritance diagram for esphome::improv_serial::ImprovSerialComponent:
esphome::Component

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

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 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_ ()
 
int available_ ()
 
uint8_t read_byte_ ()
 
void write_data_ (std::vector< uint8_t > &data)
 
- 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()> &&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()> &&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

Stream * hw_serial_ {nullptr}
 
uart_port_t uart_num_
 
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
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 29 of file improv_serial_component.h.

Member Function Documentation

◆ available_()

int esphome::improv_serial::ImprovSerialComponent::available_ ( )
protected

Definition at line 34 of file improv_serial_component.cpp.

◆ build_rpc_settings_response_()

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

Definition at line 96 of file improv_serial_component.cpp.

◆ build_version_info_()

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

Definition at line 107 of file improv_serial_component.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 32 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 35 of file improv_serial_component.h.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 66 of file improv_serial_component.cpp.

◆ on_wifi_connect_timeout_()

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

Definition at line 235 of file improv_serial_component.cpp.

◆ parse_improv_payload_()

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

Definition at line 127 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 113 of file improv_serial_component.cpp.

◆ read_byte_()

uint8_t esphome::improv_serial::ImprovSerialComponent::read_byte_ ( )
protected

Definition at line 45 of file improv_serial_component.cpp.

◆ send_response_()

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

Definition at line 219 of file improv_serial_component.cpp.

◆ set_error_()

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

Definition at line 204 of file improv_serial_component.cpp.

◆ set_state_()

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

Definition at line 186 of file improv_serial_component.cpp.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 16 of file improv_serial_component.cpp.

◆ write_data_()

void esphome::improv_serial::ImprovSerialComponent::write_data_ ( std::vector< uint8_t > &  data)
protected

Definition at line 56 of file improv_serial_component.cpp.

Field Documentation

◆ connecting_sta_

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

Definition at line 62 of file improv_serial_component.h.

◆ hw_serial_

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

Definition at line 54 of file improv_serial_component.h.

◆ last_read_byte_

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

Definition at line 61 of file improv_serial_component.h.

◆ rx_buffer_

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

Definition at line 60 of file improv_serial_component.h.

◆ state_

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

Definition at line 63 of file improv_serial_component.h.

◆ uart_num_

uart_port_t esphome::improv_serial::ImprovSerialComponent::uart_num_
protected

Definition at line 57 of file improv_serial_component.h.


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