ESPHome
2024.11.3
|
#include <uart_component_esp_idf.h>
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 |
uint8_t | get_hw_serial_number () |
QueueHandle_t * | get_uart_event_queue () |
void | load_settings (bool dump_config) override |
Load the UART with the current settings. More... | |
void | load_settings () override |
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 () const |
bool | is_ready () const |
virtual bool | can_proceed () |
bool | status_has_warning () const |
bool | status_has_error () const |
void | status_set_warning (const char *message="unspecified") |
void | status_set_error (const char *message="unspecified") |
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 |
uart_config_t | get_config_ () |
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(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 | |
uart_port_t | uart_num_ |
QueueHandle_t | uart_event_queue_ |
SemaphoreHandle_t | lock_ |
bool | has_peek_ {false} |
uint8_t | peek_byte_ |
Protected Attributes inherited from esphome::uart::UARTComponent | |
InternalGPIOPin * | tx_pin_ |
InternalGPIOPin * | rx_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} |
Definition at line 12 of file uart_component_esp_idf.h.
|
overridevirtual |
Implements esphome::uart::UARTComponent.
Definition at line 224 of file uart_component_esp_idf.cpp.
|
overrideprotectedvirtual |
Implements esphome::uart::UARTComponent.
Definition at line 243 of file uart_component_esp_idf.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 158 of file uart_component_esp_idf.cpp.
|
overridevirtual |
Implements esphome::uart::UARTComponent.
Definition at line 236 of file uart_component_esp_idf.cpp.
|
protected |
Definition at line 18 of file uart_component_esp_idf.cpp.
|
inline |
Definition at line 26 of file uart_component_esp_idf.h.
|
inlineoverridevirtual |
Reimplemented from esphome::Component.
Definition at line 16 of file uart_component_esp_idf.h.
|
inline |
Definition at line 27 of file uart_component_esp_idf.h.
|
overridevirtual |
Load the UART with the current settings.
dump_config | (Optional, default true ): True for displaying new settings or false to change it quitely |
Example:
This will load the current UART interface with the latest settings (baud_rate, parity, etc).
Reimplemented from esphome::uart::UARTComponent.
Definition at line 145 of file uart_component_esp_idf.cpp.
|
inlineoverridevirtual |
Reimplemented from esphome::uart::UARTComponent.
Definition at line 42 of file uart_component_esp_idf.h.
|
overridevirtual |
Implements esphome::uart::UARTComponent.
Definition at line 183 of file uart_component_esp_idf.cpp.
|
overridevirtual |
Implements esphome::uart::UARTComponent.
Definition at line 202 of file uart_component_esp_idf.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 61 of file uart_component_esp_idf.cpp.
|
overridevirtual |
Implements esphome::uart::UARTComponent.
Definition at line 172 of file uart_component_esp_idf.cpp.
|
protected |
Definition at line 51 of file uart_component_esp_idf.h.
|
protected |
Definition at line 49 of file uart_component_esp_idf.h.
|
protected |
Definition at line 52 of file uart_component_esp_idf.h.
|
protected |
Definition at line 47 of file uart_component_esp_idf.h.
|
protected |
Definition at line 46 of file uart_component_esp_idf.h.