Merge branch 'master' into refactor

Author: thekurtovic

CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [2.1.0] 2025-01-12
+
+## Fixed
+- Crash when retrieving descriptors if more than one exists.
+- Incorrect TX power value being advertised.
+- New user guide code for 2.x
+- Potential race condition if `NimBLEScan::clearResults1 is called from multiple tasks.
+
+## Changed
+- If privacy is not enabled identity keys will not be shared.
+- `NimBLEDevice::setPower` and `NimBLEDevice::getPower` now take an additional parameter `NimBLETxPowerType` to set/get the power level for different operations.
+
+## Added
+- Config option `CONFIG_NIMBLE_CPP_ADDR_FMT_EXCLUDE_DELIMITER`, if defined will remove the ":" delimiter from the BLE address string.
+- Config option `CONFIG_NIMBLE_CPP_ADDR_FMT_UPPERCASE` if defined will make the BLE address strings uppercase.
+
 ## [2.0.3] 2025-01-05
 
 ## Fixed

docs/Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = esp-nimble-cpp
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.0.3
+PROJECT_NUMBER         = 2.1.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

idf_component.yml

@@ -1,5 +1,5 @@
 ## IDF Component Manager Manifest File
-version: "2.0.3"
+version: "2.1.0"
 license: "Apache-2.0"
 description: "C++ wrapper for the NimBLE BLE stack"
 url: "https://github.com/h2zero/esp-nimble-cpp"

library.json

@@ -1,6 +1,6 @@
 {
   "name": "esp-nimble-cpp",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "C++ wrapper for the NimBLE BLE stack",
   "keywords": [
     "BLE",

src/NimBLEAdvertisementData.cpp

@@ -110,7 +110,7 @@ bool NimBLEAdvertisementData::addTxPower() {
     data[0] = BLE_HS_ADV_TX_PWR_LVL_LEN + 1;
     data[1] = BLE_HS_ADV_TYPE_TX_PWR_LVL;
 # ifndef CONFIG_IDF_TARGET_ESP32P4
-    data[2] = NimBLEDevice::getPower();
+    data[2] = NimBLEDevice::getPower(NimBLETxPowerType::Advertise);
 # else
     data[2] = 0;
 # endif

src/NimBLEDevice.cpp

@@ -464,17 +464,33 @@ bool NimBLEDevice::setPowerLevel(esp_power_level_t powerLevel, esp_ble_power_typ
  * @param [in] dbm The power level to set in dBm.
  * @return True if the power level was set successfully.
  */
-bool NimBLEDevice::setPower(int8_t dbm) {
+bool NimBLEDevice::setPower(int8_t dbm, NimBLETxPowerType type) {
 # ifdef ESP_PLATFORM
 #  ifdef CONFIG_IDF_TARGET_ESP32P4
     return false; // CONFIG_IDF_TARGET_ESP32P4 does not support esp_ble_tx_power_set
 #  else
     if (dbm % 3 == 2) {
         dbm++; // round up to the next multiple of 3 to be able to target 20dbm
     }
-    return setPowerLevel(static_cast<esp_power_level_t>(dbm / 3 + ESP_PWR_LVL_N0));
+
+    bool success = false;
+    esp_power_level_t espPwr = static_cast<esp_power_level_t>(dbm / 3 + ESP_PWR_LVL_N0);
+    if (type == NimBLETxPowerType::All) {
+        success  = setPowerLevel(espPwr, ESP_BLE_PWR_TYPE_ADV);
+        success &= setPowerLevel(espPwr, ESP_BLE_PWR_TYPE_SCAN);
+        success &= setPowerLevel(espPwr, ESP_BLE_PWR_TYPE_DEFAULT);
+    } else if (type == NimBLETxPowerType::Advertise) {
+        success = setPowerLevel(espPwr,  ESP_BLE_PWR_TYPE_ADV);
+    } else if (type == NimBLETxPowerType::Scan) {
+        success = setPowerLevel(espPwr, ESP_BLE_PWR_TYPE_SCAN);
+    } else if (type == NimBLETxPowerType::Connection) {
+        success = setPowerLevel(espPwr, ESP_BLE_PWR_TYPE_DEFAULT);
+    }
+
+    return success;
 #  endif
 # else
+    (void)type; // unused
     NIMBLE_LOGD(LOG_TAG, ">> setPower: %d", dbm);
     ble_hci_vs_set_tx_pwr_cp cmd{dbm};
     ble_hci_vs_set_tx_pwr_rp rsp{0};
@@ -493,12 +509,16 @@ bool NimBLEDevice::setPower(int8_t dbm) {
  * @brief Get the transmission power.
  * @return The power level currently used in dbm or 0xFF on error.
  */
-int NimBLEDevice::getPower() {
+int NimBLEDevice::getPower(NimBLETxPowerType type) {
 # ifdef ESP_PLATFORM
 #  ifdef CONFIG_IDF_TARGET_ESP32P4
     return 0xFF; // CONFIG_IDF_TARGET_ESP32P4 does not support esp_ble_tx_power_get
 #  else
-    int pwr = getPowerLevel();
+    esp_ble_power_type_t espPwr = type == NimBLETxPowerType::Advertise ? ESP_BLE_PWR_TYPE_ADV
+                                  : type == NimBLETxPowerType::Scan    ? ESP_BLE_PWR_TYPE_SCAN
+                                                                       : ESP_BLE_PWR_TYPE_DEFAULT;
+
+    int pwr = getPowerLevel(espPwr);
     if (pwr < 0) {
         NIMBLE_LOGE(LOG_TAG, "esp_ble_tx_power_get failed rc=%d", pwr);
         return 0xFF;
@@ -515,6 +535,7 @@ int NimBLEDevice::getPower() {
     return 0;
 #  endif
 # else
+    (void)type; // unused
     return ble_phy_txpwr_get();
 # endif
 } // getPower
@@ -877,17 +898,21 @@ bool NimBLEDevice::init(const std::string& deviceName) {
         nimble_port_init();
 
         // Setup callbacks for host events
-        ble_hs_cfg.reset_cb = NimBLEDevice::onReset;
-        ble_hs_cfg.sync_cb  = NimBLEDevice::onSync;
+        ble_hs_cfg.reset_cb        = NimBLEDevice::onReset;
+        ble_hs_cfg.sync_cb         = NimBLEDevice::onSync;
+        ble_hs_cfg.store_status_cb = ble_store_util_status_rr; /*TODO: Implement handler for this*/
 
         // Set initial security capabilities
         ble_hs_cfg.sm_io_cap         = BLE_HS_IO_NO_INPUT_OUTPUT;
         ble_hs_cfg.sm_bonding        = 0;
         ble_hs_cfg.sm_mitm           = 0;
         ble_hs_cfg.sm_sc             = 1;
-        ble_hs_cfg.sm_our_key_dist   = BLE_SM_PAIR_KEY_DIST_ENC | BLE_SM_PAIR_KEY_DIST_ID;
-        ble_hs_cfg.sm_their_key_dist = BLE_SM_PAIR_KEY_DIST_ENC | BLE_SM_PAIR_KEY_DIST_ID;
-        ble_hs_cfg.store_status_cb   = ble_store_util_status_rr; /*TODO: Implement handler for this*/
+        ble_hs_cfg.sm_our_key_dist   = BLE_SM_PAIR_KEY_DIST_ENC;
+        ble_hs_cfg.sm_their_key_dist = BLE_SM_PAIR_KEY_DIST_ENC;
+# if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_PRIVACY)
+        ble_hs_cfg.sm_our_key_dist   |= BLE_SM_PAIR_KEY_DIST_ID;
+        ble_hs_cfg.sm_their_key_dist |= BLE_SM_PAIR_KEY_DIST_ID;
+# endif
 
         setDeviceName(deviceName);
         ble_store_config_init();

src/NimBLEDevice.h

@@ -101,6 +101,13 @@ class NimBLEAddress;
 #  define NIMBLE_MAX_CONNECTIONS CONFIG_NIMBLE_MAX_CONNECTIONS
 # endif
 
+enum class NimBLETxPowerType {
+    All  = 0,
+    Advertise  = 1,
+    Scan = 2,
+    Connection = 3
+};
+
 typedef int (*gap_event_handler)(ble_gap_event* event, void* arg);
 
 /**
@@ -138,8 +145,8 @@ class NimBLEDevice {
     static void          onReset(int reason);
     static void          onSync(void);
     static void          host_task(void* param);
-    static int           getPower();
-    static bool          setPower(int8_t dbm);
+    static int           getPower(NimBLETxPowerType type = NimBLETxPowerType::All);
+    static bool          setPower(int8_t dbm, NimBLETxPowerType type = NimBLETxPowerType::All);
 
 # ifdef ESP_PLATFORM
 #  ifndef CONFIG_IDF_TARGET_ESP32P4

src/NimBLEExtAdvertising.cpp

@@ -359,7 +359,7 @@ NimBLEExtAdvertisement::NimBLEExtAdvertisement(uint8_t priPhy, uint8_t secPhy) {
     m_params.own_addr_type = NimBLEDevice::m_ownAddrType;
     m_params.primary_phy   = priPhy;
     m_params.secondary_phy = secPhy;
-    m_params.tx_power      = 127;
+    m_params.tx_power      = NimBLEDevice::getPower(NimBLETxPowerType::Advertise);
 } // NimBLEExtAdvertisement
 
 /**
@@ -1014,8 +1014,22 @@ bool NimBLEExtAdvertisement::setPreferredParams(uint16_t minInterval, uint16_t m
 /**
  * @brief Adds Tx power level to the advertisement data.
  */
-void NimBLEExtAdvertisement::addTxPower() {
+bool NimBLEExtAdvertisement::addTxPower() {
+    if (m_params.legacy_pdu) {
+        m_params.include_tx_power = 0;
+        uint8_t data[3];
+        data[0] = BLE_HS_ADV_TX_PWR_LVL_LEN + 1;
+        data[1] = BLE_HS_ADV_TYPE_TX_PWR_LVL;
+# ifndef CONFIG_IDF_TARGET_ESP32P4
+        data[2] = NimBLEDevice::getPower(NimBLETxPowerType::Advertise);
+# else
+        data[2] = 0;
+# endif
+        return addData(data, 3);
+    }
+
     m_params.include_tx_power = 1;
+    return true;
 } // addTxPower
 
 /**

src/NimBLEExtAdvertising.h

@@ -46,34 +46,33 @@ class NimBLEUUID;
 class NimBLEExtAdvertisement {
   public:
     NimBLEExtAdvertisement(uint8_t priPhy = BLE_HCI_LE_PHY_1M, uint8_t secPhy = BLE_HCI_LE_PHY_1M);
-    bool setAppearance(uint16_t appearance);
-    bool addServiceUUID(const NimBLEUUID& serviceUUID);
-    bool addServiceUUID(const char* serviceUUID);
-    bool removeServiceUUID(const NimBLEUUID& serviceUUID);
-    bool removeServiceUUID(const char* serviceUUID);
-    bool removeServices();
-    bool setCompleteServices(const NimBLEUUID& uuid);
-    bool setCompleteServices16(const std::vector<NimBLEUUID>& uuids);
-    bool setCompleteServices32(const std::vector<NimBLEUUID>& uuids);
-    bool setFlags(uint8_t flag);
-    bool setManufacturerData(const uint8_t* data, size_t length);
-    bool setManufacturerData(const std::string& data);
-    bool setManufacturerData(const std::vector<uint8_t>& data);
-    bool setURI(const std::string& uri);
-    bool setName(const std::string& name, bool isComplete = true);
-    bool setPartialServices(const NimBLEUUID& uuid);
-    bool setPartialServices16(const std::vector<NimBLEUUID>& uuids);
-    bool setPartialServices32(const std::vector<NimBLEUUID>& uuids);
-    bool setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length);
-    bool setServiceData(const NimBLEUUID& uuid, const std::string& data);
-    bool setServiceData(const NimBLEUUID& uuid, const std::vector<uint8_t>& data);
-    bool setShortName(const std::string& name);
-    bool setData(const uint8_t* data, size_t length);
-    bool addData(const uint8_t* data, size_t length);
-    bool addData(const std::string& data);
-    bool setPreferredParams(uint16_t min, uint16_t max);
-
-    void        addTxPower();
+    bool        setAppearance(uint16_t appearance);
+    bool        addServiceUUID(const NimBLEUUID& serviceUUID);
+    bool        addServiceUUID(const char* serviceUUID);
+    bool        removeServiceUUID(const NimBLEUUID& serviceUUID);
+    bool        removeServiceUUID(const char* serviceUUID);
+    bool        removeServices();
+    bool        setCompleteServices(const NimBLEUUID& uuid);
+    bool        setCompleteServices16(const std::vector<NimBLEUUID>& uuids);
+    bool        setCompleteServices32(const std::vector<NimBLEUUID>& uuids);
+    bool        setFlags(uint8_t flag);
+    bool        setManufacturerData(const uint8_t* data, size_t length);
+    bool        setManufacturerData(const std::string& data);
+    bool        setManufacturerData(const std::vector<uint8_t>& data);
+    bool        setURI(const std::string& uri);
+    bool        setName(const std::string& name, bool isComplete = true);
+    bool        setPartialServices(const NimBLEUUID& uuid);
+    bool        setPartialServices16(const std::vector<NimBLEUUID>& uuids);
+    bool        setPartialServices32(const std::vector<NimBLEUUID>& uuids);
+    bool        setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length);
+    bool        setServiceData(const NimBLEUUID& uuid, const std::string& data);
+    bool        setServiceData(const NimBLEUUID& uuid, const std::vector<uint8_t>& data);
+    bool        setShortName(const std::string& name);
+    bool        setData(const uint8_t* data, size_t length);
+    bool        addData(const uint8_t* data, size_t length);
+    bool        addData(const std::string& data);
+    bool        setPreferredParams(uint16_t min, uint16_t max);
+    bool        addTxPower();
     void        setLegacyAdvertising(bool enable);
     void        setConnectable(bool enable);
     void        setScannable(bool enable);

src/NimBLEScan.cpp

@@ -468,19 +468,26 @@ NimBLEScanResults NimBLEScan::getResults() {
  * @brief Clear the stored results of the scan.
  */
 void NimBLEScan::clearResults() {
-    for (const auto& dev : m_scanResults.m_deviceVec) {
-        delete dev;
+    if (m_scanResults.m_deviceVec.size()) {
+        std::vector<NimBLEAdvertisedDevice*> vSwap{};
+        ble_npl_hw_enter_critical();
+        vSwap.swap(m_scanResults.m_deviceVec);
+        ble_npl_hw_exit_critical(0);
+        for (const auto& dev : vSwap) {
+            delete dev;
+        }
     }
-    std::vector<NimBLEAdvertisedDevice*>().swap(m_scanResults.m_deviceVec);
 } // clearResults
 
 /**
  * @brief Dump the scan results to the log.
  */
 void NimBLEScanResults::dump() const {
+#if CONFIG_NIMBLE_CPP_LOG_LEVEL >=3
     for (const auto& dev : m_deviceVec) {
         NIMBLE_LOGI(LOG_TAG, "- %s", dev->toString().c_str());
     }
+#endif
 } // dump
 
 /**