ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::ld2410s::LD2410SComponent Class Referencefinal

#include <ld2410s.h>

Inheritance diagram for esphome::ld2410s::LD2410SComponent:
esphome::Component esphome::uart::UARTDevice

Protected Types

enum class  FrameType : uint8_t { NONE , SHORT_DATA , STD_DATA , COMMAND }
 

Protected Member Functions

void receive_byte_ (uint8_t byte)
 
bool handle_frame_ ()
 Returns false when the footer does not match, so the bytes can be scanned again.
 
bool handle_data_frame_ (const uint8_t *payload, uint16_t len)
 Returns false for a data frame whose state byte is impossible, so it counts as dropped.
 
void handle_command_ack_ (const uint8_t *payload, uint16_t len)
 
bool handle_parameters_ (const uint8_t *values, uint16_t len)
 
bool handle_version_ (const uint8_t *values, uint16_t len)
 
void count_dropped_frame_ ()
 
void reset_frame_ ()
 
void start_sequence_ (const uint16_t *sequence, uint8_t length, uint32_t now)
 
void restart_init_ (uint32_t at)
 
void run_sequence_ (uint32_t now)
 
uint16_t current_command_ () const
 
void send_command_ (uint16_t command)
 
void publish_target_ (bool target, uint16_t distance)
 
void publish_parameters_ ()
 
- 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.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
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

number::Number * numbers_ [PARAMETER_COUNT] {}
 
const uint16_t * sequence_ {nullptr}
 
uint32_t next_send_at_ {0}
 
uint32_t last_frame_at_ {0}
 
uint8_t parameters_ [PARAMETER_COUNT] {}
 
uint8_t rx_buffer_ [RX_BUFFER_SIZE]
 
uint8_t rx_len_ {0}
 
uint8_t expected_len_ {0}
 
uint8_t sequence_len_ {0}
 
uint8_t step_ {0}
 
uint8_t step_timeouts_ {0}
 
uint8_t dropped_frames_ {0}
 
FrameType frame_type_ {FrameType::NONE}
 
bool awaiting_ack_ {false}
 
bool rescanning_ {false}
 
bool init_done_ {false}
 
bool parameters_known_ {false}
 
bool parameters_dirty_ {false}
 
- 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_
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent * parent_ {nullptr}
 

Additional Inherited Members

- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen.
 
virtual void loop ()
 This method will be called repeatedly.
 
virtual float get_setup_priority () const
 priority of setup().
 
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 last before a reboot or deep sleep 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)
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok)
 Marks the component failed with message (default "Communication failed") unless ok; returns ok.
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok, 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)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
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)
 
- 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_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 inherited from esphome::Component
uint32_t length = 5000)
 
- Data Fields inherited from esphome::uart::UARTDevice
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 inherited from esphome::uart::UARTDevice
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.
 

Detailed Description

Definition at line 45 of file ld2410s.h.

Member Enumeration Documentation

◆ FrameType

enum class esphome::ld2410s::LD2410SComponent::FrameType : uint8_t
strongprotected
Enumerator
NONE 
SHORT_DATA 
STD_DATA 
COMMAND 

Definition at line 81 of file ld2410s.h.

Member Function Documentation

◆ count_dropped_frame_()

void esphome::ld2410s::LD2410SComponent::count_dropped_frame_ ( )
inlineprotected

Definition at line 95 of file ld2410s.h.

◆ current_command_()

uint16_t esphome::ld2410s::LD2410SComponent::current_command_ ( ) const
protected

Definition at line 189 of file ld2410s.cpp.

◆ handle_command_ack_()

void esphome::ld2410s::LD2410SComponent::handle_command_ack_ ( const uint8_t * payload,
uint16_t len )
protected

Definition at line 399 of file ld2410s.cpp.

◆ handle_data_frame_()

bool esphome::ld2410s::LD2410SComponent::handle_data_frame_ ( const uint8_t * payload,
uint16_t len )
protected

Returns false for a data frame whose state byte is impossible, so it counts as dropped.

Definition at line 374 of file ld2410s.cpp.

◆ handle_frame_()

bool esphome::ld2410s::LD2410SComponent::handle_frame_ ( )
protected

Returns false when the footer does not match, so the bytes can be scanned again.

Definition at line 327 of file ld2410s.cpp.

◆ handle_parameters_()

bool esphome::ld2410s::LD2410SComponent::handle_parameters_ ( const uint8_t * values,
uint16_t len )
protected

Definition at line 458 of file ld2410s.cpp.

◆ handle_version_()

bool esphome::ld2410s::LD2410SComponent::handle_version_ ( const uint8_t * values,
uint16_t len )
protected

Definition at line 494 of file ld2410s.cpp.

◆ publish_parameters_()

void esphome::ld2410s::LD2410SComponent::publish_parameters_ ( )
protected

Definition at line 520 of file ld2410s.cpp.

◆ publish_target_()

void esphome::ld2410s::LD2410SComponent::publish_target_ ( bool target,
uint16_t distance )
protected

Definition at line 509 of file ld2410s.cpp.

◆ receive_byte_()

void esphome::ld2410s::LD2410SComponent::receive_byte_ ( uint8_t byte)
protected

Definition at line 257 of file ld2410s.cpp.

◆ reset_frame_()

void esphome::ld2410s::LD2410SComponent::reset_frame_ ( )
inlineprotected

Definition at line 100 of file ld2410s.h.

◆ restart_init_()

void esphome::ld2410s::LD2410SComponent::restart_init_ ( uint32_t at)
protected

Definition at line 166 of file ld2410s.cpp.

◆ run_sequence_()

void esphome::ld2410s::LD2410SComponent::run_sequence_ ( uint32_t now)
protected

Definition at line 191 of file ld2410s.cpp.

◆ send_command_()

void esphome::ld2410s::LD2410SComponent::send_command_ ( uint16_t command)
protected

Definition at line 212 of file ld2410s.cpp.

◆ start_sequence_()

void esphome::ld2410s::LD2410SComponent::start_sequence_ ( const uint16_t * sequence,
uint8_t length,
uint32_t now )
protected

Definition at line 180 of file ld2410s.cpp.

Field Documentation

◆ awaiting_ack_

bool esphome::ld2410s::LD2410SComponent::awaiting_ack_ {false}
protected

Definition at line 133 of file ld2410s.h.

◆ dropped_frames_

uint8_t esphome::ld2410s::LD2410SComponent::dropped_frames_ {0}
protected

Definition at line 131 of file ld2410s.h.

◆ expected_len_

uint8_t esphome::ld2410s::LD2410SComponent::expected_len_ {0}
protected

Definition at line 127 of file ld2410s.h.

◆ frame_type_

FrameType esphome::ld2410s::LD2410SComponent::frame_type_ {FrameType::NONE}
protected

Definition at line 132 of file ld2410s.h.

◆ init_done_

bool esphome::ld2410s::LD2410SComponent::init_done_ {false}
protected

Definition at line 135 of file ld2410s.h.

◆ last_frame_at_

uint32_t esphome::ld2410s::LD2410SComponent::last_frame_at_ {0}
protected

Definition at line 121 of file ld2410s.h.

◆ next_send_at_

uint32_t esphome::ld2410s::LD2410SComponent::next_send_at_ {0}
protected

Definition at line 120 of file ld2410s.h.

◆ numbers_

number::Number* esphome::ld2410s::LD2410SComponent::numbers_[PARAMETER_COUNT] {}
protected

Definition at line 116 of file ld2410s.h.

◆ parameters_

uint8_t esphome::ld2410s::LD2410SComponent::parameters_[PARAMETER_COUNT] {}
protected

Definition at line 123 of file ld2410s.h.

◆ parameters_dirty_

bool esphome::ld2410s::LD2410SComponent::parameters_dirty_ {false}
protected

Definition at line 138 of file ld2410s.h.

◆ parameters_known_

bool esphome::ld2410s::LD2410SComponent::parameters_known_ {false}
protected

Definition at line 137 of file ld2410s.h.

◆ rescanning_

bool esphome::ld2410s::LD2410SComponent::rescanning_ {false}
protected

Definition at line 134 of file ld2410s.h.

◆ rx_buffer_

uint8_t esphome::ld2410s::LD2410SComponent::rx_buffer_[RX_BUFFER_SIZE]
protected

Definition at line 125 of file ld2410s.h.

◆ rx_len_

uint8_t esphome::ld2410s::LD2410SComponent::rx_len_ {0}
protected

Definition at line 126 of file ld2410s.h.

◆ sequence_

const uint16_t* esphome::ld2410s::LD2410SComponent::sequence_ {nullptr}
protected

Definition at line 119 of file ld2410s.h.

◆ sequence_len_

uint8_t esphome::ld2410s::LD2410SComponent::sequence_len_ {0}
protected

Definition at line 128 of file ld2410s.h.

◆ step_

uint8_t esphome::ld2410s::LD2410SComponent::step_ {0}
protected

Definition at line 129 of file ld2410s.h.

◆ step_timeouts_

uint8_t esphome::ld2410s::LD2410SComponent::step_timeouts_ {0}
protected

Definition at line 130 of file ld2410s.h.


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