ESPHome 2026.1.4
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 int two_byte_to_int(char firstbyte, char secondbyte) { return (int16_t) (secondbyte << 8) + firstbyte; }
177
178static inline bool validate_header_footer(const uint8_t *header_footer, const uint8_t *buffer) {
179 return std::memcmp(header_footer, buffer, HEADER_FOOTER_SIZE) == 0;
180}
181
182void LD2410Component::dump_config() {
183 char mac_s[18];
184 char version_s[20];
185 const char *mac_str = ld24xx::format_mac_str(this->mac_address_, mac_s);
186 ld24xx::format_version_str(this->version_, version_s);
187 ESP_LOGCONFIG(TAG,
188 "LD2410:\n"
189 " Firmware version: %s\n"
190 " MAC address: %s",
191 version_s, mac_str);
192#ifdef USE_BINARY_SENSOR
193 ESP_LOGCONFIG(TAG, "Binary Sensors:");
194 LOG_BINARY_SENSOR(" ", "Target", this->target_binary_sensor_);
195 LOG_BINARY_SENSOR(" ", "MovingTarget", this->moving_target_binary_sensor_);
196 LOG_BINARY_SENSOR(" ", "StillTarget", this->still_target_binary_sensor_);
197 LOG_BINARY_SENSOR(" ", "OutPinPresenceStatus", this->out_pin_presence_status_binary_sensor_);
198#endif
199#ifdef USE_SENSOR
200 ESP_LOGCONFIG(TAG, "Sensors:");
201 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "Light", this->light_sensor_);
202 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "DetectionDistance", this->detection_distance_sensor_);
203 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "MovingTargetDistance", this->moving_target_distance_sensor_);
204 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "MovingTargetEnergy", this->moving_target_energy_sensor_);
205 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "StillTargetDistance", this->still_target_distance_sensor_);
206 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "StillTargetEnergy", this->still_target_energy_sensor_);
207 for (auto &s : this->gate_move_sensors_) {
208 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "GateMove", s);
209 }
210 for (auto &s : this->gate_still_sensors_) {
211 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "GateStill", s);
212 }
213#endif
214#ifdef USE_TEXT_SENSOR
215 ESP_LOGCONFIG(TAG, "Text Sensors:");
216 LOG_TEXT_SENSOR(" ", "Mac", this->mac_text_sensor_);
217 LOG_TEXT_SENSOR(" ", "Version", this->version_text_sensor_);
218#endif
219#ifdef USE_NUMBER
220 ESP_LOGCONFIG(TAG, "Numbers:");
221 LOG_NUMBER(" ", "LightThreshold", this->light_threshold_number_);
222 LOG_NUMBER(" ", "MaxMoveDistanceGate", this->max_move_distance_gate_number_);
223 LOG_NUMBER(" ", "MaxStillDistanceGate", this->max_still_distance_gate_number_);
224 LOG_NUMBER(" ", "Timeout", this->timeout_number_);
225 for (number::Number *n : this->gate_move_threshold_numbers_) {
226 LOG_NUMBER(" ", "MoveThreshold", n);
227 }
228 for (number::Number *n : this->gate_still_threshold_numbers_) {
229 LOG_NUMBER(" ", "StillThreshold", n);
230 }
231#endif
232#ifdef USE_SELECT
233 ESP_LOGCONFIG(TAG, "Selects:");
234 LOG_SELECT(" ", "BaudRate", this->baud_rate_select_);
235 LOG_SELECT(" ", "DistanceResolution", this->distance_resolution_select_);
236 LOG_SELECT(" ", "LightFunction", this->light_function_select_);
237 LOG_SELECT(" ", "OutPinLevel", this->out_pin_level_select_);
238#endif
239#ifdef USE_SWITCH
240 ESP_LOGCONFIG(TAG, "Switches:");
241 LOG_SWITCH(" ", "Bluetooth", this->bluetooth_switch_);
242 LOG_SWITCH(" ", "EngineeringMode", this->engineering_mode_switch_);
243#endif
244#ifdef USE_BUTTON
245 ESP_LOGCONFIG(TAG, "Buttons:");
246 LOG_BUTTON(" ", "FactoryReset", this->factory_reset_button_);
247 LOG_BUTTON(" ", "Query", this->query_button_);
248 LOG_BUTTON(" ", "Restart", this->restart_button_);
249#endif
250}
251
252void LD2410Component::setup() { this->read_all_info(); }
253
254void LD2410Component::read_all_info() {
255 this->set_config_mode_(true);
256 this->get_version_();
257 this->get_mac_();
259 this->query_light_control_();
260 this->query_parameters_();
261 this->set_config_mode_(false);
262#ifdef USE_SELECT
263 if (this->baud_rate_select_ != nullptr) {
264 if (auto index = ld24xx::find_index(BAUD_RATES, this->parent_->get_baud_rate())) {
265 this->baud_rate_select_->publish_state(*index);
266 }
267 }
268#endif
269}
270
271void LD2410Component::restart_and_read_all_info() {
272 this->set_config_mode_(true);
273 this->restart_();
274 this->set_timeout(1000, [this]() { this->read_all_info(); });
275}
276
277void LD2410Component::loop() {
278 while (this->available()) {
279 this->readline_(this->read());
280 }
281}
282
283void LD2410Component::send_command_(uint8_t command, const uint8_t *command_value, uint8_t command_value_len) {
284 ESP_LOGV(TAG, "Sending COMMAND %02X", command);
285 // frame header bytes
286 this->write_array(CMD_FRAME_HEADER, sizeof(CMD_FRAME_HEADER));
287 // length bytes
288 uint8_t len = 2;
289 if (command_value != nullptr) {
290 len += command_value_len;
291 }
292 // 2 length bytes (low, high) + 2 command bytes (low, high)
293 uint8_t len_cmd[] = {len, 0x00, command, 0x00};
294 this->write_array(len_cmd, sizeof(len_cmd));
295 // command value bytes
296 if (command_value != nullptr) {
297 this->write_array(command_value, command_value_len);
298 }
299 // frame footer bytes
300 this->write_array(CMD_FRAME_FOOTER, sizeof(CMD_FRAME_FOOTER));
301
302 if (command != CMD_ENABLE_CONF && command != CMD_DISABLE_CONF) {
303 delay(50); // NOLINT
304 }
305}
306
308 // 4 frame header bytes + 2 length bytes + 1 data end byte + 1 crc byte + 4 frame footer bytes
309 // data header=0xAA, data footer=0x55, crc=0x00
310 if (this->buffer_pos_ < 12 || !ld2410::validate_header_footer(DATA_FRAME_HEADER, this->buffer_data_) ||
311 this->buffer_data_[7] != HEADER || this->buffer_data_[this->buffer_pos_ - 6] != FOOTER ||
312 this->buffer_data_[this->buffer_pos_ - 5] != CHECK) {
313 return;
314 }
315 /*
316 Data Type: 7th
317 0x01: Engineering mode
318 0x02: Normal mode
319 */
320 bool engineering_mode = this->buffer_data_[DATA_TYPES] == 0x01;
321#ifdef USE_SWITCH
322 if (this->engineering_mode_switch_ != nullptr) {
323 this->engineering_mode_switch_->publish_state(engineering_mode);
324 }
325#endif
326#ifdef USE_BINARY_SENSOR
327 /*
328 Target states: 9th
329 0x00 = No target
330 0x01 = Moving targets
331 0x02 = Still targets
332 0x03 = Moving+Still targets
333 */
334 char target_state = this->buffer_data_[TARGET_STATES];
335 if (this->target_binary_sensor_ != nullptr) {
336 this->target_binary_sensor_->publish_state(target_state != 0x00);
337 }
338 if (this->moving_target_binary_sensor_ != nullptr) {
339 this->moving_target_binary_sensor_->publish_state(target_state & MOVE_BITMASK);
340 }
341 if (this->still_target_binary_sensor_ != nullptr) {
342 this->still_target_binary_sensor_->publish_state(target_state & STILL_BITMASK);
343 }
344#endif
345 /*
346 Moving target distance: 10~11th bytes
347 Moving target energy: 12th byte
348 Still target distance: 13~14th bytes
349 Still target energy: 15th byte
350 Detect distance: 16~17th bytes
351 */
352#ifdef USE_SENSOR
353 SAFE_PUBLISH_SENSOR(
354 this->moving_target_distance_sensor_,
355 ld2410::two_byte_to_int(this->buffer_data_[MOVING_TARGET_LOW], this->buffer_data_[MOVING_TARGET_HIGH]))
356 SAFE_PUBLISH_SENSOR(this->moving_target_energy_sensor_, this->buffer_data_[MOVING_ENERGY])
357 SAFE_PUBLISH_SENSOR(
358 this->still_target_distance_sensor_,
359 ld2410::two_byte_to_int(this->buffer_data_[STILL_TARGET_LOW], this->buffer_data_[STILL_TARGET_HIGH]));
360 SAFE_PUBLISH_SENSOR(this->still_target_energy_sensor_, this->buffer_data_[STILL_ENERGY]);
361 SAFE_PUBLISH_SENSOR(
362 this->detection_distance_sensor_,
363 ld2410::two_byte_to_int(this->buffer_data_[DETECT_DISTANCE_LOW], this->buffer_data_[DETECT_DISTANCE_HIGH]));
364
365 if (engineering_mode) {
366 /*
367 Moving distance range: 18th byte
368 Still distance range: 19th byte
369 Moving energy: 20~28th bytes
370 */
371 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
372 SAFE_PUBLISH_SENSOR(this->gate_move_sensors_[i], this->buffer_data_[MOVING_SENSOR_START + i])
373 }
374 /*
375 Still energy: 29~37th bytes
376 */
377 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
378 SAFE_PUBLISH_SENSOR(this->gate_still_sensors_[i], this->buffer_data_[STILL_SENSOR_START + i])
379 }
380 /*
381 Light sensor: 38th bytes
382 */
383 SAFE_PUBLISH_SENSOR(this->light_sensor_, this->buffer_data_[LIGHT_SENSOR])
384 } else {
385 for (auto &gate_move_sensor : this->gate_move_sensors_) {
386 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_move_sensor)
387 }
388 for (auto &gate_still_sensor : this->gate_still_sensors_) {
389 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_still_sensor)
390 }
391 SAFE_PUBLISH_SENSOR_UNKNOWN(this->light_sensor_)
392 }
393#endif
394#ifdef USE_BINARY_SENSOR
395 if (this->out_pin_presence_status_binary_sensor_ != nullptr) {
396 this->out_pin_presence_status_binary_sensor_->publish_state(
397 engineering_mode ? this->buffer_data_[OUT_PIN_SENSOR] == 0x01 : false);
398 }
399#endif
400}
401
402#ifdef USE_NUMBER
403std::function<void(void)> set_number_value(number::Number *n, float value) {
404 if (n != nullptr && (!n->has_state() || n->state != value)) {
405 n->state = value;
406 return [n, value]() { n->publish_state(value); };
407 }
408 return []() {};
409}
410#endif
411
413 ESP_LOGV(TAG, "Handling ACK DATA for COMMAND %02X", this->buffer_data_[COMMAND]);
414 if (this->buffer_pos_ < 10) {
415 ESP_LOGE(TAG, "Invalid length");
416 return true;
417 }
418 if (!ld2410::validate_header_footer(CMD_FRAME_HEADER, this->buffer_data_)) {
419 char hex_buf[format_hex_pretty_size(HEADER_FOOTER_SIZE)];
420 ESP_LOGW(TAG, "Invalid header: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, HEADER_FOOTER_SIZE));
421 return true;
422 }
423 if (this->buffer_data_[COMMAND_STATUS] != 0x01) {
424 ESP_LOGE(TAG, "Invalid status");
425 return true;
426 }
427 if (this->buffer_data_[8] || this->buffer_data_[9]) {
428 ESP_LOGW(TAG, "Invalid command: %02X, %02X", this->buffer_data_[8], this->buffer_data_[9]);
429 return true;
430 }
431
432 switch (this->buffer_data_[COMMAND]) {
433 case CMD_ENABLE_CONF:
434 ESP_LOGV(TAG, "Enable conf");
435 break;
436
437 case CMD_DISABLE_CONF:
438 ESP_LOGV(TAG, "Disabled conf");
439 break;
440
441 case CMD_SET_BAUD_RATE:
442 ESP_LOGV(TAG, "Baud rate change");
443#ifdef USE_SELECT
444 if (this->baud_rate_select_ != nullptr) {
445 auto baud = this->baud_rate_select_->current_option();
446 ESP_LOGE(TAG, "Change baud rate to %.*s and reinstall", (int) baud.size(), baud.c_str());
447 }
448#endif
449 break;
450
451 case CMD_QUERY_VERSION: {
452 std::memcpy(this->version_, &this->buffer_data_[12], sizeof(this->version_));
453 char version_s[20];
454 ld24xx::format_version_str(this->version_, version_s);
455 ESP_LOGV(TAG, "Firmware version: %s", version_s);
456#ifdef USE_TEXT_SENSOR
457 if (this->version_text_sensor_ != nullptr) {
458 this->version_text_sensor_->publish_state(version_s);
459 }
460#endif
461 break;
462 }
463
464 case CMD_QUERY_DISTANCE_RESOLUTION: {
465 const auto *distance_resolution = find_str(DISTANCE_RESOLUTIONS_BY_UINT, this->buffer_data_[10]);
466 ESP_LOGV(TAG, "Distance resolution: %s", distance_resolution);
467#ifdef USE_SELECT
468 if (this->distance_resolution_select_ != nullptr) {
469 this->distance_resolution_select_->publish_state(distance_resolution);
470 }
471#endif
472 break;
473 }
474
475 case CMD_QUERY_LIGHT_CONTROL: {
476 this->light_function_ = this->buffer_data_[10];
477 this->light_threshold_ = this->buffer_data_[11];
478 this->out_pin_level_ = this->buffer_data_[12];
479 const auto *light_function_str = find_str(LIGHT_FUNCTIONS_BY_UINT, this->light_function_);
480 const auto *out_pin_level_str = find_str(OUT_PIN_LEVELS_BY_UINT, this->out_pin_level_);
481 ESP_LOGV(TAG,
482 "Light function: %s\n"
483 "Light threshold: %u\n"
484 "Out pin level: %s",
485 light_function_str, this->light_threshold_, out_pin_level_str);
486#ifdef USE_SELECT
487 if (this->light_function_select_ != nullptr) {
488 this->light_function_select_->publish_state(light_function_str);
489 }
490 if (this->out_pin_level_select_ != nullptr) {
491 this->out_pin_level_select_->publish_state(out_pin_level_str);
492 }
493#endif
494#ifdef USE_NUMBER
495 if (this->light_threshold_number_ != nullptr) {
496 this->light_threshold_number_->publish_state(static_cast<float>(this->light_threshold_));
497 }
498#endif
499 break;
500 }
501 case CMD_QUERY_MAC_ADDRESS: {
502 if (this->buffer_pos_ < 20) {
503 return false;
504 }
505
506 this->bluetooth_on_ = std::memcmp(&this->buffer_data_[10], NO_MAC, sizeof(NO_MAC)) != 0;
507 if (this->bluetooth_on_) {
508 std::memcpy(this->mac_address_, &this->buffer_data_[10], sizeof(this->mac_address_));
509 }
510
511 char mac_s[18];
512 const char *mac_str = ld24xx::format_mac_str(this->mac_address_, mac_s);
513 ESP_LOGV(TAG, "MAC address: %s", mac_str);
514#ifdef USE_TEXT_SENSOR
515 if (this->mac_text_sensor_ != nullptr) {
516 this->mac_text_sensor_->publish_state(mac_str);
517 }
518#endif
519#ifdef USE_SWITCH
520 if (this->bluetooth_switch_ != nullptr) {
521 this->bluetooth_switch_->publish_state(this->bluetooth_on_);
522 }
523#endif
524 break;
525 }
526
527 case CMD_GATE_SENS:
528 ESP_LOGV(TAG, "Sensitivity");
529 break;
530
531 case CMD_BLUETOOTH:
532 ESP_LOGV(TAG, "Bluetooth");
533 break;
534
535 case CMD_SET_DISTANCE_RESOLUTION:
536 ESP_LOGV(TAG, "Set distance resolution");
537 break;
538
539 case CMD_SET_LIGHT_CONTROL:
540 ESP_LOGV(TAG, "Set light control");
541 break;
542
543 case CMD_BT_PASSWORD:
544 ESP_LOGV(TAG, "Set bluetooth password");
545 break;
546
547 case CMD_QUERY: { // Query parameters response
548 if (this->buffer_data_[10] != HEADER)
549 return true; // value head=0xAA
550#ifdef USE_NUMBER
551 /*
552 Moving distance range: 13th byte
553 Still distance range: 14th byte
554 */
555 std::vector<std::function<void(void)>> updates;
556 updates.push_back(set_number_value(this->max_move_distance_gate_number_, this->buffer_data_[12]));
557 updates.push_back(set_number_value(this->max_still_distance_gate_number_, this->buffer_data_[13]));
558 /*
559 Moving Sensitivities: 15~23th bytes
560 */
561 for (std::vector<number::Number *>::size_type i = 0; i != this->gate_move_threshold_numbers_.size(); i++) {
562 updates.push_back(set_number_value(this->gate_move_threshold_numbers_[i], this->buffer_data_[14 + i]));
563 }
564 /*
565 Still Sensitivities: 24~32th bytes
566 */
567 for (std::vector<number::Number *>::size_type i = 0; i != this->gate_still_threshold_numbers_.size(); i++) {
568 updates.push_back(set_number_value(this->gate_still_threshold_numbers_[i], this->buffer_data_[23 + i]));
569 }
570 /*
571 None Duration: 33~34th bytes
572 */
573 updates.push_back(set_number_value(this->timeout_number_,
574 ld2410::two_byte_to_int(this->buffer_data_[32], this->buffer_data_[33])));
575 for (auto &update : updates) {
576 update();
577 }
578#endif
579 break;
580 }
581 default:
582 break;
583 }
584
585 return true;
586}
587
589 if (readch < 0) {
590 return; // No data available
591 }
592
593 if (this->buffer_pos_ < MAX_LINE_LENGTH - 1) {
594 this->buffer_data_[this->buffer_pos_++] = readch;
595 this->buffer_data_[this->buffer_pos_] = 0;
596 } else {
597 // We should never get here, but just in case...
598 ESP_LOGW(TAG, "Max command length exceeded; ignoring");
599 this->buffer_pos_ = 0;
600 }
601 if (this->buffer_pos_ < 4) {
602 return; // Not enough data to process yet
603 }
604 if (ld2410::validate_header_footer(DATA_FRAME_FOOTER, &this->buffer_data_[this->buffer_pos_ - 4])) {
605#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
606 char hex_buf[format_hex_pretty_size(MAX_LINE_LENGTH)];
607 ESP_LOGV(TAG, "Handling Periodic Data: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, this->buffer_pos_));
608#endif
609 this->handle_periodic_data_();
610 this->buffer_pos_ = 0; // Reset position index for next message
611 } else if (ld2410::validate_header_footer(CMD_FRAME_FOOTER, &this->buffer_data_[this->buffer_pos_ - 4])) {
612#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
613 char hex_buf[format_hex_pretty_size(MAX_LINE_LENGTH)];
614 ESP_LOGV(TAG, "Handling Ack Data: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, this->buffer_pos_));
615#endif
616 if (this->handle_ack_data_()) {
617 this->buffer_pos_ = 0; // Reset position index for next message
618 } else {
619 ESP_LOGV(TAG, "Ack Data incomplete");
620 }
621 }
622}
623
625 const uint8_t cmd = enable ? CMD_ENABLE_CONF : CMD_DISABLE_CONF;
626 const uint8_t cmd_value[2] = {0x01, 0x00};
627 this->send_command_(cmd, enable ? cmd_value : nullptr, sizeof(cmd_value));
628}
629
630void LD2410Component::set_bluetooth(bool enable) {
631 this->set_config_mode_(true);
632 const uint8_t cmd_value[2] = {enable ? (uint8_t) 0x01 : (uint8_t) 0x00, 0x00};
633 this->send_command_(CMD_BLUETOOTH, cmd_value, sizeof(cmd_value));
634 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
635}
636
637void LD2410Component::set_distance_resolution(const char *state) {
638 this->set_config_mode_(true);
639 const uint8_t cmd_value[2] = {find_uint8(DISTANCE_RESOLUTIONS_BY_STR, state), 0x00};
640 this->send_command_(CMD_SET_DISTANCE_RESOLUTION, cmd_value, sizeof(cmd_value));
641 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
642}
643
644void LD2410Component::set_baud_rate(const char *state) {
645 this->set_config_mode_(true);
646 const uint8_t cmd_value[2] = {find_uint8(BAUD_RATES_BY_STR, state), 0x00};
647 this->send_command_(CMD_SET_BAUD_RATE, cmd_value, sizeof(cmd_value));
648 this->set_timeout(200, [this]() { this->restart_(); });
649}
650
651void LD2410Component::set_bluetooth_password(const std::string &password) {
652 if (password.length() != 6) {
653 ESP_LOGE(TAG, "Password must be exactly 6 chars");
654 return;
655 }
656 this->set_config_mode_(true);
657 uint8_t cmd_value[6];
658 std::copy(password.begin(), password.end(), std::begin(cmd_value));
659 this->send_command_(CMD_BT_PASSWORD, cmd_value, sizeof(cmd_value));
660 this->set_config_mode_(false);
661}
662
663void LD2410Component::set_engineering_mode(bool enable) {
664 const uint8_t cmd = enable ? CMD_ENABLE_ENG : CMD_DISABLE_ENG;
665 this->set_config_mode_(true);
666 this->send_command_(cmd, nullptr, 0);
667 this->set_config_mode_(false);
668}
669
670void LD2410Component::factory_reset() {
671 this->set_config_mode_(true);
672 this->send_command_(CMD_RESET, nullptr, 0);
673 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
674}
675
676void LD2410Component::restart_() { this->send_command_(CMD_RESTART, nullptr, 0); }
677
678void LD2410Component::query_parameters_() { this->send_command_(CMD_QUERY, nullptr, 0); }
679
680void LD2410Component::get_version_() { this->send_command_(CMD_QUERY_VERSION, nullptr, 0); }
681
683 const uint8_t cmd_value[2] = {0x01, 0x00};
684 this->send_command_(CMD_QUERY_MAC_ADDRESS, cmd_value, sizeof(cmd_value));
685}
686
687void LD2410Component::get_distance_resolution_() { this->send_command_(CMD_QUERY_DISTANCE_RESOLUTION, nullptr, 0); }
688
689void LD2410Component::query_light_control_() { this->send_command_(CMD_QUERY_LIGHT_CONTROL, nullptr, 0); }
690
691#ifdef USE_NUMBER
692void LD2410Component::set_max_distances_timeout() {
693 if (!this->max_move_distance_gate_number_->has_state() || !this->max_still_distance_gate_number_->has_state() ||
694 !this->timeout_number_->has_state()) {
695 return;
696 }
697 int max_moving_distance_gate_range = static_cast<int>(this->max_move_distance_gate_number_->state);
698 int max_still_distance_gate_range = static_cast<int>(this->max_still_distance_gate_number_->state);
699 int timeout = static_cast<int>(this->timeout_number_->state);
700 uint8_t value[18] = {0x00,
701 0x00,
702 lowbyte(max_moving_distance_gate_range),
703 highbyte(max_moving_distance_gate_range),
704 0x00,
705 0x00,
706 0x01,
707 0x00,
708 lowbyte(max_still_distance_gate_range),
709 highbyte(max_still_distance_gate_range),
710 0x00,
711 0x00,
712 0x02,
713 0x00,
714 lowbyte(timeout),
715 highbyte(timeout),
716 0x00,
717 0x00};
718 this->set_config_mode_(true);
719 this->send_command_(CMD_MAXDIST_DURATION, value, sizeof(value));
720 this->query_parameters_();
721 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
722 this->set_config_mode_(false);
723}
724
725void LD2410Component::set_gate_threshold(uint8_t gate) {
726 number::Number *motionsens = this->gate_move_threshold_numbers_[gate];
727 number::Number *stillsens = this->gate_still_threshold_numbers_[gate];
728
729 if (!motionsens->has_state() || !stillsens->has_state()) {
730 return;
731 }
732 int motion = static_cast<int>(motionsens->state);
733 int still = static_cast<int>(stillsens->state);
734
735 this->set_config_mode_(true);
736 // reference
737 // https://drive.google.com/drive/folders/1p4dhbEJA3YubyIjIIC7wwVsSo8x29Fq-?spm=a2g0o.detail.1000023.17.93465697yFwVxH
738 // Send data: configure the motion sensitivity of distance gate 3 to 40, and the static sensitivity of 40
739 // 00 00 (gate)
740 // 03 00 00 00 (gate number)
741 // 01 00 (motion sensitivity)
742 // 28 00 00 00 (value)
743 // 02 00 (still sensitivtiy)
744 // 28 00 00 00 (value)
745 uint8_t value[18] = {0x00, 0x00, lowbyte(gate), highbyte(gate), 0x00, 0x00,
746 0x01, 0x00, lowbyte(motion), highbyte(motion), 0x00, 0x00,
747 0x02, 0x00, lowbyte(still), highbyte(still), 0x00, 0x00};
748 this->send_command_(CMD_GATE_SENS, value, sizeof(value));
749 this->query_parameters_();
750 this->set_config_mode_(false);
751}
752
753void LD2410Component::set_gate_still_threshold_number(uint8_t gate, number::Number *n) {
754 this->gate_still_threshold_numbers_[gate] = n;
755}
756
757void LD2410Component::set_gate_move_threshold_number(uint8_t gate, number::Number *n) {
758 this->gate_move_threshold_numbers_[gate] = n;
759}
760#endif
761
762void LD2410Component::set_light_out_control() {
763#ifdef USE_NUMBER
764 if (this->light_threshold_number_ != nullptr && this->light_threshold_number_->has_state()) {
765 this->light_threshold_ = static_cast<uint8_t>(this->light_threshold_number_->state);
766 }
767#endif
768#ifdef USE_SELECT
769 if (this->light_function_select_ != nullptr && this->light_function_select_->has_state()) {
770 this->light_function_ = find_uint8(LIGHT_FUNCTIONS_BY_STR, this->light_function_select_->current_option().c_str());
771 }
772 if (this->out_pin_level_select_ != nullptr && this->out_pin_level_select_->has_state()) {
773 this->out_pin_level_ = find_uint8(OUT_PIN_LEVELS_BY_STR, this->out_pin_level_select_->current_option().c_str());
774 }
775#endif
776 this->set_config_mode_(true);
777 uint8_t value[4] = {this->light_function_, this->light_threshold_, this->out_pin_level_, 0x00};
778 this->send_command_(CMD_SET_LIGHT_CONTROL, value, sizeof(value));
779 this->query_light_control_();
780 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
781 this->set_config_mode_(false);
782}
783
784#ifdef USE_SENSOR
785// These could leak memory, but they are only set once prior to 'setup()' and should never be used again.
786void LD2410Component::set_gate_move_sensor(uint8_t gate, sensor::Sensor *s) {
787 this->gate_move_sensors_[gate] = new SensorWithDedup<uint8_t>(s);
788}
789
790void LD2410Component::set_gate_still_sensor(uint8_t gate, sensor::Sensor *s) {
791 this->gate_still_sensors_[gate] = new SensorWithDedup<uint8_t>(s);
792}
793#endif
794
795} // namespace esphome::ld2410
virtual void setup()
Where the component's initialization should happen.
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:445
bool has_state() const
std::array< number::Number *, TOTAL_GATES > gate_still_threshold_numbers_
Definition ld2410.h:127
void set_config_mode_(bool enable)
Definition ld2410.cpp:624
std::array< number::Number *, TOTAL_GATES > gate_move_threshold_numbers_
Definition ld2410.h:126
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_still_sensors_
Definition ld2410.h:131
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_move_sensors_
Definition ld2410.h:130
void send_command_(uint8_t command_str, const uint8_t *command_value, uint8_t command_value_len)
Definition ld2410.cpp:283
uint8_t buffer_data_[MAX_LINE_LENGTH]
Definition ld2410.h:121
Base-class for all numbers.
Definition number.h:29
void publish_state(float state)
Definition number.cpp:31
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:0
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:403
@ 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:595
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:334
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:830
void IRAM_ATTR HOT delay(uint32_t ms)
Definition core.cpp:26