ble_presence_device.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/component.h"
#include "esphome/components/ble_device_base/ble_device.h"
#include "esphome/components/binary_sensor/binary_sensor.h"
 
// No platform #ifdef: ble_device_base provides the BLE types on every platform,
// and this component is only compiled when configured — which requires a BLE
// hub — so it builds on any platform with a BLEHub tracker without a per-chip
// guard.
namespace esphome::ble_presence {
 
class BLEPresenceDevice final : public binary_sensor::BinarySensorInitiallyOff,
                                public ble_device_base::ESPBTDeviceListener,
                                public Component {
 public:
  void set_address(uint64_t address) {
    this->match_by_ = MATCH_BY_MAC_ADDRESS;
    this->address_ = address;
  }
  void set_irk(uint8_t *irk) {
    this->match_by_ = MATCH_BY_IRK;
    this->irk_ = irk;
  }
  void set_service_uuid16(uint16_t uuid) {
    this->match_by_ = MATCH_BY_SERVICE_UUID;
    this->uuid_ = ble_device_base::ESPBTUUID::from_uint16(uuid);
  }
  void set_service_uuid32(uint32_t uuid) {
    this->match_by_ = MATCH_BY_SERVICE_UUID;
    this->uuid_ = ble_device_base::ESPBTUUID::from_uint32(uuid);
  }
  void set_service_uuid128(uint8_t *uuid) {
    this->match_by_ = MATCH_BY_SERVICE_UUID;
    this->uuid_ = ble_device_base::ESPBTUUID::from_raw(uuid);
  }
  void set_ibeacon_uuid(uint8_t *uuid) {
    this->match_by_ = MATCH_BY_IBEACON_UUID;
    this->ibeacon_uuid_ = ble_device_base::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 set_minimum_rssi(int rssi) {
    this->check_minimum_rssi_ = true;
    this->minimum_rssi_ = rssi;
  }
  void set_timeout(uint32_t timeout) { this->timeout_ = timeout; }
  bool parse_device(const ble_device_base::ESPBTDevice &device) override {
    if (this->check_minimum_rssi_ && this->minimum_rssi_ > device.get_rssi()) {
      return false;
    }
    switch (this->match_by_) {
      case MATCH_BY_MAC_ADDRESS:
        if (device.address_uint64() == this->address_) {
          this->set_found_(true);
          return true;
        }
        break;
      case MATCH_BY_IRK:
        if (device.resolve_irk(this->irk_)) {
          this->set_found_(true);
          return true;
        }
        break;
      case MATCH_BY_SERVICE_UUID:
        for (auto uuid : device.get_service_uuids()) {
          if (this->uuid_ == uuid) {
            this->set_found_(true);
            return true;
          }
        }
        break;
      case MATCH_BY_IBEACON_UUID:
        auto maybe_ibeacon = device.get_ibeacon();
        if (!maybe_ibeacon.has_value()) {
          return false;
        }
 
        auto ibeacon = *maybe_ibeacon;
 
        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->set_found_(true);
        return true;
    }
    return false;
  }
 
  void loop() override {
    if (this->found_ && millis() - this->last_seen_ > this->timeout_)
      this->set_found_(false);
  }
  void dump_config() override;
 
 protected:
  void set_found_(bool state) {
    this->found_ = state;
    if (state)
      this->last_seen_ = millis();
    this->publish_state(state);
  }
  enum MatchType { MATCH_BY_MAC_ADDRESS, MATCH_BY_IRK, MATCH_BY_SERVICE_UUID, MATCH_BY_IBEACON_UUID };
  MatchType match_by_;
 
  uint64_t address_;
  uint8_t *irk_;
 
  ble_device_base::ESPBTUUID uuid_;
 
  ble_device_base::ESPBTUUID ibeacon_uuid_;
  uint16_t ibeacon_major_{0};
  uint16_t ibeacon_minor_{0};
 
  int minimum_rssi_{0};
 
  bool check_ibeacon_major_{false};
  bool check_ibeacon_minor_{false};
  bool check_minimum_rssi_{false};
 
  bool found_{false};
  uint32_t last_seen_{};
  uint32_t timeout_{};
};
 
}  // namespace esphome::ble_presence