[ble_device_base] Migrate BLE sensor platforms to the neutral layer (batch 11: xiaomi_lywsdcgq, xiaomi_mhoc303, xiaomi_mhoc401) (#18178)

esphome/components/xiaomi_lywsdcgq/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,
@@ -16,15 +16,15 @@ from esphome.const import (
     UNIT_PERCENT,
 )
 
-DEPENDENCIES = ["esp32_ble_tracker"]
-AUTO_LOAD = ["xiaomi_ble"]
+AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
 
 xiaomi_lywsdcgq_ns = cg.esphome_ns.namespace("xiaomi_lywsdcgq")
 XiaomiLYWSDCGQ = xiaomi_lywsdcgq_ns.class_(
-    "XiaomiLYWSDCGQ", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+    "XiaomiLYWSDCGQ", ble_device_base.ESPBTDeviceListener, cg.Component
 )
 
-CONFIG_SCHEMA = (
+CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_lywsdcgq"),
     cv.Schema(
         {
             cv.GenerateID(): cv.declare_id(XiaomiLYWSDCGQ),
@@ -50,15 +50,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_lywsdcgq/xiaomi_lywsdcgq.cpp

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

esphome/components/xiaomi_lywsdcgq/xiaomi_lywsdcgq.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_lywsdcgq {
 
-class XiaomiLYWSDCGQ final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+class XiaomiLYWSDCGQ 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; }
@@ -28,5 +26,3 @@ class XiaomiLYWSDCGQ final : public Component, public esp32_ble_tracker::ESPBTDe
 };
 
 }  // namespace esphome::xiaomi_lywsdcgq
-
-#endif

esphome/components/xiaomi_mhoc303/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,
@@ -16,15 +16,15 @@ from esphome.const import (
     UNIT_PERCENT,
 )
 
-DEPENDENCIES = ["esp32_ble_tracker"]
-AUTO_LOAD = ["xiaomi_ble"]
+AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
 
 xiaomi_mhoc303_ns = cg.esphome_ns.namespace("xiaomi_mhoc303")
 XiaomiMHOC303 = xiaomi_mhoc303_ns.class_(
-    "XiaomiMHOC303", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+    "XiaomiMHOC303", ble_device_base.ESPBTDeviceListener, cg.Component
 )
 
-CONFIG_SCHEMA = (
+CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_mhoc303"),
     cv.Schema(
         {
             cv.GenerateID(): cv.declare_id(XiaomiMHOC303),
@@ -50,15 +50,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_mhoc303/xiaomi_mhoc303.cpp

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

esphome/components/xiaomi_mhoc303/xiaomi_mhoc303.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_mhoc303 {
 
-class XiaomiMHOC303 final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+class XiaomiMHOC303 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; }
@@ -28,5 +26,3 @@ class XiaomiMHOC303 final : public Component, public esp32_ble_tracker::ESPBTDev
 };
 
 }  // namespace esphome::xiaomi_mhoc303
-
-#endif

esphome/components/xiaomi_mhoc401/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,
@@ -18,15 +18,15 @@ from esphome.const import (
 )
 
 CODEOWNERS = ["@vevsvevs"]
-DEPENDENCIES = ["esp32_ble_tracker"]
-AUTO_LOAD = ["xiaomi_ble"]
+AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
 
 xiaomi_mhoc401_ns = cg.esphome_ns.namespace("xiaomi_mhoc401")
 XiaomiMHOC401 = xiaomi_mhoc401_ns.class_(
-    "XiaomiMHOC401", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
+    "XiaomiMHOC401", ble_device_base.ESPBTDeviceListener, cg.Component
 )
 
-CONFIG_SCHEMA = (
+CONFIG_SCHEMA = cv.All(
+    ble_device_base.rename_legacy_hub_id("xiaomi_mhoc401"),
     cv.Schema(
         {
             cv.GenerateID(): cv.declare_id(XiaomiMHOC401),
@@ -53,15 +53,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))
     cg.add(var.set_bindkey(config[CONF_BINDKEY]))

esphome/components/xiaomi_mhoc401/xiaomi_mhoc401.cpp

@@ -2,8 +2,6 @@
 #include "esphome/core/helpers.h"
 #include "esphome/core/log.h"
 
-#ifdef USE_ESP32
-
 namespace esphome::xiaomi_mhoc401 {
 
 static const char *const TAG = "xiaomi_mhoc401";
@@ -21,7 +19,7 @@ void XiaomiMHOC401::dump_config() {
   LOG_SENSOR("  ", "Battery Level", this->battery_level_);
 }
 
-bool XiaomiMHOC401::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
+bool XiaomiMHOC401::parse_device(const ble_device_base::ESPBTDevice &device) {
   if (device.address_uint64() != this->address_) {
     ESP_LOGVV(TAG, "parse_device(): unknown MAC address.");
     return false;
@@ -69,5 +67,3 @@ bool XiaomiMHOC401::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
 void XiaomiMHOC401::set_bindkey(const char *bindkey) { parse_hex(bindkey, this->bindkey_, sizeof(this->bindkey_)); }
 
 }  // namespace esphome::xiaomi_mhoc401
-
-#endif

esphome/components/xiaomi_mhoc401/xiaomi_mhoc401.h

@@ -2,19 +2,17 @@
 
 #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_mhoc401 {
 
-class XiaomiMHOC401 final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
+class XiaomiMHOC401 final : public Component, 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_temperature(sensor::Sensor *temperature) { temperature_ = temperature; }
   void set_humidity(sensor::Sensor *humidity) { humidity_ = humidity; }
@@ -29,5 +27,3 @@ class XiaomiMHOC401 final : public Component, public esp32_ble_tracker::ESPBTDev
 };
 
 }  // namespace esphome::xiaomi_mhoc401
-
-#endif

tests/components/xiaomi_lywsdcgq/common-ln.yaml

@@ -0,0 +1,9 @@
+sensor:
+  - platform: xiaomi_lywsdcgq
+    mac_address: 7A:80:8E:19:36:BA
+    temperature:
+      name: Xiaomi LYWSDCGQ Temperature
+    humidity:
+      name: Xiaomi LYWSDCGQ Humidity
+    battery_level:
+      name: Xiaomi LYWSDCGQ Battery Level

tests/components/xiaomi_lywsdcgq/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_lywsdcgq
+    ble_hub_id: ble_tracker_hub
     mac_address: 7A:80:8E:19:36:BA
     temperature:
       name: Xiaomi LYWSDCGQ Temperature

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

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

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

@@ -0,0 +1,22 @@
+# 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_lywsdcgq
+    ble_hub_id: ble_tracker_hub
+    mac_address: 7A:80:8E:19:36:BA
+    temperature:
+      name: Xiaomi LYWSDCGQ Temperature
+    humidity:
+      name: Xiaomi LYWSDCGQ Humidity
+    battery_level:
+      name: Xiaomi LYWSDCGQ Battery Level
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_lywsdcgq
+    mac_address: 7A:80:8E:19:36:BB
+    temperature:
+      name: BK Xiaomi LYWSDCGQ Implicit Temperature

tests/components/xiaomi_mhoc303/common-ln.yaml

@@ -0,0 +1,9 @@
+sensor:
+  - platform: xiaomi_mhoc303
+    mac_address: E7:50:59:32:A0:1C
+    temperature:
+      name: MHO-C303 Temperature
+    humidity:
+      name: MHO-C303 Humidity
+    battery_level:
+      name: MHO-C303 Battery Level

tests/components/xiaomi_mhoc303/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_mhoc303
+    ble_hub_id: ble_tracker_hub
     mac_address: E7:50:59:32:A0:1C
     temperature:
       name: MHO-C303 Temperature

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

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

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

@@ -0,0 +1,22 @@
+# 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_mhoc303
+    ble_hub_id: ble_tracker_hub
+    mac_address: E7:50:59:32:A0:1C
+    temperature:
+      name: MHO-C303 Temperature
+    humidity:
+      name: MHO-C303 Humidity
+    battery_level:
+      name: MHO-C303 Battery Level
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_mhoc303
+    mac_address: E7:50:59:32:A0:1D
+    temperature:
+      name: BK MHO-C303 Implicit Temperature

tests/components/xiaomi_mhoc401/common-ln.yaml

@@ -0,0 +1,10 @@
+sensor:
+  - platform: xiaomi_mhoc401
+    mac_address: E7:50:59:32:A0:1C
+    bindkey: eef418daf699a0c188f3bfd17e4565d9
+    temperature:
+      name: MHO-C401 Temperature
+    humidity:
+      name: MHO-C401 Humidity
+    battery_level:
+      name: MHO-C401 Battery Level

tests/components/xiaomi_mhoc401/common.yaml

@@ -1,12 +1,15 @@
 esp32_ble_tracker:
+  id: ble_tracker_hub
 
 sensor:
+  # Explicit ble_hub_id: pins the neutral binding as a declared key.
   - platform: xiaomi_mhoc401
+    ble_hub_id: ble_tracker_hub
     mac_address: E7:50:59:32:A0:1C
     bindkey: "eef418daf699a0c188f3bfd17e4565d9"
     temperature:
-      name: MHO-C303 Temperature
+      name: MHO-C401 Temperature
     humidity:
-      name: MHO-C303 Humidity
+      name: MHO-C401 Humidity
     battery_level:
-      name: MHO-C303 Battery Level
+      name: MHO-C401 Battery Level

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

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

tests/components/xiaomi_mhoc401/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_mhoc401
+    ble_hub_id: ble_tracker_hub
+    mac_address: E7:50:59:32:A0:1C
+    bindkey: "eef418daf699a0c188f3bfd17e4565d9"
+    temperature:
+      name: MHO-C401 Temperature
+    humidity:
+      name: MHO-C401 Humidity
+    battery_level:
+      name: MHO-C401 Battery Level
+  # No ble_hub_id: exercises the generated binding real configs use.
+  - platform: xiaomi_mhoc401
+    mac_address: E7:50:59:32:A0:1D
+    bindkey: eef418daf699a0c188f3bfd17e4565d9
+    temperature:
+      name: BK MHO-C401 Implicit Temperature