ESPHome  2022.1.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::uart::ESP8266UartComponent Class Reference

#include <uart_component_esp8266.h>

Inheritance diagram for esphome::uart::ESP8266UartComponent:
esphome::uart::UARTComponent esphome::Component

Public Member Functions

void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void write_array (const uint8_t *data, size_t len) override
 
bool peek_byte (uint8_t *data) override
 
bool read_array (uint8_t *data, size_t len) override
 
int available () override
 
void flush () override
 
uint32_t get_config ()
 
- Public Member Functions inherited from esphome::uart::UARTComponent
void write_array (const std::vector< uint8_t > &data)
 
void write_byte (uint8_t data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
void set_tx_pin (InternalGPIOPin *tx_pin)
 
void set_rx_pin (InternalGPIOPin *rx_pin)
 
void set_rx_buffer_size (size_t rx_buffer_size)
 
size_t get_rx_buffer_size ()
 
void set_stop_bits (uint8_t stop_bits)
 
uint8_t get_stop_bits () const
 
void set_data_bits (uint8_t data_bits)
 
uint8_t get_data_bits () const
 
void set_parity (UARTParityOptions parity)
 
UARTParityOptions get_parity () const
 
void set_baud_rate (uint32_t baud_rate)
 
uint32_t get_baud_rate () const
 
void add_debug_callback (std::function< void(UARTDirection, uint8_t)> &&callback)
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
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

void check_logger_conflict () override
 
- Protected Member Functions inherited from esphome::uart::UARTComponent
bool check_read_timeout_ (size_t len=1)
 
- 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

HardwareSerial * hw_serial_ {nullptr}
 
ESP8266SoftwareSerialsw_serial_ {nullptr}
 
- Protected Attributes inherited from esphome::uart::UARTComponent
InternalGPIOPintx_pin_
 
InternalGPIOPinrx_pin_
 
size_t rx_buffer_size_
 
uint32_t baud_rate_
 
uint8_t stop_bits_
 
uint8_t data_bits_
 
UARTParityOptions parity_
 
CallbackManager< void(UARTDirection, uint8_t)> debug_callback_ {}
 
- 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 50 of file uart_component_esp8266.h.

Member Function Documentation

◆ available()

int esphome::uart::ESP8266UartComponent::available ( )
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 170 of file uart_component_esp8266.cpp.

◆ check_logger_conflict()

void esphome::uart::ESP8266UartComponent::check_logger_conflict ( )
overrideprotectedvirtual

Implements esphome::uart::UARTComponent.

Definition at line 118 of file uart_component_esp8266.cpp.

◆ dump_config()

void esphome::uart::ESP8266UartComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 99 of file uart_component_esp8266.cpp.

◆ flush()

void esphome::uart::ESP8266UartComponent::flush ( )
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 177 of file uart_component_esp8266.cpp.

◆ get_config()

uint32_t esphome::uart::ESP8266UartComponent::get_config ( )

Definition at line 18 of file uart_component_esp8266.cpp.

◆ get_setup_priority()

float esphome::uart::ESP8266UartComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 54 of file uart_component_esp8266.h.

◆ peek_byte()

bool esphome::uart::ESP8266UartComponent::peek_byte ( uint8_t *  data)
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 144 of file uart_component_esp8266.cpp.

◆ read_array()

bool esphome::uart::ESP8266UartComponent::read_array ( uint8_t *  data,
size_t  len 
)
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 154 of file uart_component_esp8266.cpp.

◆ setup()

void esphome::uart::ESP8266UartComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 56 of file uart_component_esp8266.cpp.

◆ write_array()

void esphome::uart::ESP8266UartComponent::write_array ( const uint8_t *  data,
size_t  len 
)
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 131 of file uart_component_esp8266.cpp.

Field Documentation

◆ hw_serial_

HardwareSerial* esphome::uart::ESP8266UartComponent::hw_serial_ {nullptr}
protected

Definition at line 69 of file uart_component_esp8266.h.

◆ sw_serial_

ESP8266SoftwareSerial* esphome::uart::ESP8266UartComponent::sw_serial_ {nullptr}
protected

Definition at line 70 of file uart_component_esp8266.h.


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