fix(nimble): Fix examples and permissions

Author: lucasssvaz

libraries/BLE/examples/Client/Client.ino

@@ -19,6 +19,7 @@ static boolean doScan = false;
 static BLERemoteCharacteristic *pRemoteCharacteristic;
 static BLEAdvertisedDevice *myDevice;
 
+// Callback function to handle notifications
 static void notifyCallback(BLERemoteCharacteristic *pBLERemoteCharacteristic, uint8_t *pData, size_t length, bool isNotify) {
   Serial.print("Notify callback for characteristic ");
   Serial.print(pBLERemoteCharacteristic->getUUID().toString().c_str());
@@ -80,6 +81,7 @@ bool connectToServer() {
   }
 
   if (pRemoteCharacteristic->canNotify()) {
+    // Register/Subscribe for notifications
     pRemoteCharacteristic->registerForNotify(notifyCallback);
   }
 

libraries/BLE/examples/Notify/Notify.ino

@@ -69,6 +69,7 @@ void setup() {
   );
 
   // Creates BLE Descriptor 0x2902: Client Characteristic Configuration Descriptor (CCCD)
+  // Descriptor 2902 is not required when using NimBLE as it is automatically added based on the characteristic properties
   pCharacteristic->addDescriptor(new BLE2902());
   // Adds also the Characteristic User Description - 0x2901 descriptor
   descriptor_2901 = new BLE2901();

libraries/BLE/examples/Server_multiconnect/Server_multiconnect.ino

@@ -5,6 +5,9 @@
     updated by chegewara
 
    Create a BLE server that, once we receive a connection, will send periodic notifications.
+   The server will continue advertising for more connections after the first one and will notify
+   the value of a counter to all connected clients.
+
    The service advertises itself as: 4fafc201-1fb5-459e-8fcc-c5c9c331914b
    And has a characteristic of: beb5483e-36e1-4688-b7f5-ea07361b26a8
 
@@ -26,8 +29,8 @@
 
 BLEServer *pServer = NULL;
 BLECharacteristic *pCharacteristic = NULL;
+int connectedClients = 0;
 bool deviceConnected = false;
-bool oldDeviceConnected = false;
 uint32_t value = 0;
 
 // See the following for generating UUIDs:
@@ -38,12 +41,17 @@ uint32_t value = 0;
 
 class MyServerCallbacks : public BLEServerCallbacks {
   void onConnect(BLEServer *pServer) {
-    deviceConnected = true;
+    connectedClients++;
+    Serial.print("Client connected. Total clients: ");
+    Serial.println(connectedClients);
+    // Continue advertising for more connections
     BLEDevice::startAdvertising();
   };
 
   void onDisconnect(BLEServer *pServer) {
-    deviceConnected = false;
+    connectedClients--;
+    Serial.print("Client disconnected. Total clients: ");
+    Serial.println(connectedClients);
   }
 };
 
@@ -66,8 +74,7 @@ void setup() {
     BLECharacteristic::PROPERTY_READ | BLECharacteristic::PROPERTY_WRITE | BLECharacteristic::PROPERTY_NOTIFY | BLECharacteristic::PROPERTY_INDICATE
   );
 
-  // https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.client_characteristic_configuration.xml
-  // Create a BLE Descriptor
+  // Descriptor 2902 is not required when using NimBLE as it is automatically added based on the characteristic properties
   pCharacteristic->addDescriptor(new BLE2902());
 
   // Start the service
@@ -79,27 +86,38 @@ void setup() {
   pAdvertising->setScanResponse(false);
   pAdvertising->setMinPreferred(0x0);  // set value to 0x00 to not advertise this parameter
   BLEDevice::startAdvertising();
-  Serial.println("Waiting a client connection to notify...");
+  Serial.println("Waiting for client connections to notify...");
 }
 
 void loop() {
-  // notify changed value
-  if (deviceConnected) {
+  // Notify changed value to all connected clients
+  if (connectedClients > 0) {
+    Serial.print("Notifying value: ");
+    Serial.print(value);
+    Serial.print(" to ");
+    Serial.print(connectedClients);
+    Serial.println(" client(s)");
     pCharacteristic->setValue((uint8_t *)&value, 4);
     pCharacteristic->notify();
     value++;
-    delay(10);  // bluetooth stack will go into congestion, if too many packets are sent, in 6 hours test i was able to go as low as 3ms
+    // Bluetooth stack will go into congestion, if too many packets are sent.
+    // In 6 hours of testing, I was able to go as low as 3ms.
+    // When using core debug level "debug" or "verbose", the delay can be increased in
+    // order to reduce the number of debug messages in the serial monitor.
+    delay(100);
   }
-  // disconnecting
-  if (!deviceConnected && oldDeviceConnected) {
+
+  // Disconnecting - restart advertising when no clients are connected
+  if (connectedClients == 0 && deviceConnected) {
     delay(500);                   // give the bluetooth stack the chance to get things ready
     pServer->startAdvertising();  // restart advertising
-    Serial.println("start advertising");
-    oldDeviceConnected = deviceConnected;
+    Serial.println("No clients connected, restarting advertising");
+    deviceConnected = false;
   }
-  // connecting
-  if (deviceConnected && !oldDeviceConnected) {
-    // do stuff here on connecting
-    oldDeviceConnected = deviceConnected;
+
+  // Connecting - update state when first client connects
+  if (connectedClients > 0 && !deviceConnected) {
+    // do stuff here on first connecting
+    deviceConnected = true;
   }
 }

libraries/BLE/examples/UART/UART.ino

@@ -40,10 +40,12 @@ uint8_t txValue = 0;
 class MyServerCallbacks : public BLEServerCallbacks {
   void onConnect(BLEServer *pServer) {
     deviceConnected = true;
+    Serial.println("Device connected");
   };
 
   void onDisconnect(BLEServer *pServer) {
     deviceConnected = false;
+    Serial.println("Device disconnected");
   }
 };
 
@@ -80,6 +82,7 @@ void setup() {
   // Create a BLE Characteristic
   pTxCharacteristic = pService->createCharacteristic(CHARACTERISTIC_UUID_TX, BLECharacteristic::PROPERTY_NOTIFY);
 
+  // Descriptor 2902 is not required when using NimBLE as it is automatically added based on the characteristic properties
   pTxCharacteristic->addDescriptor(new BLE2902());
 
   BLECharacteristic *pRxCharacteristic = pService->createCharacteristic(CHARACTERISTIC_UUID_RX, BLECharacteristic::PROPERTY_WRITE);
@@ -97,22 +100,24 @@ void setup() {
 void loop() {
 
   if (deviceConnected) {
+    Serial.print("Notifying Value: ");
+    Serial.println(txValue);
     pTxCharacteristic->setValue(&txValue, 1);
     pTxCharacteristic->notify();
     txValue++;
-    delay(10);  // bluetooth stack will go into congestion, if too many packets are sent
+    delay(1000);  // Notifying every 1 second
   }
 
   // disconnecting
   if (!deviceConnected && oldDeviceConnected) {
     delay(500);                   // give the bluetooth stack the chance to get things ready
     pServer->startAdvertising();  // restart advertising
-    Serial.println("start advertising");
-    oldDeviceConnected = deviceConnected;
+    Serial.println("Started advertising again...");
+    oldDeviceConnected = false;
   }
   // connecting
   if (deviceConnected && !oldDeviceConnected) {
     // do stuff here on connecting
-    oldDeviceConnected = deviceConnected;
+    oldDeviceConnected = true;
   }
 }

libraries/BLE/src/BLEDescriptor.h

@@ -39,8 +39,18 @@
  ***************************************************************************/
 
 #if defined(CONFIG_NIMBLE_ENABLED)
-#include "host/ble_att.h"
+#include <host/ble_att.h>
 #include "BLEConnInfo.h"
+
+#define ESP_GATT_PERM_READ                BLE_ATT_F_READ
+#define ESP_GATT_PERM_WRITE               BLE_ATT_F_WRITE
+#define ESP_GATT_PERM_READ_ENCRYPTED      BLE_ATT_F_READ_ENC
+#define ESP_GATT_PERM_WRITE_ENCRYPTED     BLE_ATT_F_WRITE_ENC
+#define ESP_GATT_PERM_READ_AUTHORIZATION  BLE_ATT_F_READ_AUTHOR
+#define ESP_GATT_PERM_WRITE_AUTHORIZATION BLE_ATT_F_WRITE_AUTHOR
+#define ESP_GATT_PERM_READ_ENC_MITM       BLE_ATT_F_READ_AUTHEN
+#define ESP_GATT_PERM_WRITE_ENC_MITM      BLE_ATT_F_WRITE_AUTHEN
+
 #endif
 
 /***************************************************************************

libraries/BLE/src/BLEHIDDevice.cpp

@@ -21,17 +21,14 @@
 
 #include "BLEHIDDevice.h"
 #include "BLE2904.h"
+#include "BLEDescriptor.h"
 
 /***************************************************************************
  *                     NimBLE includes and definitions                     *
  ***************************************************************************/
 
 #ifdef CONFIG_NIMBLE_ENABLED
 #include <host/ble_att.h>
-#define ESP_GATT_PERM_READ            BLE_ATT_F_READ
-#define ESP_GATT_PERM_WRITE           BLE_ATT_F_WRITE
-#define ESP_GATT_PERM_READ_ENCRYPTED  BLE_ATT_F_READ_ENC
-#define ESP_GATT_PERM_WRITE_ENCRYPTED BLE_ATT_F_WRITE_ENC
 #endif
 
 /***************************************************************************