[ble_device_base] Migrate BLE sensor platforms to the neutral layer (batch 10: xiaomi_lywsd02, xiaomi_lywsd02mmc, xiaomi_lywsd03mmc) (#18174)

This commit is contained in:
Edvard Filistovič
2026-08-08 00:27:44 -05:00
committed by GitHub
parent 087b80eeb5
commit 413a4c5885
21 changed files with 150 additions and 57 deletions
+7 -7
View File
@@ -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_lywsd02_ns = cg.esphome_ns.namespace("xiaomi_lywsd02")
XiaomiLYWSD02 = xiaomi_lywsd02_ns.class_(
"XiaomiLYWSD02", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
"XiaomiLYWSD02", ble_device_base.ESPBTDeviceListener, cg.Component
)
CONFIG_SCHEMA = (
CONFIG_SCHEMA = cv.All(
ble_device_base.rename_legacy_hub_id("xiaomi_lywsd02"),
cv.Schema(
{
cv.GenerateID(): cv.declare_id(XiaomiLYWSD02),
@@ -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))
@@ -1,8 +1,6 @@
#include "xiaomi_lywsd02.h"
#include "esphome/core/log.h"
#ifdef USE_ESP32
namespace esphome::xiaomi_lywsd02 {
static const char *const TAG = "xiaomi_lywsd02";
@@ -14,7 +12,7 @@ void XiaomiLYWSD02::dump_config() {
LOG_SENSOR(" ", "Battery Level", this->battery_level_);
}
bool XiaomiLYWSD02::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
bool XiaomiLYWSD02::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 XiaomiLYWSD02::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
}
} // namespace esphome::xiaomi_lywsd02
#endif
@@ -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_lywsd02 {
class XiaomiLYWSD02 final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
class XiaomiLYWSD02 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 XiaomiLYWSD02 final : public Component, public esp32_ble_tracker::ESPBTDev
};
} // namespace esphome::xiaomi_lywsd02
#endif
@@ -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,
@@ -17,16 +17,16 @@ from esphome.const import (
UNIT_PERCENT,
)
AUTO_LOAD = ["xiaomi_ble"]
AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
CODEOWNERS = ["@juanluss31"]
DEPENDENCIES = ["esp32_ble_tracker"]
xiaomi_lywsd02mmc_ns = cg.esphome_ns.namespace("xiaomi_lywsd02mmc")
XiaomiLYWSD02MMC = xiaomi_lywsd02mmc_ns.class_(
"XiaomiLYWSD02MMC", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
"XiaomiLYWSD02MMC", ble_device_base.ESPBTDeviceListener, cg.Component
)
CONFIG_SCHEMA = (
CONFIG_SCHEMA = cv.All(
ble_device_base.rename_legacy_hub_id("xiaomi_lywsd02mmc"),
cv.Schema(
{
cv.GenerateID(): cv.declare_id(XiaomiLYWSD02MMC),
@@ -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]))
@@ -2,8 +2,6 @@
#include "esphome/core/helpers.h"
#include "esphome/core/log.h"
#ifdef USE_ESP32
namespace esphome::xiaomi_lywsd02mmc {
static const char *const TAG = "xiaomi_lywsd02mmc";
@@ -21,7 +19,7 @@ void XiaomiLYWSD02MMC::dump_config() {
LOG_SENSOR(" ", "Battery Level", this->battery_level_);
}
bool XiaomiLYWSD02MMC::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
bool XiaomiLYWSD02MMC::parse_device(const ble_device_base::ESPBTDevice &device) {
if (device.address_uint64() != this->address_) {
ESP_LOGVV(TAG, "parse_device(): unknown MAC address.");
return false;
@@ -65,5 +63,3 @@ bool XiaomiLYWSD02MMC::parse_device(const esp32_ble_tracker::ESPBTDevice &device
void XiaomiLYWSD02MMC::set_bindkey(const char *bindkey) { parse_hex(bindkey, this->bindkey_, sizeof(this->bindkey_)); }
} // namespace esphome::xiaomi_lywsd02mmc
#endif
@@ -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_lywsd02mmc {
class XiaomiLYWSD02MMC final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
class XiaomiLYWSD02MMC final : public Component, public ble_device_base::ESPBTDeviceListener {
public:
void set_address(uint64_t address) { this->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) { this->temperature_ = temperature; }
@@ -30,5 +28,3 @@ class XiaomiLYWSD02MMC final : public Component, public esp32_ble_tracker::ESPBT
};
} // namespace esphome::xiaomi_lywsd02mmc
#endif
@@ -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 (
CODEOWNERS = ["@ahpohl"]
DEPENDENCIES = ["esp32_ble_tracker"]
AUTO_LOAD = ["xiaomi_ble"]
AUTO_LOAD = ["ble_device_base", "xiaomi_ble"]
xiaomi_lywsd03mmc_ns = cg.esphome_ns.namespace("xiaomi_lywsd03mmc")
XiaomiLYWSD03MMC = xiaomi_lywsd03mmc_ns.class_(
"XiaomiLYWSD03MMC", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
"XiaomiLYWSD03MMC", ble_device_base.ESPBTDeviceListener, cg.Component
)
CONFIG_SCHEMA = (
CONFIG_SCHEMA = cv.All(
ble_device_base.rename_legacy_hub_id("xiaomi_lywsd03mmc"),
cv.Schema(
{
cv.GenerateID(): cv.declare_id(XiaomiLYWSD03MMC),
@@ -54,15 +54,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]))
@@ -2,8 +2,6 @@
#include "esphome/core/helpers.h"
#include "esphome/core/log.h"
#ifdef USE_ESP32
namespace esphome::xiaomi_lywsd03mmc {
static const char *const TAG = "xiaomi_lywsd03mmc";
@@ -21,7 +19,7 @@ void XiaomiLYWSD03MMC::dump_config() {
LOG_SENSOR(" ", "Battery Level", this->battery_level_);
}
bool XiaomiLYWSD03MMC::parse_device(const esp32_ble_tracker::ESPBTDevice &device) {
bool XiaomiLYWSD03MMC::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 XiaomiLYWSD03MMC::parse_device(const esp32_ble_tracker::ESPBTDevice &device
void XiaomiLYWSD03MMC::set_bindkey(const char *bindkey) { parse_hex(bindkey, this->bindkey_, sizeof(this->bindkey_)); }
} // namespace esphome::xiaomi_lywsd03mmc
#endif
@@ -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_lywsd03mmc {
class XiaomiLYWSD03MMC final : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
class XiaomiLYWSD03MMC 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 XiaomiLYWSD03MMC final : public Component, public esp32_ble_tracker::ESPBT
};
} // namespace esphome::xiaomi_lywsd03mmc
#endif
@@ -0,0 +1,9 @@
sensor:
- platform: xiaomi_lywsd02
mac_address: 3F:5B:7D:82:58:4E
temperature:
name: Xiaomi LYWSD02 Temperature
humidity:
name: Xiaomi LYWSD02 Humidity
battery_level:
name: Xiaomi LYWSD02 Battery Level
@@ -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_lywsd02
ble_hub_id: ble_tracker_hub
mac_address: 3F:5B:7D:82:58:4E
temperature:
name: Xiaomi LYWSD02 Temperature
@@ -0,0 +1,3 @@
packages:
ln882h_ble_tracker: !include ../ln882h_ble_tracker/common.yaml
xiaomi_lywsd02: !include common-ln.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_lywsd02
ble_hub_id: ble_tracker_hub
mac_address: 3F:5B:7D:82:58:4E
temperature:
name: Xiaomi LYWSD02 Temperature
humidity:
name: Xiaomi LYWSD02 Humidity
battery_level:
name: Xiaomi LYWSD02 Battery Level
# No ble_hub_id: exercises the generated binding real configs use.
- platform: xiaomi_lywsd02
mac_address: 3F:5B:7D:82:58:4F
temperature:
name: BK Xiaomi LYWSD02 Implicit Temperature
@@ -0,0 +1,10 @@
sensor:
- platform: xiaomi_lywsd02mmc
mac_address: A4:C1:38:54:5E:18
bindkey: 2529d8e0d23150a588675cc54ad48400
temperature:
name: Xiaomi LYWSD02MMC Temperature
humidity:
name: Xiaomi LYWSD02MMC Humidity
battery_level:
name: Xiaomi LYWSD02MMC Battery Level
@@ -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_lywsd02mmc
ble_hub_id: ble_tracker_hub
mac_address: A4:C1:38:54:5E:18
bindkey: 2529d8e0d23150a588675cc54ad48400
temperature:
@@ -0,0 +1,3 @@
packages:
ln882h_ble_tracker: !include ../ln882h_ble_tracker/common.yaml
xiaomi_lywsd02mmc: !include common-ln.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_lywsd02mmc
ble_hub_id: ble_tracker_hub
mac_address: A4:C1:38:54:5E:18
bindkey: 2529d8e0d23150a588675cc54ad48400
temperature:
name: Xiaomi LYWSD02MMC Temperature
humidity:
name: Xiaomi LYWSD02MMC Humidity
battery_level:
name: Xiaomi LYWSD02MMC Battery Level
# No ble_hub_id: exercises the generated binding real configs use.
- platform: xiaomi_lywsd02mmc
mac_address: A4:C1:38:54:5E:19
bindkey: 2529d8e0d23150a588675cc54ad48400
temperature:
name: BK Xiaomi LYWSD02MMC Implicit Temperature
@@ -0,0 +1,10 @@
sensor:
- platform: xiaomi_lywsd03mmc
mac_address: A4:C1:38:4E:16:78
bindkey: e9efaa6873f9f9c87a5e75a5f814801c
temperature:
name: Xiaomi LYWSD03MMC Temperature
humidity:
name: Xiaomi LYWSD03MMC Humidity
battery_level:
name: Xiaomi LYWSD03MMC Battery Level
@@ -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_lywsd03mmc
ble_hub_id: ble_tracker_hub
mac_address: A4:C1:38:4E:16:78
bindkey: e9efaa6873f9f9c87a5e75a5f814801c
temperature:
@@ -0,0 +1,3 @@
packages:
ln882h_ble_tracker: !include ../ln882h_ble_tracker/common.yaml
xiaomi_lywsd03mmc: !include common-ln.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_lywsd03mmc
ble_hub_id: ble_tracker_hub
mac_address: A4:C1:38:4E:16:78
bindkey: e9efaa6873f9f9c87a5e75a5f814801c
temperature:
name: Xiaomi LYWSD03MMC Temperature
humidity:
name: Xiaomi LYWSD03MMC Humidity
battery_level:
name: Xiaomi LYWSD03MMC Battery Level
# No ble_hub_id: exercises the generated binding real configs use.
- platform: xiaomi_lywsd03mmc
mac_address: A4:C1:38:4E:16:79
bindkey: e9efaa6873f9f9c87a5e75a5f814801c
temperature:
name: BK Xiaomi LYWSD03MMC Implicit Temperature