feat(nimble): add support for Aggregate Format (0x2905) and fix duplicate descriptor handle assignment

srgg · srgg · commit ccf45e66ac6a · 2025-10-24T07:11:55.000-06:00
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,9 @@
 docs/doxydocs
 .development
+
+# Editor/IDE (all directories)
+.idea/
+.vscode/
+
+# PlatformIO build
+.pio/
diff --git a/examples/BLE_Beacon_Scanner/main.cpp b/examples/BLE_Beacon_Scanner/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "BLE_Beacon_Scanner.ino"
+#endif
diff --git a/examples/BLE_EddystoneTLM_Beacon/main.cpp b/examples/BLE_EddystoneTLM_Beacon/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "BLE_EddystoneTLM_Beacon.ino"
+#endif
diff --git a/examples/Bluetooth_5/NimBLE_extended_client/main.cpp b/examples/Bluetooth_5/NimBLE_extended_client/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_extended_client.ino"
+#endif
diff --git a/examples/Bluetooth_5/NimBLE_extended_scan/main.cpp b/examples/Bluetooth_5/NimBLE_extended_scan/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_extended_scan.ino"
+#endif
diff --git a/examples/Bluetooth_5/NimBLE_extended_server/main.cpp b/examples/Bluetooth_5/NimBLE_extended_server/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_extended_server.ino"
+#endif
diff --git a/examples/Bluetooth_5/NimBLE_multi_advertiser/main.cpp b/examples/Bluetooth_5/NimBLE_multi_advertiser/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_multi_advertiser.ino"
+#endif
diff --git a/examples/L2CAP/L2CAP_Client/main.cpp b/examples/L2CAP/L2CAP_Client/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "L2CAP_Client.ino"
+#endif
diff --git a/examples/L2CAP/L2CAP_Server/main.cpp b/examples/L2CAP/L2CAP_Server/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "L2CAP_Server.ino"
+#endif
diff --git a/examples/NimBLE_Async_Client/main.cpp b/examples/NimBLE_Async_Client/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_Async_Client.ino"
+#endif
diff --git a/examples/NimBLE_Client/main.cpp b/examples/NimBLE_Client/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_Client.ino"
+#endif
diff --git a/examples/NimBLE_Scan_Continuous/main.cpp b/examples/NimBLE_Scan_Continuous/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_Scan_Continuous.ino"
+#endif
diff --git a/examples/NimBLE_Scan_Whitelist/main.cpp b/examples/NimBLE_Scan_Whitelist/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_Scan_whitelist.ino"
+#endif
diff --git a/examples/NimBLE_Secure_Client/main.cpp b/examples/NimBLE_Secure_Client/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_Secure_Client.ino"
+#endif
diff --git a/examples/NimBLE_Secure_Server/main.cpp b/examples/NimBLE_Secure_Server/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_Secure_Server.ino"
+#endif
diff --git a/examples/NimBLE_Server/NimBLE_Server.ino b/examples/NimBLE_Server/NimBLE_Server.ino
@@ -11,6 +11,8 @@
 #include <Arduino.h>
 #include <NimBLEDevice.h>
 
+#include "NimBLE2905.h"
+
 static NimBLEServer* pServer;
 
 /**  None of these are required as they will be handled by the library with defaults. **
@@ -123,7 +125,9 @@ class DescriptorCallbacks : public NimBLEDescriptorCallbacks {
 
 void setup(void) {
     Serial.begin(115200);
+    delay(500);
     Serial.printf("Starting NimBLE Server\n");
+    delay(500);
 
     /** Initialize NimBLE and set the device name */
     NimBLEDevice::init("NimBLE");
@@ -186,9 +190,70 @@ void setup(void) {
     pC01Ddsc->setValue("Send it back!");
     pC01Ddsc->setCallbacks(&dscCallbacks);
 
+    NimBLEService* pCafeService = pServer->createService("CAFE");
+
+    NimBLECharacteristic* pBurgerIngredientsCharacteristic =
+        pCafeService->createCharacteristic("FEED", NIMBLE_PROPERTY::READ);
+
+    NimBLE2904* pFormatName = pBurgerIngredientsCharacteristic->create2904();
+    pFormatName->setFormat(0x19);
+    pFormatName->setUnit(0x2700);
+
+    NimBLE2904* pFormatFatPercent = pBurgerIngredientsCharacteristic->create2904();
+    pFormatFatPercent->setFormat(0x04);
+    pFormatFatPercent->setUnit(0x27AD);
+
+    NimBLE2904* pFormatWeight = pBurgerIngredientsCharacteristic->create2904();
+    pFormatWeight->setFormat(0x06);
+    pFormatWeight->setUnit(0x276F);
+
+    /**
+     *  2905 “Aggregate Format” descriptor is a special case. When create2905() is called,
+     *  it creates an instance of NimBLE2905 with the correct properties and size.
+     *  We must then explicitly add the constituent 2904 descriptors that define the
+     *  aggregate format (e.g., name, fat percent, weight) using add2904Descriptor().
+     *  This ensures the aggregate descriptor correctly references all its component descriptors.
+     */
+    NimBLE2905* pFormatAggregate = pBurgerIngredientsCharacteristic->create2905();
+    pFormatAggregate->add2904Descriptor(pFormatName);
+    pFormatAggregate->add2904Descriptor(pFormatFatPercent);
+    pFormatAggregate->add2904Descriptor(pFormatWeight);
+
+
+    const char* name = "Ground Beef Patty";
+    const size_t nameLength = strlen(name);
+    uint8_t fatPercentage = 20;
+    uint16_t weightGrams = 227;
+    uint8_t rawValue[nameLength + 1 + sizeof(fatPercentage) + sizeof(weightGrams)];
+
+    size_t offset = 0;
+    // Copy name
+    memcpy(rawValue + offset, name, nameLength);
+    offset += nameLength;
+
+    // Null terminator
+    rawValue[offset++] = 0;
+
+    // Fat percentage (1 byte)
+    memcpy(rawValue + offset, &fatPercentage, sizeof(fatPercentage));
+    offset += sizeof(fatPercentage);
+    // Weight (2 bytes)
+    memcpy(rawValue + offset, &weightGrams, sizeof(weightGrams));
+    offset += sizeof(weightGrams);
+    pBurgerIngredientsCharacteristic->setValue(rawValue, offset);
+
+    const char* description = "UTF-8 Name (null-terminated) + uint8 Fat % + uint16 Weight (grams)";
+    NimBLEDescriptor* pUserDesc = pBurgerIngredientsCharacteristic->createDescriptor(
+        BLEUUID((uint16_t)0x2901),
+        NIMBLE_PROPERTY::READ,
+        strlen(description)
+    );
+    pUserDesc->setValue(description);
+
     /** Start the services when finished creating all Characteristics and Descriptors */
     pDeadService->start();
     pBaadService->start();
+    pCafeService->start();
 
     /** Create an advertising instance and add the services to the advertised data */
     NimBLEAdvertising* pAdvertising = NimBLEDevice::getAdvertising();
diff --git a/examples/NimBLE_Server/main.cpp b/examples/NimBLE_Server/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_Server.ino"
+#endif
diff --git a/examples/NimBLE_Server_Whitelist/main.cpp b/examples/NimBLE_Server_Whitelist/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_Server_Whitelist.ino"
+#endif
diff --git a/examples/NimBLE_active_passive_scan/main.cpp b/examples/NimBLE_active_passive_scan/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_active_passive_scan.ino"
+#endif
diff --git a/examples/NimBLE_iBeacon/main.cpp b/examples/NimBLE_iBeacon/main.cpp
@@ -0,0 +1,13 @@
+/*
+* main.cpp
+ *
+ * Purpose: This file exists ONLY to satisfy PlatformIO's build system.
+ * The NimBLE Server example normally compiles fine in the Arduino IDE
+ * without needing a separate main.cpp. PlatformIO requires a main entry
+ * (setup() and loop()) for any build environment, so this file exists
+ * purely to make PIO happy.
+ */
+
+#ifdef PLATFORMIO_BUILD
+    #include "NimBLE_iBeacon.ino"
+#endif
diff --git a/platformio.ini b/platformio.ini
diff --git a/src/NimBLE2905.cpp b/src/NimBLE2905.cpp
diff --git a/src/NimBLE2905.h b/src/NimBLE2905.h
diff --git a/src/NimBLECharacteristic.cpp b/src/NimBLECharacteristic.cpp
diff --git a/src/NimBLECharacteristic.h b/src/NimBLECharacteristic.h
diff --git a/src/NimBLEServer.cpp b/src/NimBLEServer.cpp
diff --git a/src/nimble/nimble/host/include/host/ble_gatt.h b/src/nimble/nimble/host/include/host/ble_gatt.h
diff --git a/src/nimble/nimble/host/src/ble_gatts.c b/src/nimble/nimble/host/src/ble_gatts.c
diff --git a/src/nimconfig.h b/src/nimconfig.h
