ESPHome 2026.3.0-dev
Loading...
Searching...
No Matches
ld2412.cpp
Go to the documentation of this file.
1#include "ld2412.h"
2
3#ifdef USE_NUMBER
5#endif
6#ifdef USE_SENSOR
8#endif
9
12
13namespace esphome::ld2412 {
14
15static const char *const TAG = "ld2412";
16
27
33
39
40enum OutPinLevel : uint8_t {
43};
44
45/*
46Data Type: 6th byte
47Target states: 9th byte
48 Moving target distance: 10~11th bytes
49 Moving target energy: 12th byte
50 Still target distance: 13~14th bytes
51 Still target energy: 15th byte
52 Detect distance: 16~17th bytes
53*/
68
69enum PeriodicDataValue : uint8_t {
70 HEADER = 0XAA,
71 FOOTER = 0x55,
72 CHECK = 0x00,
73};
74
75enum AckData : uint8_t {
78};
79
80// Memory-efficient lookup tables
81struct StringToUint8 {
82 const char *str;
83 const uint8_t value;
84};
85
86struct Uint8ToString {
87 const uint8_t value;
88 const char *str;
89};
90
91constexpr StringToUint8 BAUD_RATES_BY_STR[] = {
92 {"9600", BAUD_RATE_9600}, {"19200", BAUD_RATE_19200}, {"38400", BAUD_RATE_38400},
93 {"57600", BAUD_RATE_57600}, {"115200", BAUD_RATE_115200}, {"230400", BAUD_RATE_230400},
94 {"256000", BAUD_RATE_256000}, {"460800", BAUD_RATE_460800},
95};
96
97constexpr StringToUint8 DISTANCE_RESOLUTIONS_BY_STR[] = {
100 {"0.75m", DISTANCE_RESOLUTION_0_75},
101};
102
103constexpr Uint8ToString DISTANCE_RESOLUTIONS_BY_UINT[] = {
104 {DISTANCE_RESOLUTION_0_2, "0.2m"},
105 {DISTANCE_RESOLUTION_0_5, "0.5m"},
106 {DISTANCE_RESOLUTION_0_75, "0.75m"},
107};
108
109constexpr StringToUint8 LIGHT_FUNCTIONS_BY_STR[] = {
110 {"off", LIGHT_FUNCTION_OFF},
111 {"below", LIGHT_FUNCTION_BELOW},
112 {"above", LIGHT_FUNCTION_ABOVE},
113};
114
115constexpr Uint8ToString LIGHT_FUNCTIONS_BY_UINT[] = {
116 {LIGHT_FUNCTION_OFF, "off"},
117 {LIGHT_FUNCTION_BELOW, "below"},
118 {LIGHT_FUNCTION_ABOVE, "above"},
119};
120
121constexpr StringToUint8 OUT_PIN_LEVELS_BY_STR[] = {
122 {"low", OUT_PIN_LEVEL_LOW},
123 {"high", OUT_PIN_LEVEL_HIGH},
124};
125
126constexpr Uint8ToString OUT_PIN_LEVELS_BY_UINT[] = {
127 {OUT_PIN_LEVEL_LOW, "low"},
128 {OUT_PIN_LEVEL_HIGH, "high"},
129};
130
131constexpr uint32_t BAUD_RATES[] = {9600, 19200, 38400, 57600, 115200, 230400, 256000, 460800};
132
133// Helper functions for lookups
134template<size_t N> uint8_t find_uint8(const StringToUint8 (&arr)[N], const char *str) {
135 for (const auto &entry : arr) {
136 if (strcmp(str, entry.str) == 0) {
137 return entry.value;
138 }
139 }
140 return 0xFF; // Not found
141}
142
143template<size_t N> const char *find_str(const Uint8ToString (&arr)[N], uint8_t value) {
144 for (const auto &entry : arr) {
145 if (value == entry.value) {
146 return entry.str;
147 }
148 }
149 return ""; // Not found
150}
151
152static constexpr uint8_t DEFAULT_PRESENCE_TIMEOUT = 5; // Default used when number component is not defined
153// Commands
154static constexpr uint8_t CMD_ENABLE_CONF = 0xFF;
155static constexpr uint8_t CMD_DISABLE_CONF = 0xFE;
156static constexpr uint8_t CMD_ENABLE_ENG = 0x62;
157static constexpr uint8_t CMD_DISABLE_ENG = 0x63;
158static constexpr uint8_t CMD_QUERY_BASIC_CONF = 0x12;
159static constexpr uint8_t CMD_BASIC_CONF = 0x02;
160static constexpr uint8_t CMD_QUERY_VERSION = 0xA0;
161static constexpr uint8_t CMD_QUERY_DISTANCE_RESOLUTION = 0x11;
162static constexpr uint8_t CMD_SET_DISTANCE_RESOLUTION = 0x01;
163static constexpr uint8_t CMD_QUERY_LIGHT_CONTROL = 0x1C;
164static constexpr uint8_t CMD_SET_LIGHT_CONTROL = 0x0C;
165static constexpr uint8_t CMD_SET_BAUD_RATE = 0xA1;
166static constexpr uint8_t CMD_QUERY_MAC_ADDRESS = 0xA5;
167static constexpr uint8_t CMD_FACTORY_RESET = 0xA2;
168static constexpr uint8_t CMD_RESTART = 0xA3;
169static constexpr uint8_t CMD_BLUETOOTH = 0xA4;
170static constexpr uint8_t CMD_DYNAMIC_BACKGROUND_CORRECTION = 0x0B;
171static constexpr uint8_t CMD_QUERY_DYNAMIC_BACKGROUND_CORRECTION = 0x1B;
172static constexpr uint8_t CMD_MOTION_GATE_SENS = 0x03;
173static constexpr uint8_t CMD_QUERY_MOTION_GATE_SENS = 0x13;
174static constexpr uint8_t CMD_STATIC_GATE_SENS = 0x04;
175static constexpr uint8_t CMD_QUERY_STATIC_GATE_SENS = 0x14;
176static constexpr uint8_t CMD_NONE = 0x00;
177// Commands values
178static constexpr uint8_t CMD_MAX_MOVE_VALUE = 0x00;
179static constexpr uint8_t CMD_MAX_STILL_VALUE = 0x01;
180static constexpr uint8_t CMD_DURATION_VALUE = 0x02;
181// Bitmasks for target states
182static constexpr uint8_t MOVE_BITMASK = 0x01;
183static constexpr uint8_t STILL_BITMASK = 0x02;
184// Header & Footer size
185static constexpr uint8_t HEADER_FOOTER_SIZE = 4;
186// Command Header & Footer
187static constexpr uint8_t CMD_FRAME_HEADER[HEADER_FOOTER_SIZE] = {0xFD, 0xFC, 0xFB, 0xFA};
188static constexpr uint8_t CMD_FRAME_FOOTER[HEADER_FOOTER_SIZE] = {0x04, 0x03, 0x02, 0x01};
189// Data Header & Footer
190static constexpr uint8_t DATA_FRAME_HEADER[HEADER_FOOTER_SIZE] = {0xF4, 0xF3, 0xF2, 0xF1};
191static constexpr uint8_t DATA_FRAME_FOOTER[HEADER_FOOTER_SIZE] = {0xF8, 0xF7, 0xF6, 0xF5};
192// MAC address the module uses when Bluetooth is disabled
193static constexpr uint8_t NO_MAC[] = {0x08, 0x05, 0x04, 0x03, 0x02, 0x01};
194
195static inline bool validate_header_footer(const uint8_t *header_footer, const uint8_t *buffer) {
196 return std::memcmp(header_footer, buffer, HEADER_FOOTER_SIZE) == 0;
197}
198
199void LD2412Component::dump_config() {
200 char mac_s[18];
201 char version_s[20];
202 const char *mac_str = ld24xx::format_mac_str(this->mac_address_, mac_s);
203 ld24xx::format_version_str(this->version_, version_s);
204 ESP_LOGCONFIG(TAG,
205 "LD2412:\n"
206 " Firmware version: %s\n"
207 " MAC address: %s",
208 version_s, mac_str);
209#ifdef USE_BINARY_SENSOR
210 ESP_LOGCONFIG(TAG, "Binary Sensors:");
211 LOG_BINARY_SENSOR(" ", "DynamicBackgroundCorrectionStatus",
212 this->dynamic_background_correction_status_binary_sensor_);
213 LOG_BINARY_SENSOR(" ", "MovingTarget", this->moving_target_binary_sensor_);
214 LOG_BINARY_SENSOR(" ", "StillTarget", this->still_target_binary_sensor_);
215 LOG_BINARY_SENSOR(" ", "Target", this->target_binary_sensor_);
216#endif
217#ifdef USE_SENSOR
218 ESP_LOGCONFIG(TAG, "Sensors:");
219 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "Light", this->light_sensor_);
220 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "DetectionDistance", this->detection_distance_sensor_);
221 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "MovingTargetDistance", this->moving_target_distance_sensor_);
222 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "MovingTargetEnergy", this->moving_target_energy_sensor_);
223 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "StillTargetDistance", this->still_target_distance_sensor_);
224 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "StillTargetEnergy", this->still_target_energy_sensor_);
225 for (auto &s : this->gate_still_sensors_) {
226 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "GateStill", s);
227 }
228 for (auto &s : this->gate_move_sensors_) {
229 LOG_SENSOR_WITH_DEDUP_SAFE(" ", "GateMove", s);
230 }
231#endif
232#ifdef USE_TEXT_SENSOR
233 ESP_LOGCONFIG(TAG, "Text Sensors:");
234 LOG_TEXT_SENSOR(" ", "MAC address", this->mac_text_sensor_);
235 LOG_TEXT_SENSOR(" ", "Version", this->version_text_sensor_);
236#endif
237#ifdef USE_NUMBER
238 ESP_LOGCONFIG(TAG, "Numbers:");
239 LOG_NUMBER(" ", "LightThreshold", this->light_threshold_number_);
240 LOG_NUMBER(" ", "MaxDistanceGate", this->max_distance_gate_number_);
241 LOG_NUMBER(" ", "MinDistanceGate", this->min_distance_gate_number_);
242 LOG_NUMBER(" ", "Timeout", this->timeout_number_);
243 for (number::Number *n : this->gate_move_threshold_numbers_) {
244 LOG_NUMBER(" ", "Move Thresholds", n);
245 }
246 for (number::Number *n : this->gate_still_threshold_numbers_) {
247 LOG_NUMBER(" ", "Still Thresholds", n);
248 }
249#endif
250#ifdef USE_SELECT
251 ESP_LOGCONFIG(TAG, "Selects:");
252 LOG_SELECT(" ", "BaudRate", this->baud_rate_select_);
253 LOG_SELECT(" ", "DistanceResolution", this->distance_resolution_select_);
254 LOG_SELECT(" ", "LightFunction", this->light_function_select_);
255 LOG_SELECT(" ", "OutPinLevel", this->out_pin_level_select_);
256#endif
257#ifdef USE_SWITCH
258 ESP_LOGCONFIG(TAG, "Switches:");
259 LOG_SWITCH(" ", "Bluetooth", this->bluetooth_switch_);
260 LOG_SWITCH(" ", "EngineeringMode", this->engineering_mode_switch_);
261#endif
262#ifdef USE_BUTTON
263 ESP_LOGCONFIG(TAG, "Buttons:");
264 LOG_BUTTON(" ", "FactoryReset", this->factory_reset_button_);
265 LOG_BUTTON(" ", "Query", this->query_button_);
266 LOG_BUTTON(" ", "Restart", this->restart_button_);
267 LOG_BUTTON(" ", "StartDynamicBackgroundCorrection", this->start_dynamic_background_correction_button_);
268#endif
269}
270
272 ESP_LOGCONFIG(TAG, "Running setup");
273 this->read_all_info();
274}
275
276void LD2412Component::read_all_info() {
277 this->set_config_mode_(true);
278 this->get_version_();
279 delay(10); // NOLINT
280 this->get_mac_();
281 delay(10); // NOLINT
283 delay(10); // NOLINT
284 this->query_parameters_();
285 delay(10); // NOLINT
287 delay(10); // NOLINT
288 this->query_light_control_();
289 delay(10); // NOLINT
290#ifdef USE_NUMBER
291 this->get_gate_threshold();
292 delay(10); // NOLINT
293#endif
294 this->set_config_mode_(false);
295#ifdef USE_SELECT
296 if (this->baud_rate_select_ != nullptr) {
297 if (auto index = ld24xx::find_index(BAUD_RATES, this->parent_->get_baud_rate())) {
298 this->baud_rate_select_->publish_state(*index);
299 }
300 }
301#endif
302}
303
304void LD2412Component::restart_and_read_all_info() {
305 this->set_config_mode_(true);
306 this->restart_();
307 this->set_timeout(1000, [this]() { this->read_all_info(); });
308}
309
310void LD2412Component::loop() {
311 // Read all available bytes in batches to reduce UART call overhead.
312 size_t avail = this->available();
313 uint8_t buf[MAX_LINE_LENGTH];
314 while (avail > 0) {
315 size_t to_read = std::min(avail, sizeof(buf));
316 if (!this->read_array(buf, to_read)) {
317 break;
318 }
319 avail -= to_read;
320
321 for (size_t i = 0; i < to_read; i++) {
322 this->readline_(buf[i]);
323 }
324 }
325}
326
327void LD2412Component::send_command_(uint8_t command, const uint8_t *command_value, uint8_t command_value_len) {
328 ESP_LOGV(TAG, "Sending COMMAND %02X", command);
329 // frame header bytes
330 this->write_array(CMD_FRAME_HEADER, HEADER_FOOTER_SIZE);
331 // length bytes
332 uint8_t len = 2;
333 if (command_value != nullptr) {
334 len += command_value_len;
335 }
336 // 2 length bytes (low, high) + 2 command bytes (low, high)
337 uint8_t len_cmd[] = {len, 0x00, command, 0x00};
338 this->write_array(len_cmd, sizeof(len_cmd));
339
340 // command value bytes
341 if (command_value != nullptr) {
342 this->write_array(command_value, command_value_len);
343 }
344 // frame footer bytes
345 this->write_array(CMD_FRAME_FOOTER, HEADER_FOOTER_SIZE);
346
347 if (command != CMD_ENABLE_CONF && command != CMD_DISABLE_CONF) {
348 delay(30); // NOLINT
349 }
350 delay(20); // NOLINT
351}
352
354 // 4 frame header bytes + 2 length bytes + 1 data end byte + 1 crc byte + 4 frame footer bytes
355 // data header=0xAA, data footer=0x55, crc=0x00
356 if (this->buffer_pos_ < 12 || !ld2412::validate_header_footer(DATA_FRAME_HEADER, this->buffer_data_) ||
357 this->buffer_data_[7] != HEADER || this->buffer_data_[this->buffer_pos_ - 6] != FOOTER) {
358 return;
359 }
360 /*
361 Data Type: 7th
362 0x01: Engineering mode
363 0x02: Normal mode
364 */
365 bool engineering_mode = this->buffer_data_[DATA_TYPES] == 0x01;
366#ifdef USE_SWITCH
367 if (this->engineering_mode_switch_ != nullptr) {
368 this->engineering_mode_switch_->publish_state(engineering_mode);
369 }
370#endif
371
372#ifdef USE_BINARY_SENSOR
373 /*
374 Target states: 9th
375 0x00 = No target
376 0x01 = Moving targets
377 0x02 = Still targets
378 0x03 = Moving+Still targets
379 */
380 char target_state = this->buffer_data_[TARGET_STATES];
381 if (this->target_binary_sensor_ != nullptr) {
382 this->target_binary_sensor_->publish_state(target_state != 0x00);
383 }
384 if (this->moving_target_binary_sensor_ != nullptr) {
385 this->moving_target_binary_sensor_->publish_state(target_state & MOVE_BITMASK);
386 }
387 if (this->still_target_binary_sensor_ != nullptr) {
388 this->still_target_binary_sensor_->publish_state(target_state & STILL_BITMASK);
389 }
390#endif
391 /*
392 Moving target distance: 10~11th bytes
393 Moving target energy: 12th byte
394 Still target distance: 13~14th bytes
395 Still target energy: 15th byte
396 Detect distance: 16~17th bytes
397 */
398#ifdef USE_SENSOR
399 SAFE_PUBLISH_SENSOR(this->moving_target_distance_sensor_,
401 SAFE_PUBLISH_SENSOR(this->moving_target_energy_sensor_, this->buffer_data_[MOVING_ENERGY])
402 SAFE_PUBLISH_SENSOR(this->still_target_distance_sensor_,
404 SAFE_PUBLISH_SENSOR(this->still_target_energy_sensor_, this->buffer_data_[STILL_ENERGY])
405 if (this->detection_distance_sensor_ != nullptr) {
406 int new_detect_distance = 0;
407 if (target_state != 0x00 && (target_state & MOVE_BITMASK)) {
408 new_detect_distance =
409 encode_uint16(this->buffer_data_[MOVING_TARGET_HIGH], this->buffer_data_[MOVING_TARGET_LOW]);
410 } else if (target_state != 0x00) {
411 new_detect_distance = encode_uint16(this->buffer_data_[STILL_TARGET_HIGH], this->buffer_data_[STILL_TARGET_LOW]);
412 }
413 this->detection_distance_sensor_->publish_state_if_not_dup(new_detect_distance);
414 }
415 if (engineering_mode) {
416 /*
417 Moving distance range: 18th byte
418 Still distance range: 19th byte
419 Moving energy: 20~28th bytes
420 */
421 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
422 SAFE_PUBLISH_SENSOR(this->gate_move_sensors_[i], this->buffer_data_[MOVING_SENSOR_START + i])
423 }
424 /*
425 Still energy: 29~37th bytes
426 */
427 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
428 SAFE_PUBLISH_SENSOR(this->gate_still_sensors_[i], this->buffer_data_[STILL_SENSOR_START + i])
429 }
430 /*
431 Light sensor: 38th bytes
432 */
433 SAFE_PUBLISH_SENSOR(this->light_sensor_, this->buffer_data_[LIGHT_SENSOR])
434 } else {
435 for (auto &gate_move_sensor : this->gate_move_sensors_) {
436 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_move_sensor)
437 }
438 for (auto &gate_still_sensor : this->gate_still_sensors_) {
439 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_still_sensor)
440 }
441 SAFE_PUBLISH_SENSOR_UNKNOWN(this->light_sensor_)
442 }
443#endif
444 // the radar module won't tell us when it's done, so we just have to keep polling...
446 this->set_config_mode_(true);
448 this->set_config_mode_(false);
449 }
450}
451
452#ifdef USE_NUMBER
453std::function<void(void)> set_number_value(number::Number *n, float value) {
454 if (n != nullptr && (!n->has_state() || n->state != value)) {
455 n->state = value;
456 return [n, value]() { n->publish_state(value); };
457 }
458 return []() {};
459}
460#endif
461
463 ESP_LOGV(TAG, "Handling ACK DATA for COMMAND %02X", this->buffer_data_[COMMAND]);
464 if (this->buffer_pos_ < 10) {
465 ESP_LOGW(TAG, "Invalid length");
466 return true;
467 }
468 if (!ld2412::validate_header_footer(CMD_FRAME_HEADER, this->buffer_data_)) {
469 char hex_buf[format_hex_pretty_size(HEADER_FOOTER_SIZE)];
470 ESP_LOGW(TAG, "Invalid header: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, HEADER_FOOTER_SIZE));
471 return true;
472 }
473 if (this->buffer_data_[COMMAND_STATUS] != 0x01) {
474 ESP_LOGW(TAG, "Invalid status");
475 return true;
476 }
477 if (this->buffer_data_[8] || this->buffer_data_[9]) {
478 ESP_LOGW(TAG, "Invalid command: %02X, %02X", this->buffer_data_[8], this->buffer_data_[9]);
479 return true;
480 }
481
482 switch (this->buffer_data_[COMMAND]) {
483 case CMD_ENABLE_CONF:
484 ESP_LOGV(TAG, "Enable conf");
485 break;
486
487 case CMD_DISABLE_CONF:
488 ESP_LOGV(TAG, "Disabled conf");
489 break;
490
491 case CMD_SET_BAUD_RATE:
492 ESP_LOGV(TAG, "Baud rate change");
493#ifdef USE_SELECT
494 if (this->baud_rate_select_ != nullptr) {
495 auto baud = this->baud_rate_select_->current_option();
496 ESP_LOGW(TAG, "Change baud rate to %.*s and reinstall", (int) baud.size(), baud.c_str());
497 }
498#endif
499 break;
500
501 case CMD_QUERY_VERSION: {
502 std::memcpy(this->version_, &this->buffer_data_[12], sizeof(this->version_));
503 char version_s[20];
504 ld24xx::format_version_str(this->version_, version_s);
505 ESP_LOGV(TAG, "Firmware version: %s", version_s);
506#ifdef USE_TEXT_SENSOR
507 if (this->version_text_sensor_ != nullptr) {
508 this->version_text_sensor_->publish_state(version_s);
509 }
510#endif
511 break;
512 }
513 case CMD_QUERY_DISTANCE_RESOLUTION: {
514 const auto *distance_resolution = find_str(DISTANCE_RESOLUTIONS_BY_UINT, this->buffer_data_[10]);
515 ESP_LOGV(TAG, "Distance resolution: %s", distance_resolution);
516#ifdef USE_SELECT
517 if (this->distance_resolution_select_ != nullptr) {
518 this->distance_resolution_select_->publish_state(distance_resolution);
519 }
520#endif
521 break;
522 }
523
524 case CMD_QUERY_LIGHT_CONTROL: {
525 this->light_function_ = this->buffer_data_[10];
526 this->light_threshold_ = this->buffer_data_[11];
527 const auto *light_function_str = find_str(LIGHT_FUNCTIONS_BY_UINT, this->light_function_);
528 ESP_LOGV(TAG, "Light function: %s, threshold: %u", light_function_str, this->light_threshold_);
529#ifdef USE_SELECT
530 if (this->light_function_select_ != nullptr) {
531 this->light_function_select_->publish_state(light_function_str);
532 }
533#endif
534#ifdef USE_NUMBER
535 if (this->light_threshold_number_ != nullptr) {
536 this->light_threshold_number_->publish_state(static_cast<float>(this->light_threshold_));
537 }
538#endif
539 break;
540 }
541
542 case CMD_QUERY_MAC_ADDRESS: {
543 if (this->buffer_pos_ < 20) {
544 return false;
545 }
546
547 this->bluetooth_on_ = std::memcmp(&this->buffer_data_[10], NO_MAC, sizeof(NO_MAC)) != 0;
548 if (this->bluetooth_on_) {
549 std::memcpy(this->mac_address_, &this->buffer_data_[10], sizeof(this->mac_address_));
550 }
551
552 char mac_s[18];
553 const char *mac_str = ld24xx::format_mac_str(this->mac_address_, mac_s);
554 ESP_LOGV(TAG, "MAC address: %s", mac_str);
555#ifdef USE_TEXT_SENSOR
556 if (this->mac_text_sensor_ != nullptr) {
557 this->mac_text_sensor_->publish_state(mac_str);
558 }
559#endif
560#ifdef USE_SWITCH
561 if (this->bluetooth_switch_ != nullptr) {
562 this->bluetooth_switch_->publish_state(this->bluetooth_on_);
563 }
564#endif
565 break;
566 }
567
568 case CMD_SET_DISTANCE_RESOLUTION:
569 ESP_LOGV(TAG, "Handled set distance resolution command");
570 break;
571
572 case CMD_QUERY_DYNAMIC_BACKGROUND_CORRECTION: {
573 ESP_LOGV(TAG, "Handled query dynamic background correction");
574 bool dynamic_background_correction_active = (this->buffer_data_[10] != 0x00);
575#ifdef USE_BINARY_SENSOR
576 if (this->dynamic_background_correction_status_binary_sensor_ != nullptr) {
577 this->dynamic_background_correction_status_binary_sensor_->publish_state(dynamic_background_correction_active);
578 }
579#endif
580 this->dynamic_background_correction_active_ = dynamic_background_correction_active;
581 break;
582 }
583
584 case CMD_BLUETOOTH:
585 ESP_LOGV(TAG, "Handled bluetooth command");
586 break;
587
588 case CMD_SET_LIGHT_CONTROL:
589 ESP_LOGV(TAG, "Handled set light control command");
590 break;
591
592 case CMD_QUERY_MOTION_GATE_SENS: {
593#ifdef USE_NUMBER
594 std::vector<std::function<void(void)>> updates;
595 updates.reserve(this->gate_still_threshold_numbers_.size());
596 for (size_t i = 0; i < this->gate_still_threshold_numbers_.size(); i++) {
597 updates.push_back(set_number_value(this->gate_move_threshold_numbers_[i], this->buffer_data_[10 + i]));
598 }
599 for (auto &update : updates) {
600 update();
601 }
602#endif
603 break;
604 }
605
606 case CMD_QUERY_STATIC_GATE_SENS: {
607#ifdef USE_NUMBER
608 std::vector<std::function<void(void)>> updates;
609 updates.reserve(this->gate_still_threshold_numbers_.size());
610 for (size_t i = 0; i < this->gate_still_threshold_numbers_.size(); i++) {
611 updates.push_back(set_number_value(this->gate_still_threshold_numbers_[i], this->buffer_data_[10 + i]));
612 }
613 for (auto &update : updates) {
614 update();
615 }
616#endif
617 break;
618 }
619
620 case CMD_QUERY_BASIC_CONF: // Query parameters response
621 {
622#ifdef USE_NUMBER
623 /*
624 Moving distance range: 9th byte
625 Still distance range: 10th byte
626 */
627 std::vector<std::function<void(void)>> updates;
628 updates.push_back(set_number_value(this->min_distance_gate_number_, this->buffer_data_[10]));
629 updates.push_back(set_number_value(this->max_distance_gate_number_, this->buffer_data_[11] - 1));
630 ESP_LOGV(TAG, "min_distance_gate_number_: %u, max_distance_gate_number_ %u", this->buffer_data_[10],
631 this->buffer_data_[11]);
632 /*
633 None Duration: 11~12th bytes
634 */
635 updates.push_back(
636 set_number_value(this->timeout_number_, encode_uint16(this->buffer_data_[13], this->buffer_data_[12])));
637 ESP_LOGV(TAG, "timeout_number_: %u", encode_uint16(this->buffer_data_[13], this->buffer_data_[12]));
638 /*
639 Output pin configuration: 13th bytes
640 */
641 this->out_pin_level_ = this->buffer_data_[14];
642#ifdef USE_SELECT
643 const auto *out_pin_level_str = find_str(OUT_PIN_LEVELS_BY_UINT, this->out_pin_level_);
644 if (this->out_pin_level_select_ != nullptr) {
645 this->out_pin_level_select_->publish_state(out_pin_level_str);
646 }
647#endif
648 for (auto &update : updates) {
649 update();
650 }
651#endif
652 } break;
653 default:
654 break;
655 }
656
657 return true;
658}
659
661 if (readch < 0) {
662 return; // No data available
663 }
664 if (this->buffer_pos_ < HEADER_FOOTER_SIZE && readch != DATA_FRAME_HEADER[this->buffer_pos_] &&
665 readch != CMD_FRAME_HEADER[this->buffer_pos_]) {
666 this->buffer_pos_ = 0;
667 return;
668 }
669 if (this->buffer_pos_ < MAX_LINE_LENGTH - 1) {
670 this->buffer_data_[this->buffer_pos_++] = readch;
671 this->buffer_data_[this->buffer_pos_] = 0;
672 } else {
673 // We should never get here, but just in case...
674 ESP_LOGW(TAG, "Max command length exceeded; ignoring");
675 this->buffer_pos_ = 0;
676 }
677 if (this->buffer_pos_ < 4) {
678 return; // Not enough data to process yet
679 }
680 if (ld2412::validate_header_footer(DATA_FRAME_FOOTER, &this->buffer_data_[this->buffer_pos_ - 4])) {
681#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
682 char hex_buf[format_hex_pretty_size(MAX_LINE_LENGTH)];
683 ESP_LOGV(TAG, "Handling Periodic Data: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, this->buffer_pos_));
684#endif
685 this->handle_periodic_data_();
686 this->buffer_pos_ = 0; // Reset position index for next message
687 } else if (ld2412::validate_header_footer(CMD_FRAME_FOOTER, &this->buffer_data_[this->buffer_pos_ - 4])) {
688#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
689 char hex_buf[format_hex_pretty_size(MAX_LINE_LENGTH)];
690 ESP_LOGV(TAG, "Handling Ack Data: %s", format_hex_pretty_to(hex_buf, this->buffer_data_, this->buffer_pos_));
691#endif
692 if (this->handle_ack_data_()) {
693 this->buffer_pos_ = 0; // Reset position index for next message
694 } else {
695 ESP_LOGV(TAG, "Ack Data incomplete");
696 }
697 }
698}
699
701 const uint8_t cmd = enable ? CMD_ENABLE_CONF : CMD_DISABLE_CONF;
702 const uint8_t cmd_value[2] = {0x01, 0x00};
703 this->send_command_(cmd, enable ? cmd_value : nullptr, sizeof(cmd_value));
704}
705
706void LD2412Component::set_bluetooth(bool enable) {
707 this->set_config_mode_(true);
708 const uint8_t cmd_value[2] = {enable ? (uint8_t) 0x01 : (uint8_t) 0x00, 0x00};
709 this->send_command_(CMD_BLUETOOTH, cmd_value, sizeof(cmd_value));
710 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
711}
712
713void LD2412Component::set_distance_resolution(const char *state) {
714 this->set_config_mode_(true);
715 const uint8_t cmd_value[6] = {find_uint8(DISTANCE_RESOLUTIONS_BY_STR, state), 0x00, 0x00, 0x00, 0x00, 0x00};
716 this->send_command_(CMD_SET_DISTANCE_RESOLUTION, cmd_value, sizeof(cmd_value));
717 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
718}
719
720void LD2412Component::set_baud_rate(const char *state) {
721 this->set_config_mode_(true);
722 const uint8_t cmd_value[2] = {find_uint8(BAUD_RATES_BY_STR, state), 0x00};
723 this->send_command_(CMD_SET_BAUD_RATE, cmd_value, sizeof(cmd_value));
724 this->set_timeout(200, [this]() { this->restart_(); });
725}
726
728 this->send_command_(CMD_QUERY_DYNAMIC_BACKGROUND_CORRECTION, nullptr, 0);
729}
730
731void LD2412Component::start_dynamic_background_correction() {
733 return; // Already in progress
734 }
735#ifdef USE_BINARY_SENSOR
736 if (this->dynamic_background_correction_status_binary_sensor_ != nullptr) {
737 this->dynamic_background_correction_status_binary_sensor_->publish_state(true);
738 }
739#endif
741 this->set_config_mode_(true);
742 this->send_command_(CMD_DYNAMIC_BACKGROUND_CORRECTION, nullptr, 0);
743 this->set_config_mode_(false);
744}
745
746void LD2412Component::set_engineering_mode(bool enable) {
747 const uint8_t cmd = enable ? CMD_ENABLE_ENG : CMD_DISABLE_ENG;
748 this->set_config_mode_(true);
749 this->send_command_(cmd, nullptr, 0);
750 this->set_config_mode_(false);
751}
752
753void LD2412Component::factory_reset() {
754 this->set_config_mode_(true);
755 this->send_command_(CMD_FACTORY_RESET, nullptr, 0);
756 this->set_timeout(2000, [this]() { this->restart_and_read_all_info(); });
757}
758
759void LD2412Component::restart_() { this->send_command_(CMD_RESTART, nullptr, 0); }
760
761void LD2412Component::query_parameters_() { this->send_command_(CMD_QUERY_BASIC_CONF, nullptr, 0); }
762
763void LD2412Component::get_version_() { this->send_command_(CMD_QUERY_VERSION, nullptr, 0); }
764
766 const uint8_t cmd_value[2] = {0x01, 0x00};
767 this->send_command_(CMD_QUERY_MAC_ADDRESS, cmd_value, sizeof(cmd_value));
768}
769
770void LD2412Component::get_distance_resolution_() { this->send_command_(CMD_QUERY_DISTANCE_RESOLUTION, nullptr, 0); }
771
772void LD2412Component::query_light_control_() { this->send_command_(CMD_QUERY_LIGHT_CONTROL, nullptr, 0); }
773
774void LD2412Component::set_basic_config() {
775#ifdef USE_NUMBER
776 if (!this->min_distance_gate_number_->has_state() || !this->max_distance_gate_number_->has_state() ||
777 !this->timeout_number_->has_state()) {
778 return;
779 }
780#endif
781#ifdef USE_SELECT
782 if (!this->out_pin_level_select_->has_state()) {
783 return;
784 }
785#endif
786
787 uint8_t value[5] = {
788#ifdef USE_NUMBER
789 lowbyte(static_cast<int>(this->min_distance_gate_number_->state)),
790 lowbyte(static_cast<int>(this->max_distance_gate_number_->state) + 1),
791 lowbyte(static_cast<int>(this->timeout_number_->state)),
792 highbyte(static_cast<int>(this->timeout_number_->state)),
793#else
794 1, TOTAL_GATES, DEFAULT_PRESENCE_TIMEOUT, 0,
795#endif
796#ifdef USE_SELECT
797 find_uint8(OUT_PIN_LEVELS_BY_STR, this->out_pin_level_select_->current_option().c_str()),
798#else
799 0x01, // Default value if not using select
800#endif
801 };
802 this->set_config_mode_(true);
803 this->send_command_(CMD_BASIC_CONF, value, sizeof(value));
804 this->set_config_mode_(false);
805}
806
807#ifdef USE_NUMBER
808void LD2412Component::set_gate_threshold() {
809 if (this->gate_move_threshold_numbers_.empty() && this->gate_still_threshold_numbers_.empty()) {
810 return; // No gate threshold numbers set; nothing to do here
811 }
812 uint8_t value[TOTAL_GATES] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
813 this->set_config_mode_(true);
814 if (!this->gate_move_threshold_numbers_.empty()) {
815 for (size_t i = 0; i < this->gate_move_threshold_numbers_.size(); i++) {
816 value[i] = lowbyte(static_cast<int>(this->gate_move_threshold_numbers_[i]->state));
817 }
818 this->send_command_(CMD_MOTION_GATE_SENS, value, sizeof(value));
819 }
820 if (!this->gate_still_threshold_numbers_.empty()) {
821 for (size_t i = 0; i < this->gate_still_threshold_numbers_.size(); i++) {
822 value[i] = lowbyte(static_cast<int>(this->gate_still_threshold_numbers_[i]->state));
823 }
824 this->send_command_(CMD_STATIC_GATE_SENS, value, sizeof(value));
825 }
826 this->set_config_mode_(false);
827}
828
829void LD2412Component::get_gate_threshold() {
830 this->send_command_(CMD_QUERY_MOTION_GATE_SENS, nullptr, 0);
831 this->send_command_(CMD_QUERY_STATIC_GATE_SENS, nullptr, 0);
832}
833
834void LD2412Component::set_gate_still_threshold_number(uint8_t gate, number::Number *n) {
835 this->gate_still_threshold_numbers_[gate] = n;
836}
837
838void LD2412Component::set_gate_move_threshold_number(uint8_t gate, number::Number *n) {
839 this->gate_move_threshold_numbers_[gate] = n;
840}
841#endif
842
843void LD2412Component::set_light_out_control() {
844#ifdef USE_NUMBER
845 if (this->light_threshold_number_ != nullptr && this->light_threshold_number_->has_state()) {
846 this->light_threshold_ = static_cast<uint8_t>(this->light_threshold_number_->state);
847 }
848#endif
849#ifdef USE_SELECT
850 if (this->light_function_select_ != nullptr && this->light_function_select_->has_state()) {
851 this->light_function_ = find_uint8(LIGHT_FUNCTIONS_BY_STR, this->light_function_select_->current_option().c_str());
852 }
853#endif
854 uint8_t value[2] = {this->light_function_, this->light_threshold_};
855 this->set_config_mode_(true);
856 this->send_command_(CMD_SET_LIGHT_CONTROL, value, sizeof(value));
857 this->query_light_control_();
858 this->set_timeout(200, [this]() { this->restart_and_read_all_info(); });
859}
860
861#ifdef USE_SENSOR
862// These could leak memory, but they are only set once prior to 'setup()' and should never be used again.
863void LD2412Component::set_gate_move_sensor(uint8_t gate, sensor::Sensor *s) {
864 this->gate_move_sensors_[gate] = new SensorWithDedup<uint8_t>(s);
865}
866void LD2412Component::set_gate_still_sensor(uint8_t gate, sensor::Sensor *s) {
867 this->gate_still_sensors_[gate] = new SensorWithDedup<uint8_t>(s);
868}
869#endif
870
871} // namespace esphome::ld2412
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
void set_config_mode_(bool enable)
Definition ld2412.cpp:700
std::array< number::Number *, TOTAL_GATES > gate_move_threshold_numbers_
Definition ld2412.h:130
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_move_sensors_
Definition ld2412.h:134
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_still_sensors_
Definition ld2412.h:135
std::array< number::Number *, TOTAL_GATES > gate_still_threshold_numbers_
Definition ld2412.h:131
uint8_t buffer_data_[MAX_LINE_LENGTH]
Definition ld2412.h:124
void send_command_(uint8_t command_str, const uint8_t *command_value, uint8_t command_value_len)
Definition ld2412.cpp:327
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
uint8_t find_uint8(const StringToUint8(&arr)[N], const char *str)
Definition ld2412.cpp:134
constexpr Uint8ToString OUT_PIN_LEVELS_BY_UINT[]
Definition ld2412.cpp:126
std::function< void(void)> set_number_value(number::Number *n, float value)
Definition ld2412.cpp:453
constexpr Uint8ToString LIGHT_FUNCTIONS_BY_UINT[]
Definition ld2412.cpp:115
@ DISTANCE_RESOLUTION_0_5
Definition ld2412.cpp:30
@ DISTANCE_RESOLUTION_0_2
Definition ld2412.cpp:29
@ DISTANCE_RESOLUTION_0_75
Definition ld2412.cpp:31
const char * find_str(const Uint8ToString(&arr)[N], uint8_t value)
Definition ld2412.cpp:143
constexpr uint32_t BAUD_RATES[]
Definition ld2412.cpp:131
constexpr StringToUint8 BAUD_RATES_BY_STR[]
Definition ld2412.cpp:91
constexpr StringToUint8 LIGHT_FUNCTIONS_BY_STR[]
Definition ld2412.cpp:109
constexpr StringToUint8 DISTANCE_RESOLUTIONS_BY_STR[]
Definition ld2412.cpp:97
constexpr Uint8ToString DISTANCE_RESOLUTIONS_BY_UINT[]
Definition ld2412.cpp:103
constexpr StringToUint8 OUT_PIN_LEVELS_BY_STR[]
Definition ld2412.cpp:121
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