11 #include <esp_bt_defs.h> 12 #include <esp_bt_main.h> 13 #include <esp_gap_ble_api.h> 14 #include <freertos/FreeRTOS.h> 15 #include <freertos/FreeRTOSConfig.h> 16 #include <freertos/task.h> 17 #include <nvs_flash.h> 25 #include <esp32-hal-bt.h> 28 #define MBEDTLS_AES_ALT 35 namespace esp32_ble_tracker {
37 static const char *
const TAG =
"esp32_ble_tracker";
44 if (this->
parent_->is_failed()) {
46 ESP_LOGE(TAG,
"BLE Tracker was marked failed by ESP32BLE");
54 ESP_LOGE(TAG,
"Could not allocate buffer for BLE Tracker!");
58 global_esp32_ble_tracker =
this;
68 for (
auto *client : this->
clients_) {
77 if (!this->
parent_->is_active()) {
90 int disconnecting = 0;
91 for (
auto *client : this->
clients_) {
92 switch (client->state()) {
110 bool promote_to_connecting = discovered && !searching && !connecting;
117 ESP_LOGW(TAG,
"Too many BLE events to process. Some devices may not show up.");
124 for (
auto *client : this->clients_) {
130 for (
size_t i = 0; i < index; i++) {
136 if (listener->parse_device(device))
140 for (
auto *client : this->clients_) {
141 if (client->parse_device(device)) {
144 promote_to_connecting =
true;
171 if (!connecting && !disconnecting && xSemaphoreTake(this->
scan_end_lock_, 0L)) {
187 ESP_LOGE(TAG,
"ESP-IDF BLE scan could not restart after 255 attempts, rebooting to restore BLE stack...");
193 ESP_LOGD(TAG,
"Stopping scan after failure...");
211 if (promote_to_connecting) {
212 for (
auto *client : this->clients_) {
222 ESP_LOGD(TAG,
"Pausing scan to make connection...");
235 ESP_LOGW(TAG,
"Scan requested when a scan is already in progress. Ignoring.");
240 ESP_LOGD(TAG,
"Stopping scan.");
255 esp_err_t err = esp_ble_gap_stop_scanning();
257 ESP_LOGE(TAG,
"esp_ble_gap_stop_scanning failed: %d", err);
263 if (!this->
parent_->is_active()) {
264 ESP_LOGW(TAG,
"Cannot start scan while ESP32BLE is disabled.");
269 ESP_LOGE(TAG,
"start_scan called without holding scan_end_lock_");
273 ESP_LOGD(TAG,
"Starting scan...");
276 listener->on_scan_end();
280 this->
scan_params_.own_addr_type = BLE_ADDR_TYPE_PUBLIC;
281 this->
scan_params_.scan_filter_policy = BLE_SCAN_FILTER_ALLOW_ALL;
285 esp_err_t err = esp_ble_gap_set_scan_params(&this->
scan_params_);
287 ESP_LOGE(TAG,
"esp_ble_gap_set_scan_params failed: %d", err);
292 ESP_LOGE(TAG,
"esp_ble_gap_start_scanning failed: %d", err);
298 ESP_LOGE(TAG,
"ESP-IDF BLE scan never terminated, rebooting to restore BLE stack...");
306 ESP_LOGE(TAG,
"end_of_scan_ called without holding the scan_end_lock_");
310 ESP_LOGD(TAG,
"End of scan.");
317 listener->on_scan_end();
342 for (
auto *client : this->
clients_) {
353 case ESP_GAP_BLE_SCAN_RESULT_EVT:
356 case ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT:
359 case ESP_GAP_BLE_SCAN_START_COMPLETE_EVT:
362 case ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT:
368 for (
auto *client : this->
clients_) {
369 client->gap_event_handler(event, param);
374 if (param.status == ESP_BT_STATUS_DONE) {
383 if (param.status == ESP_BT_STATUS_SUCCESS) {
396 if (param.search_evt == ESP_GAP_SEARCH_INQ_RES_EVT) {
403 }
else if (param.search_evt == ESP_GAP_SEARCH_INQ_CMPL_EVT) {
409 esp_ble_gattc_cb_param_t *param) {
410 for (
auto *client : this->
clients_) {
411 client->gattc_event_handler(event, gattc_if, param);
420 if (data.
data.size() != 23)
426 this->scan_result_ = param;
427 for (uint8_t i = 0; i < ESP_BD_ADDR_LEN; i++)
428 this->address_[i] = param.bda[i];
429 this->address_type_ = param.ble_addr_type;
430 this->rssi_ = param.rssi;
431 this->parse_adv_(param);
433 #ifdef ESPHOME_LOG_HAS_VERY_VERBOSE 434 ESP_LOGVV(TAG,
"Parse Result:");
435 const char *address_type;
436 switch (this->address_type_) {
437 case BLE_ADDR_TYPE_PUBLIC:
438 address_type =
"PUBLIC";
440 case BLE_ADDR_TYPE_RANDOM:
441 address_type =
"RANDOM";
443 case BLE_ADDR_TYPE_RPA_PUBLIC:
444 address_type =
"RPA_PUBLIC";
446 case BLE_ADDR_TYPE_RPA_RANDOM:
447 address_type =
"RPA_RANDOM";
450 address_type =
"UNKNOWN";
453 ESP_LOGVV(TAG,
" Address: %02X:%02X:%02X:%02X:%02X:%02X (%s)", this->address_[0], this->address_[1],
454 this->address_[2], this->address_[3], this->address_[4], this->address_[5], address_type);
456 ESP_LOGVV(TAG,
" RSSI: %d", this->rssi_);
457 ESP_LOGVV(TAG,
" Name: '%s'", this->name_.c_str());
458 for (
auto &it : this->tx_powers_) {
459 ESP_LOGVV(TAG,
" TX Power: %d", it);
461 if (this->appearance_.has_value()) {
462 ESP_LOGVV(TAG,
" Appearance: %u", *this->appearance_);
464 if (this->ad_flag_.has_value()) {
465 ESP_LOGVV(TAG,
" Ad Flag: %u", *this->ad_flag_);
467 for (
auto &uuid : this->service_uuids_) {
468 ESP_LOGVV(TAG,
" Service UUID: %s", uuid.to_string().c_str());
470 for (
auto &data : this->manufacturer_datas_) {
472 if (ibeacon.has_value()) {
473 ESP_LOGVV(TAG,
" Manufacturer iBeacon:");
474 ESP_LOGVV(TAG,
" UUID: %s", ibeacon.value().get_uuid().to_string().c_str());
475 ESP_LOGVV(TAG,
" Major: %u", ibeacon.value().get_major());
476 ESP_LOGVV(TAG,
" Minor: %u", ibeacon.value().get_minor());
477 ESP_LOGVV(TAG,
" TXPower: %d", ibeacon.value().get_signal_power());
479 ESP_LOGVV(TAG,
" Manufacturer ID: %s, data: %s", data.uuid.to_string().c_str(),
483 for (
auto &data : this->service_datas_) {
484 ESP_LOGVV(TAG,
" Service data:");
485 ESP_LOGVV(TAG,
" UUID: %s", data.uuid.to_string().c_str());
489 ESP_LOGVV(TAG,
" Adv data: %s",
format_hex_pretty(param.ble_adv, param.adv_data_len + param.scan_rsp_len).c_str());
494 const uint8_t *payload = param.ble_adv;
495 uint8_t
len = param.adv_data_len + param.scan_rsp_len;
497 while (offset + 2 < len) {
498 const uint8_t field_length = payload[offset++];
499 if (field_length == 0) {
504 const uint8_t record_type = payload[offset++];
505 const uint8_t *record = &payload[offset];
506 const uint8_t record_length = field_length - 1;
507 offset += record_length;
515 switch (record_type) {
516 case ESP_BLE_AD_TYPE_NAME_SHORT:
517 case ESP_BLE_AD_TYPE_NAME_CMPL: {
524 if (record_length > this->name_.length()) {
525 this->name_ = std::string(reinterpret_cast<const char *>(record), record_length);
529 case ESP_BLE_AD_TYPE_TX_PWR: {
533 this->tx_powers_.push_back(*payload);
536 case ESP_BLE_AD_TYPE_APPEARANCE: {
542 this->appearance_ = *
reinterpret_cast<const uint16_t *
>(record);
545 case ESP_BLE_AD_TYPE_FLAG: {
551 this->ad_flag_ = *record;
558 case ESP_BLE_AD_TYPE_16SRV_CMPL:
559 case ESP_BLE_AD_TYPE_16SRV_PART: {
561 for (uint8_t i = 0; i < record_length / 2; i++) {
562 this->service_uuids_.push_back(
ESPBTUUID::from_uint16(*reinterpret_cast<const uint16_t *>(record + 2 * i)));
566 case ESP_BLE_AD_TYPE_32SRV_CMPL:
567 case ESP_BLE_AD_TYPE_32SRV_PART: {
569 for (uint8_t i = 0; i < record_length / 4; i++) {
570 this->service_uuids_.push_back(
ESPBTUUID::from_uint32(*reinterpret_cast<const uint32_t *>(record + 4 * i)));
574 case ESP_BLE_AD_TYPE_128SRV_CMPL:
575 case ESP_BLE_AD_TYPE_128SRV_PART: {
580 case ESP_BLE_AD_MANUFACTURER_SPECIFIC_TYPE: {
586 if (record_length < 2) {
587 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_MANUFACTURER_SPECIFIC_TYPE");
592 data.data.assign(record + 2UL, record + record_length);
593 this->manufacturer_datas_.push_back(data);
600 case ESP_BLE_AD_TYPE_SERVICE_DATA: {
604 if (record_length < 2) {
605 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_SERVICE_DATA");
610 data.data.assign(record + 2UL, record + record_length);
611 this->service_datas_.push_back(data);
614 case ESP_BLE_AD_TYPE_32SERVICE_DATA: {
618 if (record_length < 4) {
619 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_32SERVICE_DATA");
624 data.data.assign(record + 4UL, record + record_length);
625 this->service_datas_.push_back(data);
628 case ESP_BLE_AD_TYPE_128SERVICE_DATA: {
632 if (record_length < 16) {
633 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_128SERVICE_DATA");
638 data.data.assign(record + 16UL, record + record_length);
639 this->service_datas_.push_back(data);
642 case ESP_BLE_AD_TYPE_INT_RANGE:
646 ESP_LOGV(TAG,
"Unhandled type: advType: 0x%02x", record_type);
654 snprintf(mac,
sizeof(mac),
"%02X:%02X:%02X:%02X:%02X:%02X", this->address_[0], this->address_[1], this->address_[2],
655 this->address_[3], this->address_[4], this->address_[5]);
661 ESP_LOGCONFIG(TAG,
"BLE Tracker:");
662 ESP_LOGCONFIG(TAG,
" Scan Duration: %" PRIu32
" s", this->
scan_duration_);
663 ESP_LOGCONFIG(TAG,
" Scan Interval: %.1f ms", this->
scan_interval_ * 0.625f);
664 ESP_LOGCONFIG(TAG,
" Scan Window: %.1f ms", this->
scan_window_ * 0.625f);
665 ESP_LOGCONFIG(TAG,
" Scan Type: %s", this->
scan_active_ ?
"ACTIVE" :
"PASSIVE");
666 ESP_LOGCONFIG(TAG,
" Continuous Scanning: %s", this->
scan_continuous_ ?
"True" :
"False");
675 this->already_discovered_.push_back(address);
679 const char *address_type_s;
681 case BLE_ADDR_TYPE_PUBLIC:
682 address_type_s =
"PUBLIC";
684 case BLE_ADDR_TYPE_RANDOM:
685 address_type_s =
"RANDOM";
687 case BLE_ADDR_TYPE_RPA_PUBLIC:
688 address_type_s =
"RPA_PUBLIC";
690 case BLE_ADDR_TYPE_RPA_RANDOM:
691 address_type_s =
"RPA_RANDOM";
694 address_type_s =
"UNKNOWN";
698 ESP_LOGD(TAG,
" Address Type: %s", address_type_s);
700 ESP_LOGD(TAG,
" Name: '%s'", device.
get_name().c_str());
703 ESP_LOGD(TAG,
" TX Power: %d", tx_power);
709 uint8_t ecb_plaintext[16];
710 uint8_t ecb_ciphertext[16];
714 memcpy(&ecb_key, irk, 16);
715 memset(&ecb_plaintext, 0, 16);
717 ecb_plaintext[13] = (addr64 >> 40) & 0xff;
718 ecb_plaintext[14] = (addr64 >> 32) & 0xff;
719 ecb_plaintext[15] = (addr64 >> 24) & 0xff;
721 mbedtls_aes_context ctx = {0, 0, {0}};
722 mbedtls_aes_init(&ctx);
724 if (mbedtls_aes_setkey_enc(&ctx, ecb_key, 128) != 0) {
725 mbedtls_aes_free(&ctx);
729 if (mbedtls_aes_crypt_ecb(&ctx, ESP_AES_ENCRYPT, ecb_plaintext, ecb_ciphertext) != 0) {
730 mbedtls_aes_free(&ctx);
734 mbedtls_aes_free(&ctx);
736 return ecb_ciphertext[15] == (addr64 & 0xff) && ecb_ciphertext[14] == ((addr64 >> 8) & 0xff) &&
737 ecb_ciphertext[13] == ((addr64 >> 16) & 0xff);
static const u_int8_t SCAN_RESULT_BUFFER_SIZE
void end_of_scan_()
Called when a scan ends.
uint64_t ble_addr_to_uint64(const esp_bd_addr_t address)
esp_bt_status_t scan_start_failed_
std::string format_hex_pretty(const uint8_t *data, size_t length)
Format the byte array data of length len in pretty-printed, human-readable hex.
bool cancel_timeout(const std::string &name)
Cancel a timeout function.
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override
void setup() override
Setup the FreeRTOS task and the Bluetooth stack.
void register_listener(ESPBTDeviceListener *listener)
void start_scan_(bool first)
Start a single scan by setting up the parameters and doing some esp-idf calls.
void ble_before_disabled_event_handler() override
void set_timeout(const std::string &name, uint32_t timeout, std::function< void()> &&f)
Set a timeout function with a unique name.
void parse_scan_rst(const esp_ble_gap_cb_param_t::ble_scan_result_evt_param ¶m)
void recalculate_advertisement_parser_types()
const std::vector< int8_t > & get_tx_powers() const
std::string address_str() const
esp_bt_status_t scan_set_param_failed_
const float AFTER_BLUETOOTH
esp_ble_scan_params_t scan_params_
A structure holding the ESP BLE scan parameters.
SemaphoreHandle_t scan_end_lock_
void register_client(ESPBTClient *client)
ESP32BLETracker * global_esp32_ble_tracker
static ESPBTUUID from_uint32(uint32_t uuid)
void set_parent(ESP32BLETracker *parent)
void dump_config() override
esp_ble_gap_cb_param_t::ble_scan_result_evt_param * scan_result_buffer_
static ESPBTUUID from_uint16(uint16_t uuid)
Application App
Global storage of Application pointer - only one Application can exist.
bool parse_advertisements_
void add_on_state_callback(std::function< void(OTAState, float, uint8_t, OTAComponent *)> &&callback)
bool resolve_irk(const uint8_t *irk) const
esp_ble_addr_type_t get_address_type() const
void gap_scan_set_param_complete_(const esp_ble_gap_cb_param_t::ble_scan_param_cmpl_evt_param ¶m)
Called when a ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT event is received.
uint64_t address_uint64() const
uint8_t scan_start_fail_count_
SemaphoreHandle_t scan_result_lock_
uint32_t scan_duration_
The interval in seconds to perform scans.
std::vector< uint64_t > already_discovered_
Vector of addresses that have already been printed in print_bt_device_info.
virtual void mark_failed()
Mark this component as failed.
bool contains(uint8_t data1, uint8_t data2) const
void gap_scan_result_(const esp_ble_gap_cb_param_t::ble_scan_result_evt_param ¶m)
Called when a ESP_GAP_BLE_SCAN_RESULT_EVT event is received.
Implementation of SPI Controller mode.
static ESPBTUUID from_raw(const uint8_t *data)
void print_bt_device_info(const ESPBTDevice &device)
const std::string & get_name() const
An STL allocator that uses SPI or internal RAM.
OTAGlobalCallback * get_global_ota_callback()
float get_setup_priority() const override
size_t scan_result_index_
void gap_scan_stop_complete_(const esp_ble_gap_cb_param_t::ble_scan_stop_cmpl_evt_param ¶m)
Called when a ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT event is received.
static optional< ESPBLEiBeacon > from_manufacturer_data(const ServiceData &data)
void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override
std::vector< ESPBTDeviceListener * > listeners_
std::vector< ESPBTClient * > clients_
Client parameters.
void parse_adv_(const esp_ble_gap_cb_param_t::ble_scan_result_evt_param ¶m)
void gap_scan_start_complete_(const esp_ble_gap_cb_param_t::ble_scan_start_cmpl_evt_param ¶m)
Called when a ESP_GAP_BLE_SCAN_START_COMPLETE_EVT event is received.