iBeacon support for ble_presence (#1627)

esphome/components/ble_presence/binary_sensor.py

@@ -1,7 +1,14 @@
 import esphome.codegen as cg
 import esphome.config_validation as cv
 from esphome.components import binary_sensor, esp32_ble_tracker
-from esphome.const import CONF_MAC_ADDRESS, CONF_SERVICE_UUID, CONF_ID
+from esphome.const import (
+    CONF_MAC_ADDRESS,
+    CONF_SERVICE_UUID,
+    CONF_IBEACON_MAJOR,
+    CONF_IBEACON_MINOR,
+    CONF_IBEACON_UUID,
+    CONF_ID,
+)
 
 DEPENDENCIES = ["esp32_ble_tracker"]
 
@@ -13,17 +20,30 @@ BLEPresenceDevice = ble_presence_ns.class_(
     esp32_ble_tracker.ESPBTDeviceListener,
 )
 
+
+def _validate(config):
+    if CONF_IBEACON_MAJOR in config and CONF_IBEACON_UUID not in config:
+        raise cv.Invalid("iBeacon major identifier requires iBeacon UUID")
+    if CONF_IBEACON_MINOR in config and CONF_IBEACON_UUID not in config:
+        raise cv.Invalid("iBeacon minor identifier requires iBeacon UUID")
+    return config
+
+
 CONFIG_SCHEMA = cv.All(
     binary_sensor.BINARY_SENSOR_SCHEMA.extend(
         {
             cv.GenerateID(): cv.declare_id(BLEPresenceDevice),
             cv.Optional(CONF_MAC_ADDRESS): cv.mac_address,
             cv.Optional(CONF_SERVICE_UUID): esp32_ble_tracker.bt_uuid,
+            cv.Optional(CONF_IBEACON_MAJOR): cv.uint16_t,
+            cv.Optional(CONF_IBEACON_MINOR): cv.uint16_t,
+            cv.Optional(CONF_IBEACON_UUID): cv.uuid,
         }
     )
     .extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
     .extend(cv.COMPONENT_SCHEMA),
-    cv.has_exactly_one_key(CONF_MAC_ADDRESS, CONF_SERVICE_UUID),
+    cv.has_exactly_one_key(CONF_MAC_ADDRESS, CONF_SERVICE_UUID, CONF_IBEACON_UUID),
+    _validate,
 )
 
 
@@ -50,5 +70,15 @@ async def to_code(config):
                 )
             )
         elif len(config[CONF_SERVICE_UUID]) == len(esp32_ble_tracker.bt_uuid128_format):
-            uuid128 = esp32_ble_tracker.as_hex_array(config[CONF_SERVICE_UUID])
+            uuid128 = esp32_ble_tracker.as_reversed_hex_array(config[CONF_SERVICE_UUID])
             cg.add(var.set_service_uuid128(uuid128))
+
+    if CONF_IBEACON_UUID in config:
+        ibeacon_uuid = esp32_ble_tracker.as_hex_array(str(config[CONF_IBEACON_UUID]))
+        cg.add(var.set_ibeacon_uuid(ibeacon_uuid))
+
+        if CONF_IBEACON_MAJOR in config:
+            cg.add(var.set_ibeacon_major(config[CONF_IBEACON_MAJOR]))
+
+        if CONF_IBEACON_MINOR in config:
+            cg.add(var.set_ibeacon_minor(config[CONF_IBEACON_MINOR]))

esphome/components/ble_presence/ble_presence_device.h

@@ -14,41 +14,78 @@ class BLEPresenceDevice : public binary_sensor::BinarySensorInitiallyOff,
                           public Component {
  public:
   void set_address(uint64_t address) {
-    this->by_address_ = true;
+    this->match_by_ = MATCH_BY_MAC_ADDRESS;
     this->address_ = address;
   }
   void set_service_uuid16(uint16_t uuid) {
-    this->by_address_ = false;
+    this->match_by_ = MATCH_BY_SERVICE_UUID;
     this->uuid_ = esp32_ble_tracker::ESPBTUUID::from_uint16(uuid);
   }
   void set_service_uuid32(uint32_t uuid) {
-    this->by_address_ = false;
+    this->match_by_ = MATCH_BY_SERVICE_UUID;
     this->uuid_ = esp32_ble_tracker::ESPBTUUID::from_uint32(uuid);
   }
   void set_service_uuid128(uint8_t *uuid) {
-    this->by_address_ = false;
+    this->match_by_ = MATCH_BY_SERVICE_UUID;
     this->uuid_ = esp32_ble_tracker::ESPBTUUID::from_raw(uuid);
   }
+  void set_ibeacon_uuid(uint8_t *uuid) {
+    this->match_by_ = MATCH_BY_IBEACON_UUID;
+    this->ibeacon_uuid_ = esp32_ble_tracker::ESPBTUUID::from_raw(uuid);
+  }
+  void set_ibeacon_major(uint16_t major) {
+    this->check_ibeacon_major_ = true;
+    this->ibeacon_major_ = major;
+  }
+  void set_ibeacon_minor(uint16_t minor) {
+    this->check_ibeacon_minor_ = true;
+    this->ibeacon_minor_ = minor;
+  }
   void on_scan_end() override {
     if (!this->found_)
       this->publish_state(false);
     this->found_ = false;
   }
   bool parse_device(const esp32_ble_tracker::ESPBTDevice &device) override {
-    if (this->by_address_) {
-      if (device.address_uint64() == this->address_) {
-        this->publish_state(true);
-        this->found_ = true;
-        return true;
-      }
-    } else {
-      for (auto uuid : device.get_service_uuids()) {
-        if (this->uuid_ == uuid) {
-          this->publish_state(device.get_rssi());
+    switch (this->match_by_) {
+      case MATCH_BY_MAC_ADDRESS:
+        if (device.address_uint64() == this->address_) {
+          this->publish_state(true);
           this->found_ = true;
           return true;
         }
-      }
+        break;
+      case MATCH_BY_SERVICE_UUID:
+        for (auto uuid : device.get_service_uuids()) {
+          if (this->uuid_ == uuid) {
+            this->publish_state(device.get_rssi());
+            this->found_ = true;
+            return true;
+          }
+        }
+        break;
+      case MATCH_BY_IBEACON_UUID:
+        if (!device.get_ibeacon().has_value()) {
+          return false;
+        }
+
+        auto ibeacon = device.get_ibeacon().value();
+
+        if (this->ibeacon_uuid_ != ibeacon.get_uuid()) {
+          return false;
+        }
+
+        if (this->check_ibeacon_major_ && this->ibeacon_major_ != ibeacon.get_major()) {
+          return false;
+        }
+
+        if (this->check_ibeacon_minor_ && this->ibeacon_minor_ != ibeacon.get_minor()) {
+          return false;
+        }
+
+        this->publish_state(device.get_rssi());
+        this->found_ = true;
+        return true;
     }
     return false;
   }
@@ -56,10 +93,20 @@ class BLEPresenceDevice : public binary_sensor::BinarySensorInitiallyOff,
   float get_setup_priority() const override { return setup_priority::DATA; }
 
  protected:
+  enum MATCH_TYPE { MATCH_BY_MAC_ADDRESS, MATCH_BY_SERVICE_UUID, MATCH_BY_IBEACON_UUID };
+  MATCH_TYPE match_by_;
+
   bool found_{false};
-  bool by_address_{false};
+
   uint64_t address_;
+
   esp32_ble_tracker::ESPBTUUID uuid_;
+
+  esp32_ble_tracker::ESPBTUUID ibeacon_uuid_;
+  uint16_t ibeacon_major_;
+  bool check_ibeacon_major_;
+  uint16_t ibeacon_minor_;
+  bool check_ibeacon_minor_;
 };
 
 }  // namespace ble_presence

esphome/components/ble_rssi/sensor.py

@@ -60,5 +60,5 @@ async def to_code(config):
                 )
             )
         elif len(config[CONF_SERVICE_UUID]) == len(esp32_ble_tracker.bt_uuid128_format):
-            uuid128 = esp32_ble_tracker.as_hex_array(config[CONF_SERVICE_UUID])
+            uuid128 = esp32_ble_tracker.as_reversed_hex_array(config[CONF_SERVICE_UUID])
             cg.add(var.set_service_uuid128(uuid128))

esphome/components/esp32_ble_tracker/__init__.py

@@ -108,6 +108,16 @@ def as_hex(value):
 
 
 def as_hex_array(value):
+    value = value.replace("-", "")
+    cpp_array = [
+        f"0x{part}" for part in [value[i : i + 2] for i in range(0, len(value), 2)]
+    ]
+    return cg.RawExpression(
+        "(uint8_t*)(const uint8_t[16]){{{}}}".format(",".join(cpp_array))
+    )
+
+
+def as_reversed_hex_array(value):
     value = value.replace("-", "")
     cpp_array = [
         f"0x{part}" for part in [value[i : i + 2] for i in range(0, len(value), 2)]
@@ -193,7 +203,7 @@ async def to_code(config):
         elif len(conf[CONF_SERVICE_UUID]) == len(bt_uuid32_format):
             cg.add(trigger.set_service_uuid32(as_hex(conf[CONF_SERVICE_UUID])))
         elif len(conf[CONF_SERVICE_UUID]) == len(bt_uuid128_format):
-            uuid128 = as_hex_array(conf[CONF_SERVICE_UUID])
+            uuid128 = as_reversed_hex_array(conf[CONF_SERVICE_UUID])
             cg.add(trigger.set_service_uuid128(uuid128))
         if CONF_MAC_ADDRESS in conf:
             cg.add(trigger.set_address(conf[CONF_MAC_ADDRESS].as_hex))
@@ -205,7 +215,7 @@ async def to_code(config):
         elif len(conf[CONF_MANUFACTURER_ID]) == len(bt_uuid32_format):
             cg.add(trigger.set_manufacturer_uuid32(as_hex(conf[CONF_MANUFACTURER_ID])))
         elif len(conf[CONF_MANUFACTURER_ID]) == len(bt_uuid128_format):
-            uuid128 = as_hex_array(conf[CONF_MANUFACTURER_ID])
+            uuid128 = as_reversed_hex_array(conf[CONF_MANUFACTURER_ID])
             cg.add(trigger.set_manufacturer_uuid128(uuid128))
         if CONF_MAC_ADDRESS in conf:
             cg.add(trigger.set_address(conf[CONF_MAC_ADDRESS].as_hex))

esphome/components/esp32_ble_tracker/esp32_ble_tracker.cpp

@@ -434,6 +434,14 @@ void ESPBTDevice::parse_scan_rst(const esp_ble_gap_cb_param_t::ble_scan_result_e
   }
   for (auto &data : this->manufacturer_datas_) {
     ESP_LOGVV(TAG, "  Manufacturer data: %s", hexencode(data.data).c_str());
+    if (this->get_ibeacon().has_value()) {
+      auto ibeacon = this->get_ibeacon().value();
+      ESP_LOGVV(TAG, "    iBeacon data:");
+      ESP_LOGVV(TAG, "      UUID: %s", ibeacon.get_uuid().to_string().c_str());
+      ESP_LOGVV(TAG, "      Major: %u", ibeacon.get_major());
+      ESP_LOGVV(TAG, "      Minor: %u", ibeacon.get_minor());
+      ESP_LOGVV(TAG, "      TXPower: %d", ibeacon.get_signal_power());
+    }
   }
   for (auto &data : this->service_datas_) {
     ESP_LOGVV(TAG, "  Service data:");

esphome/const.py

@@ -279,6 +279,9 @@ CONF_HUMIDITY = "humidity"
 CONF_HYSTERESIS = "hysteresis"
 CONF_I2C = "i2c"
 CONF_I2C_ID = "i2c_id"
+CONF_IBEACON_MAJOR = "ibeacon_major"
+CONF_IBEACON_MINOR = "ibeacon_minor"
+CONF_IBEACON_UUID = "ibeacon_uuid"
 CONF_ICON = "icon"
 CONF_ID = "id"
 CONF_IDENTITY = "identity"

tests/test2.yaml

@@ -294,6 +294,11 @@ binary_sensor:
   - platform: ble_presence
     service_uuid: '11223344-5566-7788-99aa-bbccddeeff00'
     name: 'BLE Test Service 128 Presence'
+  - platform: ble_presence
+    ibeacon_uuid: '11223344-5566-7788-99aa-bbccddeeff00'
+    ibeacon_major: 100
+    ibeacon_minor: 1
+    name: 'BLE Test iBeacon Presence'
   - platform: esp32_touch
     name: 'ESP32 Touch Pad GPIO27'
     pin: GPIO27