ble_hub.h

Go to the documentation of this file.

// ble_hub.h
//
// BLEHub — the platform-neutral BLE tracker contract.
//
// Every BLE tracker component (esp32_ble_tracker, bk72xx_ble_tracker,
// ln882h_ble_tracker, future chips) implements this interface; every BLE
// consumer (sensor components, bluetooth_proxy) binds to it — in YAML via
// `cv.use_id(BLEHub)`, which resolves whichever tracker the config declares.
// Adding a new BLE chip therefore requires only a new tracker component that
// implements BLEHub: no consumer, registry, or base changes.
//
// Chip differences are expressed as data (HubCapabilities), never as
// platform conditionals in consumers.
 
#pragma once
 
#include "ble_device.h"
 
#include <cstdint>
#include <functional>
 
namespace esphome::ble_device_base {
 
using RawAdvertisementCallback =
    std::function<void(const uint8_t *mac, int rssi, uint8_t addr_type, const uint8_t *data, uint16_t data_len)>;
 
struct HubCapabilities {
  bool active_scan;
  bool merges_scan_response;
  bool gatt;
};
 
class BLEHub {
 public:
  virtual ~BLEHub() = default;
 
  virtual void register_listener(ESPBTDeviceListener *listener) = 0;
 
  virtual void set_raw_advertisement_callback(RawAdvertisementCallback cb) = 0;
 
  virtual HubCapabilities get_capabilities() const = 0;
 
  virtual void get_adapter_mac(uint8_t out[6]) = 0;
 
  virtual bool scan_running() = 0;
  virtual bool scan_active() = 0;
};
 
}  // namespace esphome::ble_device_base