ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
ld2420.h
Go to the documentation of this file.
1#pragma once
2
7#include <array>
8#include <span>
9#ifdef USE_TEXT_SENSOR
11#endif
12#ifdef USE_SELECT
14#endif
15#ifdef USE_NUMBER
17#endif
18#ifdef USE_BUTTON
20#endif
21
22namespace esphome::ld2420 {
23
24namespace testing {
25class LD2420OperatingModeTest;
26} // namespace testing
27
28static constexpr uint8_t CALIBRATE_SAMPLES = 64;
29// Energy frame is 45 bytes; +1 for null terminator, +4 so that a frame footer always lands
30// inside the buffer during footer-based resynchronization after losing sync.
31static constexpr uint8_t MAX_LINE_LENGTH = 50;
32static constexpr uint8_t TOTAL_GATES = 16;
33
39
41 public:
42 virtual void on_presence(bool presence) {};
43 virtual void on_distance(uint16_t distance) {};
44 virtual void on_fw_version(const char *fw) {};
45};
46
47class LD2420Component final : public Component, public uart::UARTDevice {
48 public:
49 struct CmdFrameT {
52 uint16_t length{0};
53 uint16_t command{0};
54 uint16_t data_length{0};
55 uint8_t data[18];
56 };
57
58 struct RegConfigT {
59 uint32_t move_thresh[TOTAL_GATES];
60 uint32_t still_thresh[TOTAL_GATES];
61 uint16_t min_gate{0};
62 uint16_t max_gate{0};
63 uint16_t timeout{0};
64 };
65
66 void setup() override;
67 void dump_config() override;
68 void loop() override;
69#ifdef USE_SELECT
70 SUB_SELECT(operating_mode)
71#endif
72#ifdef USE_NUMBER
73 SUB_NUMBER(gate_timeout)
74 SUB_NUMBER(gate_select)
75 SUB_NUMBER(min_gate_distance)
76 SUB_NUMBER(max_gate_distance)
79 void set_gate_still_threshold_numbers(int gate, number::Number *n) { this->gate_still_threshold_numbers_[gate] = n; };
81 bool is_gate_select() { return gate_select_number_ != nullptr; };
82 uint8_t get_gate_select_value() { return static_cast<uint8_t>(this->gate_select_number_->state); };
83 float get_min_gate_distance_value() { return min_gate_distance_number_->state; };
84 float get_max_gate_distance_value() { return max_gate_distance_number_->state; };
85 void publish_gate_move_threshold(uint8_t gate) {
86 // With gate_select we only use 1 number pointer, thus we hard code [0]
87 this->gate_move_threshold_numbers_[0]->publish_state(this->new_config.move_thresh[gate]);
88 };
89 void publish_gate_still_threshold(uint8_t gate) {
90 this->gate_still_threshold_numbers_[0]->publish_state(this->new_config.still_thresh[gate]);
91 };
92 // Stores a threshold number's value for its gate, or for the selected gate with gate_select
96#endif
97#ifdef USE_BUTTON
98 SUB_BUTTON(apply_config)
99 SUB_BUTTON(revert_config)
100 SUB_BUTTON(restart_module)
101 SUB_BUTTON(factory_reset)
102#endif
103#ifdef LD2420_LISTENER_COUNT
104 void register_listener(LD2420Listener *listener) { this->listeners_.push_back(listener); }
105#endif
106
107 void send_module_restart();
109 void apply_config_action();
112 int send_cmd_from_array(CmdFrameT cmd_frame);
113 void report_gate_data();
114 void handle_cmd_error(uint16_t error);
115 void set_operating_mode(const char *state);
119 void update_radar_data(uint16_t const *gate_energy, uint8_t sample_number);
120 uint8_t set_config_mode(bool enable);
121 void set_min_max_distances_timeout(uint32_t max_gate_distance, uint32_t min_gate_distance, uint32_t timeout);
122 void set_gate_threshold(uint8_t gate);
123 void set_reg_value(uint16_t reg, uint16_t value);
124 void set_system_mode(uint16_t mode);
125 void ld2420_restart();
126
133 uint16_t radar_data[TOTAL_GATES][CALIBRATE_SAMPLES];
134 uint16_t gate_avg[TOTAL_GATES];
135 uint16_t gate_peak[TOTAL_GATES];
142
143 protected:
144 struct CmdReplyT {
146 uint16_t error;
147 uint8_t command;
148 uint8_t status;
149 uint8_t length;
150 volatile bool ack;
151 };
152
154 int get_gate_threshold_(uint8_t gate);
155 void get_reg_value_(uint16_t reg);
157 uint16_t get_mode_() { return this->system_mode_; };
158 void set_mode_(uint16_t mode) { this->system_mode_ = mode; };
159 bool get_presence_() { return this->presence_; };
160 void set_presence_(bool presence) { this->presence_ = presence; };
161 uint16_t get_distance_() { return this->distance_; };
162 void set_distance_(uint16_t distance) { this->distance_ = distance; };
163 void handle_simple_mode_(const uint8_t *inbuf, int len);
164 void handle_energy_mode_(uint8_t *buffer, int len);
165 void handle_ack_data_(uint8_t *buffer, int len);
166 void readline_(int rx_data, uint8_t *buffer, int len);
167 void read_batch_(std::span<uint8_t, MAX_LINE_LENGTH> buffer);
168 void set_calibration_(bool state) { this->calibration_ = state; };
169 bool get_calibration_() { return this->calibration_; };
170
171#ifdef USE_NUMBER
172 std::array<number::Number *, TOTAL_GATES> gate_still_threshold_numbers_{};
173 std::array<number::Number *, TOTAL_GATES> gate_move_threshold_numbers_{};
174#endif
175
176 uint16_t distance_{0};
177 uint16_t system_mode_;
178 uint16_t gate_energy_[TOTAL_GATES];
179 uint8_t buffer_pos_{0}; // where to resume processing/populating buffer
180 uint8_t buffer_data_[MAX_LINE_LENGTH];
181 char firmware_ver_[8]{"v0.0.0"};
182 bool cmd_active_{false};
183 bool presence_{false};
184 bool calibration_{false};
186#ifdef LD2420_LISTENER_COUNT
188#endif
189
190 // clang-tidy compiles the host tests without USE_HOST, so the friend is unconditional
191 friend class testing::LD2420OperatingModeTest;
192};
193
194} // namespace esphome::ld2420
BedjetMode mode
BedJet operating mode.
Minimal static vector - saves memory by avoiding std::vector overhead.
Definition helpers.h:304
void readline_(int rx_data, uint8_t *buffer, int len)
Definition ld2420.cpp:408
void set_system_mode(uint16_t mode)
Definition ld2420.cpp:777
void handle_ack_data_(uint8_t *buffer, int len)
Definition ld2420.cpp:538
uint8_t set_config_mode(bool enable)
Definition ld2420.cpp:666
void update_radar_data(uint16_t const *gate_energy, uint8_t sample_number)
Definition ld2420.cpp:308
void set_distance_(uint16_t distance)
Definition ld2420.h:162
SUB_SELECT(operating_mode) SUB_NUMBER(gate_timeout) SUB_NUMBER(gate_select) SUB_NUMBER(min_gate_distance) SUB_NUMBER(max_gate_distance) SUB_NUMBER(gate_move_sensitivity_factor) SUB_NUMBER(gate_still_sensitivity_factor) void set_gate_still_threshold_numbers(int gate
void set_min_max_distances_timeout(uint32_t max_gate_distance, uint32_t min_gate_distance, uint32_t timeout)
Definition ld2420.cpp:807
void set_gate_threshold(uint8_t gate)
Definition ld2420.cpp:840
void change_operating_mode(OpMode mode)
Definition ld2420.cpp:363
void handle_energy_mode_(uint8_t *buffer, int len)
Definition ld2420.cpp:438
void set_gate_move_threshold_numbers(int gate, number::Number *n)
Definition ld2420.h:80
void publish_gate_still_threshold(uint8_t gate)
Definition ld2420.h:89
void set_calibration_(bool state)
Definition ld2420.h:168
void set_gate_threshold_value(number::Number *n, float value)
Definition ld2420.cpp:882
uint16_t gate_peak[TOTAL_GATES]
Definition ld2420.h:135
std::array< number::Number *, TOTAL_GATES > gate_move_threshold_numbers_
Definition ld2420.h:173
void set_mode_(uint16_t mode)
Definition ld2420.h:158
uint16_t gate_avg[TOTAL_GATES]
Definition ld2420.h:134
void read_batch_(std::span< uint8_t, MAX_LINE_LENGTH > buffer)
Definition ld2420.cpp:533
uint8_t buffer_data_[MAX_LINE_LENGTH]
Definition ld2420.h:180
int get_gate_threshold_(uint8_t gate)
Definition ld2420.cpp:729
int send_cmd_from_array(CmdFrameT cmd_frame)
Definition ld2420.cpp:605
void get_reg_value_(uint16_t reg)
Definition ld2420.cpp:694
uint16_t gate_energy_[TOTAL_GATES]
Definition ld2420.h:178
void publish_gate_move_threshold(uint8_t gate)
Definition ld2420.h:85
void handle_simple_mode_(const uint8_t *inbuf, int len)
Definition ld2420.cpp:486
SUB_BUTTON(apply_config) SUB_BUTTON(revert_config) SUB_BUTTON(restart_module) SUB_BUTTON(factory_reset) void register_listener(LD2420Listener *listener)
Definition ld2420.h:98
StaticVector< LD2420Listener *, LD2420_LISTENER_COUNT > listeners_
Definition ld2420.h:187
void set_operating_mode(const char *state)
Definition ld2420.cpp:356
uint16_t radar_data[TOTAL_GATES][CALIBRATE_SAMPLES]
Definition ld2420.h:133
void handle_cmd_error(uint16_t error)
Definition ld2420.cpp:720
void set_presence_(bool presence)
Definition ld2420.h:160
void set_reg_value(uint16_t reg, uint16_t value)
Definition ld2420.cpp:706
std::array< number::Number *, TOTAL_GATES > gate_still_threshold_numbers_
Definition ld2420.h:172
virtual void on_distance(uint16_t distance)
Definition ld2420.h:43
virtual void on_presence(bool presence)
Definition ld2420.h:42
virtual void on_fw_version(const char *fw)
Definition ld2420.h:44
Base-class for all numbers.
Definition number.h:29
bool state
Definition fan.h:2
uint32_t buffer
Definition gif.cpp:50
@ OP_CALIBRATE_MODE
Definition ld2420.h:36
uint32_t value
Definition hal.cpp:41
const void size_t len
Definition hal.h:68
static void uint32_t