Merge branch 'master' into v1.4.2-adv-data-refresh

Author: h2zero

.clang-format

@@ -0,0 +1,42 @@
+BasedOnStyle: Google
+Language: Cpp
+ColumnLimit: 120
+IndentWidth: 4
+TabWidth: 4
+UseTab: Never
+SortIncludes: Never
+PPIndentWidth : 1
+IndentPPDirectives: AfterHash
+ReflowComments: true
+SpacesBeforeTrailingComments: 1
+AlignTrailingComments: true
+AlignAfterOpenBracket: Align
+AlignConsecutiveMacros:
+  Enabled: true
+  AcrossEmptyLines: true
+  AcrossComments: true
+AlignConsecutiveAssignments:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: true
+  AlignCompound: true
+  PadOperators: true
+AlignConsecutiveDeclarations:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: true
+AlignEscapedNewlines: Left
+AccessModifierOffset: -2
+AlignArrayOfStructures: Right
+AlignOperands: Align
+AllowAllArgumentsOnNextLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortBlocksOnASingleLine: Empty
+BreakBeforeBinaryOperators: None
+BinPackArguments: false
+BinPackParameters: false
+DerivePointerAlignment: false
+PenaltyBreakAssignment: 4
+PenaltyExcessCharacter: 4
+PenaltyBreakBeforeFirstCallParameter: 1
+PointerAlignment: Left

.github/workflows/build.yml

@@ -1,6 +1,11 @@
 name: Build
 
-on: [push, pull_request]
+on:
+  workflow_dispatch:      # Start a workflow
+  pull_request:
+  push:
+    branches:
+      - master
 
 jobs:
   build_esp_pio:

docs/Migration_guide.md

@@ -383,7 +383,7 @@ The security callback methods are now incorporated in the `NimBLEServerCallbacks
 
 The callback methods are:
 
-> `bool onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pin)`
+> `bool onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pin)`
 
 Receives the pin when using numeric comparison authentication.
 Call `NimBLEDevice::injectConfirmPasskey(connInfo, true);` to accept or `NimBLEDevice::injectConfirmPasskey(connInfo, false);` to reject.

examples/BLE_EddystoneTLM_Beacon/BLE_EddystoneTLM_Beacon.ino

@@ -12,7 +12,7 @@
    4. wait
    5. Stop advertising.
    6. deep sleep
-   
+
 */
 
 #include "NimBLEDevice.h"
@@ -26,7 +26,7 @@
 #define GPIO_DEEP_SLEEP_DURATION 10     // sleep x seconds and then wake up
 
 // UUID 1 128-Bit (may use linux tool uuidgen or random numbers via https://www.uuidgenerator.net/)
-#define BEACON_UUID "8ec76ea3-6668-48da-9866-75be8bc86f4d" 
+#define BEACON_UUID "8ec76ea3-6668-48da-9866-75be8bc86f4d"
 
 RTC_DATA_ATTR static time_t last;    // remember last boot in RTC Memory
 RTC_DATA_ATTR static uint32_t bootcount; // remember number of boots in RTC Memory
@@ -96,6 +96,7 @@ void setup()
   BLEDevice::setPower(ESP_PWR_LVL_N12);
 
   pAdvertising = BLEDevice::getAdvertising();
+  pAdvertising->enableScanResponse(true);
 
   setBeacon();
   // Start advertising

examples/BLE_EddystoneURL_Beacon/BLE_EddystoneURL_Beacon.ino

@@ -26,7 +26,7 @@
 #define GPIO_DEEP_SLEEP_DURATION 10     // sleep x seconds and then wake up
 
 // UUID 1 128-Bit (may use linux tool uuidgen or random numbers via https://www.uuidgenerator.net/)
-#define BEACON_UUID "8ec76ea3-6668-48da-9866-75be8bc86f4d" 
+#define BEACON_UUID "8ec76ea3-6668-48da-9866-75be8bc86f4d"
 
 RTC_DATA_ATTR static time_t last;    // remember last boot in RTC Memory
 RTC_DATA_ATTR static uint32_t bootcount; // remember number of boots in RTC Memory
@@ -168,6 +168,7 @@ void setup()
   BLEDevice::setPower(ESP_PWR_LVL_N12);
 
   pAdvertising = BLEDevice::getAdvertising();
+  pAdvertising->enableScanResponse(true);
 
   setBeacon();
   // Start advertising

examples/Bluetooth_5/NimBLE_extended_client/NimBLE_extended_client.ino

@@ -16,7 +16,7 @@
 #define SERVICE_UUID        "ABCD"
 #define CHARACTERISTIC_UUID "1234"
 
-static NimBLEAdvertisedDevice* advDevice;
+static const NimBLEAdvertisedDevice* advDevice;
 static bool doConnect = false;
 static uint32_t scanTime = 10 * 1000; // In milliseconds, 0 = scan forever
 
@@ -40,7 +40,7 @@ class ClientCallbacks : public NimBLEClientCallbacks {
 /* Define a class to handle the callbacks when advertisements are received */
 class scanCallbacks: public NimBLEScanCallbacks {
 
-    void onResult(NimBLEAdvertisedDevice* advertisedDevice) {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) {
         Serial.printf("Advertised Device found: %s\n", advertisedDevice->toString().c_str());
         if(advertisedDevice->isAdvertisingService(NimBLEUUID("ABCD")))
         {
@@ -55,8 +55,8 @@ class scanCallbacks: public NimBLEScanCallbacks {
     }
 
     /** Callback to process the results of the completed scan or restart it */
-    void onScanEnd(NimBLEScanResults results) {
-        Serial.println("Scan Ended");
+    void onScanEnd(const NimBLEScanResults& results, int reason) {
+        Serial.print("Scan Ended; reason = "); Serial.println(reason);
     }
 };
 

examples/Bluetooth_5/NimBLE_extended_scan/NimBLE_extended_scan.ino

@@ -0,0 +1,74 @@
+/**
+ *  NimBLE Extended Scanner Demo:
+ *
+ *  Demonstrates the Bluetooth 5.x scanning capabilities of the NimBLE library.
+ *
+ *  Created: on November 28, 2024
+ *      Author: H2zero
+ *
+*/
+
+#include <Arduino.h>
+#include <NimBLEDevice.h>
+
+static uint32_t scanTime = 10 * 1000; // In milliseconds, 0 = scan forever
+static NimBLEScan::Phy scanPhy = NimBLEScan::Phy::SCAN_ALL;
+
+// Define a class to handle the callbacks when advertisements are received
+class scanCallbacks: public NimBLEScanCallbacks {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) {
+        Serial.printf("Advertised Device found: %s\n PHY1: %d\n PHY2: %d\n", advertisedDevice->toString().c_str(),
+               advertisedDevice->getPrimaryPhy(), advertisedDevice->getSecondaryPhy());
+    }
+
+    // Callback to process the results of the completed scan or restart it
+    void onScanEnd(const NimBLEScanResults& scanResults, int reason) {
+        Serial.printf("Scan Ended, reason: %d; found %d devices\n", reason, scanResults.getCount());
+
+        // Try Different PHY's
+        switch (scanPhy) {
+            case NimBLEScan::Phy::SCAN_ALL:
+                Serial.prinln("Scanning only 1M PHY");
+                scanPhy = NimBLEScan::Phy::SCAN_1M;
+                break;
+            case NimBLEScan::Phy::SCAN_1M:
+                Serial.println("Scanning only CODED PHY");
+                scanPhy = NimBLEScan::Phy::SCAN_CODED;
+                break;
+            case NimBLEScan::Phy::SCAN_CODED:
+                Serial.println("Scanning all PHY's");
+                scanPhy = NimBLEScan::Phy::SCAN_ALL;
+                break;
+        }
+
+        NimBLEScan* pScan = NimBLEDevice::getScan();
+        pScan->setPhy(scanPhy);
+        pScan->start(scanTime);
+    }
+} scanCb;
+
+void setup() {
+    Serial.begin(115200);
+    Serial.printf("Starting Extended Scanner\n");
+
+    // Initialize NimBLE, no device name specified as we are not advertising
+    NimBLEDevice::init("");
+    NimBLEScan* pScan = NimBLEDevice::getScan();
+
+    // Set the callbacks that the scanner will call on events.
+    pScan->setScanCallbacks(&scanCb);
+
+    // Use active scanning to obtain scan response data from advertisers
+    pScan->setActiveScan(true);
+
+    // Set the initial PHY's to scan on, default is SCAN_ALL
+    pScan->setPhy(scanPhy);
+
+    // Start scanning for scanTime, 0 = forever
+    pScan->start(scanTime);
+    Serial.println("Scanning for peripherals");
+}
+
+void loop() {
+    delay(2000);
+}

examples/NimBLE_Async_Client/NimBLE_Async_Client.ino

@@ -0,0 +1,84 @@
+
+/**
+ *  NimBLE_Async_client Demo:
+ *
+ *  Demonstrates asynchronous client operations.
+ *
+ *  Created: on November 4, 2024
+ *      Author: H2zero
+ *
+ */
+
+#include <NimBLEDevice.h>
+
+static constexpr uint32_t scanTimeMs = 5 * 1000;
+
+class ClientCallbacks : public NimBLEClientCallbacks {
+    void onConnect(NimBLEClient* pClient) {
+        Serial.printf("Connected to: %s\n", pClient->getPeerAddress().toString().c_str());
+    }
+
+    void onDisconnect(NimBLEClient* pClient, int reason) {
+        Serial.printf("%s Disconnected, reason = %d - Starting scan\n", pClient->getPeerAddress().toString().c_str(), reason);
+        NimBLEDevice::getScan()->start(scanTimeMs);
+    }
+} clientCB;
+
+class scanCallbacks : public NimBLEScanCallbacks {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) {
+        Serial.printf("Advertised Device found: %s\n", advertisedDevice->toString().c_str());
+        if (advertisedDevice->haveName() && advertisedDevice->getName() == "NimBLE-Server") {
+            Serial.println("Found Our Device");
+
+            auto pClient = NimBLEDevice::getDisconnectedClient();
+            if (!pClient) {
+                pClient = NimBLEDevice::createClient(advertisedDevice->getAddress());
+                if (!pClient) {
+                    Serial.println("Failed to create client");
+                    return;
+                }
+            }
+
+            pClient->setClientCallbacks(&clientCB, false);
+            if (!pClient->connect(true, true, false)) { // delete attributes, async connect, no MTU exchange
+                NimBLEDevice::deleteClient(pClient);
+                Serial.println("Failed to connect");
+                return;
+            }
+        }
+    }
+
+    void onScanEnd(const NimBLEScanResults& results, int reason) {
+        Serial.print("Scan Ended; reason = "); Serial.println(reason);
+        NimBLEDevice::getScan()->start(scanTimeMs);
+    }
+};
+
+void setup() {
+    Serial.begin(115200);
+    Serial.println("Starting NimBLE Client");
+    NimBLEDevice::init("");
+    NimBLEDevice::setPower(3); /** +3db */
+
+    NimBLEScan* pScan = NimBLEDevice::getScan();
+    pScan->setScanCallbacks(new scanCallbacks());
+    pScan->setInterval(45);
+    pScan->setWindow(15);
+    pScan->setActiveScan(true);
+    pScan->start(scanTimeMs);
+}
+
+void loop() {
+    delay(1000);
+    auto pClients = NimBLEDevice::getConnectedClients();
+    if (pClients.size() == 0) {
+        return;
+    }
+
+    for (auto& pClient : pClients) {
+        Serial.println(pClient->toString().c_str());
+        NimBLEDevice::deleteClient(pClient);
+    }
+
+    NimBLEDevice::getScan()->start(scanTimeMs);
+}

examples/NimBLE_Client/NimBLE_Client.ino

@@ -10,7 +10,7 @@
 
 #include <NimBLEDevice.h>
 
-static NimBLEAdvertisedDevice* advDevice;
+static const NimBLEAdvertisedDevice* advDevice;
 
 static bool doConnect = false;
 static uint32_t scanTime = 0 * 1000; // In milliseconds, 0 = scan forever
@@ -64,7 +64,7 @@ class ClientCallbacks : public NimBLEClientCallbacks {
         NimBLEDevice::injectPassKey(connInfo, 123456);
     };
 
-    void onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pass_key){
+    void onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pass_key){
         Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
         /** Inject false if passkeys don't match. */
         NimBLEDevice::injectConfirmPasskey(connInfo, true);
@@ -85,7 +85,7 @@ class ClientCallbacks : public NimBLEClientCallbacks {
 /** Define a class to handle the callbacks when advertisments are received */
 class scanCallbacks: public NimBLEScanCallbacks {
 
-    void onResult(NimBLEAdvertisedDevice* advertisedDevice) {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) {
         Serial.print("Advertised Device found: ");
         Serial.println(advertisedDevice->toString().c_str());
         if(advertisedDevice->isAdvertisingService(NimBLEUUID("DEAD")))
@@ -101,8 +101,8 @@ class scanCallbacks: public NimBLEScanCallbacks {
     }
 
     /** Callback to process the results of the completed scan or restart it */
-    void onScanEnd(NimBLEScanResults results) {
-        Serial.println("Scan Ended");
+    void onScanEnd(const NimBLEScanResults& results, int reason) {
+        Serial.print("Scan Ended; reason = "); Serial.println(reason);
     }
 };
 
@@ -352,9 +352,6 @@ void setup (){
     NimBLEDevice::setPower(9); /** +9db */
 #endif
 
-    /** Optional: set any devices you don't want to get advertisments from */
-    // NimBLEDevice::addIgnored(NimBLEAddress ("aa:bb:cc:dd:ee:ff"));
-
     /** create new scan */
     NimBLEScan* pScan = NimBLEDevice::getScan();