14static const char *
const TAG =
"ld2410";
120constexpr uint32_t
BAUD_RATES[] = {9600, 19200, 38400, 57600, 115200, 230400, 256000, 460800};
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)
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)
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;
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;
163static constexpr uint8_t MOVE_BITMASK = 0x01;
164static constexpr uint8_t STILL_BITMASK = 0x02;
166static constexpr uint8_t HEADER_FOOTER_SIZE = 4;
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};
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};
174static constexpr uint8_t NO_MAC[] = {0x08, 0x05, 0x04, 0x03, 0x02, 0x01};
176static inline bool validate_header_footer(
const uint8_t *header_footer,
const uint8_t *buffer) {
177 return std::memcmp(header_footer, buffer, HEADER_FOOTER_SIZE) == 0;
180void LD2410Component::dump_config() {
187 " Firmware version: %s\n"
190#ifdef USE_BINARY_SENSOR
191 ESP_LOGCONFIG(TAG,
"Binary Sensors:");
192 LOG_BINARY_SENSOR(
" ",
"Target", this->target_binary_sensor_);
193 LOG_BINARY_SENSOR(
" ",
"MovingTarget", this->moving_target_binary_sensor_);
194 LOG_BINARY_SENSOR(
" ",
"StillTarget", this->still_target_binary_sensor_);
195 LOG_BINARY_SENSOR(
" ",
"OutPinPresenceStatus", this->out_pin_presence_status_binary_sensor_);
198 ESP_LOGCONFIG(TAG,
"Sensors:");
199 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"Light", this->light_sensor_);
200 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"DetectionDistance", this->detection_distance_sensor_);
201 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"MovingTargetDistance", this->moving_target_distance_sensor_);
202 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"MovingTargetEnergy", this->moving_target_energy_sensor_);
203 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"StillTargetDistance", this->still_target_distance_sensor_);
204 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"StillTargetEnergy", this->still_target_energy_sensor_);
206 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"GateMove", s);
209 LOG_SENSOR_WITH_DEDUP_SAFE(
" ",
"GateStill", s);
212#ifdef USE_TEXT_SENSOR
213 ESP_LOGCONFIG(TAG,
"Text Sensors:");
214 LOG_TEXT_SENSOR(
" ",
"Mac", this->mac_text_sensor_);
215 LOG_TEXT_SENSOR(
" ",
"Version", this->version_text_sensor_);
218 ESP_LOGCONFIG(TAG,
"Numbers:");
219 LOG_NUMBER(
" ",
"LightThreshold", this->light_threshold_number_);
220 LOG_NUMBER(
" ",
"MaxMoveDistanceGate", this->max_move_distance_gate_number_);
221 LOG_NUMBER(
" ",
"MaxStillDistanceGate", this->max_still_distance_gate_number_);
222 LOG_NUMBER(
" ",
"Timeout", this->timeout_number_);
224 LOG_NUMBER(
" ",
"MoveThreshold", n);
227 LOG_NUMBER(
" ",
"StillThreshold", n);
231 ESP_LOGCONFIG(TAG,
"Selects:");
232 LOG_SELECT(
" ",
"BaudRate", this->baud_rate_select_);
233 LOG_SELECT(
" ",
"DistanceResolution", this->distance_resolution_select_);
234 LOG_SELECT(
" ",
"LightFunction", this->light_function_select_);
235 LOG_SELECT(
" ",
"OutPinLevel", this->out_pin_level_select_);
238 ESP_LOGCONFIG(TAG,
"Switches:");
239 LOG_SWITCH(
" ",
"Bluetooth", this->bluetooth_switch_);
240 LOG_SWITCH(
" ",
"EngineeringMode", this->engineering_mode_switch_);
243 ESP_LOGCONFIG(TAG,
"Buttons:");
244 LOG_BUTTON(
" ",
"FactoryReset", this->factory_reset_button_);
245 LOG_BUTTON(
" ",
"Query", this->query_button_);
246 LOG_BUTTON(
" ",
"Restart", this->restart_button_);
252void LD2410Component::read_all_info() {
261 if (this->baud_rate_select_ !=
nullptr) {
263 this->baud_rate_select_->publish_state(*index);
269void LD2410Component::restart_and_read_all_info() {
272 this->
set_timeout(1000, [
this]() { this->read_all_info(); });
275void LD2410Component::loop() {
278 uint8_t buf[MAX_LINE_LENGTH];
280 size_t to_read = std::min(avail,
sizeof(buf));
286 for (
size_t i = 0; i < to_read; i++) {
293 ESP_LOGV(TAG,
"Sending COMMAND %02X", command);
295 this->
write_array(CMD_FRAME_HEADER,
sizeof(CMD_FRAME_HEADER));
298 if (command_value !=
nullptr) {
299 len += command_value_len;
302 uint8_t len_cmd[] = {
len, 0x00, command, 0x00};
305 if (command_value !=
nullptr) {
306 this->
write_array(command_value, command_value_len);
309 this->
write_array(CMD_FRAME_FOOTER,
sizeof(CMD_FRAME_FOOTER));
311 if (command != CMD_ENABLE_CONF && command != CMD_DISABLE_CONF) {
331 if (this->engineering_mode_switch_ !=
nullptr) {
332 this->engineering_mode_switch_->publish_state(engineering_mode);
335#ifdef USE_BINARY_SENSOR
344 if (this->target_binary_sensor_ !=
nullptr) {
345 this->target_binary_sensor_->publish_state(target_state != 0x00);
347 if (this->moving_target_binary_sensor_ !=
nullptr) {
348 this->moving_target_binary_sensor_->publish_state(target_state & MOVE_BITMASK);
350 if (this->still_target_binary_sensor_ !=
nullptr) {
351 this->still_target_binary_sensor_->publish_state(target_state & STILL_BITMASK);
362 SAFE_PUBLISH_SENSOR(this->moving_target_distance_sensor_,
365 SAFE_PUBLISH_SENSOR(this->still_target_distance_sensor_,
368 SAFE_PUBLISH_SENSOR(this->detection_distance_sensor_,
371 if (engineering_mode) {
377 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
383 for (uint8_t i = 0; i < TOTAL_GATES; i++) {
391 for (
auto &gate_move_sensor : this->gate_move_sensors_) {
392 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_move_sensor)
394 for (
auto &gate_still_sensor : this->gate_still_sensors_) {
395 SAFE_PUBLISH_SENSOR_UNKNOWN(gate_still_sensor)
397 SAFE_PUBLISH_SENSOR_UNKNOWN(this->light_sensor_)
400#ifdef USE_BINARY_SENSOR
401 if (this->out_pin_presence_status_binary_sensor_ !=
nullptr) {
402 this->out_pin_presence_status_binary_sensor_->publish_state(
421 ESP_LOGE(TAG,
"Invalid length");
424 if (!ld2410::validate_header_footer(CMD_FRAME_HEADER, this->
buffer_data_)) {
430 ESP_LOGE(TAG,
"Invalid status");
439 case CMD_ENABLE_CONF:
440 ESP_LOGV(TAG,
"Enable conf");
443 case CMD_DISABLE_CONF:
444 ESP_LOGV(TAG,
"Disabled conf");
447 case CMD_SET_BAUD_RATE:
448 ESP_LOGV(TAG,
"Baud rate change");
450 if (this->baud_rate_select_ !=
nullptr) {
451 auto baud = this->baud_rate_select_->current_option();
452 ESP_LOGE(TAG,
"Change baud rate to %.*s and reinstall", (
int) baud.size(), baud.c_str());
457 case CMD_QUERY_VERSION: {
461 ESP_LOGV(TAG,
"Firmware version: %s", version_s);
462#ifdef USE_TEXT_SENSOR
463 if (this->version_text_sensor_ !=
nullptr) {
464 this->version_text_sensor_->publish_state(version_s);
470 case CMD_QUERY_DISTANCE_RESOLUTION: {
472 ESP_LOGV(TAG,
"Distance resolution: %s", distance_resolution);
474 if (this->distance_resolution_select_ !=
nullptr) {
475 this->distance_resolution_select_->publish_state(distance_resolution);
481 case CMD_QUERY_LIGHT_CONTROL: {
487 ESP_LOGV(TAG,
"Light function: %s, threshold: %u, out pin level: %s", light_function_str, this->
light_threshold_,
490 if (this->light_function_select_ !=
nullptr) {
491 this->light_function_select_->publish_state(light_function_str);
493 if (this->out_pin_level_select_ !=
nullptr) {
494 this->out_pin_level_select_->publish_state(out_pin_level_str);
498 if (this->light_threshold_number_ !=
nullptr) {
499 this->light_threshold_number_->publish_state(
static_cast<float>(this->
light_threshold_));
504 case CMD_QUERY_MAC_ADDRESS: {
516 ESP_LOGV(TAG,
"MAC address: %s", mac_str);
517#ifdef USE_TEXT_SENSOR
518 if (this->mac_text_sensor_ !=
nullptr) {
519 this->mac_text_sensor_->publish_state(mac_str);
523 if (this->bluetooth_switch_ !=
nullptr) {
531 ESP_LOGV(TAG,
"Sensitivity");
535 ESP_LOGV(TAG,
"Bluetooth");
538 case CMD_SET_DISTANCE_RESOLUTION:
539 ESP_LOGV(TAG,
"Set distance resolution");
542 case CMD_SET_LIGHT_CONTROL:
543 ESP_LOGV(TAG,
"Set light control");
546 case CMD_BT_PASSWORD:
547 ESP_LOGV(TAG,
"Set bluetooth password");
558 std::vector<std::function<void(
void)>> updates;
564 for (std::vector<number::Number *>::size_type i = 0; i != this->gate_move_threshold_numbers_.size(); i++) {
578 for (
auto &update : updates) {
601 ESP_LOGW(TAG,
"Max command length exceeded; ignoring");
609#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
616#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
623 ESP_LOGV(TAG,
"Ack Data incomplete");
629 const uint8_t cmd = enable ? CMD_ENABLE_CONF : CMD_DISABLE_CONF;
630 const uint8_t cmd_value[2] = {0x01, 0x00};
631 this->
send_command_(cmd, enable ? cmd_value :
nullptr,
sizeof(cmd_value));
634void LD2410Component::set_bluetooth(
bool enable) {
636 const uint8_t cmd_value[2] = {enable ? (uint8_t) 0x01 : (uint8_t) 0x00, 0x00};
637 this->
send_command_(CMD_BLUETOOTH, cmd_value,
sizeof(cmd_value));
638 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
641void LD2410Component::set_distance_resolution(
const char *
state) {
644 this->
send_command_(CMD_SET_DISTANCE_RESOLUTION, cmd_value,
sizeof(cmd_value));
645 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
648void LD2410Component::set_baud_rate(
const char *
state) {
651 this->
send_command_(CMD_SET_BAUD_RATE, cmd_value,
sizeof(cmd_value));
655void LD2410Component::set_bluetooth_password(
const std::string &password) {
656 if (password.length() != 6) {
657 ESP_LOGE(TAG,
"Password must be exactly 6 chars");
661 uint8_t cmd_value[6];
662 std::copy(password.begin(), password.end(), std::begin(cmd_value));
663 this->
send_command_(CMD_BT_PASSWORD, cmd_value,
sizeof(cmd_value));
667void LD2410Component::set_engineering_mode(
bool enable) {
668 const uint8_t cmd = enable ? CMD_ENABLE_ENG : CMD_DISABLE_ENG;
674void LD2410Component::factory_reset() {
677 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
687 const uint8_t cmd_value[2] = {0x01, 0x00};
688 this->
send_command_(CMD_QUERY_MAC_ADDRESS, cmd_value,
sizeof(cmd_value));
696void LD2410Component::set_max_distances_timeout() {
697 if (!this->max_move_distance_gate_number_->has_state() || !this->max_still_distance_gate_number_->has_state() ||
698 !this->timeout_number_->has_state()) {
701 int max_moving_distance_gate_range =
static_cast<int>(this->max_move_distance_gate_number_->state);
702 int max_still_distance_gate_range =
static_cast<int>(this->max_still_distance_gate_number_->state);
703 int timeout =
static_cast<int>(this->timeout_number_->state);
704 uint8_t value[18] = {0x00,
706 lowbyte(max_moving_distance_gate_range),
707 highbyte(max_moving_distance_gate_range),
712 lowbyte(max_still_distance_gate_range),
713 highbyte(max_still_distance_gate_range),
723 this->
send_command_(CMD_MAXDIST_DURATION, value,
sizeof(value));
725 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
729void LD2410Component::set_gate_threshold(uint8_t gate) {
730 number::Number *motionsens = this->gate_move_threshold_numbers_[gate];
733 if (!motionsens->has_state() || !stillsens->has_state()) {
736 int motion =
static_cast<int>(motionsens->state);
737 int still =
static_cast<int>(stillsens->state);
749 uint8_t value[18] = {0x00, 0x00, lowbyte(gate), highbyte(gate), 0x00, 0x00,
750 0x01, 0x00, lowbyte(motion), highbyte(motion), 0x00, 0x00,
751 0x02, 0x00, lowbyte(still), highbyte(still), 0x00, 0x00};
757void LD2410Component::set_gate_still_threshold_number(uint8_t gate, number::Number *n) {
761void LD2410Component::set_gate_move_threshold_number(uint8_t gate, number::Number *n) {
762 this->gate_move_threshold_numbers_[gate] = n;
766void LD2410Component::set_light_out_control() {
768 if (this->light_threshold_number_ !=
nullptr && this->light_threshold_number_->has_state()) {
769 this->
light_threshold_ =
static_cast<uint8_t
>(this->light_threshold_number_->state);
773 if (this->light_function_select_ !=
nullptr && this->light_function_select_->has_state()) {
776 if (this->out_pin_level_select_ !=
nullptr && this->out_pin_level_select_->has_state()) {
782 this->
send_command_(CMD_SET_LIGHT_CONTROL, value,
sizeof(value));
784 this->
set_timeout(200, [
this]() { this->restart_and_read_all_info(); });
790void LD2410Component::set_gate_move_sensor(uint8_t gate, sensor::Sensor *s) {
791 this->gate_move_sensors_[gate] =
new SensorWithDedup<uint8_t>(s);
794void LD2410Component::set_gate_still_sensor(uint8_t gate, sensor::Sensor *s) {
795 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.
std::array< number::Number *, TOTAL_GATES > gate_still_threshold_numbers_
void get_distance_resolution_()
void set_config_mode_(bool enable)
std::array< number::Number *, TOTAL_GATES > gate_move_threshold_numbers_
void readline_(int readch)
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_still_sensors_
std::array< SensorWithDedup< uint8_t > *, TOTAL_GATES > gate_move_sensors_
void handle_periodic_data_()
void send_command_(uint8_t command_str, const uint8_t *command_value, uint8_t command_value_len)
uint8_t buffer_data_[MAX_LINE_LENGTH]
void query_light_control_()
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)
constexpr Uint8ToString DISTANCE_RESOLUTIONS_BY_UINT[]
constexpr StringToUint8 DISTANCE_RESOLUTIONS_BY_STR[]
constexpr StringToUint8 BAUD_RATES_BY_STR[]
uint8_t find_uint8(const StringToUint8(&arr)[N], const char *str)
constexpr StringToUint8 OUT_PIN_LEVELS_BY_STR[]
const char * find_str(const Uint8ToString(&arr)[N], uint8_t value)
std::function< void(void)> set_number_value(number::Number *n, float value)
@ DISTANCE_RESOLUTION_0_2
@ DISTANCE_RESOLUTION_0_75
constexpr uint32_t BAUD_RATES[]
constexpr Uint8ToString OUT_PIN_LEVELS_BY_UINT[]
constexpr StringToUint8 LIGHT_FUNCTIONS_BY_STR[]
constexpr Uint8ToString LIGHT_FUNCTIONS_BY_UINT[]
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)