#include <uart_component_rp2.h>

Inheritance diagram for esphome::uart::RP2UartComponent:

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

size_t	available () override

UARTFlushResult	flush () override

uint16_t	get_config ()

bool	is_hw_serial ()

HardwareSerial *	get_hw_serial ()

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)

virtual bool	is_connected ()

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

virtual void	load_settings (bool dump_config)=0
	Load the UART settings.

void	load_settings ()
	Load the UART settings.

template<typename F >
void	add_debug_callback (F &&callback)

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

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.

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 ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

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

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.

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
bool	hw_serial_ {false}

HardwareSerial *	serial_ {nullptr}

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_

Additional Inherited Members
Static Public Attributes inherited from esphome::uart::UARTComponent
static constexpr size_t	RX_FULL_THRESHOLD_UNSET = 0

Detailed Description

Definition at line 16 of file uart_component_rp2.h.

Member Function Documentation

◆ available()

size_t esphome::uart::RP2UartComponent::available ( )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 210 of file uart_component_rp2.cpp.

◆ check_logger_conflict()

void esphome::uart::RP2UartComponent::check_logger_conflict ( )

inlineoverrideprotectedvirtual

Implements esphome::uart::UARTComponent.

Definition at line 36 of file uart_component_rp2.h.

◆ dump_config()

void esphome::uart::RP2UartComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 165 of file uart_component_rp2.cpp.

◆ flush()

UARTFlushResult esphome::uart::RP2UartComponent::flush ( )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 211 of file uart_component_rp2.cpp.

◆ get_config()

uint16_t esphome::uart::RP2UartComponent::get_config ( )

Definition at line 18 of file uart_component_rp2.cpp.

◆ get_hw_serial()

HardwareSerial * esphome::uart::RP2UartComponent::get_hw_serial ( )

inline

Definition at line 33 of file uart_component_rp2.h.

◆ get_setup_priority()

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

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file uart_component_rp2.h.

◆ is_hw_serial()

bool esphome::uart::RP2UartComponent::is_hw_serial ( )

inline

Definition at line 32 of file uart_component_rp2.h.

◆ peek_byte()

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

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 193 of file uart_component_rp2.cpp.

◆ read_array()

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

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 199 of file uart_component_rp2.cpp.

◆ setup()

void esphome::uart::RP2UartComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 53 of file uart_component_rp2.cpp.

◆ write_array()

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

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 185 of file uart_component_rp2.cpp.

Field Documentation

◆ hw_serial_

bool esphome::uart::RP2UartComponent::hw_serial_ {false}

protected

Definition at line 37 of file uart_component_rp2.h.

◆ serial_

HardwareSerial* esphome::uart::RP2UartComponent::serial_ {nullptr}

protected

Definition at line 39 of file uart_component_rp2.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ available()

◆ check_logger_conflict()

◆ dump_config()

◆ flush()

◆ get_config()

◆ get_hw_serial()

◆ get_setup_priority()

◆ is_hw_serial()

◆ peek_byte()

◆ read_array()

◆ setup()

◆ write_array()

Field Documentation

◆ hw_serial_

◆ serial_