Merge branch 'h2zero:master' into misc-ctx-cleanup

thekurtovic · web-flow · commit d307e00f53c6 · 2025-01-05T20:19:14.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,24 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [2.0.3] 2025-01-05
+
+## Fixed
+- Unused variable warning when log level is below info.
+- Build error missing definition of CONFIG_NIMBLE_CPP_FREERTOS_TASK_BLOCK_BIT in platformio.
+- Race condition in `NimBLEScan` that can cause a crash due to heap corruption if `NimBLEScan::stop` is called from the `onResult` callback.
+- Advertisement data not set if scan response is enabled after the data is set.
+- `NimBLECharacteristic`/`NimBLEDescriptor` not able to update their values in the `onRead` callback.
+- Too short of a timeout being requested in NimBLE_Server example leading to frequent disconnects.
+
+## Changed
+- `NimBLEHIDDevice` now allows for the same report ID in multiple input/output/feature reports.
 
 ## Added
 - Config for custom log colors pre level.
+- Error logs in the case that NIMBLE_CPP_DEBUG_ASSERT is not defined.
+- Error logs when setting advertisement data fails.
+- Missing documentation in the migration guide about enabling automatic advertising on disconnect, which was disabled by default in 2.x.
 
 ## [2.0.2] 2024-12-21
 
diff --git a/docs/1.x_to2.x_migration_guide.md b/docs/1.x_to2.x_migration_guide.md
@@ -65,7 +65,8 @@ This returns a pointer to `const ble_addr_t` instead of a pointer to the address
 ## Server
 - `NimBLEServer::disconnect` now returns `bool`, true = success,  instead of `int` to be consistent with the rest of the library.
 - `NimBLEServerCallbacks::onMTUChanged` renamed to `NimBLEServerCallbacks::onMTUChange` to be consistent with the client callback.
-- `NimBLEServer::getPeerIDInfo` renamed to `NimBLEServer::getPeerInfoByHandle` to better describe it's use.  
+- `NimBLEServer::getPeerIDInfo` renamed to `NimBLEServer::getPeerInfoByHandle` to better describe it's use.
+- Advertising is no longer automatically restarted when a peer disconnects, to re-enable this feature either call `NimBLEServer::advertiseOnDisconnect(true);` after creating the server or manually restart advertising in the `onDisconnect` callback.  
 <br/>
 
 ### Services
diff --git a/docs/Doxyfile b/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.2
+PROJECT_NUMBER         = 2.0.3
 
 # 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
diff --git a/examples/NimBLE_Server/main/main.cpp b/examples/NimBLE_Server/main/main.cpp
@@ -26,7 +26,7 @@ class ServerCallbacks : public NimBLEServerCallbacks {
          *  Latency: number of intervals allowed to skip.
          *  Timeout: 10 millisecond increments.
          */
-        pServer->updateConnParams(connInfo.getConnHandle(), 24, 48, 0, 18);
+        pServer->updateConnParams(connInfo.getConnHandle(), 24, 48, 0, 180);
     }
 
     void onDisconnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo, int reason) override {
diff --git a/idf_component.yml b/idf_component.yml
@@ -1,5 +1,5 @@
 ## IDF Component Manager Manifest File
-version: "2.0.2"
+version: "2.0.3"
 license: "Apache-2.0"
 description: "C++ wrapper for the NimBLE BLE stack"
 url: "https://github.com/h2zero/esp-nimble-cpp"
diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "esp-nimble-cpp",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "C++ wrapper for the NimBLE BLE stack",
   "keywords": [
     "BLE",
diff --git a/src/NimBLEAdvertisementData.cpp b/src/NimBLEAdvertisementData.cpp
@@ -39,7 +39,7 @@ static const char* LOG_TAG = "NimBLEAdvertisementData";
  * @param [in] length The size of data to be added to the payload.
  */
 bool NimBLEAdvertisementData::addData(const uint8_t* data, size_t length) {
-    if ((m_payload.size() + length) > BLE_HS_ADV_MAX_SZ) {
+    if (m_payload.size() + length > BLE_HS_ADV_MAX_SZ) {
         NIMBLE_LOGE(LOG_TAG, "Data length exceeded");
         return false;
     }
@@ -159,6 +159,7 @@ bool NimBLEAdvertisementData::addServiceUUID(const NimBLEUUID& serviceUUID) {
             type = BLE_HS_ADV_TYPE_COMP_UUIDS128;
             break;
         default:
+            NIMBLE_LOGE(LOG_TAG, "Cannot add UUID, invalid size!");
             return false;
     }
 
@@ -169,10 +170,11 @@ bool NimBLEAdvertisementData::addServiceUUID(const NimBLEUUID& serviceUUID) {
     }
 
     if (length + getPayload().size() > BLE_HS_ADV_MAX_SZ) {
+        NIMBLE_LOGE(LOG_TAG, "Cannot add UUID, data length exceeded!");
         return false;
     }
 
-    uint8_t        data[31];
+    uint8_t        data[BLE_HS_ADV_MAX_SZ];
     const uint8_t* uuid = serviceUUID.getValue();
     if (dataLoc == -1) {
         data[0] = 1 + bytes;
@@ -214,6 +216,7 @@ bool NimBLEAdvertisementData::removeServiceUUID(const NimBLEUUID& serviceUUID) {
             type = BLE_HS_ADV_TYPE_COMP_UUIDS128;
             break;
         default:
+            NIMBLE_LOGE(LOG_TAG, "Cannot remove UUID, invalid size!");
             return false;
     }
 
@@ -266,12 +269,12 @@ bool NimBLEAdvertisementData::removeServices() {
  * @return True if successful.
  */
 bool NimBLEAdvertisementData::setManufacturerData(const uint8_t* data, size_t length) {
-    if (length > 29) {
+    if (length > BLE_HS_ADV_MAX_FIELD_SZ) {
         NIMBLE_LOGE(LOG_TAG, "MFG data too long");
         return false;
     }
 
-    uint8_t mdata[31];
+    uint8_t mdata[BLE_HS_ADV_MAX_SZ];
     mdata[0] = length + 1;
     mdata[1] = BLE_HS_ADV_TYPE_MFG_DATA;
     memcpy(&mdata[2], data, length);
@@ -302,12 +305,12 @@ bool NimBLEAdvertisementData::setManufacturerData(const std::vector<uint8_t>& da
  * @return True if successful.
  */
 bool NimBLEAdvertisementData::setURI(const std::string& uri) {
-    if (uri.length() > 29) {
+    if (uri.length() > BLE_HS_ADV_MAX_FIELD_SZ) {
         NIMBLE_LOGE(LOG_TAG, "URI too long");
         return false;
     }
 
-    uint8_t data[31];
+    uint8_t data[BLE_HS_ADV_MAX_SZ];
     uint8_t length = 2 + uri.length();
     data[0]        = length - 1;
     data[1]        = BLE_HS_ADV_TYPE_URI;
@@ -324,16 +327,16 @@ bool NimBLEAdvertisementData::setURI(const std::string& uri) {
  * @return True if successful.
  */
 bool NimBLEAdvertisementData::setName(const std::string& name, bool isComplete) {
-    if (name.length() > 29) {
+    if (name.length() > BLE_HS_ADV_MAX_FIELD_SZ) {
         NIMBLE_LOGE(LOG_TAG, "Name too long - truncating");
         isComplete = false;
     }
 
-    uint8_t data[31];
-    uint8_t length = 2 + std::min<uint8_t>(name.length(), 29);
+    uint8_t data[BLE_HS_ADV_MAX_SZ];
+    uint8_t length = 2 + std::min<uint8_t>(name.length(), BLE_HS_ADV_MAX_FIELD_SZ);
     data[0]        = length - 1;
     data[1]        = isComplete ? BLE_HS_ADV_TYPE_COMP_NAME : BLE_HS_ADV_TYPE_INCOMP_NAME;
-    memcpy(&data[2], name.c_str(), std::min<uint8_t>(name.length(), 29));
+    memcpy(&data[2], name.c_str(), std::min<uint8_t>(name.length(), BLE_HS_ADV_MAX_FIELD_SZ));
     return addData(data, length);
 } // setName
 
@@ -411,14 +414,14 @@ bool NimBLEAdvertisementData::setPartialServices32(const std::vector<NimBLEUUID>
 bool NimBLEAdvertisementData::setServices(bool complete, uint8_t size, const std::vector<NimBLEUUID>& uuids) {
     uint8_t bytes  = size / 8;
     uint8_t length = 2; // start with 2 for length + type bytes
-    uint8_t data[31];
+    uint8_t data[BLE_HS_ADV_MAX_SZ];
 
     for (const auto& uuid : uuids) {
         if (uuid.bitSize() != size) {
             NIMBLE_LOGE(LOG_TAG, "Service UUID(%d) invalid", size);
             continue;
         } else {
-            if (length + bytes >= 31) {
+            if (length + bytes >= BLE_HS_ADV_MAX_SZ) {
                 NIMBLE_LOGW(LOG_TAG, "Too many services - truncating");
                 complete = false;
                 break;
@@ -441,6 +444,7 @@ bool NimBLEAdvertisementData::setServices(bool complete, uint8_t size, const std
             data[1] = (complete ? BLE_HS_ADV_TYPE_COMP_UUIDS128 : BLE_HS_ADV_TYPE_INCOMP_UUIDS128);
             break;
         default:
+            NIMBLE_LOGE(LOG_TAG, "Cannot set services, invalid size!");
             return false;
     }
 
@@ -458,7 +462,7 @@ bool NimBLEAdvertisementData::setServices(bool complete, uint8_t size, const std
 bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length) {
     uint8_t uuidBytes = uuid.bitSize() / 8;
     uint8_t sDataLen  = 2 + uuidBytes + length;
-    if (sDataLen > 31) {
+    if (sDataLen > BLE_HS_ADV_MAX_SZ) {
         NIMBLE_LOGE(LOG_TAG, "Service Data too long");
         return false;
     }
@@ -475,6 +479,7 @@ bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const uint8
             type = BLE_HS_ADV_TYPE_SVC_DATA_UUID128;
             break;
         default:
+            NIMBLE_LOGE(LOG_TAG, "Cannot set service data, invalid size!");
             return false;
     }
 
@@ -483,7 +488,7 @@ bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const uint8
         return true;
     }
 
-    uint8_t sData[31];
+    uint8_t sData[BLE_HS_ADV_MAX_SZ];
     sData[0] = uuidBytes + length + 1;
     sData[1] = type;
     memcpy(&sData[2], uuid.getValue(), uuidBytes);
diff --git a/src/NimBLEAdvertising.cpp b/src/NimBLEAdvertising.cpp
@@ -408,7 +408,7 @@ bool NimBLEAdvertising::refreshAdvertisingData() {
  * @return True if the service was added successfully.
  */
 bool NimBLEAdvertising::addServiceUUID(const NimBLEUUID& serviceUUID) {
-    if (!m_advData.addServiceUUID(serviceUUID) && m_scanResp) {
+    if (!m_advData.addServiceUUID(serviceUUID)) {
         if (!m_scanData.addServiceUUID(serviceUUID)) {
             return false;
         }
@@ -466,7 +466,7 @@ bool NimBLEAdvertising::removeServices() {
  * @return True if the appearance was set successfully.
  */
 bool NimBLEAdvertising::setAppearance(uint16_t appearance) {
-    if (!m_advData.setAppearance(appearance) && m_scanResp) {
+    if (!m_advData.setAppearance(appearance)) {
         if (!m_scanData.setAppearance(appearance)) {
             return false;
         }
@@ -484,7 +484,7 @@ bool NimBLEAdvertising::setAppearance(uint16_t appearance) {
  * @details  Range = 0x0006(7.5ms) to 0x0C80(4000ms), values not within the range will be limited to this range.
  */
 bool NimBLEAdvertising::setPreferredParams(uint16_t minInterval, uint16_t maxInterval) {
-    if (!m_advData.setPreferredParams(minInterval, maxInterval) && m_scanResp) {
+    if (!m_advData.setPreferredParams(minInterval, maxInterval)) {
         if (!m_scanData.setPreferredParams(minInterval, maxInterval)) {
             return false;
         }
@@ -499,7 +499,7 @@ bool NimBLEAdvertising::setPreferredParams(uint16_t minInterval, uint16_t maxInt
  * @return True if the transmission power level was added successfully.
  */
 bool NimBLEAdvertising::addTxPower() {
-    if (!m_advData.addTxPower() && m_scanResp) {
+    if (!m_advData.addTxPower()) {
         if (!m_scanData.addTxPower()) {
             return false;
         }
@@ -537,7 +537,7 @@ bool NimBLEAdvertising::setName(const std::string& name) {
  * @return True if the manufacturer data was set successfully.
  */
 bool NimBLEAdvertising::setManufacturerData(const uint8_t* data, size_t length) {
-    if (!m_advData.setManufacturerData(data, length) && m_scanResp) {
+    if (!m_advData.setManufacturerData(data, length)) {
         if (!m_scanData.setManufacturerData(data, length)) {
             return false;
         }
@@ -571,7 +571,7 @@ bool NimBLEAdvertising::setManufacturerData(const std::vector<uint8_t>& data) {
  * @return True if the URI was set successfully.
  */
 bool NimBLEAdvertising::setURI(const std::string& uri) {
-    if (!m_advData.setURI(uri) && m_scanResp) {
+    if (!m_advData.setURI(uri)) {
         if (!m_scanData.setURI(uri)) {
             return false;
         }
@@ -590,7 +590,7 @@ bool NimBLEAdvertising::setURI(const std::string& uri) {
  * @note If data length is 0 the service data will not be advertised.
  */
 bool NimBLEAdvertising::setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length) {
-    if (!m_advData.setServiceData(uuid, data, length) && m_scanResp) {
+    if (!m_advData.setServiceData(uuid, data, length)) {
         if (!m_scanData.setServiceData(uuid, data, length)) {
             return false;
         }
diff --git a/src/NimBLEExtAdvertising.cpp b/src/NimBLEExtAdvertising.cpp
@@ -701,6 +701,7 @@ bool NimBLEExtAdvertisement::addServiceUUID(const NimBLEUUID& serviceUUID) {
             type = BLE_HS_ADV_TYPE_COMP_UUIDS128;
             break;
         default:
+            NIMBLE_LOGE(LOG_TAG, "Cannot add UUID, invalid size!");
             return false;
     }
 
@@ -711,10 +712,11 @@ bool NimBLEExtAdvertisement::addServiceUUID(const NimBLEUUID& serviceUUID) {
     }
 
     if (length + getDataSize() > CONFIG_BT_NIMBLE_MAX_EXT_ADV_DATA_LEN) {
+        NIMBLE_LOGE(LOG_TAG, "Cannot add UUID, data length exceeded!");
         return false;
     }
 
-    uint8_t        data[31];
+    uint8_t        data[BLE_HS_ADV_MAX_SZ];
     const uint8_t* uuid = serviceUUID.getValue();
     if (dataLoc == -1) {
         data[0] = 1 + bytes;
@@ -756,6 +758,7 @@ bool NimBLEExtAdvertisement::removeServiceUUID(const NimBLEUUID& serviceUUID) {
             type = BLE_HS_ADV_TYPE_COMP_UUIDS128;
             break;
         default:
+            NIMBLE_LOGE(LOG_TAG, "Cannot remove UUID, invalid size!");
             return false;
     }
 
@@ -878,6 +881,7 @@ bool NimBLEExtAdvertisement::setServices(bool complete, uint8_t size, const std:
             header[1] = complete ? BLE_HS_ADV_TYPE_COMP_UUIDS128 : BLE_HS_ADV_TYPE_INCOMP_UUIDS128;
             break;
         default:
+            NIMBLE_LOGE(LOG_TAG, "Cannot set services, invalid size!");
             return false;
     }
 
@@ -932,6 +936,7 @@ bool NimBLEExtAdvertisement::setServiceData(const NimBLEUUID& uuid, const uint8_
             type = BLE_HS_ADV_TYPE_SVC_DATA_UUID128;
             break;
         default:
+            NIMBLE_LOGE(LOG_TAG, "Cannot set service data, invalid size!");
             return false;
     }
 
diff --git a/src/NimBLEServer.cpp b/src/NimBLEServer.cpp
@@ -611,8 +611,9 @@ int NimBLEServer::handleGattEvent(uint16_t connHandle, uint16_t attrHandle, ble_
     NIMBLE_LOGD(LOG_TAG,
                 "Gatt %s event",
                 (ctxt->op == BLE_GATT_ACCESS_OP_READ_CHR || ctxt->op == BLE_GATT_ACCESS_OP_READ_DSC) ? "Read" : "Write");
-    auto           pAtt = static_cast<NimBLELocalValueAttribute*>(arg);
-    auto           val  = pAtt->getAttVal();
+    auto                  pAtt = static_cast<NimBLELocalValueAttribute*>(arg);
+    const NimBLEAttValue& val  = pAtt->getAttVal();
+
     NimBLEConnInfo peerInfo{};
     ble_gap_conn_find(connHandle, &peerInfo.m_desc);
 
@@ -623,7 +624,7 @@ int NimBLEServer::handleGattEvent(uint16_t connHandle, uint16_t attrHandle, ble_
             if (connHandle != BLE_HS_CONN_HANDLE_NONE) {
                 // If the packet header is only 8 bytes then this is a follow up of a long read
                 // so we don't want to call the onRead() callback again.
-                if (ctxt->om->om_pkthdr_len > 8 || pAtt->getAttVal().size() <= (ble_att_mtu(connHandle) - 3)) {
+                if (ctxt->om->om_pkthdr_len > 8 || val.size() <= (ble_att_mtu(connHandle) - 3)) {
                     pAtt->readEvent(peerInfo);
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class ServerCallbacks : public NimBLEServerCallbacks {`
`26`	`26`	`* Latency: number of intervals allowed to skip.`
`27`	`27`	`* Timeout: 10 millisecond increments.`
`28`	`28`	`*/`
`29`		`- pServer->updateConnParams(connInfo.getConnHandle(), 24, 48, 0, 18);`
	`29`	`+ pServer->updateConnParams(connInfo.getConnHandle(), 24, 48, 0, 180);`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`void onDisconnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo, int reason) override {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "esp-nimble-cpp",`
`3`		`- "version": "2.0.2",`
	`3`	`+ "version": "2.0.3",`
`4`	`4`	`"description": "C++ wrapper for the NimBLE BLE stack",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"BLE",`