15static const char *
const TAG =
"ld2412";
131constexpr uint32_t
BAUD_RATES[] = {9600, 19200, 38400, 57600, 115200, 230400, 256000, 460800};
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) {
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) {
152static constexpr uint8_t DEFAULT_PRESENCE_TIMEOUT = 5;
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;
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;
182static constexpr uint8_t MOVE_BITMASK = 0x01;
183static constexpr uint8_t STILL_BITMASK = 0x02;
185static constexpr uint8_t HEADER_FOOTER_SIZE = 4;
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};
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};
193static constexpr uint8_t NO_MAC[] = {0x08, 0x05, 0x04, 0x03, 0x02, 0x01};
195static inline int two_byte_to_int(
char firstbyte,
char secondbyte) {
return (int16_t) (secondbyte << 8) + firstbyte; }
197static inline bool validate_header_footer(
const uint8_t *header_footer,
const uint8_t *buffer) {
198 return std::memcmp(header_footer, buffer, HEADER_FOOTER_SIZE) == 0;
201void LD2412Component::dump_config() {
208 " Firmware version: %s\n"
211#ifdef USE_BINARY_SENSOR
212 ESP_LOGCONFIG(TAG,
"Binary Sensors:");
213 LOG_BINARY_SENSOR(
" ",
"DynamicBackgroundCorrectionStatus",
214 this->dynamic_background_correction_status_binary_sensor_);
215 LOG_BINARY_SENSOR(
" ",
"MovingTarget", this->moving_target_binary_sensor_);
216 LOG_BINARY_SENSOR(
" ",
"StillTarget", this->still_target_binary_sensor_);
217 LOG_BINARY_SENSOR(
" ",
"Target", this->target_binary_sensor_);
220 ESP_LOGCONFIG(TAG,
"Sensors:");
221 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"Light", this->light_sensor_);
222 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"DetectionDistance", this->detection_distance_sensor_);
223 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"MovingTargetDistance", this->moving_target_distance_sensor_);
224 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"MovingTargetEnergy", this->moving_target_energy_sensor_);
225 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"StillTargetDistance", this->still_target_distance_sensor_);
226 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"StillTargetEnergy", this->still_target_energy_sensor_);
228 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"GateStill", s);
231 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"GateMove", s);
234#ifdef USE_TEXT_SENSOR
235 ESP_LOGCONFIG(TAG,
"Text Sensors:");
236 LOG_TEXT_SENSOR(
" ",
"MAC address", this->mac_text_sensor_);
237 LOG_TEXT_SENSOR(
" ",
"Version", this->version_text_sensor_);
240 ESP_LOGCONFIG(TAG,
"Numbers:");
241 LOG_NUMBER(
" ",
"LightThreshold", this->light_threshold_number_);
242 LOG_NUMBER(
" ",
"MaxDistanceGate", this->max_distance_gate_number_);
243 LOG_NUMBER(
" ",
"MinDistanceGate", this->min_distance_gate_number_);
244 LOG_NUMBER(
" ",
"Timeout", this->timeout_number_);
246 LOG_NUMBER(
" ",
"Move Thresholds", n);
249 LOG_NUMBER(
" ",
"Still Thresholds", n);
253 ESP_LOGCONFIG(TAG,
"Selects:");
254 LOG_SELECT(
" ",
"BaudRate", this->baud_rate_select_);
255 LOG_SELECT(
" ",
"DistanceResolution", this->distance_resolution_select_);
256 LOG_SELECT(
" ",
"LightFunction", this->light_function_select_);
257 LOG_SELECT(
" ",
"OutPinLevel", this->out_pin_level_select_);
260 ESP_LOGCONFIG(TAG,
"Switches:");
261 LOG_SWITCH(
" ",
"Bluetooth", this->bluetooth_switch_);
262 LOG_SWITCH(
" ",
"EngineeringMode", this->engineering_mode_switch_);
265 ESP_LOGCONFIG(TAG,
"Buttons:");
266 LOG_BUTTON(
" ",
"FactoryReset", this->factory_reset_button_);
267 LOG_BUTTON(
" ",
"Query", this->query_button_);
268 LOG_BUTTON(
" ",
"Restart", this->restart_button_);
269 LOG_BUTTON(
" ",
"StartDynamicBackgroundCorrection", this->start_dynamic_background_correction_button_);
274 ESP_LOGCONFIG(TAG,
"Running setup");
275 this->read_all_info();
278void LD2412Component::read_all_info() {
293 this->get_gate_threshold();
298 if (this->baud_rate_select_ !=
nullptr) {
300 this->baud_rate_select_->publish_state(*index);
306void LD2412Component::restart_and_read_all_info() {
309 this->
set_timeout(1000, [
this]() { this->read_all_info(); });
312void LD2412Component::loop() {
319 ESP_LOGV(TAG,
"Sending COMMAND %02X", command);
321 this->
write_array(CMD_FRAME_HEADER, HEADER_FOOTER_SIZE);
324 if (command_value !=
nullptr) {
325 len += command_value_len;
328 uint8_t len_cmd[] = {
len, 0x00, command, 0x00};
332 if (command_value !=
nullptr) {
333 this->
write_array(command_value, command_value_len);
336 this->
write_array(CMD_FRAME_FOOTER, HEADER_FOOTER_SIZE);
338 if (command != CMD_ENABLE_CONF && command != CMD_DISABLE_CONF) {
358 if (this->engineering_mode_switch_ !=
nullptr) {
359 this->engineering_mode_switch_->publish_state(engineering_mode);
363#ifdef USE_BINARY_SENSOR
372 if (this->target_binary_sensor_ !=
nullptr) {
373 this->target_binary_sensor_->publish_state(target_state != 0x00);
375 if (this->moving_target_binary_sensor_ !=
nullptr) {
376 this->moving_target_binary_sensor_->publish_state(target_state & MOVE_BITMASK);
378 if (this->still_target_binary_sensor_ !=
nullptr) {
379 this->still_target_binary_sensor_->publish_state(target_state & STILL_BITMASK);
391 this->moving_target_distance_sensor_,
395 this->still_target_distance_sensor_,
398 if (this->detection_distance_sensor_ !=
nullptr) {
399 int new_detect_distance = 0;
400 if (target_state != 0x00 && (target_state & MOVE_BITMASK)) {
401 new_detect_distance =
403 }
else if (target_state != 0x00) {
404 new_detect_distance =
407 this->detection_distance_sensor_->publish_state_if_not_dup(new_detect_distance);
409 if (engineering_mode) {
415 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
421 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
429 for (
auto &gate_move_sensor : this->gate_move_sensors_) {
430 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_move_sensor)
432 for (
auto &gate_still_sensor : this->gate_still_sensors_) {
433 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_still_sensor)
435 SAFE_PUBLISH_SENSOR_UNKNOWN(this->light_sensor_)
459 ESP_LOGW(TAG,
"Invalid length");
462 if (!ld2412::validate_header_footer(CMD_FRAME_HEADER, this->
buffer_data_)) {
468 ESP_LOGW(TAG,
"Invalid status");
477 case CMD_ENABLE_CONF:
478 ESP_LOGV(TAG,
"Enable conf");
481 case CMD_DISABLE_CONF:
482 ESP_LOGV(TAG,
"Disabled conf");
485 case CMD_SET_BAUD_RATE:
486 ESP_LOGV(TAG,
"Baud rate change");
488 if (this->baud_rate_select_ !=
nullptr) {
489 auto baud = this->baud_rate_select_->current_option();
490 ESP_LOGW(TAG,
"Change baud rate to %.*s and reinstall", (
int) baud.size(), baud.c_str());
495 case CMD_QUERY_VERSION: {
499 ESP_LOGV(TAG,
"Firmware version: %s", version_s);
500#ifdef USE_TEXT_SENSOR
501 if (this->version_text_sensor_ !=
nullptr) {
502 this->version_text_sensor_->publish_state(version_s);
507 case CMD_QUERY_DISTANCE_RESOLUTION: {
509 ESP_LOGV(TAG,
"Distance resolution: %s", distance_resolution);
511 if (this->distance_resolution_select_ !=
nullptr) {
512 this->distance_resolution_select_->publish_state(distance_resolution);
518 case CMD_QUERY_LIGHT_CONTROL: {
523 "Light function: %s\n"
524 "Light threshold: %u",
527 if (this->light_function_select_ !=
nullptr) {
528 this->light_function_select_->publish_state(light_function_str);
532 if (this->light_threshold_number_ !=
nullptr) {
533 this->light_threshold_number_->publish_state(
static_cast<float>(this->
light_threshold_));
539 case CMD_QUERY_MAC_ADDRESS: {
551 ESP_LOGV(TAG,
"MAC address: %s", mac_str);
552#ifdef USE_TEXT_SENSOR
553 if (this->mac_text_sensor_ !=
nullptr) {
554 this->mac_text_sensor_->publish_state(mac_str);
558 if (this->bluetooth_switch_ !=
nullptr) {
565 case CMD_SET_DISTANCE_RESOLUTION:
566 ESP_LOGV(TAG,
"Handled set distance resolution command");
569 case CMD_QUERY_DYNAMIC_BACKGROUND_CORRECTION: {
570 ESP_LOGV(TAG,
"Handled query dynamic background correction");
571 bool dynamic_background_correction_active = (this->
buffer_data_[10] != 0x00);
572#ifdef USE_BINARY_SENSOR
573 if (this->dynamic_background_correction_status_binary_sensor_ !=
nullptr) {
574 this->dynamic_background_correction_status_binary_sensor_->publish_state(dynamic_background_correction_active);
582 ESP_LOGV(TAG,
"Handled bluetooth command");
585 case CMD_SET_LIGHT_CONTROL:
586 ESP_LOGV(TAG,
"Handled set light control command");
589 case CMD_QUERY_MOTION_GATE_SENS: {
591 std::vector<std::function<void(
void)>> updates;
596 for (
auto &update : updates) {
603 case CMD_QUERY_STATIC_GATE_SENS: {
605 std::vector<std::function<void(
void)>> updates;
610 for (
auto &update : updates) {
617 case CMD_QUERY_BASIC_CONF:
624 std::vector<std::function<void(
void)>> updates;
627 ESP_LOGV(TAG,
"min_distance_gate_number_: %u, max_distance_gate_number_ %u", this->
buffer_data_[10],
641 if (this->out_pin_level_select_ !=
nullptr) {
642 this->out_pin_level_select_->publish_state(out_pin_level_str);
645 for (
auto &update : updates) {
663 this->buffer_pos_ = 0;
666 if (this->buffer_pos_ < MAX_LINE_LENGTH - 1) {
671 ESP_LOGW(TAG,
"Max command length exceeded; ignoring");
672 this->buffer_pos_ = 0;
674 if (this->buffer_pos_ < 4) {
677 if (ld2412::validate_header_footer(DATA_FRAME_FOOTER, &this->
buffer_data_[this->buffer_pos_ - 4])) {
678#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
683 this->buffer_pos_ = 0;
684 }
else if (ld2412::validate_header_footer(CMD_FRAME_FOOTER, &this->
buffer_data_[this->buffer_pos_ - 4])) {
685#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
690 this->buffer_pos_ = 0;
692 ESP_LOGV(TAG,
"Ack Data incomplete");
698 const uint8_t cmd = enable ? CMD_ENABLE_CONF : CMD_DISABLE_CONF;
699 const uint8_t cmd_value[2] = {0x01, 0x00};
700 this->
send_command_(cmd, enable ? cmd_value :
nullptr,
sizeof(cmd_value));
703void LD2412Component::set_bluetooth(
bool enable) {
705 const uint8_t cmd_value[2] = {enable ? (uint8_t) 0x01 : (uint8_t) 0x00, 0x00};
706 this->
send_command_(CMD_BLUETOOTH, cmd_value,
sizeof(cmd_value));
707 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
710void LD2412Component::set_distance_resolution(
const char *
state) {
713 this->
send_command_(CMD_SET_DISTANCE_RESOLUTION, cmd_value,
sizeof(cmd_value));
714 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
717void LD2412Component::set_baud_rate(
const char *
state) {
720 this->
send_command_(CMD_SET_BAUD_RATE, cmd_value,
sizeof(cmd_value));
725 this->
send_command_(CMD_QUERY_DYNAMIC_BACKGROUND_CORRECTION,
nullptr, 0);
728void LD2412Component::start_dynamic_background_correction() {
732#ifdef USE_BINARY_SENSOR
733 if (this->dynamic_background_correction_status_binary_sensor_ !=
nullptr) {
734 this->dynamic_background_correction_status_binary_sensor_->publish_state(
true);
739 this->
send_command_(CMD_DYNAMIC_BACKGROUND_CORRECTION,
nullptr, 0);
743void LD2412Component::set_engineering_mode(
bool enable) {
744 const uint8_t cmd = enable ? CMD_ENABLE_ENG : CMD_DISABLE_ENG;
750void LD2412Component::factory_reset() {
753 this->
set_timeout(2000, [
this]() { this->restart_and_read_all_info(); });
763 const uint8_t cmd_value[2] = {0x01, 0x00};
764 this->
send_command_(CMD_QUERY_MAC_ADDRESS, cmd_value,
sizeof(cmd_value));
771void LD2412Component::set_basic_config() {
773 if (!this->min_distance_gate_number_->has_state() || !this->max_distance_gate_number_->has_state() ||
774 !this->timeout_number_->has_state()) {
779 if (!this->out_pin_level_select_->has_state()) {
786 lowbyte(
static_cast<int>(this->min_distance_gate_number_->state)),
787 lowbyte(
static_cast<int>(this->max_distance_gate_number_->state) + 1),
788 lowbyte(
static_cast<int>(this->timeout_number_->state)),
789 highbyte(
static_cast<int>(this->timeout_number_->state)),
791 1, TOTAL_GATES, DEFAULT_PRESENCE_TIMEOUT, 0,
805void LD2412Component::set_gate_threshold() {
806 if (this->gate_move_threshold_numbers_.empty() && this->gate_still_threshold_numbers_.empty()) {
809 uint8_t value[TOTAL_GATES] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
811 if (!this->gate_move_threshold_numbers_.empty()) {
812 for (
size_t i = 0; i < this->gate_move_threshold_numbers_.size(); i++) {
813 value[i] = lowbyte(
static_cast<int>(this->gate_move_threshold_numbers_[i]->
state));
815 this->
send_command_(CMD_MOTION_GATE_SENS, value,
sizeof(value));
821 this->
send_command_(CMD_STATIC_GATE_SENS, value,
sizeof(value));
826void LD2412Component::get_gate_threshold() {
831void LD2412Component::set_gate_still_threshold_number(uint8_t gate, number::Number *n) {
835void LD2412Component::set_gate_move_threshold_number(uint8_t gate, number::Number *n) {
836 this->gate_move_threshold_numbers_[gate] = n;
840void LD2412Component::set_light_out_control() {
842 if (this->light_threshold_number_ !=
nullptr && this->light_threshold_number_->has_state()) {
843 this->
light_threshold_ =
static_cast<uint8_t
>(this->light_threshold_number_->state);
847 if (this->light_function_select_ !=
nullptr && this->light_function_select_->has_state()) {
853 this->
send_command_(CMD_SET_LIGHT_CONTROL, value,
sizeof(value));
855 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
860void LD2412Component::set_gate_move_sensor(uint8_t gate, sensor::Sensor *s) {
861 this->gate_move_sensors_[gate] =
new SensorWithDedup<uint8_t>(s);
863void LD2412Component::set_gate_still_sensor(uint8_t gate, sensor::Sensor *s) {
864 this->gate_still_sensors_[gate] =
new SensorWithDedup<uint8_t>(s);
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.
void query_light_control_()
bool dynamic_background_correction_active_
void query_dynamic_background_correction_()
void set_config_mode_(bool enable)
std::array< number::Number *, TOTAL_GATES > gate_move_threshold_numbers_
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_move_sensors_
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_still_sensors_
std::array< number::Number *, TOTAL_GATES > gate_still_threshold_numbers_
void handle_periodic_data_()
void readline_(int readch)
uint8_t buffer_data_[MAX_LINE_LENGTH]
void send_command_(uint8_t command_str, const uint8_t *command_value, uint8_t command_value_len)
void get_distance_resolution_()
Base-class for all numbers.
void publish_state(float state)
uint32_t get_baud_rate() const
void write_array(const uint8_t *data, size_t len)
uint8_t find_uint8(const StringToUint8(&arr)[N], const char *str)
constexpr Uint8ToString OUT_PIN_LEVELS_BY_UINT[]
std::function< void(void)> set_number_value(number::Number *n, float value)
constexpr Uint8ToString LIGHT_FUNCTIONS_BY_UINT[]
@ DISTANCE_RESOLUTION_0_5
@ DISTANCE_RESOLUTION_0_2
@ DISTANCE_RESOLUTION_0_75
const char * find_str(const Uint8ToString(&arr)[N], uint8_t value)
constexpr uint32_t BAUD_RATES[]
constexpr StringToUint8 BAUD_RATES_BY_STR[]
constexpr StringToUint8 LIGHT_FUNCTIONS_BY_STR[]
constexpr StringToUint8 DISTANCE_RESOLUTIONS_BY_STR[]
constexpr Uint8ToString DISTANCE_RESOLUTIONS_BY_UINT[]
constexpr StringToUint8 OUT_PIN_LEVELS_BY_STR[]
void format_version_str(const uint8_t *version, std::span< char, 20 > buffer)
const char * format_mac_str(const uint8_t *mac_address, std::span< char, 18 > buffer)
optional< size_t > find_index(const uint32_t(&arr)[N], uint32_t value)
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).
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".
void IRAM_ATTR HOT delay(uint32_t ms)