ESPHome
2026.11.0b6
Loading...
Searching...
No Matches
esphome
components
uart_tcp
uart_tcp.h
Go to the documentation of this file.
1
#pragma once
2
3
#include "
esphome/core/defines.h
"
4
#ifdef USE_BINARY_SENSOR
5
#include "
esphome/components/binary_sensor/binary_sensor.h
"
6
#endif
7
#ifdef USE_SENSOR
8
#include "
esphome/components/sensor/sensor.h
"
9
#endif
10
#include "
esphome/components/socket/tcp_client_link.h
"
11
#ifdef USE_SOCKET_TCP_LISTENER
12
#include "
esphome/components/socket/tcp_listener.h
"
13
#endif
14
#include "
esphome/components/uart/uart.h
"
15
#include "
esphome/core/component.h
"
16
17
#include <cstdint>
18
#include <memory>
19
20
namespace
esphome::uart_tcp
{
21
23
class
UartTcp
final :
public
Component
,
public
uart::UARTDevice
{
24
#ifdef USE_BINARY_SENSOR
25
SUB_BINARY_SENSOR(connected)
26
#endif
27
#ifdef USE_SENSOR
28
SUB_SENSOR(disconnects)
29
#endif
30
31
public
:
32
void
set_host(
const
char
*host) { this->
link_
.
set_host
(host); }
33
void
set_port(uint16_t port) { this->
link_
.
set_port
(port); }
34
void
set_reconnect_interval(
uint32_t
ms) { this->
link_
.
set_reconnect_interval
(ms); }
35
#ifdef USE_SOCKET_TCP_LISTENER
36
void
set_server(
bool
server) { this->
server_
= server; }
37
#ifdef USE_SOCKET_IPV4_ALLOW
38
void
set_allow(
const
socket::Ipv4AllowEntry
*entries,
size_t
count
) { this->
listener_
.
set_allow
(entries,
count
); }
39
#endif
40
#endif
41
42
void
setup()
override
;
43
void
loop()
override
;
44
void
dump_config()
override
;
45
void
on_shutdown()
override
;
46
float
get_setup_priority()
const override
{
return
setup_priority::AFTER_WIFI
; }
47
48
protected
:
49
void
sync_link_
();
50
void
read_socket_
();
51
void
read_uart_
();
52
void
discard_uart_
();
53
54
static
constexpr
size_t
READ_CHUNK
= 128;
55
// Scratch size for dropping stale UART bytes on connect.
56
static
constexpr
size_t
DISCARD_CHUNK
= 32;
57
58
socket::TcpClientLink
link_
;
59
#ifdef USE_SOCKET_TCP_LISTENER
60
socket::TcpListener
listener_
;
61
#endif
62
// Loop start time of the last socket-to-UART write; sizes the next paced write.
63
uint32_t
last_write_ms_
{0};
64
#ifdef USE_SENSOR
65
uint32_t
disconnects_
{0};
66
#endif
67
bool
server_
{
false
};
68
// The link state loop() saw last; edges clear the buffer and publish the sensor.
69
bool
link_was_up_
{
false
};
70
// A read stopped before EAGAIN. ready() stays false until new data arrives.
71
bool
rx_pending_
{
false
};
72
};
73
74
}
// namespace esphome::uart_tcp
binary_sensor.h
esphome::Component
Definition
component.h:147
esphome::socket::TcpClientLink
A reconnecting TCP stream driven from loop().
Definition
tcp_client_link.h:22
esphome::socket::TcpClientLink::set_reconnect_interval
void set_reconnect_interval(uint32_t ms)
Definition
tcp_client_link.h:26
esphome::socket::TcpClientLink::set_port
void set_port(uint16_t port)
Definition
tcp_client_link.h:25
esphome::socket::TcpClientLink::set_host
void set_host(const char *host)
Definition
tcp_client_link.h:24
esphome::socket::TcpListener
The server side of a bridged TCP link: owns the listen socket and the allow list, accepts one peer at...
Definition
tcp_listener.h:21
esphome::socket::TcpListener::set_allow
void set_allow(const Ipv4AllowEntry *entries, size_t count)
Definition
tcp_listener.h:24
esphome::uart::UARTDevice
Definition
uart.h:15
esphome::uart_tcp::UartTcp
Copies raw bytes between one hardware UART and one TCP socket.
Definition
uart_tcp.h:23
esphome::uart_tcp::UartTcp::DISCARD_CHUNK
static constexpr size_t DISCARD_CHUNK
Definition
uart_tcp.h:56
esphome::uart_tcp::UartTcp::link_was_up_
bool link_was_up_
Definition
uart_tcp.h:69
esphome::uart_tcp::UartTcp::link_
socket::TcpClientLink link_
Definition
uart_tcp.h:58
esphome::uart_tcp::UartTcp::READ_CHUNK
static constexpr size_t READ_CHUNK
Definition
uart_tcp.h:54
esphome::uart_tcp::UartTcp::listener_
socket::TcpListener listener_
Definition
uart_tcp.h:60
esphome::uart_tcp::UartTcp::read_socket_
void read_socket_()
Definition
uart_tcp.cpp:72
esphome::uart_tcp::UartTcp::disconnects_
uint32_t disconnects_
Definition
uart_tcp.h:65
esphome::uart_tcp::UartTcp::read_uart_
void read_uart_()
Definition
uart_tcp.cpp:108
esphome::uart_tcp::UartTcp::discard_uart_
void discard_uart_()
Definition
uart_tcp.cpp:95
esphome::uart_tcp::UartTcp::rx_pending_
bool rx_pending_
Definition
uart_tcp.h:71
esphome::uart_tcp::UartTcp::last_write_ms_
uint32_t last_write_ms_
Definition
uart_tcp.h:63
esphome::uart_tcp::UartTcp::server_
bool server_
Definition
uart_tcp.h:67
esphome::uart_tcp::UartTcp::sync_link_
void sync_link_()
Definition
uart_tcp.cpp:53
component.h
defines.h
count
unsigned count
Definition
gif.cpp:51
esphome::setup_priority::AFTER_WIFI
constexpr float AFTER_WIFI
For components that should be initialized after WiFi is connected.
Definition
component.h:55
esphome::uart_tcp
Definition
uart_tcp.cpp:10
uint32_t
static void uint32_t
Definition
crash_handler.cpp:153
sensor.h
esphome::socket::Ipv4AllowEntry
One allowed IPv4 network, network byte order, host bits cleared.
Definition
ipv4_allow.h:14
tcp_client_link.h
tcp_listener.h
uart.h
Generated by
1.12.0