ESPHome 2026.1.0b1
Loading...
Searching...
No Matches
esphome::rd03d::RD03DComponent Class Reference

#include <rd03d.h>

Inheritance diagram for esphome::rd03d::RD03DComponent:
esphome::Component esphome::uart::UARTDevice

Public Member Functions

void setup () override
 
void loop () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_target_count_sensor (sensor::Sensor *sensor)
 
void set_x_sensor (uint8_t target, sensor::Sensor *sensor)
 
void set_y_sensor (uint8_t target, sensor::Sensor *sensor)
 
void set_speed_sensor (uint8_t target, sensor::Sensor *sensor)
 
void set_distance_sensor (uint8_t target, sensor::Sensor *sensor)
 
void set_resolution_sensor (uint8_t target, sensor::Sensor *sensor)
 
void set_angle_sensor (uint8_t target, sensor::Sensor *sensor)
 
void set_target_binary_sensor (binary_sensor::BinarySensor *sensor)
 
void set_target_binary_sensor (uint8_t target, binary_sensor::BinarySensor *sensor)
 
void set_tracking_mode (TrackingMode mode)
 
void set_throttle (uint32_t throttle)
 
- 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.
 
 ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)
 
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 (const char *message=nullptr)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
 ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)
 
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
 
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 apply_config_ ()
 
void send_command_ (uint16_t command, const uint8_t *data=nullptr, uint8_t data_len=0)
 
void process_frame_ ()
 
void publish_target_ (uint8_t target_num, int16_t x, int16_t y, int16_t speed, uint16_t resolution)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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 (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (uint32_t id)
 
void set_retry (uint32_t id, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set a retry function with a numeric ID (zero heap allocation).
 
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 (uint32_t id)
 
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 (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (uint32_t id)
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 

Protected Attributes

std::array< TargetSensor, MAX_TARGETS > targets_ {}
 
sensor::Sensortarget_count_sensor_ {nullptr}
 
std::array< binary_sensor::BinarySensor *, MAX_TARGETS > target_presence_ {}
 
binary_sensor::BinarySensortarget_binary_sensor_ {nullptr}
 
optional< TrackingModetracking_mode_ {}
 
uint32_t throttle_ {0}
 
uint32_t last_publish_time_ {0}
 
std::array< uint8_t, FRAME_SIZE > buffer_ {}
 
uint8_t buffer_pos_ {0}
 
- Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo cancel_interval )(const char *name)
 Cancel an interval function.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_retry(const std voi set_retry )(const char *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.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_retry(const std boo cancel_retry )(const char *name)
 Cancel a retry function.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo cancel_timeout )(const char *name)
 Cancel a timeout function.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi defer )(const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo cancel_defer )(const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
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
UARTComponentparent_ {nullptr}
 

Detailed Description

Definition at line 40 of file rd03d.h.

Member Function Documentation

◆ apply_config_()

void esphome::rd03d::RD03DComponent::apply_config_ ( )
protected

Definition at line 256 of file rd03d.cpp.

◆ dump_config()

void esphome::rd03d::RD03DComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 51 of file rd03d.cpp.

◆ get_setup_priority()

float esphome::rd03d::RD03DComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 45 of file rd03d.h.

◆ loop()

void esphome::rd03d::RD03DComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 82 of file rd03d.cpp.

◆ process_frame_()

void esphome::rd03d::RD03DComponent::process_frame_ ( )
protected

Definition at line 118 of file rd03d.cpp.

◆ publish_target_()

void esphome::rd03d::RD03DComponent::publish_target_ ( uint8_t target_num,
int16_t x,
int16_t y,
int16_t speed,
uint16_t resolution )
protected

Definition at line 186 of file rd03d.cpp.

◆ send_command_()

void esphome::rd03d::RD03DComponent::send_command_ ( uint16_t command,
const uint8_t * data = nullptr,
uint8_t data_len = 0 )
protected

Definition at line 232 of file rd03d.cpp.

◆ set_angle_sensor()

void esphome::rd03d::RD03DComponent::set_angle_sensor ( uint8_t target,
sensor::Sensor * sensor )
inline

Definition at line 54 of file rd03d.h.

◆ set_distance_sensor()

void esphome::rd03d::RD03DComponent::set_distance_sensor ( uint8_t target,
sensor::Sensor * sensor )
inline

Definition at line 52 of file rd03d.h.

◆ set_resolution_sensor()

void esphome::rd03d::RD03DComponent::set_resolution_sensor ( uint8_t target,
sensor::Sensor * sensor )
inline

Definition at line 53 of file rd03d.h.

◆ set_speed_sensor()

void esphome::rd03d::RD03DComponent::set_speed_sensor ( uint8_t target,
sensor::Sensor * sensor )
inline

Definition at line 51 of file rd03d.h.

◆ set_target_binary_sensor() [1/2]

void esphome::rd03d::RD03DComponent::set_target_binary_sensor ( binary_sensor::BinarySensor * sensor)
inline

Definition at line 57 of file rd03d.h.

◆ set_target_binary_sensor() [2/2]

void esphome::rd03d::RD03DComponent::set_target_binary_sensor ( uint8_t target,
binary_sensor::BinarySensor * sensor )
inline

Definition at line 58 of file rd03d.h.

◆ set_target_count_sensor()

void esphome::rd03d::RD03DComponent::set_target_count_sensor ( sensor::Sensor * sensor)
inline

Definition at line 48 of file rd03d.h.

◆ set_throttle()

void esphome::rd03d::RD03DComponent::set_throttle ( uint32_t throttle)
inline

Definition at line 65 of file rd03d.h.

◆ set_tracking_mode()

void esphome::rd03d::RD03DComponent::set_tracking_mode ( TrackingMode mode)
inline

Definition at line 64 of file rd03d.h.

◆ set_x_sensor()

void esphome::rd03d::RD03DComponent::set_x_sensor ( uint8_t target,
sensor::Sensor * sensor )
inline

Definition at line 49 of file rd03d.h.

◆ set_y_sensor()

void esphome::rd03d::RD03DComponent::set_y_sensor ( uint8_t target,
sensor::Sensor * sensor )
inline

Definition at line 50 of file rd03d.h.

◆ setup()

void esphome::rd03d::RD03DComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 46 of file rd03d.cpp.

Field Documentation

◆ buffer_

std::array<uint8_t, FRAME_SIZE> esphome::rd03d::RD03DComponent::buffer_ {}
protected

Definition at line 89 of file rd03d.h.

◆ buffer_pos_

uint8_t esphome::rd03d::RD03DComponent::buffer_pos_ {0}
protected

Definition at line 90 of file rd03d.h.

◆ last_publish_time_

uint32_t esphome::rd03d::RD03DComponent::last_publish_time_ {0}
protected

Definition at line 87 of file rd03d.h.

◆ target_binary_sensor_

binary_sensor::BinarySensor* esphome::rd03d::RD03DComponent::target_binary_sensor_ {nullptr}
protected

Definition at line 81 of file rd03d.h.

◆ target_count_sensor_

sensor::Sensor* esphome::rd03d::RD03DComponent::target_count_sensor_ {nullptr}
protected

Definition at line 77 of file rd03d.h.

◆ target_presence_

std::array<binary_sensor::BinarySensor *, MAX_TARGETS> esphome::rd03d::RD03DComponent::target_presence_ {}
protected

Definition at line 80 of file rd03d.h.

◆ targets_

std::array<TargetSensor, MAX_TARGETS> esphome::rd03d::RD03DComponent::targets_ {}
protected

Definition at line 76 of file rd03d.h.

◆ throttle_

uint32_t esphome::rd03d::RD03DComponent::throttle_ {0}
protected

Definition at line 86 of file rd03d.h.

◆ tracking_mode_

optional<TrackingMode> esphome::rd03d::RD03DComponent::tracking_mode_ {}
protected

Definition at line 85 of file rd03d.h.


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