ESPHome 2025.9.0-dev
Loading...
Searching...
No Matches
esphome::ld2412::LD2412Component Class Reference

#include <ld2412.h>

Inheritance diagram for esphome::ld2412::LD2412Component:
esphome::Component esphome::uart::UARTDevice

Protected Member Functions

void send_command_ (uint8_t command_str, const uint8_t *command_value, uint8_t command_value_len)
 
void set_config_mode_ (bool enable)
 
void handle_periodic_data_ ()
 
bool handle_ack_data_ ()
 
void readline_ (int readch)
 
void query_parameters_ ()
 
void get_version_ ()
 
void get_mac_ ()
 
void get_distance_resolution_ ()
 
void query_light_control_ ()
 
void restart_ ()
 
void query_dynamic_background_correction_ ()
 
- 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 (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

uint8_t light_function_ = 0
 
uint8_t light_threshold_ = 0
 
uint8_t out_pin_level_ = 0
 
uint8_t buffer_pos_ = 0
 
uint8_t buffer_data_ [MAX_LINE_LENGTH]
 
uint8_t mac_address_ [6] = {0, 0, 0, 0, 0, 0}
 
uint8_t version_ [6] = {0, 0, 0, 0, 0, 0}
 
bool bluetooth_on_ {false}
 
bool dynamic_background_correction_active_ {false}
 
std::array< number::Number *, TOTAL_GATES > gate_move_threshold_numbers_ {}
 
std::array< number::Number *, TOTAL_GATES > gate_still_threshold_numbers_ {}
 
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_move_sensors_ {}
 
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_still_sensors_ {}
 
- Protected Attributes inherited from esphome::Component
const char * 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}
 

Additional Inherited Members

- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen.
 
virtual float get_setup_priority () const
 priority of setup().
 
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.
 
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_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 char *source)
 Set where this component was loaded from for some debug messages.
 
const char * get_component_source () const
 Get the integration where this component was declared as a string.
 
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 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.
 

Detailed Description

Definition at line 40 of file ld2412.h.

Member Function Documentation

◆ get_distance_resolution_()

void esphome::ld2412::LD2412Component::get_distance_resolution_ ( )
protected

Definition at line 759 of file ld2412.cpp.

◆ get_mac_()

void esphome::ld2412::LD2412Component::get_mac_ ( )
protected

Definition at line 754 of file ld2412.cpp.

◆ get_version_()

void esphome::ld2412::LD2412Component::get_version_ ( )
protected

Definition at line 752 of file ld2412.cpp.

◆ handle_ack_data_()

bool esphome::ld2412::LD2412Component::handle_ack_data_ ( )
protected

Definition at line 456 of file ld2412.cpp.

◆ handle_periodic_data_()

void esphome::ld2412::LD2412Component::handle_periodic_data_ ( )
protected

Definition at line 344 of file ld2412.cpp.

◆ query_dynamic_background_correction_()

void esphome::ld2412::LD2412Component::query_dynamic_background_correction_ ( )
protected

Definition at line 716 of file ld2412.cpp.

◆ query_light_control_()

void esphome::ld2412::LD2412Component::query_light_control_ ( )
protected

Definition at line 761 of file ld2412.cpp.

◆ query_parameters_()

void esphome::ld2412::LD2412Component::query_parameters_ ( )
protected

Definition at line 750 of file ld2412.cpp.

◆ readline_()

void esphome::ld2412::LD2412Component::readline_ ( int readch)
protected

Definition at line 655 of file ld2412.cpp.

◆ restart_()

void esphome::ld2412::LD2412Component::restart_ ( )
protected

Definition at line 748 of file ld2412.cpp.

◆ send_command_()

void esphome::ld2412::LD2412Component::send_command_ ( uint8_t command_str,
const uint8_t * command_value,
uint8_t command_value_len )
protected

Definition at line 318 of file ld2412.cpp.

◆ set_config_mode_()

void esphome::ld2412::LD2412Component::set_config_mode_ ( bool enable)
protected

Definition at line 689 of file ld2412.cpp.

Field Documentation

◆ bluetooth_on_

bool esphome::ld2412::LD2412Component::bluetooth_on_ {false}
protected

Definition at line 128 of file ld2412.h.

◆ buffer_data_

uint8_t esphome::ld2412::LD2412Component::buffer_data_[MAX_LINE_LENGTH]
protected

Definition at line 125 of file ld2412.h.

◆ buffer_pos_

uint8_t esphome::ld2412::LD2412Component::buffer_pos_ = 0
protected

Definition at line 124 of file ld2412.h.

◆ dynamic_background_correction_active_

bool esphome::ld2412::LD2412Component::dynamic_background_correction_active_ {false}
protected

Definition at line 129 of file ld2412.h.

◆ gate_move_sensors_

std::array<SensorWithDedup<uint8_t> *, TOTAL_GATES> esphome::ld2412::LD2412Component::gate_move_sensors_ {}
protected

Definition at line 135 of file ld2412.h.

◆ gate_move_threshold_numbers_

std::array<number::Number *, TOTAL_GATES> esphome::ld2412::LD2412Component::gate_move_threshold_numbers_ {}
protected

Definition at line 131 of file ld2412.h.

◆ gate_still_sensors_

std::array<SensorWithDedup<uint8_t> *, TOTAL_GATES> esphome::ld2412::LD2412Component::gate_still_sensors_ {}
protected

Definition at line 136 of file ld2412.h.

◆ gate_still_threshold_numbers_

std::array<number::Number *, TOTAL_GATES> esphome::ld2412::LD2412Component::gate_still_threshold_numbers_ {}
protected

Definition at line 132 of file ld2412.h.

◆ light_function_

uint8_t esphome::ld2412::LD2412Component::light_function_ = 0
protected

Definition at line 121 of file ld2412.h.

◆ light_threshold_

uint8_t esphome::ld2412::LD2412Component::light_threshold_ = 0
protected

Definition at line 122 of file ld2412.h.

◆ mac_address_

uint8_t esphome::ld2412::LD2412Component::mac_address_[6] = {0, 0, 0, 0, 0, 0}
protected

Definition at line 126 of file ld2412.h.

◆ out_pin_level_

uint8_t esphome::ld2412::LD2412Component::out_pin_level_ = 0
protected

Definition at line 123 of file ld2412.h.

◆ version_

uint8_t esphome::ld2412::LD2412Component::version_[6] = {0, 0, 0, 0, 0, 0}
protected

Definition at line 127 of file ld2412.h.


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