#include <uart.h>

Inheritance diagram for esphome::uart::UARTDevice:

Public Member Functions
	UARTDevice ()=default

	UARTDevice (UARTComponent *parent)

void	set_uart_parent (UARTComponent *parent)

void	write_byte (uint8_t data)

void	set_rx_full_threshold (size_t rx_full_threshold)

void	set_rx_full_threshold_ms (size_t time)

size_t	get_rx_full_threshold ()

void	set_rx_timeout (size_t rx_timeout)

size_t	get_rx_timeout ()

void	write_array (const uint8_t *data, size_t len)

void	write_array_progmem (const uint8_t *data, size_t len)

void	write_array (const std::vector< uint8_t > &data)

template<size_t N>
void	write_array (const std::array< uint8_t, N > &data)

void	write_str (const char *str)

bool	read_byte (uint8_t *data)

bool	peek_byte (uint8_t *data)

bool	read_array (uint8_t *data, size_t len)

template<size_t N>
optional< std::array< uint8_t, N > >	read_array ()

size_t	available ()

template<size_t N = 64, typename F >
bool	read_available_chunks (F &&on_chunk)
	Pass the bytes available now to on_chunk(data, len) in N byte chunks; returning false stops.

template<size_t N = 64, typename F >
bool	read_available_chunks (F &&on_chunk, size_t count)
	Same, reading exactly count bytes; count must not exceed available().

template<size_t N = 64, typename F >
bool	read_available (F &&on_byte)
	Same as read_available_chunks(), calling on_byte(uint8_t) once per byte.

template<size_t N = 64, typename F >
bool	read_available (F &&on_byte, size_t count)

void	discard_available ()
	Read and drop every byte waiting in the receive buffer.

UARTFlushResult	flush ()

int	read ()

size_t	write (uint8_t data)

int	peek ()

	ESPDEPRECATED ("Use uart.final_validate_device_schema() in Python instead. Removed in 2027.3.0", "2026.9.0") void check_uart_settings(uint32_t baud_rate
	Check that the configuration of the UART bus matches the provided values and otherwise print a warning.

Data Fields
uint8_t	stop_bits = 1

uint8_t UARTParityOptions	parity = UART_CONFIG_PARITY_NONE

uint8_t UARTParityOptions uint8_t	data_bits = 8)

Static Protected Member Functions
template<typename F , typename... A>
static bool	continue_after (F &f, A... args)
	Call f(args...) and return its result; a void callback always continues.

Protected Attributes
UARTComponent *	parent_ {nullptr}

Detailed Description

Definition at line 15 of file uart.h.

Constructor & Destructor Documentation

◆ UARTDevice() [1/2]

esphome::uart::UARTDevice::UARTDevice ( )

default

◆ UARTDevice() [2/2]

esphome::uart::UARTDevice::UARTDevice ( UARTComponent * parent )

inline

Definition at line 18 of file uart.h.

Member Function Documentation

◆ available()

size_t esphome::uart::UARTDevice::available ( )

inline

Definition at line 52 of file uart.h.

◆ continue_after()

template<typename F , typename... A>

static bool esphome::uart::UARTDevice::continue_after	(	F &	f,
		A...	args )

inlinestaticprotected

Call f(args...) and return its result; a void callback always continues.

Definition at line 123 of file uart.h.

◆ discard_available()

void esphome::uart::UARTDevice::discard_available ( )

Read and drop every byte waiting in the receive buffer.

Definition at line 36 of file uart.cpp.

◆ ESPDEPRECATED()

esphome::uart::UARTDevice::ESPDEPRECATED	(	"Use uart.final_validate_device_schema() in Python instead. Removed in 2027.3.0"	,
		"2026.9.0"	)

Check that the configuration of the UART bus matches the provided values and otherwise print a warning.

◆ flush()

UARTFlushResult esphome::uart::UARTDevice::flush ( )

inline

Definition at line 96 of file uart.h.

◆ get_rx_full_threshold()

size_t esphome::uart::UARTDevice::get_rx_full_threshold ( )

inline

Definition at line 26 of file uart.h.

◆ get_rx_timeout()

size_t esphome::uart::UARTDevice::get_rx_timeout ( )

inline

Definition at line 28 of file uart.h.

◆ peek()

int esphome::uart::UARTDevice::peek ( )

inline

Definition at line 109 of file uart.h.

◆ peek_byte()

bool esphome::uart::UARTDevice::peek_byte ( uint8_t * data )

inline

Definition at line 40 of file uart.h.

◆ read()

int esphome::uart::UARTDevice::read ( )

inline

Definition at line 99 of file uart.h.

◆ read_array() [1/2]

template<size_t N>

optional< std::array< uint8_t, N > > esphome::uart::UARTDevice::read_array ( )

inline

Definition at line 43 of file uart.h.

◆ read_array() [2/2]

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

inline

Definition at line 42 of file uart.h.

◆ read_available() [1/2]

template<size_t N = 64, typename F >

bool esphome::uart::UARTDevice::read_available ( F && on_byte )

inline

Same as read_available_chunks(), calling on_byte(uint8_t) once per byte.

Definition at line 77 of file uart.h.

◆ read_available() [2/2]

template<size_t N = 64, typename F >

bool esphome::uart::UARTDevice::read_available	(	F &&	on_byte,
		size_t	count )

inline

Definition at line 80 of file uart.h.

◆ read_available_chunks() [1/2]

template<size_t N = 64, typename F >

bool esphome::uart::UARTDevice::read_available_chunks ( F && on_chunk )

inline

Pass the bytes available now to on_chunk(data, len) in N byte chunks; returning false stops.

Returns false only on a read error.

Definition at line 56 of file uart.h.

◆ read_available_chunks() [2/2]

template<size_t N = 64, typename F >

bool esphome::uart::UARTDevice::read_available_chunks	(	F &&	on_chunk,
		size_t	count )

inline

Same, reading exactly count bytes; count must not exceed available().

Definition at line 60 of file uart.h.

◆ read_byte()

bool esphome::uart::UARTDevice::read_byte ( uint8_t * data )

inline

Definition at line 39 of file uart.h.

◆ set_rx_full_threshold()

void esphome::uart::UARTDevice::set_rx_full_threshold ( size_t rx_full_threshold )

inline

Definition at line 24 of file uart.h.

◆ set_rx_full_threshold_ms()

void esphome::uart::UARTDevice::set_rx_full_threshold_ms ( size_t time )

inline

Definition at line 25 of file uart.h.

◆ set_rx_timeout()

void esphome::uart::UARTDevice::set_rx_timeout ( size_t rx_timeout )

inline

Definition at line 27 of file uart.h.

◆ set_uart_parent()

void esphome::uart::UARTDevice::set_uart_parent ( UARTComponent * parent )

inline

Definition at line 20 of file uart.h.

◆ write()

size_t esphome::uart::UARTDevice::write ( uint8_t data )

inline

Definition at line 105 of file uart.h.

◆ write_array() [1/3]

template<size_t N>

void esphome::uart::UARTDevice::write_array ( const std::array< uint8_t, N > & data )

inline

Definition at line 33 of file uart.h.

◆ write_array() [2/3]

void esphome::uart::UARTDevice::write_array ( const std::vector< uint8_t > & data )

inline

Definition at line 32 of file uart.h.

◆ write_array() [3/3]

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

inline

Definition at line 30 of file uart.h.

◆ write_array_progmem()

void esphome::uart::UARTDevice::write_array_progmem	(	const uint8_t *	data,
		size_t	len )

inline

Definition at line 31 of file uart.h.

◆ write_byte()

void esphome::uart::UARTDevice::write_byte ( uint8_t data )

inline

Definition at line 22 of file uart.h.

◆ write_str()

void esphome::uart::UARTDevice::write_str ( const char * str )

inline

Definition at line 37 of file uart.h.

Field Documentation

◆ data_bits

uint8_t UARTParityOptions uint8_t esphome::uart::UARTDevice::data_bits = 8)

Definition at line 119 of file uart.h.

◆ parent_

UARTComponent* esphome::uart::UARTDevice::parent_ {nullptr}

protected

Definition at line 134 of file uart.h.

◆ parity

uint8_t UARTParityOptions esphome::uart::UARTDevice::parity = UART_CONFIG_PARITY_NONE

Definition at line 119 of file uart.h.

◆ stop_bits

uint8_t esphome::uart::UARTDevice::stop_bits = 1

Definition at line 118 of file uart.h.

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

esphome/components/uart/uart.h
esphome/components/uart/uart.cpp

Public Member Functions

Data Fields

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UARTDevice() [1/2]

◆ UARTDevice() [2/2]

Member Function Documentation

◆ available()

◆ continue_after()

◆ discard_available()

◆ ESPDEPRECATED()

◆ flush()

◆ get_rx_full_threshold()

◆ get_rx_timeout()

◆ peek()

◆ peek_byte()

◆ read()

◆ read_array() [1/2]

◆ read_array() [2/2]

◆ read_available() [1/2]

◆ read_available() [2/2]

◆ read_available_chunks() [1/2]

◆ read_available_chunks() [2/2]

◆ read_byte()

◆ set_rx_full_threshold()

◆ set_rx_full_threshold_ms()

◆ set_rx_timeout()

◆ set_uart_parent()

◆ write()

◆ write_array() [1/3]

◆ write_array() [2/3]

◆ write_array() [3/3]

◆ write_array_progmem()

◆ write_byte()

◆ write_str()

Field Documentation

◆ data_bits

◆ parent_

◆ parity

◆ stop_bits