[ble_device_base] Migrate BLE sensor platforms to the neutral layer (batch 9: xiaomi_hhccjcy10, xiaomi_hhccpot002, xiaomi_jqjcy01ym) (#18172)

esphome/components/xiaomi_hhccjcy10/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,14 +22,15 @@ from esphome.const import (
     UNIT_PERCENT,
 )
 
-DEPENDENCIES = ["esp32_ble_tracker"]
+AUTO_LOAD = ["ble_device_base"]
 
 xiaomi_hhccjcy10_ns = cg.esphome_ns.namespace("xiaomi_hhccjcy10")
 XiaomiHHCCJCY10 = xiaomi_hhccjcy10_ns.class_(
-    "XiaomiHHCCJCY10", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+    "XiaomiHHCCJCY10", ble_device_base.ESPBTDeviceListener, cg.Component
 )
 
-CONFIG_SCHEMA = (
+CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_hhccjcy10"),
     cv.Schema(
         {
             cv.GenerateID(): cv.declare_id(XiaomiHHCCJCY10),
@@ -67,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_hhccjcy10/xiaomi_hhccjcy10.cpp

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

esphome/components/xiaomi_hhccjcy10/xiaomi_hhccjcy10.h

@@ -2,17 +2,15 @@
 
 #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"
-
-#ifdef USE_ESP32
 
 namespace esphome::xiaomi_hhccjcy10 {
 
-class XiaomiHHCCJCY10 final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+class XiaomiHHCCJCY10 final : public Component, public ble_device_base::ESPBTDeviceListener {
  public:
   void set_address(uint64_t address) { this->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) { this->temperature_ = temperature; }
@@ -31,5 +29,3 @@ class XiaomiHHCCJCY10 final : public Component, public esp32_ble_tracker::ESPBTD
 };
 
 }  // namespace esphome::xiaomi_hhccjcy10
-
-#endif

esphome/components/xiaomi_hhccpot002/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,
@@ -13,15 +13,15 @@ from esphome.const import (
     UNIT_PERCENT,
 )
 
-DEPENDENCIES = ["esp32_ble_tracker"]
+AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
-AUTO_LOAD = ["xiaomi_ble"]
 
 xiaomi_hhccpot002_ns = cg.esphome_ns.namespace("xiaomi_hhccpot002")
 XiaomiHHCCPOT002 = xiaomi_hhccpot002_ns.class_(
-    "XiaomiHHCCPOT002", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+    "XiaomiHHCCPOT002", ble_device_base.ESPBTDeviceListener, cg.Component
 )
 
-CONFIG_SCHEMA = (
+CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_hhccpot002"),
     cv.Schema(
         {
             cv.GenerateID(): cv.declare_id(XiaomiHHCCPOT002),
@@ -40,15 +40,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_hhccpot002/xiaomi_hhccpot002.cpp

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

esphome/components/xiaomi_hhccpot002/xiaomi_hhccpot002.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_hhccpot002 {
 
-class XiaomiHHCCPOT002 final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+class XiaomiHHCCPOT002 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_moisture(sensor::Sensor *moisture) { moisture_ = moisture; }
@@ -26,5 +24,3 @@ class XiaomiHHCCPOT002 final : public Component, public esp32_ble_tracker::ESPBT
 };
 
 }  // namespace esphome::xiaomi_hhccpot002
-
-#endif

esphome/components/xiaomi_jqjcy01ym/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,
@@ -19,15 +19,15 @@ from esphome.const import (
     UNIT_PERCENT,
 )
 
-DEPENDENCIES = ["esp32_ble_tracker"]
+AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
-AUTO_LOAD = ["xiaomi_ble"]
 
 xiaomi_jqjcy01ym_ns = cg.esphome_ns.namespace("xiaomi_jqjcy01ym")
 XiaomiJQJCY01YM = xiaomi_jqjcy01ym_ns.class_(
-    "XiaomiJQJCY01YM", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+    "XiaomiJQJCY01YM", ble_device_base.ESPBTDeviceListener, cg.Component
 )
 
-CONFIG_SCHEMA = (
+CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_jqjcy01ym"),
     cv.Schema(
         {
             cv.GenerateID(): cv.declare_id(XiaomiJQJCY01YM),
@@ -59,15 +59,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_jqjcy01ym/xiaomi_jqjcy01ym.cpp

@@ -1,8 +1,6 @@
 #include "xiaomi_jqjcy01ym.h"
 #include "esphome/core/log.h"
 
-#ifdef USE_ESP32
-
 namespace esphome::xiaomi_jqjcy01ym {
 
 static const char *const TAG = "xiaomi_jqjcy01ym";
@@ -15,7 +13,7 @@ void XiaomiJQJCY01YM::dump_config() {
   LOG_SENSOR("  ", "Battery Level", this->battery_level_);
 }
 
-bool XiaomiJQJCY01YM::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
+bool XiaomiJQJCY01YM::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 XiaomiJQJCY01YM::parse_device(const esp32_ble_tracker::ESPBTDevice &device)
 }
 
 }  // namespace esphome::xiaomi_jqjcy01ym
-
-#endif

esphome/components/xiaomi_jqjcy01ym/xiaomi_jqjcy01ym.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_jqjcy01ym {
 
-class XiaomiJQJCY01YM final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+class XiaomiJQJCY01YM 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 XiaomiJQJCY01YM final : public Component, public esp32_ble_tracker::ESPBTD
 };
 
 }  // namespace esphome::xiaomi_jqjcy01ym
-
-#endif

tests/components/xiaomi_cgpr1/common-ln.yaml

@@ -4,7 +4,7 @@ binary_sensor:
     mac_address: "12:34:56:12:34:56"
     bindkey: 48403ebe2d385db8d0c187f81e62cb64
     battery_level:
-      name: CGPR1 battery Level
+      name: CGPR1 Battery Level
     idle_time:
       name: CGPR1 Idle Time
     illuminance:

tests/components/xiaomi_cgpr1/common.yaml

@@ -9,7 +9,7 @@ binary_sensor:
     mac_address: "12:34:56:12:34:56"
     bindkey: 48403ebe2d385db8d0c187f81e62cb64
     battery_level:
-      name: CGPR1 battery Level
+      name: CGPR1 Battery Level
     idle_time:
       name: CGPR1 Idle Time
     illuminance:

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

@@ -12,7 +12,7 @@ binary_sensor:
     mac_address: "12:34:56:12:34:56"
     bindkey: 48403ebe2d385db8d0c187f81e62cb64
     battery_level:
-      name: CGPR1 battery Level
+      name: CGPR1 Battery Level
     idle_time:
       name: CGPR1 Idle Time
     illuminance:

tests/components/xiaomi_hhccjcy10/common-ln.yaml

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

tests/components/xiaomi_hhccjcy10/common.yaml

@@ -0,0 +1,18 @@
+esp32_ble_tracker:
+  id: ble_tracker_hub
+
+sensor:
+  # Explicit ble_hub_id: pins the neutral binding as a declared key.
+  - platform: xiaomi_hhccjcy10
+    ble_hub_id: ble_tracker_hub
+    mac_address: 94:2B:FF:5C:91:61
+    temperature:
+      name: Xiaomi HHCCJCY10 Temperature
+    moisture:
+      name: Xiaomi HHCCJCY10 Moisture
+    illuminance:
+      name: Xiaomi HHCCJCY10 Illuminance
+    conductivity:
+      name: Xiaomi HHCCJCY10 Conductivity
+    battery_level:
+      name: Xiaomi HHCCJCY10 Battery Level

tests/components/xiaomi_hhccjcy10/test.esp32-idf.yaml

@@ -0,0 +1,3 @@
+packages:
+  ble: !include ../../test_build_components/common/ble/esp32-idf.yaml
+  xiaomi_hhccjcy10: !include common.yaml

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

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

tests/components/xiaomi_hhccjcy10/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_hhccjcy10
+    ble_hub_id: ble_tracker_hub
+    mac_address: 94:2B:FF:5C:91:61
+    temperature:
+      name: Xiaomi HHCCJCY10 Temperature
+    moisture:
+      name: Xiaomi HHCCJCY10 Moisture
+    illuminance:
+      name: Xiaomi HHCCJCY10 Illuminance
+    conductivity:
+      name: Xiaomi HHCCJCY10 Conductivity
+    battery_level:
+      name: Xiaomi HHCCJCY10 Battery Level
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_hhccjcy10
+    mac_address: 94:2B:FF:5C:91:62
+    temperature:
+      name: BK Xiaomi HHCCJCY10 Implicit Temperature

tests/components/xiaomi_hhccpot002/common-ln.yaml

@@ -0,0 +1,7 @@
+sensor:
+  - platform: xiaomi_hhccpot002
+    mac_address: 94:2B:FF:5C:91:61
+    moisture:
+      name: HHCCPOT002 Moisture
+    conductivity:
+      name: HHCCPOT002 Soil Conductivity

tests/components/xiaomi_hhccpot002/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_hhccpot002
+    ble_hub_id: ble_tracker_hub
     mac_address: 94:2B:FF:5C:91:61
     moisture:
       name: HHCCPOT002 Moisture

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

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

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

@@ -0,0 +1,20 @@
+# 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_hhccpot002
+    ble_hub_id: ble_tracker_hub
+    mac_address: 94:2B:FF:5C:91:61
+    moisture:
+      name: HHCCPOT002 Moisture
+    conductivity:
+      name: HHCCPOT002 Soil Conductivity
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_hhccpot002
+    mac_address: 94:2B:FF:5C:91:62
+    moisture:
+      name: BK HHCCPOT002 Implicit Moisture

tests/components/xiaomi_jqjcy01ym/common-ln.yaml

@@ -0,0 +1,11 @@
+sensor:
+  - platform: xiaomi_jqjcy01ym
+    mac_address: 7A:80:8E:19:36:BA
+    temperature:
+      name: JQJCY01YM Temperature
+    humidity:
+      name: JQJCY01YM Humidity
+    formaldehyde:
+      name: JQJCY01YM Formaldehyde
+    battery_level:
+      name: JQJCY01YM Battery Level

tests/components/xiaomi_jqjcy01ym/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_jqjcy01ym
+    ble_hub_id: ble_tracker_hub
     mac_address: 7A:80:8E:19:36:BA
     temperature:
       name: JQJCY01YM Temperature

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

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

tests/components/xiaomi_jqjcy01ym/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_jqjcy01ym
+    ble_hub_id: ble_tracker_hub
+    mac_address: 7A:80:8E:19:36:BA
+    temperature:
+      name: JQJCY01YM Temperature
+    humidity:
+      name: JQJCY01YM Humidity
+    formaldehyde:
+      name: JQJCY01YM Formaldehyde
+    battery_level:
+      name: JQJCY01YM Battery Level
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_jqjcy01ym
+    mac_address: 7A:80:8E:19:36:BB
+    temperature:
+      name: BK JQJCY01YM Implicit Temperature