10#ifndef CONFIG_ESP_HOSTED_ENABLE_BT_BLUEDROID
13#include <esp_bt_defs.h>
14#include <esp_bt_main.h>
15#include <esp_gap_ble_api.h>
16#include <freertos/FreeRTOS.h>
17#include <freertos/FreeRTOSConfig.h>
18#include <freertos/task.h>
26#ifdef USE_ESP32_BLE_SOFTWARE_COEXISTENCE
27#include <esp_coexist.h>
30#define MBEDTLS_AES_ALT
38static const char *
const TAG =
"esp32_ble_tracker";
41static constexpr size_t BLE_ADV_MAX_LOG_BYTES = 62;
50 return "DISCONNECTING";
69 if (this->parent_->is_failed()) {
71 ESP_LOGE(TAG,
"BLE Tracker was marked failed by ESP32BLE");
77#ifdef USE_OTA_STATE_LISTENER
82#ifdef USE_OTA_STATE_LISTENER
86#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
87 for (
auto *client : this->
clients_) {
96 if (!this->parent_->is_active()) {
119 ESP_LOGW(TAG,
"Scan timeout exceeded");
126 ESP_LOGE(TAG,
"Scan never terminated, rebooting");
158 this->client_state_counts_.discovered, this->client_state_counts_.disconnecting);
183#ifdef USE_ESP32_BLE_SOFTWARE_COEXISTENCE
205 ESP_LOGD(TAG,
"Stopping scan.");
223 esp_err_t err = esp_ble_gap_stop_scanning();
225 ESP_LOGE(TAG,
"esp_ble_gap_stop_scanning failed: %d", err);
231 if (!this->parent_->is_active()) {
232 ESP_LOGW(TAG,
"Cannot start scan while ESP32BLE is disabled.");
240 ESP_LOGD(TAG,
"Starting scan, set scanner state to STARTING.");
242#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
244 listener->on_scan_end();
247#ifdef USE_ESP32_BLE_DEVICE
251 this->
scan_params_.own_addr_type = BLE_ADDR_TYPE_PUBLIC;
252 this->
scan_params_.scan_filter_policy = BLE_SCAN_FILTER_ALLOW_ALL;
262 esp_err_t err = esp_ble_gap_set_scan_params(&this->
scan_params_);
264 ESP_LOGE(TAG,
"esp_ble_gap_set_scan_params failed: %d", err);
269 ESP_LOGE(TAG,
"esp_ble_gap_start_scanning failed: %d", err);
275#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
287#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
297#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
306#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
307 for (
auto *client : this->
clients_) {
321 case ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT:
324 case ESP_GAP_BLE_SCAN_START_COMPLETE_EVT:
327 case ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT:
334#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
335 for (
auto *client : this->
clients_) {
336 client->gap_event_handler(event, param);
344 ESP_LOGVV(TAG,
"gap_scan_result - event %d", scan_result.search_evt);
346 if (scan_result.search_evt == ESP_GAP_SEARCH_INQ_RES_EVT) {
349 }
else if (scan_result.search_evt == ESP_GAP_SEARCH_INQ_CMPL_EVT) {
361 ESP_LOGV(TAG,
"gap_scan_set_param_complete - status %d", param.status);
362 if (param.status == ESP_BT_STATUS_DONE) {
371 ESP_LOGV(TAG,
"gap_scan_start_complete - status %d", param.status);
376 if (param.status == ESP_BT_STATUS_SUCCESS) {
390 ESP_LOGV(TAG,
"gap_scan_stop_complete - status %d", param.status);
400 esp_ble_gattc_cb_param_t *param) {
401#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
402 for (
auto *client : this->
clients_) {
403 client->gattc_event_handler(event, gattc_if, param);
412 listener->on_scanner_state(
state);
416#ifdef USE_ESP32_BLE_DEVICE
422 if (data.
data.size() != 23)
429 for (uint8_t i = 0; i < ESP_BD_ADDR_LEN; i++)
430 this->
address_[i] = scan_result.bda[i];
431 this->
address_type_ =
static_cast<esp_ble_addr_type_t
>(scan_result.ble_addr_type);
432 this->
rssi_ = scan_result.rssi;
435 uint8_t total_len = scan_result.adv_data_len + scan_result.scan_rsp_len;
436 this->
parse_adv_(scan_result.ble_adv, total_len);
438#ifdef ESPHOME_LOG_HAS_VERY_VERBOSE
439 ESP_LOGVV(TAG,
"Parse Result:");
440 const char *address_type;
442 case BLE_ADDR_TYPE_PUBLIC:
443 address_type =
"PUBLIC";
445 case BLE_ADDR_TYPE_RANDOM:
446 address_type =
"RANDOM";
448 case BLE_ADDR_TYPE_RPA_PUBLIC:
449 address_type =
"RPA_PUBLIC";
451 case BLE_ADDR_TYPE_RPA_RANDOM:
452 address_type =
"RPA_RANDOM";
455 address_type =
"UNKNOWN";
458 ESP_LOGVV(TAG,
" Address: %02X:%02X:%02X:%02X:%02X:%02X (%s)", this->
address_[0], this->
address_[1],
461 ESP_LOGVV(TAG,
" RSSI: %d", this->
rssi_);
462 ESP_LOGVV(TAG,
" Name: '%s'", this->
name_.c_str());
464 ESP_LOGVV(TAG,
" TX Power: %d", it);
467 ESP_LOGVV(TAG,
" Appearance: %u", *this->
appearance_);
470 ESP_LOGVV(TAG,
" Ad Flag: %u", *this->
ad_flag_);
473 char uuid_buf[esp32_ble::UUID_STR_LEN];
474 uuid.to_str(uuid_buf);
475 ESP_LOGVV(TAG,
" Service UUID: %s", uuid_buf);
480 if (ibeacon.has_value()) {
481 ESP_LOGVV(TAG,
" Manufacturer iBeacon:");
482 char uuid_buf[esp32_ble::UUID_STR_LEN];
483 ibeacon.value().get_uuid().to_str(uuid_buf);
484 ESP_LOGVV(TAG,
" UUID: %s", uuid_buf);
485 ESP_LOGVV(TAG,
" Major: %u", ibeacon.value().get_major());
486 ESP_LOGVV(TAG,
" Minor: %u", ibeacon.value().get_minor());
487 ESP_LOGVV(TAG,
" TXPower: %d", ibeacon.value().get_signal_power());
489 char uuid_buf[esp32_ble::UUID_STR_LEN];
490 data.uuid.to_str(uuid_buf);
491 ESP_LOGVV(TAG,
" Manufacturer ID: %s, data: %s", uuid_buf,
496 ESP_LOGVV(TAG,
" Service data:");
497 char uuid_buf[esp32_ble::UUID_STR_LEN];
498 data.uuid.to_str(uuid_buf);
499 ESP_LOGVV(TAG,
" UUID: %s", uuid_buf);
503 ESP_LOGVV(TAG,
" Adv data: %s",
504 format_hex_pretty_to(hex_buf, scan_result.ble_adv, scan_result.adv_data_len + scan_result.scan_rsp_len));
511 while (offset + 2 <
len) {
512 const uint8_t field_length = payload[offset++];
513 if (field_length == 0) {
518 const uint8_t record_type = payload[offset++];
519 const uint8_t *record = &payload[offset];
520 const uint8_t record_length = field_length - 1;
521 offset += record_length;
529 switch (record_type) {
530 case ESP_BLE_AD_TYPE_NAME_SHORT:
531 case ESP_BLE_AD_TYPE_NAME_CMPL: {
538 if (record_length > this->
name_.length()) {
539 this->
name_ = std::string(
reinterpret_cast<const char *
>(record), record_length);
543 case ESP_BLE_AD_TYPE_TX_PWR: {
550 case ESP_BLE_AD_TYPE_APPEARANCE: {
556 this->
appearance_ = *
reinterpret_cast<const uint16_t *
>(record);
559 case ESP_BLE_AD_TYPE_FLAG: {
572 case ESP_BLE_AD_TYPE_16SRV_CMPL:
573 case ESP_BLE_AD_TYPE_16SRV_PART: {
575 for (uint8_t i = 0; i < record_length / 2; i++) {
580 case ESP_BLE_AD_TYPE_32SRV_CMPL:
581 case ESP_BLE_AD_TYPE_32SRV_PART: {
583 for (uint8_t i = 0; i < record_length / 4; i++) {
588 case ESP_BLE_AD_TYPE_128SRV_CMPL:
589 case ESP_BLE_AD_TYPE_128SRV_PART: {
594 case ESP_BLE_AD_MANUFACTURER_SPECIFIC_TYPE: {
600 if (record_length < 2) {
601 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_MANUFACTURER_SPECIFIC_TYPE");
606 data.data.assign(record + 2UL, record + record_length);
614 case ESP_BLE_AD_TYPE_SERVICE_DATA: {
618 if (record_length < 2) {
619 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_SERVICE_DATA");
624 data.data.assign(record + 2UL, record + record_length);
628 case ESP_BLE_AD_TYPE_32SERVICE_DATA: {
632 if (record_length < 4) {
633 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_32SERVICE_DATA");
638 data.data.assign(record + 4UL, record + record_length);
642 case ESP_BLE_AD_TYPE_128SERVICE_DATA: {
646 if (record_length < 16) {
647 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_128SERVICE_DATA");
652 data.data.assign(record + 16UL, record + record_length);
656 case ESP_BLE_AD_TYPE_INT_RANGE:
660 ESP_LOGV(TAG,
"Unhandled type: advType: 0x%02x", record_type);
668 char buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
676 ESP_LOGCONFIG(TAG,
"BLE Tracker:");
678 " Scan Duration: %" PRIu32
" s\n"
679 " Scan Interval: %.1f ms\n"
680 " Scan Window: %.1f ms\n"
682 " Continuous Scanning: %s",
686 " Scanner State: %s\n"
687 " Connecting: %d, discovered: %d, disconnecting: %d",
689 this->client_state_counts_.discovered, this->client_state_counts_.disconnecting);
695#ifdef USE_ESP32_BLE_DEVICE
702 this->already_discovered_.push_back(
address);
704 char addr_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
707 const char *address_type_s;
709 case BLE_ADDR_TYPE_PUBLIC:
710 address_type_s =
"PUBLIC";
712 case BLE_ADDR_TYPE_RANDOM:
713 address_type_s =
"RANDOM";
715 case BLE_ADDR_TYPE_RPA_PUBLIC:
716 address_type_s =
"RPA_PUBLIC";
718 case BLE_ADDR_TYPE_RPA_RANDOM:
719 address_type_s =
"RPA_RANDOM";
722 address_type_s =
"UNKNOWN";
726 ESP_LOGD(TAG,
" Address Type: %s", address_type_s);
728 ESP_LOGD(TAG,
" Name: '%s'", device.
get_name().c_str());
731 ESP_LOGD(TAG,
" TX Power: %d", tx_power);
737 uint8_t ecb_plaintext[16];
738 uint8_t ecb_ciphertext[16];
742 memcpy(&ecb_key, irk, 16);
743 memset(&ecb_plaintext, 0, 16);
745 ecb_plaintext[13] = (addr64 >> 40) & 0xff;
746 ecb_plaintext[14] = (addr64 >> 32) & 0xff;
747 ecb_plaintext[15] = (addr64 >> 24) & 0xff;
749 mbedtls_aes_context ctx = {0, 0, {0}};
750 mbedtls_aes_init(&ctx);
752 if (mbedtls_aes_setkey_enc(&ctx, ecb_key, 128) != 0) {
753 mbedtls_aes_free(&ctx);
757 if (mbedtls_aes_crypt_ecb(&ctx, ESP_AES_ENCRYPT, ecb_plaintext, ecb_ciphertext) != 0) {
758 mbedtls_aes_free(&ctx);
762 mbedtls_aes_free(&ctx);
764 return ecb_ciphertext[15] == (addr64 & 0xff) && ecb_ciphertext[14] == ((addr64 >> 8) & 0xff) &&
765 ecb_ciphertext[13] == ((addr64 >> 16) & 0xff);
773#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
775 listener->parse_devices(&scan_result, 1);
778#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
779 for (
auto *client : this->
clients_) {
780 client->parse_devices(&scan_result, 1);
787#ifdef USE_ESP32_BLE_DEVICE
792#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
794 if (listener->parse_device(device))
799#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
800 for (
auto *client : this->
clients_) {
801 if (client->parse_device(device)) {
815 ESP_LOGD(TAG,
"Scan %scomplete, set scanner state to IDLE.", is_stop_complete ?
"stop " :
"");
816#ifdef USE_ESP32_BLE_DEVICE
822#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
824 listener->on_scan_end();
833 ESP_LOGE(TAG,
"Scan could not restart after %d attempts, rebooting to restore stack (IDF)",
834 std::numeric_limits<uint8_t>::max());
849#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
850 for (
auto *client : this->
clients_) {
856 ESP_LOGD(TAG,
"Stopping scan to make connection");
864 ESP_LOGD(TAG,
"Promoting client to connect");
865#ifdef USE_ESP32_BLE_SOFTWARE_COEXISTENCE
896#ifdef USE_ESP32_BLE_SOFTWARE_COEXISTENCE
898#ifndef CONFIG_ESP_HOSTED_ENABLE_BT_BLUEDROID
900 ESP_LOGD(TAG,
"Setting coexistence to Bluetooth to make connection.");
902 esp_coex_preference_set(ESP_COEX_PREFER_BT);
904 ESP_LOGD(TAG,
"Setting coexistence preference to balanced.");
906 esp_coex_preference_set(ESP_COEX_PREFER_BALANCE);
uint32_t IRAM_ATTR HOT get_loop_component_start_time() const
Get the cached time in milliseconds from when the current component started its loop execution.
virtual void mark_failed()
Mark this component as failed.
static ESPBTUUID from_uint32(uint32_t uuid)
static ESPBTUUID from_uint16(uint16_t uuid)
static ESPBTUUID from_raw(const uint8_t *data)
bool contains(uint8_t data1, uint8_t data2) const
void try_promote_discovered_clients_()
Try to promote discovered clients to ready to connect.
std::vector< uint64_t > already_discovered_
Vector of addresses that have already been printed in print_bt_device_info.
uint8_t state_version_
Version counter for loop() fast-path optimization.
StaticVector< ESPBTClient *, ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT > clients_
uint32_t scan_start_time_
uint8_t scan_start_fail_count_
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.
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override
ClientStateCounts count_client_states_() const
Count clients in each state.
ClientStateCounts client_state_counts_
uint8_t last_processed_version_
Last state_version_ value when loop() did full processing.
float get_setup_priority() const override
void register_client(ESPBTClient *client)
bool parse_advertisements_
std::vector< BLEScannerStateListener * > scanner_state_listeners_
void dump_config() override
void recalculate_advertisement_parser_types()
ScanTimeoutState scan_timeout_state_
ScannerState scanner_state_
esp_ble_scan_params_t scan_params_
A structure holding the ESP BLE scan parameters.
StaticVector< ESPBTDeviceListener *, ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT > listeners_
void register_listener(ESPBTDeviceListener *listener)
uint32_t scan_timeout_ms_
Precomputed timeout value: scan_duration_ * 2000.
void update_coex_preference_(bool force_ble)
Update BLE coexistence preference.
const char * scanner_state_to_string_(ScannerState state) const
Convert scanner state enum to string for logging.
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.
uint32_t scan_duration_
The interval in seconds to perform scans.
void setup() override
Setup the FreeRTOS task and the Bluetooth stack.
esp_bt_status_t scan_start_failed_
void handle_scanner_failure_()
Handle scanner failure states.
esp_bt_status_t scan_set_param_failed_
void cleanup_scan_state_(bool is_stop_complete)
Common cleanup logic when transitioning scanner to IDLE state.
void ble_before_disabled_event_handler() override
void set_scanner_state_(ScannerState state)
Called to set the scanner state. Will also call callbacks to let listeners know when state is changed...
void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override
void print_bt_device_info(const ESPBTDevice &device)
void gap_scan_event_handler(const BLEScanResult &scan_result) override
void process_scan_result_(const BLEScanResult &scan_result)
Process a single scan result immediately.
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.
void log_unexpected_state_(const char *operation, ScannerState expected_state) const
Log an unexpected scanner state.
void on_ota_global_state(ota::OTAState state, float progress, uint8_t error, ota::OTAComponent *comp) override
void start_scan_(bool first)
Start a single scan by setting up the parameters and doing some esp-idf calls.
static optional< ESPBLEiBeacon > from_manufacturer_data(const ServiceData &data)
struct esphome::esp32_ble_tracker::ESPBLEiBeacon::@83 beacon_data_
Base class for BLE GATT clients that connect to remote devices.
void set_tracker_state_version(uint8_t *version)
Called by ESP32BLETracker::register_client() to enable state change notifications.
uint64_t address_uint64() const
esp_ble_addr_type_t get_address_type() const
esp_ble_addr_type_t address_type_
optional< uint16_t > appearance_
void parse_adv_(const uint8_t *payload, uint8_t len)
void parse_scan_rst(const BLEScanResult &scan_result)
optional< uint8_t > ad_flag_
std::vector< ServiceData > manufacturer_datas_
const char * address_str_to(std::span< char, MAC_ADDRESS_PRETTY_BUFFER_SIZE > buf) const
Format MAC address into provided buffer, returns pointer to buffer for convenience.
std::vector< ESPBTUUID > service_uuids_
const std::vector< int8_t > & get_tx_powers() const
const std::string & get_name() const
std::string address_str() const
bool resolve_irk(const uint8_t *irk) const
std::vector< int8_t > tx_powers_
const BLEScanResult * scan_result_
std::vector< ServiceData > service_datas_
void set_parent(ESP32BLETracker *parent)
void add_global_state_listener(OTAGlobalStateListener *listener)
ESP32BLETracker * global_esp32_ble_tracker
const char * client_state_to_string(ClientState state)
uint64_t ble_addr_to_uint64(const esp_bd_addr_t address)
OTAGlobalCallback * get_global_ota_callback()
const float AFTER_BLUETOOTH
char * format_hex_pretty_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length, char separator)
Format byte array as uppercase hex to buffer (base implementation).
constexpr size_t format_hex_pretty_size(size_t byte_count)
Calculate buffer size needed for format_hex_pretty_to with separator: "XX:XX:...:XX\0".
Application App
Global storage of Application pointer - only one Application can exist.