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 bool validate_header_footer(
const uint8_t *header_footer,
const uint8_t *buffer) {
196 return std::memcmp(header_footer, buffer, HEADER_FOOTER_SIZE) == 0;
199void LD2412Component::dump_config() {
206 " Firmware version: %s\n"
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_);
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_);
226 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"GateStill", s);
229 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"GateMove", s);
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_);
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_);
244 LOG_NUMBER(
" ",
"Move Thresholds", n);
247 LOG_NUMBER(
" ",
"Still Thresholds", n);
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_);
258 ESP_LOGCONFIG(TAG,
"Switches:");
259 LOG_SWITCH(
" ",
"Bluetooth", this->bluetooth_switch_);
260 LOG_SWITCH(
" ",
"EngineeringMode", this->engineering_mode_switch_);
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_);
272 ESP_LOGCONFIG(TAG,
"Running setup");
273 this->read_all_info();
276void LD2412Component::read_all_info() {
291 this->get_gate_threshold();
296 if (this->baud_rate_select_ !=
nullptr) {
298 this->baud_rate_select_->publish_state(*index);
304void LD2412Component::restart_and_read_all_info() {
307 this->
set_timeout(1000, [
this]() { this->read_all_info(); });
310void LD2412Component::loop() {
313 uint8_t buf[MAX_LINE_LENGTH];
315 size_t to_read = std::min(avail,
sizeof(buf));
321 for (
size_t i = 0; i < to_read; i++) {
328 ESP_LOGV(TAG,
"Sending COMMAND %02X", command);
330 this->
write_array(CMD_FRAME_HEADER, HEADER_FOOTER_SIZE);
333 if (command_value !=
nullptr) {
334 len += command_value_len;
337 uint8_t len_cmd[] = {
len, 0x00, command, 0x00};
341 if (command_value !=
nullptr) {
342 this->
write_array(command_value, command_value_len);
345 this->
write_array(CMD_FRAME_FOOTER, HEADER_FOOTER_SIZE);
347 if (command != CMD_ENABLE_CONF && command != CMD_DISABLE_CONF) {
367 if (this->engineering_mode_switch_ !=
nullptr) {
368 this->engineering_mode_switch_->publish_state(engineering_mode);
372#ifdef USE_BINARY_SENSOR
381 if (this->target_binary_sensor_ !=
nullptr) {
382 this->target_binary_sensor_->publish_state(target_state != 0x00);
384 if (this->moving_target_binary_sensor_ !=
nullptr) {
385 this->moving_target_binary_sensor_->publish_state(target_state & MOVE_BITMASK);
387 if (this->still_target_binary_sensor_ !=
nullptr) {
388 this->still_target_binary_sensor_->publish_state(target_state & STILL_BITMASK);
399 SAFE_PUBLISH_SENSOR(this->moving_target_distance_sensor_,
402 SAFE_PUBLISH_SENSOR(this->still_target_distance_sensor_,
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 =
410 }
else if (target_state != 0x00) {
413 this->detection_distance_sensor_->publish_state_if_not_dup(new_detect_distance);
415 if (engineering_mode) {
421 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
427 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
435 for (
auto &gate_move_sensor : this->gate_move_sensors_) {
436 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_move_sensor)
438 for (
auto &gate_still_sensor : this->gate_still_sensors_) {
439 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_still_sensor)
441 SAFE_PUBLISH_SENSOR_UNKNOWN(this->light_sensor_)
465 ESP_LOGW(TAG,
"Invalid length");
468 if (!ld2412::validate_header_footer(CMD_FRAME_HEADER, this->
buffer_data_)) {
474 ESP_LOGW(TAG,
"Invalid status");
483 case CMD_ENABLE_CONF:
484 ESP_LOGV(TAG,
"Enable conf");
487 case CMD_DISABLE_CONF:
488 ESP_LOGV(TAG,
"Disabled conf");
491 case CMD_SET_BAUD_RATE:
492 ESP_LOGV(TAG,
"Baud rate change");
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());
501 case CMD_QUERY_VERSION: {
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);
513 case CMD_QUERY_DISTANCE_RESOLUTION: {
515 ESP_LOGV(TAG,
"Distance resolution: %s", distance_resolution);
517 if (this->distance_resolution_select_ !=
nullptr) {
518 this->distance_resolution_select_->publish_state(distance_resolution);
524 case CMD_QUERY_LIGHT_CONTROL: {
528 ESP_LOGV(TAG,
"Light function: %s, threshold: %u", light_function_str, this->
light_threshold_);
530 if (this->light_function_select_ !=
nullptr) {
531 this->light_function_select_->publish_state(light_function_str);
535 if (this->light_threshold_number_ !=
nullptr) {
536 this->light_threshold_number_->publish_state(
static_cast<float>(this->
light_threshold_));
542 case CMD_QUERY_MAC_ADDRESS: {
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);
561 if (this->bluetooth_switch_ !=
nullptr) {
568 case CMD_SET_DISTANCE_RESOLUTION:
569 ESP_LOGV(TAG,
"Handled set distance resolution command");
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);
585 ESP_LOGV(TAG,
"Handled bluetooth command");
588 case CMD_SET_LIGHT_CONTROL:
589 ESP_LOGV(TAG,
"Handled set light control command");
592 case CMD_QUERY_MOTION_GATE_SENS: {
594 std::vector<std::function<void(
void)>> updates;
599 for (
auto &update : updates) {
606 case CMD_QUERY_STATIC_GATE_SENS: {
608 std::vector<std::function<void(
void)>> updates;
613 for (
auto &update : updates) {
620 case CMD_QUERY_BASIC_CONF:
627 std::vector<std::function<void(
void)>> updates;
630 ESP_LOGV(TAG,
"min_distance_gate_number_: %u, max_distance_gate_number_ %u", this->
buffer_data_[10],
644 if (this->out_pin_level_select_ !=
nullptr) {
645 this->out_pin_level_select_->publish_state(out_pin_level_str);
648 for (
auto &update : updates) {
666 this->buffer_pos_ = 0;
669 if (this->buffer_pos_ < MAX_LINE_LENGTH - 1) {
674 ESP_LOGW(TAG,
"Max command length exceeded; ignoring");
675 this->buffer_pos_ = 0;
677 if (this->buffer_pos_ < 4) {
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
686 this->buffer_pos_ = 0;
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
693 this->buffer_pos_ = 0;
695 ESP_LOGV(TAG,
"Ack Data incomplete");
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));
706void LD2412Component::set_bluetooth(
bool enable) {
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(); });
713void LD2412Component::set_distance_resolution(
const char *
state) {
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(); });
720void LD2412Component::set_baud_rate(
const char *
state) {
723 this->
send_command_(CMD_SET_BAUD_RATE, cmd_value,
sizeof(cmd_value));
728 this->
send_command_(CMD_QUERY_DYNAMIC_BACKGROUND_CORRECTION,
nullptr, 0);
731void LD2412Component::start_dynamic_background_correction() {
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);
742 this->
send_command_(CMD_DYNAMIC_BACKGROUND_CORRECTION,
nullptr, 0);
746void LD2412Component::set_engineering_mode(
bool enable) {
747 const uint8_t cmd = enable ? CMD_ENABLE_ENG : CMD_DISABLE_ENG;
753void LD2412Component::factory_reset() {
756 this->
set_timeout(2000, [
this]() { this->restart_and_read_all_info(); });
766 const uint8_t cmd_value[2] = {0x01, 0x00};
767 this->
send_command_(CMD_QUERY_MAC_ADDRESS, cmd_value,
sizeof(cmd_value));
774void LD2412Component::set_basic_config() {
776 if (!this->min_distance_gate_number_->has_state() || !this->max_distance_gate_number_->has_state() ||
777 !this->timeout_number_->has_state()) {
782 if (!this->out_pin_level_select_->has_state()) {
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)),
794 1, TOTAL_GATES, DEFAULT_PRESENCE_TIMEOUT, 0,
808void LD2412Component::set_gate_threshold() {
809 if (this->gate_move_threshold_numbers_.empty() && this->gate_still_threshold_numbers_.empty()) {
812 uint8_t value[TOTAL_GATES] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
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));
818 this->
send_command_(CMD_MOTION_GATE_SENS, value,
sizeof(value));
824 this->
send_command_(CMD_STATIC_GATE_SENS, value,
sizeof(value));
829void LD2412Component::get_gate_threshold() {
834void LD2412Component::set_gate_still_threshold_number(uint8_t gate, number::Number *n) {
838void LD2412Component::set_gate_move_threshold_number(uint8_t gate, number::Number *n) {
839 this->gate_move_threshold_numbers_[gate] = n;
843void LD2412Component::set_light_out_control() {
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);
850 if (this->light_function_select_ !=
nullptr && this->light_function_select_->has_state()) {
856 this->
send_command_(CMD_SET_LIGHT_CONTROL, value,
sizeof(value));
858 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
863void LD2412Component::set_gate_move_sensor(uint8_t gate, sensor::Sensor *s) {
864 this->gate_move_sensors_[gate] =
new SensorWithDedup<uint8_t>(s);
866void LD2412Component::set_gate_still_sensor(uint8_t gate, sensor::Sensor *s) {
867 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
optional< std::array< uint8_t, N > > read_array()
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".
constexpr uint16_t encode_uint16(uint8_t msb, uint8_t lsb)
Encode a 16-bit value given the most and least significant byte.
void HOT delay(uint32_t ms)