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#ifdef USE_ESP32_BLE_DEVICE
31#ifdef USE_BLE_TRACKER_PSA_AES
32#include <psa/crypto.h>
34#define MBEDTLS_AES_ALT
44static const char *
const TAG =
"esp32_ble_tracker";
47static constexpr size_t BLE_ADV_MAX_LOG_BYTES = 62;
56 return "DISCONNECTING";
75 if (this->parent_->is_failed()) {
77 ESP_LOGE(TAG,
"BLE Tracker was marked failed by ESP32BLE");
83#ifdef USE_OTA_STATE_LISTENER
88#ifdef USE_OTA_STATE_LISTENER
93#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
94 for (
auto *client : this->
clients_) {
108 if (!this->parent_->is_active()) {
131 ESP_LOGW(TAG,
"Scan timeout exceeded");
138 ESP_LOGE(TAG,
"Scan never terminated, rebooting");
169 ESP_LOGD(TAG,
"connecting: %d, discovered: %d, disconnecting: %d, active: %d",
171 this->client_state_counts_.disconnecting, this->client_state_counts_.active);
198#ifdef USE_ESP32_BLE_SOFTWARE_COEXISTENCE
226 ESP_LOGD(TAG,
"Stopping scan.");
244 esp_err_t err = esp_ble_gap_stop_scanning();
246 ESP_LOGE(TAG,
"esp_ble_gap_stop_scanning failed: %d", err);
252 if (!this->parent_->is_active()) {
253 ESP_LOGW(TAG,
"Cannot start scan while ESP32BLE is disabled.");
261 ESP_LOGV(TAG,
"Starting scan, set scanner state to STARTING.");
263#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
265 listener->on_scan_end();
268#ifdef USE_ESP32_BLE_DEVICE
272 this->
scan_params_.own_addr_type = BLE_ADDR_TYPE_PUBLIC;
273 this->
scan_params_.scan_filter_policy = BLE_SCAN_FILTER_ALLOW_ALL;
283 esp_err_t err = esp_ble_gap_set_scan_params(&this->
scan_params_);
285 ESP_LOGE(TAG,
"esp_ble_gap_set_scan_params failed: %d", err);
290 ESP_LOGE(TAG,
"esp_ble_gap_start_scanning failed: %d", err);
296#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
308#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
318#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
327#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
328 for (
auto *client : this->
clients_) {
342 case ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT:
345 case ESP_GAP_BLE_SCAN_START_COMPLETE_EVT:
348 case ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT:
355#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
356 for (
auto *client : this->
clients_) {
357 client->gap_event_handler(event, param);
365 ESP_LOGVV(TAG,
"gap_scan_result - event %d", scan_result.search_evt);
367 if (scan_result.search_evt == ESP_GAP_SEARCH_INQ_RES_EVT) {
370 }
else if (scan_result.search_evt == ESP_GAP_SEARCH_INQ_CMPL_EVT) {
382 ESP_LOGV(TAG,
"gap_scan_set_param_complete - status %d", param.status);
383 if (param.status == ESP_BT_STATUS_DONE) {
392 ESP_LOGV(TAG,
"gap_scan_start_complete - status %d", param.status);
397 if (param.status == ESP_BT_STATUS_SUCCESS) {
411 ESP_LOGV(TAG,
"gap_scan_stop_complete - status %d", param.status);
421 esp_ble_gattc_cb_param_t *param) {
422#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
423 for (
auto *client : this->
clients_) {
424 client->gattc_event_handler(event, gattc_if, param);
433 listener->on_scanner_state(
state);
437#ifdef USE_ESP32_BLE_DEVICE
440 if (!data.uuid.contains(0x4C, 0x00))
443 if (data.data.size() != 23)
450 for (uint8_t i = 0; i < ESP_BD_ADDR_LEN; i++)
451 this->
address_[i] = scan_result.bda[i];
452 this->
address_type_ =
static_cast<esp_ble_addr_type_t
>(scan_result.ble_addr_type);
453 this->
rssi_ = scan_result.rssi;
456 uint8_t total_len = scan_result.adv_data_len + scan_result.scan_rsp_len;
457 this->
parse_adv_(scan_result.ble_adv, total_len);
459#ifdef ESPHOME_LOG_HAS_VERY_VERBOSE
460 ESP_LOGVV(TAG,
"Parse Result:");
461 const char *address_type;
463 case BLE_ADDR_TYPE_PUBLIC:
464 address_type =
"PUBLIC";
466 case BLE_ADDR_TYPE_RANDOM:
467 address_type =
"RANDOM";
469 case BLE_ADDR_TYPE_RPA_PUBLIC:
470 address_type =
"RPA_PUBLIC";
472 case BLE_ADDR_TYPE_RPA_RANDOM:
473 address_type =
"RPA_RANDOM";
476 address_type =
"UNKNOWN";
479 ESP_LOGVV(TAG,
" Address: %02X:%02X:%02X:%02X:%02X:%02X (%s)", this->
address_[0], this->
address_[1],
482 ESP_LOGVV(TAG,
" RSSI: %d", this->
rssi_);
483 ESP_LOGVV(TAG,
" Name: '%s'", this->
name_.c_str());
485 ESP_LOGVV(TAG,
" TX Power: %d", it);
488 ESP_LOGVV(TAG,
" Appearance: %u", *this->
appearance_);
491 ESP_LOGVV(TAG,
" Ad Flag: %u", *this->
ad_flag_);
494 char uuid_buf[esp32_ble::UUID_STR_LEN];
495 uuid.to_str(uuid_buf);
496 ESP_LOGVV(TAG,
" Service UUID: %s", uuid_buf);
501 if (ibeacon.has_value()) {
502 ESP_LOGVV(TAG,
" Manufacturer iBeacon:");
503 char uuid_buf[esp32_ble::UUID_STR_LEN];
504 ibeacon.value().get_uuid().to_str(uuid_buf);
505 ESP_LOGVV(TAG,
" UUID: %s", uuid_buf);
506 ESP_LOGVV(TAG,
" Major: %u", ibeacon.value().get_major());
507 ESP_LOGVV(TAG,
" Minor: %u", ibeacon.value().get_minor());
508 ESP_LOGVV(TAG,
" TXPower: %d", ibeacon.value().get_signal_power());
510 char uuid_buf[esp32_ble::UUID_STR_LEN];
511 data.uuid.to_str(uuid_buf);
512 ESP_LOGVV(TAG,
" Manufacturer ID: %s, data: %s", uuid_buf,
517 ESP_LOGVV(TAG,
" Service data:");
518 char uuid_buf[esp32_ble::UUID_STR_LEN];
519 data.uuid.to_str(uuid_buf);
520 ESP_LOGVV(TAG,
" UUID: %s", uuid_buf);
524 ESP_LOGVV(TAG,
" Adv data: %s",
525 format_hex_pretty_to(hex_buf, scan_result.ble_adv, scan_result.adv_data_len + scan_result.scan_rsp_len));
532 while (offset + 2 <
len) {
533 const uint8_t field_length = payload[offset++];
534 if (field_length == 0) {
539 if (offset + field_length >
len) {
544 const uint8_t record_type = payload[offset++];
545 const uint8_t *record = &payload[offset];
546 const uint8_t record_length = field_length - 1;
547 offset += record_length;
555 switch (record_type) {
556 case ESP_BLE_AD_TYPE_NAME_SHORT:
557 case ESP_BLE_AD_TYPE_NAME_CMPL: {
564 if (record_length > this->
name_.length()) {
565 this->
name_ = std::string(
reinterpret_cast<const char *
>(record), record_length);
569 case ESP_BLE_AD_TYPE_TX_PWR: {
576 case ESP_BLE_AD_TYPE_APPEARANCE: {
582 this->
appearance_ = *
reinterpret_cast<const uint16_t *
>(record);
585 case ESP_BLE_AD_TYPE_FLAG: {
598 case ESP_BLE_AD_TYPE_16SRV_CMPL:
599 case ESP_BLE_AD_TYPE_16SRV_PART: {
601 for (uint8_t i = 0; i < record_length / 2; i++) {
606 case ESP_BLE_AD_TYPE_32SRV_CMPL:
607 case ESP_BLE_AD_TYPE_32SRV_PART: {
609 for (uint8_t i = 0; i < record_length / 4; i++) {
614 case ESP_BLE_AD_TYPE_128SRV_CMPL:
615 case ESP_BLE_AD_TYPE_128SRV_PART: {
620 case ESP_BLE_AD_MANUFACTURER_SPECIFIC_TYPE: {
626 if (record_length < 2) {
627 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_MANUFACTURER_SPECIFIC_TYPE");
632 data.data.assign(record + 2UL, record + record_length);
640 case ESP_BLE_AD_TYPE_SERVICE_DATA: {
644 if (record_length < 2) {
645 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_SERVICE_DATA");
650 data.data.assign(record + 2UL, record + record_length);
654 case ESP_BLE_AD_TYPE_32SERVICE_DATA: {
658 if (record_length < 4) {
659 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_32SERVICE_DATA");
664 data.data.assign(record + 4UL, record + record_length);
668 case ESP_BLE_AD_TYPE_128SERVICE_DATA: {
672 if (record_length < 16) {
673 ESP_LOGV(TAG,
"Record length too small for ESP_BLE_AD_TYPE_128SERVICE_DATA");
678 data.data.assign(record + 16UL, record + record_length);
682 case ESP_BLE_AD_TYPE_INT_RANGE:
686 ESP_LOGV(TAG,
"Unhandled type: advType: 0x%02x", record_type);
694 char buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
702 ESP_LOGCONFIG(TAG,
"BLE Tracker:");
704 " Scan Duration: %" PRIu32
" s\n"
705 " Scan Interval: %.1f ms\n"
706 " Scan Window: %.1f ms\n"
708 " Continuous Scanning: %s",
712 " Scanner State: %s\n"
713 " Connecting: %d, discovered: %d, disconnecting: %d, active: %d",
715 this->client_state_counts_.discovered, this->client_state_counts_.disconnecting,
716 this->client_state_counts_.active);
722#ifdef USE_ESP32_BLE_DEVICE
729 this->already_discovered_.push_back(
address);
731 char addr_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
734 const char *address_type_s;
736 case BLE_ADDR_TYPE_PUBLIC:
737 address_type_s =
"PUBLIC";
739 case BLE_ADDR_TYPE_RANDOM:
740 address_type_s =
"RANDOM";
742 case BLE_ADDR_TYPE_RPA_PUBLIC:
743 address_type_s =
"RPA_PUBLIC";
745 case BLE_ADDR_TYPE_RPA_RANDOM:
746 address_type_s =
"RPA_RANDOM";
749 address_type_s =
"UNKNOWN";
753 ESP_LOGD(TAG,
" Address Type: %s", address_type_s);
755 ESP_LOGD(TAG,
" Name: '%s'", device.
get_name().c_str());
758 ESP_LOGD(TAG,
" TX Power: %d", tx_power);
763 static constexpr size_t AES_BLOCK_SIZE = 16;
764 static constexpr size_t AES_KEY_BITS = 128;
766 uint8_t ecb_key[AES_BLOCK_SIZE];
767 uint8_t ecb_plaintext[AES_BLOCK_SIZE];
768 uint8_t ecb_ciphertext[AES_BLOCK_SIZE];
772 memcpy(&ecb_key, irk, AES_BLOCK_SIZE);
773 memset(&ecb_plaintext, 0, AES_BLOCK_SIZE);
775 ecb_plaintext[13] = (addr64 >> 40) & 0xff;
776 ecb_plaintext[14] = (addr64 >> 32) & 0xff;
777 ecb_plaintext[15] = (addr64 >> 24) & 0xff;
779#ifdef USE_BLE_TRACKER_PSA_AES
781 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
782 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
783 psa_set_key_bits(&attributes, AES_KEY_BITS);
784 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
785 psa_set_key_algorithm(&attributes, PSA_ALG_ECB_NO_PADDING);
787 mbedtls_svc_key_id_t key_id;
788 if (psa_import_key(&attributes, ecb_key, AES_BLOCK_SIZE, &key_id) != PSA_SUCCESS) {
792 size_t output_length;
793 psa_status_t
status = psa_cipher_encrypt(key_id, PSA_ALG_ECB_NO_PADDING, ecb_plaintext, AES_BLOCK_SIZE,
794 ecb_ciphertext, AES_BLOCK_SIZE, &output_length);
795 psa_destroy_key(key_id);
796 if (
status != PSA_SUCCESS || output_length != AES_BLOCK_SIZE) {
801 mbedtls_aes_context ctx = {0, 0, {0}};
802 mbedtls_aes_init(&ctx);
804 if (mbedtls_aes_setkey_enc(&ctx, ecb_key, AES_KEY_BITS) != 0) {
805 mbedtls_aes_free(&ctx);
809 if (mbedtls_aes_crypt_ecb(&ctx, ESP_AES_ENCRYPT, ecb_plaintext, ecb_ciphertext) != 0) {
810 mbedtls_aes_free(&ctx);
814 mbedtls_aes_free(&ctx);
817 return ecb_ciphertext[15] == (addr64 & 0xff) && ecb_ciphertext[14] == ((addr64 >> 8) & 0xff) &&
818 ecb_ciphertext[13] == ((addr64 >> 16) & 0xff);
826#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
828 listener->parse_devices(&scan_result, 1);
831#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
832 for (
auto *client : this->
clients_) {
833 client->parse_devices(&scan_result, 1);
840#ifdef USE_ESP32_BLE_DEVICE
845#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
847 if (listener->parse_device(device))
852#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
853 for (
auto *client : this->
clients_) {
854 if (client->parse_device(device)) {
868 ESP_LOGV(TAG,
"Scan %scomplete, set scanner state to IDLE.", is_stop_complete ?
"stop " :
"");
869#ifdef USE_ESP32_BLE_DEVICE
875#ifdef ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT
877 listener->on_scan_end();
886 ESP_LOGE(TAG,
"Scan could not restart after %d attempts, rebooting to restore stack (IDF)",
887 std::numeric_limits<uint8_t>::max());
902#ifdef ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT
903 for (
auto *client : this->
clients_) {
909 ESP_LOGD(TAG,
"Stopping scan to make connection");
917 ESP_LOGD(TAG,
"Promoting client to connect");
918#ifdef USE_ESP32_BLE_SOFTWARE_COEXISTENCE
949#ifdef USE_ESP32_BLE_SOFTWARE_COEXISTENCE
951#ifndef CONFIG_ESP_HOSTED_ENABLE_BT_BLUEDROID
953 ESP_LOGD(TAG,
"Setting coexistence to Bluetooth to make connection.");
955 esp_coex_preference_set(ESP_COEX_PREFER_BT);
957 ESP_LOGD(TAG,
"Setting coexistence preference to balanced.");
959 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.
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)
void try_promote_discovered_clients_()
Try to promote discovered clients to ready to connect.
void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
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.
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.
void gap_scan_event_handler(const BLEScanResult &scan_result)
float get_setup_priority() const override
void register_client(ESPBTClient *client)
bool parse_advertisements_
std::vector< BLEScannerStateListener * > scanner_state_listeners_
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param)
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.
bool scan_continuous_before_ota_
uint32_t scan_duration_
The interval in seconds to perform scans.
void setup() override
Setup the FreeRTOS task and the Bluetooth stack.
void ble_before_disabled_event_handler()
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 set_scanner_state_(ScannerState state)
Called to set the scanner state. Will also call callbacks to let listeners know when state is changed...
void print_bt_device_info(const ESPBTDevice &device)
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()
constexpr 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.