Add Xiaomi RTCGQ02LM - Mi Motion Sensor 2 (#3186)

esphome/components/xiaomi_rtcgq02lm/__init__.py

@@ -0,0 +1,36 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import esp32_ble_tracker
+from esphome.const import CONF_MAC_ADDRESS, CONF_ID, CONF_BINDKEY
+
+
+AUTO_LOAD = ["xiaomi_ble"]
+CODEOWNERS = ["@jesserockz"]
+DEPENDENCIES = ["esp32_ble_tracker"]
+MULTI_CONF = True
+
+xiaomi_rtcgq02lm_ns = cg.esphome_ns.namespace("xiaomi_rtcgq02lm")
+XiaomiRTCGQ02LM = xiaomi_rtcgq02lm_ns.class_(
+    "XiaomiRTCGQ02LM", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+)
+
+CONFIG_SCHEMA = (
+    cv.Schema(
+        {
+            cv.GenerateID(): cv.declare_id(XiaomiRTCGQ02LM),
+            cv.Required(CONF_BINDKEY): cv.bind_key,
+            cv.Required(CONF_MAC_ADDRESS): cv.mac_address,
+        }
+    )
+    .extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
+    .extend(cv.COMPONENT_SCHEMA)
+)
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    await cg.register_component(var, config)
+    await esp32_ble_tracker.register_ble_device(var, config)
+
+    cg.add(var.set_address(config[CONF_MAC_ADDRESS].as_hex))
+    cg.add(var.set_bindkey(config[CONF_BINDKEY]))

esphome/components/xiaomi_rtcgq02lm/binary_sensor.py

@@ -0,0 +1,64 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import binary_sensor
+from esphome.const import (
+    CONF_LIGHT,
+    CONF_MOTION,
+    CONF_TIMEOUT,
+    DEVICE_CLASS_LIGHT,
+    DEVICE_CLASS_MOTION,
+    CONF_ID,
+)
+from esphome.core import TimePeriod
+
+from . import XiaomiRTCGQ02LM
+
+DEPENDENCIES = ["xiaomi_rtcgq02lm"]
+
+CONF_BUTTON = "button"
+
+
+CONFIG_SCHEMA = cv.Schema(
+    {
+        cv.GenerateID(): cv.use_id(XiaomiRTCGQ02LM),
+        cv.Optional(CONF_MOTION): binary_sensor.binary_sensor_schema(
+            device_class=DEVICE_CLASS_MOTION
+        ).extend(
+            {
+                cv.Optional(CONF_TIMEOUT, default="5s"): cv.All(
+                    cv.positive_time_period_milliseconds,
+                    cv.Range(max=TimePeriod(milliseconds=65535)),
+                ),
+            }
+        ),
+        cv.Optional(CONF_LIGHT): binary_sensor.binary_sensor_schema(
+            device_class=DEVICE_CLASS_LIGHT
+        ),
+        cv.Optional(CONF_BUTTON): binary_sensor.binary_sensor_schema().extend(
+            {
+                cv.Optional(CONF_TIMEOUT, default="200ms"): cv.All(
+                    cv.positive_time_period_milliseconds,
+                    cv.Range(max=TimePeriod(milliseconds=65535)),
+                ),
+            }
+        ),
+    }
+)
+
+
+async def to_code(config):
+    parent = await cg.get_variable(config[CONF_ID])
+
+    if CONF_MOTION in config:
+        sens = await binary_sensor.new_binary_sensor(config[CONF_MOTION])
+        cg.add(parent.set_motion(sens))
+        cg.add(parent.set_motion_timeout(config[CONF_MOTION][CONF_TIMEOUT]))
+
+    if CONF_LIGHT in config:
+        sens = await binary_sensor.new_binary_sensor(config[CONF_LIGHT])
+        cg.add(parent.set_light(sens))
+
+    if CONF_BUTTON in config:
+        sens = await binary_sensor.new_binary_sensor(config[CONF_BUTTON])
+        cg.add(parent.set_button(sens))
+        cg.add(parent.set_button_timeout(config[CONF_BUTTON][CONF_TIMEOUT]))

esphome/components/xiaomi_rtcgq02lm/sensor.py

@@ -0,0 +1,37 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import sensor
+from esphome.const import (
+    CONF_BATTERY_LEVEL,
+    ENTITY_CATEGORY_DIAGNOSTIC,
+    STATE_CLASS_MEASUREMENT,
+    UNIT_PERCENT,
+    CONF_ID,
+    DEVICE_CLASS_BATTERY,
+)
+
+from . import XiaomiRTCGQ02LM
+
+DEPENDENCIES = ["xiaomi_rtcgq02lm"]
+
+
+CONFIG_SCHEMA = cv.Schema(
+    {
+        cv.GenerateID(): cv.use_id(XiaomiRTCGQ02LM),
+        cv.Optional(CONF_BATTERY_LEVEL): sensor.sensor_schema(
+            unit_of_measurement=UNIT_PERCENT,
+            accuracy_decimals=0,
+            device_class=DEVICE_CLASS_BATTERY,
+            state_class=STATE_CLASS_MEASUREMENT,
+            entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
+        ),
+    }
+)
+
+
+async def to_code(config):
+    parent = await cg.get_variable(config[CONF_ID])
+
+    if CONF_BATTERY_LEVEL in config:
+        sens = await sensor.new_sensor(config[CONF_BATTERY_LEVEL])
+        cg.add(parent.set_battery_level(sens))

esphome/components/xiaomi_rtcgq02lm/xiaomi_rtcgq02lm.cpp

@@ -0,0 +1,91 @@
+#include "xiaomi_rtcgq02lm.h"
+#include "esphome/core/log.h"
+
+#ifdef USE_ESP32
+
+namespace esphome {
+namespace xiaomi_rtcgq02lm {
+
+static const char *const TAG = "xiaomi_rtcgq02lm";
+
+void XiaomiRTCGQ02LM::dump_config() {
+  ESP_LOGCONFIG(TAG, "Xiaomi RTCGQ02LM");
+  ESP_LOGCONFIG(TAG, "  Bindkey: %s", format_hex_pretty(this->bindkey_, 16).c_str());
+#ifdef USE_BINARY_SENSOR
+  LOG_BINARY_SENSOR("  ", "Motion", this->motion_);
+  LOG_BINARY_SENSOR("  ", "Light", this->light_);
+  LOG_BINARY_SENSOR("  ", "Button", this->button_);
+#endif
+#ifdef USE_SENSOR
+  LOG_SENSOR("  ", "Battery Level", this->battery_level_);
+#endif
+}
+
+bool XiaomiRTCGQ02LM::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
+  if (device.address_uint64() != this->address_) {
+    ESP_LOGVV(TAG, "parse_device(): unknown MAC address.");
+    return false;
+  }
+  ESP_LOGVV(TAG, "parse_device(): MAC address %s found.", device.address_str().c_str());
+
+  bool success = false;
+  for (auto &service_data : device.get_service_datas()) {
+    auto res = xiaomi_ble::parse_xiaomi_header(service_data);
+    if (!res.has_value()) {
+      continue;
+    }
+    if (res->is_duplicate) {
+      continue;
+    }
+    if (res->has_encryption &&
+        (!(xiaomi_ble::decrypt_xiaomi_payload(const_cast<std::vector<uint8_t> &>(service_data.data), this->bindkey_,
+                                              this->address_)))) {
+      continue;
+    }
+    if (!(xiaomi_ble::parse_xiaomi_message(service_data.data, *res))) {
+      continue;
+    }
+
+    if (!(xiaomi_ble::report_xiaomi_results(res, device.address_str()))) {
+      continue;
+    }
+#ifdef USE_BINARY_SENSOR
+    if (res->has_motion.has_value() && this->motion_ != nullptr) {
+      this->motion_->publish_state(*res->has_motion);
+      this->set_timeout("motion_timeout", this->motion_timeout_,
+                        [this, res]() { this->motion_->publish_state(false); });
+    }
+    if (res->is_light.has_value() && this->light_ != nullptr)
+      this->light_->publish_state(*res->is_light);
+    if (res->button_press.has_value() && this->button_ != nullptr) {
+      this->button_->publish_state(*res->button_press);
+      this->set_timeout("button_timeout", this->button_timeout_,
+                        [this, res]() { this->button_->publish_state(false); });
+    }
+#endif
+#ifdef USE_SENSOR
+    if (res->battery_level.has_value() && this->battery_level_ != nullptr)
+      this->battery_level_->publish_state(*res->battery_level);
+#endif
+    success = true;
+  }
+
+  return success;
+}
+
+void XiaomiRTCGQ02LM::set_bindkey(const std::string &bindkey) {
+  memset(bindkey_, 0, 16);
+  if (bindkey.size() != 32) {
+    return;
+  }
+  char temp[3] = {0};
+  for (int i = 0; i < 16; i++) {
+    strncpy(temp, &(bindkey.c_str()[i * 2]), 2);
+    bindkey_[i] = std::strtoul(temp, nullptr, 16);
+  }
+}
+
+}  // namespace xiaomi_rtcgq02lm
+}  // namespace esphome
+
+#endif

esphome/components/xiaomi_rtcgq02lm/xiaomi_rtcgq02lm.h

@@ -0,0 +1,61 @@
+#pragma once
+
+#include "esphome/components/esp32_ble_tracker/esp32_ble_tracker.h"
+#include "esphome/core/defines.h"
+#ifdef USE_BINARY_SENSOR
+#include "esphome/components/binary_sensor/binary_sensor.h"
+#endif
+#ifdef USE_SENSOR
+#include "esphome/components/sensor/sensor.h"
+#endif
+#include "esphome/components/xiaomi_ble/xiaomi_ble.h"
+#include "esphome/core/component.h"
+
+#ifdef USE_ESP32
+
+namespace esphome {
+namespace xiaomi_rtcgq02lm {
+
+class XiaomiRTCGQ02LM : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+ public:
+  void set_address(uint64_t address) { address_ = address; };
+  void set_bindkey(const std::string &bindkey);
+
+  bool parse_device(const esp32_ble_tracker::ESPBTDevice &device) override;
+  void dump_config() override;
+  float get_setup_priority() const override { return setup_priority::DATA; }
+
+#ifdef USE_BINARY_SENSOR
+  void set_motion(binary_sensor::BinarySensor *motion) { this->motion_ = motion; }
+  void set_motion_timeout(uint16_t timeout) { this->motion_timeout_ = timeout; }
+
+  void set_light(binary_sensor::BinarySensor *light) { this->light_ = light; }
+  void set_button(binary_sensor::BinarySensor *button) { this->button_ = button; }
+  void set_button_timeout(uint16_t timeout) { this->button_timeout_ = timeout; }
+#endif
+
+#ifdef USE_SENSOR
+  void set_battery_level(sensor::Sensor *battery_level) { battery_level_ = battery_level; }
+#endif
+
+ protected:
+  uint64_t address_;
+  uint8_t bindkey_[16];
+
+#ifdef USE_BINARY_SENSOR
+  uint16_t motion_timeout_;
+  uint16_t button_timeout_;
+
+  binary_sensor::BinarySensor *motion_{nullptr};
+  binary_sensor::BinarySensor *light_{nullptr};
+  binary_sensor::BinarySensor *button_{nullptr};
+#endif
+#ifdef USE_SENSOR
+  sensor::Sensor *battery_level_{nullptr};
+#endif
+};
+
+}  // namespace xiaomi_rtcgq02lm
+}  // namespace esphome
+
+#endif