ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::tcp_uart::TcpUart Class Reference

TCP client or server presented as a UART. Bytes are copied unchanged. More...

#include <tcp_uart.h>

Inheritance diagram for esphome::tcp_uart::TcpUart:
esphome::uart::UARTComponent esphome::Component

Public Member Functions

 TcpUart ()
 
void set_host (const char *host)
 
void set_port (uint16_t port)
 
void set_reconnect_interval (uint32_t ms)
 
void set_connected_sensor (binary_sensor::BinarySensor *sensor)
 
void set_disconnects_sensor (sensor::Sensor *sensor)
 
void set_server (bool server)
 
void set_allow (const socket::Ipv4AllowEntry *entries, size_t count)
 
void setup () override
 
void loop () override
 
void dump_config () override
 
void on_shutdown () 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
 
size_t available () override
 
size_t available_for_write () override
 
uart::UARTFlushResult flush () override
 
bool is_connected () override
 
void load_settings (bool dump_config) 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)
 
void write_array_progmem (const uint8_t *data, size_t len)
 
void write_array_progmem (const uint8_t *data, size_t len)
 
bool read_byte (uint8_t *data)
 
size_t paced_write_room (uint32_t last_write_ms)
 
virtual void set_flush_timeout (uint32_t flush_timeout_ms)
 
void set_tx_pin (InternalGPIOPin *tx_pin)
 
void set_rx_pin (InternalGPIOPin *rx_pin)
 
void set_flow_control_pin (InternalGPIOPin *flow_control_pin)
 
void set_rx_buffer_size (size_t rx_buffer_size)
 
size_t get_rx_buffer_size ()
 
virtual void set_rx_full_threshold (size_t rx_full_threshold)
 
void set_rx_full_threshold_ms (uint8_t time)
 
size_t get_rx_full_threshold ()
 
virtual void set_rx_timeout (size_t rx_timeout)
 
size_t get_rx_timeout ()
 
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 load_settings ()
 Load the UART settings.
 
template<typename F >
void add_debug_callback (F &&callback)
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
void call ()
 
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 ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
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)
 

Protected Member Functions

void check_logger_conflict () override
 
void sync_link_ ()
 
void read_socket_ ()
 
- Protected Member Functions inherited from esphome::uart::UARTComponent
bool check_read_timeout_ (size_t len=1)
 
- 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.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
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 Attributes

socket::TcpClientLink link_
 
socket::TcpListener listener_
 
binary_sensor::BinarySensor * connected_sensor_ {nullptr}
 
sensor::Sensor * disconnects_sensor_ {nullptr}
 
uint32_t disconnects_ {0}
 
uint32_t last_drop_log_ms_ {0}
 
uint16_t rx_start_ {0}
 
uint16_t rx_end_ {0}
 
bool server_ {false}
 
bool link_was_up_ {false}
 
bool rx_pending_ {false}
 
uint8_t rx_ [RX_BUFFER_SIZE] {}
 
- Protected Attributes inherited from esphome::uart::UARTComponent
InternalGPIOPin * tx_pin_ {}
 
InternalGPIOPin * rx_pin_ {}
 
InternalGPIOPin * flow_control_pin_ {}
 
size_t rx_buffer_size_ {}
 
size_t rx_full_threshold_ {RX_FULL_THRESHOLD_UNSET}
 
size_t rx_timeout_ {0}
 
uint32_t baud_rate_ {0}
 
uint8_t stop_bits_ {0}
 
uint8_t data_bits_ {0}
 
UARTParityOptions parity_ {UART_CONFIG_PARITY_NONE}
 
CallbackManager< void(UARTDirection, uint8_t)> debug_callback_ {}
 
- 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_
 

Static Protected Attributes

static constexpr size_t RX_BUFFER_SIZE = 1024
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 
- Static Public Attributes inherited from esphome::uart::UARTComponent
static constexpr size_t RX_FULL_THRESHOLD_UNSET = 0
 

Detailed Description

TCP client or server presented as a UART. Bytes are copied unchanged.

Definition at line 19 of file tcp_uart.h.

Constructor & Destructor Documentation

◆ TcpUart()

esphome::tcp_uart::TcpUart::TcpUart ( )
inline

Definition at line 21 of file tcp_uart.h.

Member Function Documentation

◆ available()

size_t esphome::tcp_uart::TcpUart::available ( )
inlineoverridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 46 of file tcp_uart.h.

◆ available_for_write()

size_t esphome::tcp_uart::TcpUart::available_for_write ( )
inlineoverridevirtual

Reimplemented from esphome::uart::UARTComponent.

Definition at line 48 of file tcp_uart.h.

◆ check_logger_conflict()

void esphome::tcp_uart::TcpUart::check_logger_conflict ( )
inlineoverrideprotectedvirtual

Implements esphome::uart::UARTComponent.

Definition at line 57 of file tcp_uart.h.

◆ dump_config()

void esphome::tcp_uart::TcpUart::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 30 of file tcp_uart.cpp.

◆ flush()

uart::UARTFlushResult esphome::tcp_uart::TcpUart::flush ( )
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 150 of file tcp_uart.cpp.

◆ get_setup_priority()

float esphome::tcp_uart::TcpUart::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 41 of file tcp_uart.h.

◆ is_connected()

bool esphome::tcp_uart::TcpUart::is_connected ( )
inlineoverridevirtual

Reimplemented from esphome::uart::UARTComponent.

Definition at line 50 of file tcp_uart.h.

◆ load_settings()

void esphome::tcp_uart::TcpUart::load_settings ( bool dump_config)
inlineoverridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 52 of file tcp_uart.h.

◆ loop()

void esphome::tcp_uart::TcpUart::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 96 of file tcp_uart.cpp.

◆ on_shutdown()

void esphome::tcp_uart::TcpUart::on_shutdown ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file tcp_uart.cpp.

◆ peek_byte()

bool esphome::tcp_uart::TcpUart::peek_byte ( uint8_t * data)
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 133 of file tcp_uart.cpp.

◆ read_array()

bool esphome::tcp_uart::TcpUart::read_array ( uint8_t * data,
size_t len )
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 141 of file tcp_uart.cpp.

◆ read_socket_()

void esphome::tcp_uart::TcpUart::read_socket_ ( )
protected

Definition at line 73 of file tcp_uart.cpp.

◆ set_allow()

void esphome::tcp_uart::TcpUart::set_allow ( const socket::Ipv4AllowEntry * entries,
size_t count )
inline

Definition at line 33 of file tcp_uart.h.

◆ set_connected_sensor()

void esphome::tcp_uart::TcpUart::set_connected_sensor ( binary_sensor::BinarySensor * sensor)
inline

Definition at line 26 of file tcp_uart.h.

◆ set_disconnects_sensor()

void esphome::tcp_uart::TcpUart::set_disconnects_sensor ( sensor::Sensor * sensor)
inline

Definition at line 28 of file tcp_uart.h.

◆ set_host()

void esphome::tcp_uart::TcpUart::set_host ( const char * host)
inline

Definition at line 23 of file tcp_uart.h.

◆ set_port()

void esphome::tcp_uart::TcpUart::set_port ( uint16_t port)
inline

Definition at line 24 of file tcp_uart.h.

◆ set_reconnect_interval()

void esphome::tcp_uart::TcpUart::set_reconnect_interval ( uint32_t ms)
inline

Definition at line 25 of file tcp_uart.h.

◆ set_server()

void esphome::tcp_uart::TcpUart::set_server ( bool server)
inline

Definition at line 31 of file tcp_uart.h.

◆ setup()

void esphome::tcp_uart::TcpUart::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file tcp_uart.cpp.

◆ sync_link_()

void esphome::tcp_uart::TcpUart::sync_link_ ( )
protected

Definition at line 54 of file tcp_uart.cpp.

◆ write_array()

void esphome::tcp_uart::TcpUart::write_array ( const uint8_t * data,
size_t len )
overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 120 of file tcp_uart.cpp.

Field Documentation

◆ connected_sensor_

binary_sensor::BinarySensor* esphome::tcp_uart::TcpUart::connected_sensor_ {nullptr}
protected

Definition at line 67 of file tcp_uart.h.

◆ disconnects_

uint32_t esphome::tcp_uart::TcpUart::disconnects_ {0}
protected

Definition at line 70 of file tcp_uart.h.

◆ disconnects_sensor_

sensor::Sensor* esphome::tcp_uart::TcpUart::disconnects_sensor_ {nullptr}
protected

Definition at line 69 of file tcp_uart.h.

◆ last_drop_log_ms_

uint32_t esphome::tcp_uart::TcpUart::last_drop_log_ms_ {0}
protected

Definition at line 72 of file tcp_uart.h.

◆ link_

socket::TcpClientLink esphome::tcp_uart::TcpUart::link_
protected

Definition at line 63 of file tcp_uart.h.

◆ link_was_up_

bool esphome::tcp_uart::TcpUart::link_was_up_ {false}
protected

Definition at line 78 of file tcp_uart.h.

◆ listener_

socket::TcpListener esphome::tcp_uart::TcpUart::listener_
protected

Definition at line 65 of file tcp_uart.h.

◆ rx_

uint8_t esphome::tcp_uart::TcpUart::rx_[RX_BUFFER_SIZE] {}
protected

Definition at line 81 of file tcp_uart.h.

◆ RX_BUFFER_SIZE

size_t esphome::tcp_uart::TcpUart::RX_BUFFER_SIZE = 1024
staticconstexprprotected

Definition at line 61 of file tcp_uart.h.

◆ rx_end_

uint16_t esphome::tcp_uart::TcpUart::rx_end_ {0}
protected

Definition at line 75 of file tcp_uart.h.

◆ rx_pending_

bool esphome::tcp_uart::TcpUart::rx_pending_ {false}
protected

Definition at line 80 of file tcp_uart.h.

◆ rx_start_

uint16_t esphome::tcp_uart::TcpUart::rx_start_ {0}
protected

Definition at line 74 of file tcp_uart.h.

◆ server_

bool esphome::tcp_uart::TcpUart::server_ {false}
protected

Definition at line 76 of file tcp_uart.h.


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