[ble_device_base] Migrate BLE sensor platforms to the neutral layer (batch 8: xiaomi_cgpr1, xiaomi_gcls002, xiaomi_hhccjcy01) (#18171)

esphome/components/xiaomi_cgpr1/binary_sensor.py

@@ -1,5 +1,5 @@
 import esphome.codegen as cg
-from esphome.components import binary_sensor, esp32_ble_tracker, sensor
+from esphome.components import binary_sensor, ble_device_base, sensor
 import esphome.config_validation as cv
 from esphome.const import (
     CONF_BATTERY_LEVEL,
@@ -18,18 +18,18 @@ from esphome.const import (
     UNIT_PERCENT,
 )
 
-DEPENDENCIES = ["esp32_ble_tracker"]
-AUTO_LOAD = ["xiaomi_ble", "sensor"]
+AUTO_LOAD = ["ble_device_base", "xiaomi_ble", "sensor"]
 
 xiaomi_cgpr1_ns = cg.esphome_ns.namespace("xiaomi_cgpr1")
 XiaomiCGPR1 = xiaomi_cgpr1_ns.class_(
     "XiaomiCGPR1",
     binary_sensor.BinarySensor,
     cg.Component,
-    esp32_ble_tracker.ESPBTDeviceListener,
+    ble_device_base.ESPBTDeviceListener,
 )
 
 CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_cgpr1"),
     binary_sensor.binary_sensor_schema(XiaomiCGPR1, device_class=DEVICE_CLASS_MOTION)
     .extend(
         {
@@ -57,15 +57,15 @@ CONFIG_SCHEMA = cv.All(
             ),
         }
     )
-    .extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
     .extend(cv.COMPONENT_SCHEMA)
+    .extend(ble_device_base.BLE_DEVICE_SCHEMA),
 )
 
 
 async def to_code(config):
     var = await binary_sensor.new_binary_sensor(config)
     await cg.register_component(var, config)
-    await esp32_ble_tracker.register_ble_device(var, config)
+    await ble_device_base.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_cgpr1/xiaomi_cgpr1.cpp

@@ -2,8 +2,6 @@
 #include "esphome/core/helpers.h"
 #include "esphome/core/log.h"
 
-#ifdef USE_ESP32
-
 namespace esphome::xiaomi_cgpr1 {
 
 static const char *const TAG = "xiaomi_cgpr1";
@@ -16,7 +14,7 @@ void XiaomiCGPR1::dump_config() {
   LOG_SENSOR("  ", "Illuminance", this->illuminance_);
 }
 
-bool XiaomiCGPR1::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
+bool XiaomiCGPR1::parse_device(const ble_device_base::ESPBTDevice &device) {
   if (device.address_uint64() != this->address_) {
     ESP_LOGVV(TAG, "parse_device(): unknown MAC address.");
     return false;
@@ -62,5 +60,3 @@ bool XiaomiCGPR1::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
 void XiaomiCGPR1::set_bindkey(const char *bindkey) { parse_hex(bindkey, this->bindkey_, sizeof(this->bindkey_)); }
 
 }  // namespace esphome::xiaomi_cgpr1
-
-#endif

esphome/components/xiaomi_cgpr1/xiaomi_cgpr1.h

@@ -3,21 +3,19 @@
 #include "esphome/core/component.h"
 #include "esphome/components/sensor/sensor.h"
 #include "esphome/components/binary_sensor/binary_sensor.h"
-#include "esphome/components/esp32_ble_tracker/esp32_ble_tracker.h"
+#include "esphome/components/ble_device_base/ble_device.h"
 #include "esphome/components/xiaomi_ble/xiaomi_ble.h"
 
-#ifdef USE_ESP32
-
 namespace esphome::xiaomi_cgpr1 {
 
 class XiaomiCGPR1 final : public Component,
                           public binary_sensor::BinarySensorInitiallyOff,
-                          public esp32_ble_tracker::ESPBTDeviceListener {
+                          public ble_device_base::ESPBTDeviceListener {
  public:
   void set_address(uint64_t address) { address_ = address; }
   void set_bindkey(const char *bindkey);
 
-  bool parse_device(const esp32_ble_tracker::ESPBTDevice &device) override;
+  bool parse_device(const ble_device_base::ESPBTDevice &device) override;
 
   void dump_config() override;
   void set_battery_level(sensor::Sensor *battery_level) { battery_level_ = battery_level; }
@@ -33,5 +31,3 @@ class XiaomiCGPR1 final : public Component,
 };
 
 }  // namespace esphome::xiaomi_cgpr1
-
-#endif

esphome/components/xiaomi_gcls002/sensor.py

@@ -1,5 +1,5 @@
 import esphome.codegen as cg
-from esphome.components import esp32_ble_tracker, sensor
+from esphome.components import ble_device_base, sensor
 import esphome.config_validation as cv
 from esphome.const import (
     CONF_CONDUCTIVITY,
@@ -19,15 +19,15 @@ from esphome.const import (
     UNIT_PERCENT,
 )
 
-DEPENDENCIES = ["esp32_ble_tracker"]
-AUTO_LOAD = ["xiaomi_ble"]
+AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
 
 xiaomi_gcls002_ns = cg.esphome_ns.namespace("xiaomi_gcls002")
 XiaomiGCLS002 = xiaomi_gcls002_ns.class_(
-    "XiaomiGCLS002", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+    "XiaomiGCLS002", ble_device_base.ESPBTDeviceListener, cg.Component
 )
 
-CONFIG_SCHEMA = (
+CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_gcls002"),
     cv.Schema(
         {
             cv.GenerateID(): cv.declare_id(XiaomiGCLS002),
@@ -58,15 +58,15 @@ CONFIG_SCHEMA = (
             ),
         }
     )
-    .extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
     .extend(cv.COMPONENT_SCHEMA)
+    .extend(ble_device_base.BLE_DEVICE_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)
+    await ble_device_base.register_ble_device(var, config)
 
     cg.add(var.set_address(config[CONF_MAC_ADDRESS].as_hex))
 

esphome/components/xiaomi_gcls002/xiaomi_gcls002.cpp

@@ -1,8 +1,6 @@
 #include "xiaomi_gcls002.h"
 #include "esphome/core/log.h"
 
-#ifdef USE_ESP32
-
 namespace esphome::xiaomi_gcls002 {
 
 static const char *const TAG = "xiaomi_gcls002";
@@ -15,7 +13,7 @@ void XiaomiGCLS002::dump_config() {
   LOG_SENSOR("  ", "Illuminance", this->illuminance_);
 }
 
-bool XiaomiGCLS002::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
+bool XiaomiGCLS002::parse_device(const ble_device_base::ESPBTDevice &device) {
   if (device.address_uint64() != this->address_) {
     ESP_LOGVV(TAG, "parse_device(): unknown MAC address.");
     return false;
@@ -58,5 +56,3 @@ bool XiaomiGCLS002::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
 }
 
 }  // namespace esphome::xiaomi_gcls002
-
-#endif

esphome/components/xiaomi_gcls002/xiaomi_gcls002.h

@@ -2,18 +2,16 @@
 
 #include "esphome/core/component.h"
 #include "esphome/components/sensor/sensor.h"
-#include "esphome/components/esp32_ble_tracker/esp32_ble_tracker.h"
+#include "esphome/components/ble_device_base/ble_device.h"
 #include "esphome/components/xiaomi_ble/xiaomi_ble.h"
 
-#ifdef USE_ESP32
-
 namespace esphome::xiaomi_gcls002 {
 
-class XiaomiGCLS002 final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+class XiaomiGCLS002 final : public Component, public ble_device_base::ESPBTDeviceListener {
  public:
   void set_address(uint64_t address) { address_ = address; }
 
-  bool parse_device(const esp32_ble_tracker::ESPBTDevice &device) override;
+  bool parse_device(const ble_device_base::ESPBTDevice &device) override;
 
   void dump_config() override;
   void set_temperature(sensor::Sensor *temperature) { temperature_ = temperature; }
@@ -30,5 +28,3 @@ class XiaomiGCLS002 final : public Component, public esp32_ble_tracker::ESPBTDev
 };
 
 }  // namespace esphome::xiaomi_gcls002
-
-#endif

esphome/components/xiaomi_hhccjcy01/sensor.py

@@ -1,5 +1,5 @@
 import esphome.codegen as cg
-from esphome.components import esp32_ble_tracker, sensor
+from esphome.components import ble_device_base, sensor
 import esphome.config_validation as cv
 from esphome.const import (
     CONF_BATTERY_LEVEL,
@@ -22,15 +22,15 @@ from esphome.const import (
     UNIT_PERCENT,
 )
 
-DEPENDENCIES = ["esp32_ble_tracker"]
-AUTO_LOAD = ["xiaomi_ble"]
+AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
 
 xiaomi_hhccjcy01_ns = cg.esphome_ns.namespace("xiaomi_hhccjcy01")
 XiaomiHHCCJCY01 = xiaomi_hhccjcy01_ns.class_(
-    "XiaomiHHCCJCY01", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+    "XiaomiHHCCJCY01", ble_device_base.ESPBTDeviceListener, cg.Component
 )
 
-CONFIG_SCHEMA = (
+CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_hhccjcy01"),
     cv.Schema(
         {
             cv.GenerateID(): cv.declare_id(XiaomiHHCCJCY01),
@@ -68,15 +68,15 @@ CONFIG_SCHEMA = (
             ),
         }
     )
-    .extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
     .extend(cv.COMPONENT_SCHEMA)
+    .extend(ble_device_base.BLE_DEVICE_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)
+    await ble_device_base.register_ble_device(var, config)
 
     cg.add(var.set_address(config[CONF_MAC_ADDRESS].as_hex))
 

esphome/components/xiaomi_hhccjcy01/xiaomi_hhccjcy01.cpp

@@ -1,8 +1,6 @@
 #include "xiaomi_hhccjcy01.h"
 #include "esphome/core/log.h"
 
-#ifdef USE_ESP32
-
 namespace esphome::xiaomi_hhccjcy01 {
 
 static const char *const TAG = "xiaomi_hhccjcy01";
@@ -16,7 +14,7 @@ void XiaomiHHCCJCY01::dump_config() {
   LOG_SENSOR("  ", "Battery Level", this->battery_level_);
 }
 
-bool XiaomiHHCCJCY01::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
+bool XiaomiHHCCJCY01::parse_device(const ble_device_base::ESPBTDevice &device) {
   if (device.address_uint64() != this->address_) {
     ESP_LOGVV(TAG, "parse_device(): unknown MAC address.");
     return false;
@@ -61,5 +59,3 @@ bool XiaomiHHCCJCY01::parse_device(const esp32_ble_tracker::ESPBTDevice &device)
 }
 
 }  // namespace esphome::xiaomi_hhccjcy01
-
-#endif

esphome/components/xiaomi_hhccjcy01/xiaomi_hhccjcy01.h

@@ -2,18 +2,16 @@
 
 #include "esphome/core/component.h"
 #include "esphome/components/sensor/sensor.h"
-#include "esphome/components/esp32_ble_tracker/esp32_ble_tracker.h"
+#include "esphome/components/ble_device_base/ble_device.h"
 #include "esphome/components/xiaomi_ble/xiaomi_ble.h"
 
-#ifdef USE_ESP32
-
 namespace esphome::xiaomi_hhccjcy01 {
 
-class XiaomiHHCCJCY01 final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+class XiaomiHHCCJCY01 final : public Component, public ble_device_base::ESPBTDeviceListener {
  public:
   void set_address(uint64_t address) { address_ = address; }
 
-  bool parse_device(const esp32_ble_tracker::ESPBTDevice &device) override;
+  bool parse_device(const ble_device_base::ESPBTDevice &device) override;
 
   void dump_config() override;
   void set_temperature(sensor::Sensor *temperature) { temperature_ = temperature; }
@@ -32,5 +30,3 @@ class XiaomiHHCCJCY01 final : public Component, public esp32_ble_tracker::ESPBTD
 };
 
 }  // namespace esphome::xiaomi_hhccjcy01
-
-#endif

tests/components/xiaomi_cgpr1/common-ln.yaml

@@ -0,0 +1,11 @@
+binary_sensor:
+  - platform: xiaomi_cgpr1
+    name: CGPR1 Motion
+    mac_address: "12:34:56:12:34:56"
+    bindkey: 48403ebe2d385db8d0c187f81e62cb64
+    battery_level:
+      name: CGPR1 battery Level
+    idle_time:
+      name: CGPR1 Idle Time
+    illuminance:
+      name: CGPR1 Illuminance

tests/components/xiaomi_cgpr1/common.yaml

@@ -1,7 +1,10 @@
 esp32_ble_tracker:
+  id: ble_tracker_hub
 
 binary_sensor:
+  # Explicit ble_hub_id: pins the neutral binding as a declared key.
   - platform: xiaomi_cgpr1
+    ble_hub_id: ble_tracker_hub
     name: CGPR1 Motion
     mac_address: "12:34:56:12:34:56"
     bindkey: 48403ebe2d385db8d0c187f81e62cb64

tests/components/xiaomi_cgpr1/test.ln882x-ard.yaml

@@ -0,0 +1,3 @@
+packages:
+  ln882h_ble_tracker: !include ../ln882h_ble_tracker/common.yaml
+  xiaomi_cgpr1: !include common-ln.yaml

tests/components/xiaomi_cgpr1/validate.bk72xx-ard.yaml

@@ -0,0 +1,24 @@
+# Config-only: the CI base board (generic-bk7252, BLE 4.2) cannot compile the
+# BLE 5.x tracker, so this fixture proves validation (schema + neutral binding)
+# on a non-esp32 platform; codegen and compilation are not exercised here.
+bk72xx_ble_tracker:
+  id: ble_tracker_hub
+
+binary_sensor:
+  # Explicit ble_hub_id: pins the neutral binding as a declared key.
+  - platform: xiaomi_cgpr1
+    ble_hub_id: ble_tracker_hub
+    name: CGPR1 Motion
+    mac_address: "12:34:56:12:34:56"
+    bindkey: 48403ebe2d385db8d0c187f81e62cb64
+    battery_level:
+      name: CGPR1 battery Level
+    idle_time:
+      name: CGPR1 Idle Time
+    illuminance:
+      name: CGPR1 Illuminance
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_cgpr1
+    name: BK CGPR1 Implicit Motion
+    mac_address: "12:34:56:12:34:57"
+    bindkey: 48403ebe2d385db8d0c187f81e62cb64

tests/components/xiaomi_gcls002/common-ln.yaml

@@ -0,0 +1,11 @@
+sensor:
+  - platform: xiaomi_gcls002
+    mac_address: 94:2B:FF:5C:91:61
+    temperature:
+      name: GCLS02 Temperature
+    moisture:
+      name: GCLS02 Moisture
+    conductivity:
+      name: GCLS02 Soil Conductivity
+    illuminance:
+      name: GCLS02 Illuminance

tests/components/xiaomi_gcls002/common.yaml

@@ -1,7 +1,10 @@
 esp32_ble_tracker:
+  id: ble_tracker_hub
 
 sensor:
+  # Explicit ble_hub_id: pins the neutral binding as a declared key.
   - platform: xiaomi_gcls002
+    ble_hub_id: ble_tracker_hub
     mac_address: 94:2B:FF:5C:91:61
     temperature:
       name: GCLS02 Temperature

tests/components/xiaomi_gcls002/test.ln882x-ard.yaml

@@ -0,0 +1,3 @@
+packages:
+  ln882h_ble_tracker: !include ../ln882h_ble_tracker/common.yaml
+  xiaomi_gcls002: !include common-ln.yaml

tests/components/xiaomi_gcls002/validate.bk72xx-ard.yaml

@@ -0,0 +1,24 @@
+# Config-only: the CI base board (generic-bk7252, BLE 4.2) cannot compile the
+# BLE 5.x tracker, so this fixture proves validation (schema + neutral binding)
+# on a non-esp32 platform; codegen and compilation are not exercised here.
+bk72xx_ble_tracker:
+  id: ble_tracker_hub
+
+sensor:
+  # Explicit ble_hub_id: pins the neutral binding as a declared key.
+  - platform: xiaomi_gcls002
+    ble_hub_id: ble_tracker_hub
+    mac_address: 94:2B:FF:5C:91:61
+    temperature:
+      name: GCLS02 Temperature
+    moisture:
+      name: GCLS02 Moisture
+    conductivity:
+      name: GCLS02 Soil Conductivity
+    illuminance:
+      name: GCLS02 Illuminance
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_gcls002
+    mac_address: 94:2B:FF:5C:91:62
+    temperature:
+      name: BK GCLS02 Implicit Temperature

tests/components/xiaomi_hhccjcy01/common-ln.yaml

@@ -0,0 +1,13 @@
+sensor:
+  - platform: xiaomi_hhccjcy01
+    mac_address: 94:2B:FF:5C:91:61
+    temperature:
+      name: Xiaomi HHCCJCY01 Temperature
+    moisture:
+      name: Xiaomi HHCCJCY01 Moisture
+    illuminance:
+      name: Xiaomi HHCCJCY01 Illuminance
+    conductivity:
+      name: Xiaomi HHCCJCY01 Soil Conductivity
+    battery_level:
+      name: Xiaomi HHCCJCY01 Battery Level

tests/components/xiaomi_hhccjcy01/common.yaml

@@ -1,7 +1,10 @@
 esp32_ble_tracker:
+  id: ble_tracker_hub
 
 sensor:
+  # Explicit ble_hub_id: pins the neutral binding as a declared key.
   - platform: xiaomi_hhccjcy01
+    ble_hub_id: ble_tracker_hub
     mac_address: 94:2B:FF:5C:91:61
     temperature:
       name: Xiaomi HHCCJCY01 Temperature

tests/components/xiaomi_hhccjcy01/test.ln882x-ard.yaml

@@ -0,0 +1,3 @@
+packages:
+  ln882h_ble_tracker: !include ../ln882h_ble_tracker/common.yaml
+  xiaomi_hhccjcy01: !include common-ln.yaml

tests/components/xiaomi_hhccjcy01/validate.bk72xx-ard.yaml

@@ -0,0 +1,26 @@
+# Config-only: the CI base board (generic-bk7252, BLE 4.2) cannot compile the
+# BLE 5.x tracker, so this fixture proves validation (schema + neutral binding)
+# on a non-esp32 platform; codegen and compilation are not exercised here.
+bk72xx_ble_tracker:
+  id: ble_tracker_hub
+
+sensor:
+  # Explicit ble_hub_id: pins the neutral binding as a declared key.
+  - platform: xiaomi_hhccjcy01
+    ble_hub_id: ble_tracker_hub
+    mac_address: 94:2B:FF:5C:91:61
+    temperature:
+      name: Xiaomi HHCCJCY01 Temperature
+    moisture:
+      name: Xiaomi HHCCJCY01 Moisture
+    illuminance:
+      name: Xiaomi HHCCJCY01 Illuminance
+    conductivity:
+      name: Xiaomi HHCCJCY01 Soil Conductivity
+    battery_level:
+      name: Xiaomi HHCCJCY01 Battery Level
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_hhccjcy01
+    mac_address: 94:2B:FF:5C:91:62
+    temperature:
+      name: BK Xiaomi HHCCJCY01 Implicit Temperature