#include <uart_transport.h>

Inheritance diagram for esphome::uart::UARTTransport:

Public Member Functions
void	loop () override

void	update () override

float	get_setup_priority () const override

Public Member Functions inherited from esphome::packet_transport::PacketTransport
void	setup () override

void	dump_config () override

void	add_sensor (const char id, sensor::Sensor sensor)

void	add_remote_sensor (const char hostname, const char remote_id, sensor::Sensor *sensor)

void	add_binary_sensor (const char id, binary_sensor::BinarySensor sensor)

void	add_remote_binary_sensor (const char hostname, const char remote_id, binary_sensor::BinarySensor *sensor)

void	add_provider (const char *hostname)

void	set_encryption_key (std::vector< uint8_t > key)

void	set_rolling_code_enable (bool enable)

void	set_ping_pong_enable (bool enable)

void	set_ping_pong_recycle_time (uint32_t recycle_time)

void	set_provider_encryption (const char *name, std::vector< uint8_t > key)

void	set_provider_status_sensor (const char name, binary_sensor::BinarySensor sensor)

void	set_platform_name (const char *name)

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::uart::UARTDevice
	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 (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 ()

int	available ()

void	flush ()

int	read ()

size_t	write (uint8_t data)

int	peek ()

void	check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
	Check that the configuration of the UART bus matches the provided values and otherwise print a warning.

Protected Member Functions
void	write_byte_ (uint8_t byte) const
	Write a byte to the UART bus.

void	send_packet (const std::vector< uint8_t > &buf) const override

bool	should_send () override

size_t	get_max_packet_size () override

Protected Member Functions inherited from esphome::packet_transport::PacketTransport
void	process_ (const std::vector< uint8_t > &data)
	Process a received packet.

void	send_data_ (bool all)

void	flush_ ()

void	add_data_ (uint8_t key, const char *id, float data)

void	add_data_ (uint8_t key, const char *id, uint32_t data)

void	increment_code_ ()

void	add_binary_data_ (uint8_t key, const char *id, bool data)

void	init_data_ ()

void	add_key_ (const char *name, uint32_t key)

void	send_ping_pong_request_ ()

bool	is_encrypted_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
std::vector< uint8_t >	receive_buffer_ {}

bool	rx_started_ {}

bool	rx_control_ {}

Protected Attributes inherited from esphome::packet_transport::PacketTransport
bool	updated_ {}

uint32_t	ping_key_ {}

uint32_t	rolling_code_ [2] {}

bool	rolling_code_enable_ {}

bool	ping_pong_enable_ {}

uint32_t	ping_pong_recyle_time_ {}

uint32_t	last_key_time_ {}

bool	resend_ping_key_ {}

bool	resend_data_ {}

const char *	name_ {}

ESPPreferenceObject	pref_ {}

std::vector< uint8_t >	encryption_key_ {}

std::vector< Sensor >	sensors_ {}

std::map< std::string, std::map< std::string, sensor::Sensor * > >	remote_sensors_ {}

std::vector< BinarySensor >	binary_sensors_ {}

std::map< std::string, std::map< std::string, binary_sensor::BinarySensor * > >	remote_binary_sensors_ {}

std::map< std::string, Provider >	providers_ {}

std::vector< uint8_t >	ping_header_ {}

std::vector< uint8_t >	header_ {}

std::vector< uint8_t >	data_ {}

std::map< const char *, uint32_t >	ping_keys_ {}

const char *	platform_name_ {""}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

Detailed Description

Definition at line 24 of file uart_transport.h.

Member Function Documentation

◆ get_max_packet_size()

size_t esphome::uart::UARTTransport::get_max_packet_size ( )

inlineoverrideprotectedvirtual

Implements esphome::packet_transport::PacketTransport.

Definition at line 34 of file uart_transport.h.

◆ get_setup_priority()

float esphome::uart::UARTTransport::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file uart_transport.h.

◆ loop()

void esphome::uart::UARTTransport::loop ( )

overridevirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 10 of file uart_transport.cpp.

◆ send_packet()

void esphome::uart::UARTTransport::send_packet ( const std::vector< uint8_t > & buf ) const

overrideprotectedvirtual

Implements esphome::packet_transport::PacketTransport.

Definition at line 77 of file uart_transport.cpp.

◆ should_send()

bool esphome::uart::UARTTransport::should_send ( )

inlineoverrideprotectedvirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 33 of file uart_transport.h.

◆ update()

void esphome::uart::UARTTransport::update ( )

overridevirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 59 of file uart_transport.cpp.

◆ write_byte_()

void esphome::uart::UARTTransport::write_byte_ ( uint8_t byte ) const

protected

Write a byte to the UART bus.

If the byte is a flag or control byte, it will be escaped.

Parameters

byte	The byte to write.

Definition at line 69 of file uart_transport.cpp.

Field Documentation

◆ receive_buffer_

std::vector<uint8_t> esphome::uart::UARTTransport::receive_buffer_ {}

protected

Definition at line 35 of file uart_transport.h.

◆ rx_control_

bool esphome::uart::UARTTransport::rx_control_ {}

protected

Definition at line 37 of file uart_transport.h.

◆ rx_started_

bool esphome::uart::UARTTransport::rx_started_ {}

protected

Definition at line 36 of file uart_transport.h.

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

esphome/components/uart/packet_transport/uart_transport.h
esphome/components/uart/packet_transport/uart_transport.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ get_max_packet_size()

◆ get_setup_priority()

◆ loop()

◆ send_packet()

◆ should_send()

◆ update()

◆ write_byte_()

Field Documentation

◆ receive_buffer_

◆ rx_control_

◆ rx_started_