ESPHome  2024.11.2
Public Member Functions | Protected Attributes
esphome::ld2420::LD2420Sensor Class Reference

#include <ld2420_sensor.h>

Inheritance diagram for esphome::ld2420::LD2420Sensor:
esphome::ld2420::LD2420Listener esphome::Component esphome::sensor::Sensor

Public Member Functions

void dump_config () override
 
void set_distance_sensor (sensor::Sensor *sensor)
 
void on_distance (uint16_t distance) override
 
void on_energy (uint16_t *gate_energy, size_t size) override
 
- Public Member Functions inherited from esphome::ld2420::LD2420Listener
virtual void on_presence (bool presence)
 
virtual void on_fw_version (std::string &fw)
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual float get_setup_priority () const
 priority of setup(). More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
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="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Attributes

sensor::Sensordistance_sensor_ {nullptr}
 
std::vector< sensor::Sensor * > energy_sensors_ = std::vector<sensor::Sensor *>(LD2420_TOTAL_GATES)
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
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. More...
 
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. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Detailed Description

Definition at line 9 of file ld2420_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::ld2420::LD2420Sensor::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file ld2420_sensor.cpp.

◆ on_distance()

void esphome::ld2420::LD2420Sensor::on_distance ( uint16_t  distance)
inlineoverridevirtual

Reimplemented from esphome::ld2420::LD2420Listener.

Definition at line 13 of file ld2420_sensor.h.

◆ on_energy()

void esphome::ld2420::LD2420Sensor::on_energy ( uint16_t *  gate_energy,
size_t  size 
)
inlineoverridevirtual

Reimplemented from esphome::ld2420::LD2420Listener.

Definition at line 20 of file ld2420_sensor.h.

◆ set_distance_sensor()

void esphome::ld2420::LD2420Sensor::set_distance_sensor ( sensor::Sensor sensor)
inline

Definition at line 12 of file ld2420_sensor.h.

Field Documentation

◆ distance_sensor_

sensor::Sensor* esphome::ld2420::LD2420Sensor::distance_sensor_ {nullptr}
protected

Definition at line 29 of file ld2420_sensor.h.

◆ energy_sensors_

std::vector<sensor::Sensor *> esphome::ld2420::LD2420Sensor::energy_sensors_ = std::vector<sensor::Sensor *>(LD2420_TOTAL_GATES)
protected

Definition at line 30 of file ld2420_sensor.h.


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