ESPHome 2026.3.0-dev
Loading...
Searching...
No Matches
ld2410.cpp
Go to the documentation of this file.
1#include "ld2410.h"
2
3#ifdef USE_NUMBER
5#endif
6#ifdef USE_SENSOR
8#endif
9
11
12namespace esphome::ld2410 {
13
14static const char *const TAG = "ld2410";
15
26
31
37
38enum OutPinLevel : uint8_t {
41};
42
59
60enum PeriodicDataValue : uint8_t {
61 HEADER = 0xAA,
62 FOOTER = 0x55,
63 CHECK = 0x00,
64};
65
66enum AckData : uint8_t {
69};
70
71// Memory-efficient lookup tables
72struct StringToUint8 {
73 const char *str;
74 const uint8_t value;
75};
76
77struct Uint8ToString {
78 const uint8_t value;
79 const char *str;
80};
81
82constexpr StringToUint8 BAUD_RATES_BY_STR[] = {
83 {"9600", BAUD_RATE_9600}, {"19200", BAUD_RATE_19200}, {"38400", BAUD_RATE_38400},
84 {"57600", BAUD_RATE_57600}, {"115200", BAUD_RATE_115200}, {"230400", BAUD_RATE_230400},
85 {"256000", BAUD_RATE_256000}, {"460800", BAUD_RATE_460800},
86};
87
88constexpr StringToUint8 DISTANCE_RESOLUTIONS_BY_STR[] = {
90 {"0.75m", DISTANCE_RESOLUTION_0_75},
91};
92
93constexpr Uint8ToString DISTANCE_RESOLUTIONS_BY_UINT[] = {
95 {DISTANCE_RESOLUTION_0_75, "0.75m"},
96};
97
98constexpr StringToUint8 LIGHT_FUNCTIONS_BY_STR[] = {
99 {"off", LIGHT_FUNCTION_OFF},
100 {"below", LIGHT_FUNCTION_BELOW},
101 {"above", LIGHT_FUNCTION_ABOVE},
102};
103
104constexpr Uint8ToString LIGHT_FUNCTIONS_BY_UINT[] = {
105 {LIGHT_FUNCTION_OFF, "off"},
106 {LIGHT_FUNCTION_BELOW, "below"},
107 {LIGHT_FUNCTION_ABOVE, "above"},
108};
109
110constexpr StringToUint8 OUT_PIN_LEVELS_BY_STR[] = {
111 {"low", OUT_PIN_LEVEL_LOW},
112 {"high", OUT_PIN_LEVEL_HIGH},
113};
114
115constexpr Uint8ToString OUT_PIN_LEVELS_BY_UINT[] = {
116 {OUT_PIN_LEVEL_LOW, "low"},
117 {OUT_PIN_LEVEL_HIGH, "high"},
118};
119
120constexpr uint32_t BAUD_RATES[] = {9600, 19200, 38400, 57600, 115200, 230400, 256000, 460800};
121
122// Helper functions for lookups
123template<size_t N> uint8_t find_uint8(const StringToUint8 (&arr)[N], const char *str) {
124 for (const auto &entry : arr) {
125 if (strcmp(str, entry.str) == 0)
126 return entry.value;
127 }
128 return 0xFF; // Not found
129}
130
131template<size_t N> const char *find_str(const Uint8ToString (&arr)[N], uint8_t value) {
132 for (const auto &entry : arr) {
133 if (value == entry.value)
134 return entry.str;
135 }
136 return ""; // Not found
137}
138
139// Commands
140static constexpr uint8_t CMD_ENABLE_CONF = 0xFF;
141static constexpr uint8_t CMD_DISABLE_CONF = 0xFE;
142static constexpr uint8_t CMD_ENABLE_ENG = 0x62;
143static constexpr uint8_t CMD_DISABLE_ENG = 0x63;
144static constexpr uint8_t CMD_MAXDIST_DURATION = 0x60;
145static constexpr uint8_t CMD_QUERY = 0x61;
146static constexpr uint8_t CMD_GATE_SENS = 0x64;
147static constexpr uint8_t CMD_QUERY_VERSION = 0xA0;
148static constexpr uint8_t CMD_QUERY_DISTANCE_RESOLUTION = 0xAB;
149static constexpr uint8_t CMD_SET_DISTANCE_RESOLUTION = 0xAA;
150static constexpr uint8_t CMD_QUERY_LIGHT_CONTROL = 0xAE;
151static constexpr uint8_t CMD_SET_LIGHT_CONTROL = 0xAD;
152static constexpr uint8_t CMD_SET_BAUD_RATE = 0xA1;
153static constexpr uint8_t CMD_BT_PASSWORD = 0xA9;
154static constexpr uint8_t CMD_QUERY_MAC_ADDRESS = 0xA5;
155static constexpr uint8_t CMD_RESET = 0xA2;
156static constexpr uint8_t CMD_RESTART = 0xA3;
157static constexpr uint8_t CMD_BLUETOOTH = 0xA4;
158// Commands values
159static constexpr uint8_t CMD_MAX_MOVE_VALUE = 0x00;
160static constexpr uint8_t CMD_MAX_STILL_VALUE = 0x01;
161static constexpr uint8_t CMD_DURATION_VALUE = 0x02;
162// Bitmasks for target states
163static constexpr uint8_t MOVE_BITMASK = 0x01;
164static constexpr uint8_t STILL_BITMASK = 0x02;
165// Header & Footer size
166static constexpr uint8_t HEADER_FOOTER_SIZE = 4;
167// Command Header & Footer
168static constexpr uint8_t CMD_FRAME_HEADER[HEADER_FOOTER_SIZE] = {0xFD, 0xFC, 0xFB, 0xFA};
169static constexpr uint8_t CMD_FRAME_FOOTER[HEADER_FOOTER_SIZE] = {0x04, 0x03, 0x02, 0x01};
170// Data Header & Footer
171static constexpr uint8_t DATA_FRAME_HEADER[HEADER_FOOTER_SIZE] = {0xF4, 0xF3, 0xF2, 0xF1};
172static constexpr uint8_t DATA_FRAME_FOOTER[HEADER_FOOTER_SIZE] = {0xF8, 0xF7, 0xF6, 0xF5};
173// MAC address the module uses when Bluetooth is disabled
174static constexpr uint8_t NO_MAC[] = {0x08, 0x05, 0x04, 0x03, 0x02, 0x01};
175
176static inline bool validate_header_footer(const uint8_t *header_footer, const uint8_t *buffer) {
177 return std::memcmp(header_footer, buffer, HEADER_FOOTER_SIZE) == 0;
178}
179
180void LD2410Component::dump_config() {
181 char mac_s[18];
182 char version_s[20];
183 const char *mac_str = ld24xx::format_mac_str(this->mac_address_, mac_s);
184 ld24xx::format_version_str(this->version_, version_s);
185 ESP_LOGCONFIG(TAG,
186 "LD2410:\n"
187 " Firmware version: %s\n"
188 " MAC address: %s",
189 version_s, mac_str);
190#ifdef USE_BINARY_SENSOR
191 ESP_LOGCONFIG(TAG, "Binary Sensors:");
192 LOG_BINARY_SENSOR(" ", "Target", this->target_binary_sensor_);
193 LOG_BINARY_SENSOR(" ", "MovingTarget", this->moving_target_binary_sensor_);
194 LOG_BINARY_SENSOR(" ", "StillTarget", this->still_target_binary_sensor_);
195 LOG_BINARY_SENSOR(" ", "OutPinPresenceStatus", this->out_pin_presence_status_binary_sensor_);
196#endif
197#ifdef USE_SENSOR
198 ESP_LOGCONFIG(TAG, "Sensors:");
199 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "Light", this->light_sensor_);
200 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "DetectionDistance", this->detection_distance_sensor_);
201 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "MovingTargetDistance", this->moving_target_distance_sensor_);
202 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "MovingTargetEnergy", this->moving_target_energy_sensor_);
203 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "StillTargetDistance", this->still_target_distance_sensor_);
204 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "StillTargetEnergy", this->still_target_energy_sensor_);
205 for (auto &s : this->gate_move_sensors_) {
206 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "GateMove", s);
207 }
208 for (auto &s : this->gate_still_sensors_) {
209 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "GateStill", s);
210 }
211#endif
212#ifdef USE_TEXT_SENSOR
213 ESP_LOGCONFIG(TAG, "Text Sensors:");
214 LOG_TEXT_SENSOR(" ", "Mac", this->mac_text_sensor_);
215 LOG_TEXT_SENSOR(" ", "Version", this->version_text_sensor_);
216#endif
217#ifdef USE_NUMBER
218 ESP_LOGCONFIG(TAG, "Numbers:");
219 LOG_NUMBER(" ", "LightThreshold", this->light_threshold_number_);
220 LOG_NUMBER(" ", "MaxMoveDistanceGate", this->max_move_distance_gate_number_);
221 LOG_NUMBER(" ", "MaxStillDistanceGate", this->max_still_distance_gate_number_);
222 LOG_NUMBER(" ", "Timeout", this->timeout_number_);
223 for (number::Number *n : this->gate_move_threshold_numbers_) {
224 LOG_NUMBER(" ", "MoveThreshold", n);
225 }
226 for (number::Number *n : this->gate_still_threshold_numbers_) {
227 LOG_NUMBER(" ", "StillThreshold", n);
228 }
229#endif
230#ifdef USE_SELECT
231 ESP_LOGCONFIG(TAG, "Selects:");
232 LOG_SELECT(" ", "BaudRate", this->baud_rate_select_);
233 LOG_SELECT(" ", "DistanceResolution", this->distance_resolution_select_);
234 LOG_SELECT(" ", "LightFunction", this->light_function_select_);
235 LOG_SELECT(" ", "OutPinLevel", this->out_pin_level_select_);
236#endif
237#ifdef USE_SWITCH
238 ESP_LOGCONFIG(TAG, "Switches:");
239 LOG_SWITCH(" ", "Bluetooth", this->bluetooth_switch_);
240 LOG_SWITCH(" ", "EngineeringMode", this->engineering_mode_switch_);
241#endif
242#ifdef USE_BUTTON
243 ESP_LOGCONFIG(TAG, "Buttons:");
244 LOG_BUTTON(" ", "FactoryReset", this->factory_reset_button_);
245 LOG_BUTTON(" ", "Query", this->query_button_);
246 LOG_BUTTON(" ", "Restart", this->restart_button_);
247#endif
248}
249
250void LD2410Component::setup() { this->read_all_info(); }
251
252void LD2410Component::read_all_info() {
253 this->set_config_mode_(true);
254 this->get_version_();
255 this->get_mac_();
257 this->query_light_control_();
258 this->query_parameters_();
259 this->set_config_mode_(false);
260#ifdef USE_SELECT
261 if (this->baud_rate_select_ != nullptr) {
262 if (auto index = ld24xx::find_index(BAUD_RATES, this->parent_->get_baud_rate())) {
263 this->baud_rate_select_->publish_state(*index);
264 }
265 }
266#endif
267}
268
269void LD2410Component::restart_and_read_all_info() {
270 this->set_config_mode_(true);
271 this->restart_();
272 this->set_timeout(1000, [this]() { this->read_all_info(); });
273}
274
275void LD2410Component::loop() {
276 // Read all available bytes in batches to reduce UART call overhead.
277 size_t avail = this->available();
278 uint8_t buf[MAX_LINE_LENGTH];
279 while (avail > 0) {
280 size_t to_read = std::min(avail, sizeof(buf));
281 if (!this->read_array(buf, to_read)) {
282 break;
283 }
284 avail -= to_read;
285
286 for (size_t i = 0; i < to_read; i++) {
287 this->readline_(buf[i]);
288 }
289 }
290}
291
292void LD2410Component::send_command_(uint8_t command, const uint8_t *command_value, uint8_t command_value_len) {
293 ESP_LOGV(TAG, "Sending COMMAND %02X", command);
294 // frame header bytes
295 this->write_array(CMD_FRAME_HEADER, sizeof(CMD_FRAME_HEADER));
296 // length bytes
297 uint8_t len = 2;
298 if (command_value != nullptr) {
299 len += command_value_len;
300 }
301 // 2 length bytes (low, high) + 2 command bytes (low, high)
302 uint8_t len_cmd[] = {len, 0x00, command, 0x00};
303 this->write_array(len_cmd, sizeof(len_cmd));
304 // command value bytes
305 if (command_value != nullptr) {
306 this->write_array(command_value, command_value_len);
307 }
308 // frame footer bytes
309 this->write_array(CMD_FRAME_FOOTER, sizeof(CMD_FRAME_FOOTER));
310
311 if (command != CMD_ENABLE_CONF && command != CMD_DISABLE_CONF) {
312 delay(50); // NOLINT
313 }
314}
315
317 // 4 frame header bytes + 2 length bytes + 1 data end byte + 1 crc byte + 4 frame footer bytes
318 // data header=0xAA, data footer=0x55, crc=0x00
319 if (this->buffer_pos_ < 12 || !ld2410::validate_header_footer(DATA_FRAME_HEADER, this->buffer_data_) ||
320 this->buffer_data_[7] != HEADER || this->buffer_data_[this->buffer_pos_ - 6] != FOOTER ||
321 this->buffer_data_[this->buffer_pos_ - 5] != CHECK) {
322 return;
323 }
324 /*
325 Data Type: 7th
326 0x01: Engineering mode
327 0x02: Normal mode
328 */
329 bool engineering_mode = this->buffer_data_[DATA_TYPES] == 0x01;
330#ifdef USE_SWITCH
331 if (this->engineering_mode_switch_ != nullptr) {
332 this->engineering_mode_switch_->publish_state(engineering_mode);
333 }
334#endif
335#ifdef USE_BINARY_SENSOR
336 /*
337 Target states: 9th
338 0x00 = No target
339 0x01 = Moving targets
340 0x02 = Still targets
341 0x03 = Moving+Still targets
342 */
343 char target_state = this->buffer_data_[TARGET_STATES];
344 if (this->target_binary_sensor_ != nullptr) {
345 this->target_binary_sensor_->publish_state(target_state != 0x00);
346 }
347 if (this->moving_target_binary_sensor_ != nullptr) {
348 this->moving_target_binary_sensor_->publish_state(target_state & MOVE_BITMASK);
349 }
350 if (this->still_target_binary_sensor_ != nullptr) {
351 this->still_target_binary_sensor_->publish_state(target_state & STILL_BITMASK);
352 }
353#endif
354 /*
355 Moving target distance: 10~11th bytes
356 Moving target energy: 12th byte
357 Still target distance: 13~14th bytes
358 Still target energy: 15th byte
359 Detect distance: 16~17th bytes
360 */
361#ifdef USE_SENSOR
362 SAFE_PUBLISH_SENSOR(this->moving_target_distance_sensor_,
364 SAFE_PUBLISH_SENSOR(this->moving_target_energy_sensor_, this->buffer_data_[MOVING_ENERGY])
365 SAFE_PUBLISH_SENSOR(this->still_target_distance_sensor_,
367 SAFE_PUBLISH_SENSOR(this->still_target_energy_sensor_, this->buffer_data_[STILL_ENERGY]);
368 SAFE_PUBLISH_SENSOR(this->detection_distance_sensor_,
370
371 if (engineering_mode) {
372 /*
373 Moving distance range: 18th byte
374 Still distance range: 19th byte
375 Moving energy: 20~28th bytes
376 */
377 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
378 SAFE_PUBLISH_SENSOR(this->gate_move_sensors_[i], this->buffer_data_[MOVING_SENSOR_START + i])
379 }
380 /*
381 Still energy: 29~37th bytes
382 */
383 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
384 SAFE_PUBLISH_SENSOR(this->gate_still_sensors_[i], this->buffer_data_[STILL_SENSOR_START + i])
385 }
386 /*
387 Light sensor: 38th bytes
388 */
389 SAFE_PUBLISH_SENSOR(this->light_sensor_, this->buffer_data_[LIGHT_SENSOR])
390 } else {
391 for (auto &gate_move_sensor : this->gate_move_sensors_) {
392 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_move_sensor)
393 }
394 for (auto &gate_still_sensor : this->gate_still_sensors_) {
395 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_still_sensor)
396 }
397 SAFE_PUBLISH_SENSOR_UNKNOWN(this->light_sensor_)
398 }
399#endif
400#ifdef USE_BINARY_SENSOR
401 if (this->out_pin_presence_status_binary_sensor_ != nullptr) {
402 this->out_pin_presence_status_binary_sensor_->publish_state(
403 engineering_mode ? this->buffer_data_[OUT_PIN_SENSOR] == 0x01 : false);
404 }
405#endif
406}
407
408#ifdef USE_NUMBER
409std::function<void(void)> set_number_value(number::Number *n, float value) {
410 if (n != nullptr && (!n->has_state() || n->state != value)) {
411 n->state = value;
412 return [n, value]() { n->publish_state(value); };
413 }
414 return []() {};
415}
416#endif
417
419 ESP_LOGV(TAG, "Handling ACK DATA for COMMAND %02X", this->buffer_data_[COMMAND]);
420 if (this->buffer_pos_ < 10) {
421 ESP_LOGE(TAG, "Invalid length");
422 return true;
423 }
424 if (!ld2410::validate_header_footer(CMD_FRAME_HEADER, this->buffer_data_)) {
425 char hex_buf[format_hex_pretty_size(HEADER_FOOTER_SIZE)];
426 ESP_LOGW(TAG, "Invalid header: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, HEADER_FOOTER_SIZE));
427 return true;
428 }
429 if (this->buffer_data_[COMMAND_STATUS] != 0x01) {
430 ESP_LOGE(TAG, "Invalid status");
431 return true;
432 }
433 if (this->buffer_data_[8] || this->buffer_data_[9]) {
434 ESP_LOGW(TAG, "Invalid command: %02X, %02X", this->buffer_data_[8], this->buffer_data_[9]);
435 return true;
436 }
437
438 switch (this->buffer_data_[COMMAND]) {
439 case CMD_ENABLE_CONF:
440 ESP_LOGV(TAG, "Enable conf");
441 break;
442
443 case CMD_DISABLE_CONF:
444 ESP_LOGV(TAG, "Disabled conf");
445 break;
446
447 case CMD_SET_BAUD_RATE:
448 ESP_LOGV(TAG, "Baud rate change");
449#ifdef USE_SELECT
450 if (this->baud_rate_select_ != nullptr) {
451 auto baud = this->baud_rate_select_->current_option();
452 ESP_LOGE(TAG, "Change baud rate to %.*s and reinstall", (int) baud.size(), baud.c_str());
453 }
454#endif
455 break;
456
457 case CMD_QUERY_VERSION: {
458 std::memcpy(this->version_, &this->buffer_data_[12], sizeof(this->version_));
459 char version_s[20];
460 ld24xx::format_version_str(this->version_, version_s);
461 ESP_LOGV(TAG, "Firmware version: %s", version_s);
462#ifdef USE_TEXT_SENSOR
463 if (this->version_text_sensor_ != nullptr) {
464 this->version_text_sensor_->publish_state(version_s);
465 }
466#endif
467 break;
468 }
469
470 case CMD_QUERY_DISTANCE_RESOLUTION: {
471 const auto *distance_resolution = find_str(DISTANCE_RESOLUTIONS_BY_UINT, this->buffer_data_[10]);
472 ESP_LOGV(TAG, "Distance resolution: %s", distance_resolution);
473#ifdef USE_SELECT
474 if (this->distance_resolution_select_ != nullptr) {
475 this->distance_resolution_select_->publish_state(distance_resolution);
476 }
477#endif
478 break;
479 }
480
481 case CMD_QUERY_LIGHT_CONTROL: {
482 this->light_function_ = this->buffer_data_[10];
483 this->light_threshold_ = this->buffer_data_[11];
484 this->out_pin_level_ = this->buffer_data_[12];
485 const auto *light_function_str = find_str(LIGHT_FUNCTIONS_BY_UINT, this->light_function_);
486 const auto *out_pin_level_str = find_str(OUT_PIN_LEVELS_BY_UINT, this->out_pin_level_);
487 ESP_LOGV(TAG, "Light function: %s, threshold: %u, out pin level: %s", light_function_str, this->light_threshold_,
488 out_pin_level_str);
489#ifdef USE_SELECT
490 if (this->light_function_select_ != nullptr) {
491 this->light_function_select_->publish_state(light_function_str);
492 }
493 if (this->out_pin_level_select_ != nullptr) {
494 this->out_pin_level_select_->publish_state(out_pin_level_str);
495 }
496#endif
497#ifdef USE_NUMBER
498 if (this->light_threshold_number_ != nullptr) {
499 this->light_threshold_number_->publish_state(static_cast<float>(this->light_threshold_));
500 }
501#endif
502 break;
503 }
504 case CMD_QUERY_MAC_ADDRESS: {
505 if (this->buffer_pos_ < 20) {
506 return false;
507 }
508
509 this->bluetooth_on_ = std::memcmp(&this->buffer_data_[10], NO_MAC, sizeof(NO_MAC)) != 0;
510 if (this->bluetooth_on_) {
511 std::memcpy(this->mac_address_, &this->buffer_data_[10], sizeof(this->mac_address_));
512 }
513
514 char mac_s[18];
515 const char *mac_str = ld24xx::format_mac_str(this->mac_address_, mac_s);
516 ESP_LOGV(TAG, "MAC address: %s", mac_str);
517#ifdef USE_TEXT_SENSOR
518 if (this->mac_text_sensor_ != nullptr) {
519 this->mac_text_sensor_->publish_state(mac_str);
520 }
521#endif
522#ifdef USE_SWITCH
523 if (this->bluetooth_switch_ != nullptr) {
524 this->bluetooth_switch_->publish_state(this->bluetooth_on_);
525 }
526#endif
527 break;
528 }
529
530 case CMD_GATE_SENS:
531 ESP_LOGV(TAG, "Sensitivity");
532 break;
533
534 case CMD_BLUETOOTH:
535 ESP_LOGV(TAG, "Bluetooth");
536 break;
537
538 case CMD_SET_DISTANCE_RESOLUTION:
539 ESP_LOGV(TAG, "Set distance resolution");
540 break;
541
542 case CMD_SET_LIGHT_CONTROL:
543 ESP_LOGV(TAG, "Set light control");
544 break;
545
546 case CMD_BT_PASSWORD:
547 ESP_LOGV(TAG, "Set bluetooth password");
548 break;
549
550 case CMD_QUERY: { // Query parameters response
551 if (this->buffer_data_[10] != HEADER)
552 return true; // value head=0xAA
553#ifdef USE_NUMBER
554 /*
555 Moving distance range: 13th byte
556 Still distance range: 14th byte
557 */
558 std::vector<std::function<void(void)>> updates;
559 updates.push_back(set_number_value(this->max_move_distance_gate_number_, this->buffer_data_[12]));
560 updates.push_back(set_number_value(this->max_still_distance_gate_number_, this->buffer_data_[13]));
561 /*
562 Moving Sensitivities: 15~23th bytes
563 */
564 for (std::vector<number::Number *>::size_type i = 0; i != this->gate_move_threshold_numbers_.size(); i++) {
565 updates.push_back(set_number_value(this->gate_move_threshold_numbers_[i], this->buffer_data_[14 + i]));
566 }
567 /*
568 Still Sensitivities: 24~32th bytes
569 */
570 for (std::vector<number::Number *>::size_type i = 0; i != this->gate_still_threshold_numbers_.size(); i++) {
571 updates.push_back(set_number_value(this->gate_still_threshold_numbers_[i], this->buffer_data_[23 + i]));
572 }
573 /*
574 None Duration: 33~34th bytes
575 */
576 updates.push_back(
577 set_number_value(this->timeout_number_, encode_uint16(this->buffer_data_[33], this->buffer_data_[32])));
578 for (auto &update : updates) {
579 update();
580 }
581#endif
582 break;
583 }
584 default:
585 break;
586 }
587
588 return true;
589}
590
592 if (readch < 0) {
593 return; // No data available
594 }
595
596 if (this->buffer_pos_ < MAX_LINE_LENGTH - 1) {
597 this->buffer_data_[this->buffer_pos_++] = readch;
598 this->buffer_data_[this->buffer_pos_] = 0;
599 } else {
600 // We should never get here, but just in case...
601 ESP_LOGW(TAG, "Max command length exceeded; ignoring");
602 this->buffer_pos_ = 0;
603 return;
604 }
605 if (this->buffer_pos_ < HEADER_FOOTER_SIZE) {
606 return; // Not enough data to process yet
607 }
608 if (ld2410::validate_header_footer(DATA_FRAME_FOOTER, &this->buffer_data_[this->buffer_pos_ - 4])) {
609#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
610 char hex_buf[format_hex_pretty_size(MAX_LINE_LENGTH)];
611 ESP_LOGV(TAG, "Handling Periodic Data: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, this->buffer_pos_));
612#endif
613 this->handle_periodic_data_();
614 this->buffer_pos_ = 0; // Reset position index for next message
615 } else if (ld2410::validate_header_footer(CMD_FRAME_FOOTER, &this->buffer_data_[this->buffer_pos_ - 4])) {
616#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
617 char hex_buf[format_hex_pretty_size(MAX_LINE_LENGTH)];
618 ESP_LOGV(TAG, "Handling Ack Data: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, this->buffer_pos_));
619#endif
620 if (this->handle_ack_data_()) {
621 this->buffer_pos_ = 0; // Reset position index for next message
622 } else {
623 ESP_LOGV(TAG, "Ack Data incomplete");
624 }
625 }
626}
627
629 const uint8_t cmd = enable ? CMD_ENABLE_CONF : CMD_DISABLE_CONF;
630 const uint8_t cmd_value[2] = {0x01, 0x00};
631 this->send_command_(cmd, enable ? cmd_value : nullptr, sizeof(cmd_value));
632}
633
634void LD2410Component::set_bluetooth(bool enable) {
635 this->set_config_mode_(true);
636 const uint8_t cmd_value[2] = {enable ? (uint8_t) 0x01 : (uint8_t) 0x00, 0x00};
637 this->send_command_(CMD_BLUETOOTH, cmd_value, sizeof(cmd_value));
638 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
639}
640
641void LD2410Component::set_distance_resolution(const char *state) {
642 this->set_config_mode_(true);
643 const uint8_t cmd_value[2] = {find_uint8(DISTANCE_RESOLUTIONS_BY_STR, state), 0x00};
644 this->send_command_(CMD_SET_DISTANCE_RESOLUTION, cmd_value, sizeof(cmd_value));
645 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
646}
647
648void LD2410Component::set_baud_rate(const char *state) {
649 this->set_config_mode_(true);
650 const uint8_t cmd_value[2] = {find_uint8(BAUD_RATES_BY_STR, state), 0x00};
651 this->send_command_(CMD_SET_BAUD_RATE, cmd_value, sizeof(cmd_value));
652 this->set_timeout(200, [this]() { this->restart_(); });
653}
654
655void LD2410Component::set_bluetooth_password(const std::string &password) {
656 if (password.length() != 6) {
657 ESP_LOGE(TAG, "Password must be exactly 6 chars");
658 return;
659 }
660 this->set_config_mode_(true);
661 uint8_t cmd_value[6];
662 std::copy(password.begin(), password.end(), std::begin(cmd_value));
663 this->send_command_(CMD_BT_PASSWORD, cmd_value, sizeof(cmd_value));
664 this->set_config_mode_(false);
665}
666
667void LD2410Component::set_engineering_mode(bool enable) {
668 const uint8_t cmd = enable ? CMD_ENABLE_ENG : CMD_DISABLE_ENG;
669 this->set_config_mode_(true);
670 this->send_command_(cmd, nullptr, 0);
671 this->set_config_mode_(false);
672}
673
674void LD2410Component::factory_reset() {
675 this->set_config_mode_(true);
676 this->send_command_(CMD_RESET, nullptr, 0);
677 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
678}
679
680void LD2410Component::restart_() { this->send_command_(CMD_RESTART, nullptr, 0); }
681
682void LD2410Component::query_parameters_() { this->send_command_(CMD_QUERY, nullptr, 0); }
683
684void LD2410Component::get_version_() { this->send_command_(CMD_QUERY_VERSION, nullptr, 0); }
685
687 const uint8_t cmd_value[2] = {0x01, 0x00};
688 this->send_command_(CMD_QUERY_MAC_ADDRESS, cmd_value, sizeof(cmd_value));
689}
690
691void LD2410Component::get_distance_resolution_() { this->send_command_(CMD_QUERY_DISTANCE_RESOLUTION, nullptr, 0); }
692
693void LD2410Component::query_light_control_() { this->send_command_(CMD_QUERY_LIGHT_CONTROL, nullptr, 0); }
694
695#ifdef USE_NUMBER
696void LD2410Component::set_max_distances_timeout() {
697 if (!this->max_move_distance_gate_number_->has_state() || !this->max_still_distance_gate_number_->has_state() ||
698 !this->timeout_number_->has_state()) {
699 return;
700 }
701 int max_moving_distance_gate_range = static_cast<int>(this->max_move_distance_gate_number_->state);
702 int max_still_distance_gate_range = static_cast<int>(this->max_still_distance_gate_number_->state);
703 int timeout = static_cast<int>(this->timeout_number_->state);
704 uint8_t value[18] = {0x00,
705 0x00,
706 lowbyte(max_moving_distance_gate_range),
707 highbyte(max_moving_distance_gate_range),
708 0x00,
709 0x00,
710 0x01,
711 0x00,
712 lowbyte(max_still_distance_gate_range),
713 highbyte(max_still_distance_gate_range),
714 0x00,
715 0x00,
716 0x02,
717 0x00,
718 lowbyte(timeout),
719 highbyte(timeout),
720 0x00,
721 0x00};
722 this->set_config_mode_(true);
723 this->send_command_(CMD_MAXDIST_DURATION, value, sizeof(value));
724 this->query_parameters_();
725 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
726 this->set_config_mode_(false);
727}
728
729void LD2410Component::set_gate_threshold(uint8_t gate) {
730 number::Number *motionsens = this->gate_move_threshold_numbers_[gate];
731 number::Number *stillsens = this->gate_still_threshold_numbers_[gate];
732
733 if (!motionsens->has_state() || !stillsens->has_state()) {
734 return;
735 }
736 int motion = static_cast<int>(motionsens->state);
737 int still = static_cast<int>(stillsens->state);
738
739 this->set_config_mode_(true);
740 // reference
741 // https://drive.google.com/drive/folders/1p4dhbEJA3YubyIjIIC7wwVsSo8x29Fq-?spm=a2g0o.detail.1000023.17.93465697yFwVxH
742 // Send data: configure the motion sensitivity of distance gate 3 to 40, and the static sensitivity of 40
743 // 00 00 (gate)
744 // 03 00 00 00 (gate number)
745 // 01 00 (motion sensitivity)
746 // 28 00 00 00 (value)
747 // 02 00 (still sensitivtiy)
748 // 28 00 00 00 (value)
749 uint8_t value[18] = {0x00, 0x00, lowbyte(gate), highbyte(gate), 0x00, 0x00,
750 0x01, 0x00, lowbyte(motion), highbyte(motion), 0x00, 0x00,
751 0x02, 0x00, lowbyte(still), highbyte(still), 0x00, 0x00};
752 this->send_command_(CMD_GATE_SENS, value, sizeof(value));
753 this->query_parameters_();
754 this->set_config_mode_(false);
755}
756
757void LD2410Component::set_gate_still_threshold_number(uint8_t gate, number::Number *n) {
758 this->gate_still_threshold_numbers_[gate] = n;
759}
760
761void LD2410Component::set_gate_move_threshold_number(uint8_t gate, number::Number *n) {
762 this->gate_move_threshold_numbers_[gate] = n;
763}
764#endif
765
766void LD2410Component::set_light_out_control() {
767#ifdef USE_NUMBER
768 if (this->light_threshold_number_ != nullptr && this->light_threshold_number_->has_state()) {
769 this->light_threshold_ = static_cast<uint8_t>(this->light_threshold_number_->state);
770 }
771#endif
772#ifdef USE_SELECT
773 if (this->light_function_select_ != nullptr && this->light_function_select_->has_state()) {
774 this->light_function_ = find_uint8(LIGHT_FUNCTIONS_BY_STR, this->light_function_select_->current_option().c_str());
775 }
776 if (this->out_pin_level_select_ != nullptr && this->out_pin_level_select_->has_state()) {
777 this->out_pin_level_ = find_uint8(OUT_PIN_LEVELS_BY_STR, this->out_pin_level_select_->current_option().c_str());
778 }
779#endif
780 this->set_config_mode_(true);
781 uint8_t value[4] = {this->light_function_, this->light_threshold_, this->out_pin_level_, 0x00};
782 this->send_command_(CMD_SET_LIGHT_CONTROL, value, sizeof(value));
783 this->query_light_control_();
784 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
785 this->set_config_mode_(false);
786}
787
788#ifdef USE_SENSOR
789// These could leak memory, but they are only set once prior to 'setup()' and should never be used again.
790void LD2410Component::set_gate_move_sensor(uint8_t gate, sensor::Sensor *s) {
791 this->gate_move_sensors_[gate] = new SensorWithDedup<uint8_t>(s);
792}
793
794void LD2410Component::set_gate_still_sensor(uint8_t gate, sensor::Sensor *s) {
795 this->gate_still_sensors_[gate] = new SensorWithDedup<uint8_t>(s);
796}
797#endif
798
799} // namespace esphome::ld2410
virtual void setup()
Where the component's initialization should happen.
Definition component.cpp:94
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.
Definition component.h:443
bool has_state() const
std::array< number::Number *, TOTAL_GATES > gate_still_threshold_numbers_
Definition ld2410.h:129
void set_config_mode_(bool enable)
Definition ld2410.cpp:628
std::array< number::Number *, TOTAL_GATES > gate_move_threshold_numbers_
Definition ld2410.h:128
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_still_sensors_
Definition ld2410.h:133
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_move_sensors_
Definition ld2410.h:132
void send_command_(uint8_t command_str, const uint8_t *command_value, uint8_t command_value_len)
Definition ld2410.cpp:292
uint8_t buffer_data_[MAX_LINE_LENGTH]
Definition ld2410.h:123
Base-class for all numbers.
Definition number.h:29
void publish_state(float state)
Definition number.cpp:22
optional< std::array< uint8_t, N > > read_array()
Definition uart.h:38
UARTComponent * parent_
Definition uart.h:73
void write_array(const uint8_t *data, size_t len)
Definition uart.h:26
bool state
Definition fan.h:2
constexpr Uint8ToString DISTANCE_RESOLUTIONS_BY_UINT[]
Definition ld2410.cpp:93
constexpr StringToUint8 DISTANCE_RESOLUTIONS_BY_STR[]
Definition ld2410.cpp:88
constexpr StringToUint8 BAUD_RATES_BY_STR[]
Definition ld2410.cpp:82
uint8_t find_uint8(const StringToUint8(&arr)[N], const char *str)
Definition ld2410.cpp:123
constexpr StringToUint8 OUT_PIN_LEVELS_BY_STR[]
Definition ld2410.cpp:110
const char * find_str(const Uint8ToString(&arr)[N], uint8_t value)
Definition ld2410.cpp:131
std::function< void(void)> set_number_value(number::Number *n, float value)
Definition ld2410.cpp:409
@ DISTANCE_RESOLUTION_0_2
Definition ld2410.cpp:28
@ DISTANCE_RESOLUTION_0_75
Definition ld2410.cpp:29
constexpr uint32_t BAUD_RATES[]
Definition ld2410.cpp:120
constexpr Uint8ToString OUT_PIN_LEVELS_BY_UINT[]
Definition ld2410.cpp:115
constexpr StringToUint8 LIGHT_FUNCTIONS_BY_STR[]
Definition ld2410.cpp:98
constexpr Uint8ToString LIGHT_FUNCTIONS_BY_UINT[]
Definition ld2410.cpp:104
void format_version_str(const uint8_t *version, std::span< char, 20 > buffer)
Definition ld24xx.h:67
const char * format_mac_str(const uint8_t *mac_address, std::span< char, 18 > buffer)
Definition ld24xx.h:57
optional< size_t > find_index(const uint32_t(&arr)[N], uint32_t value)
Definition ld24xx.h:43
std::string size_t len
Definition helpers.h:817
char * format_hex_pretty_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length, char separator)
Format byte array as uppercase hex to buffer (base implementation).
Definition helpers.cpp:353
constexpr size_t format_hex_pretty_size(size_t byte_count)
Calculate buffer size needed for format_hex_pretty_to with separator: "XX:XX:...:XX\0".
Definition helpers.h:1103
constexpr uint16_t encode_uint16(uint8_t msb, uint8_t lsb)
Encode a 16-bit value given the most and least significant byte.
Definition helpers.h:653
void HOT delay(uint32_t ms)
Definition core.cpp:27