change NimBLE example

Author: Jason2866

.github/workflows/examples.yml

@@ -20,10 +20,10 @@ jobs:
           - "examples/arduino-wifiscan"
           - "examples/arduino-zigbee-light"
           - "examples/arduino-zigbee-switch"
+          - "examples/arduino-NimBLE-ext_client"
+          - "examples/arduino-matter-light"
           - "examples/tasmota"
-          - "examples/espidf-arduino-h2zero-BLE_scan"
           - "examples/espidf-arduino-matter-light"
-          - "examples/arduino-matter-light"
           - "examples/espidf-arduino-blink"
           - "examples/espidf-arduino-littlefs"
           - "examples/espidf-blink"

examples/arduino-NimBLE-ext_client/README.md

@@ -0,0 +1,5 @@
+# NimBLE_extended_client example using h2zero Arduino NimBLE stack
+
+BLE 5 client example, using the great [h2zero NimBLE](https://github.com/h2zero/NimBLE-Arduino) implementation.
+
+Thx @h2zero for the great BLE library.

examples/espidf-arduino-h2zero-BLE_scan/include/README renamed to examples/arduino-NimBLE-ext_client/include/README

@@ -0,0 +1,53 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env]
+platform = espressif32
+framework = arduino
+monitor_speed = 115200
+build_flags =
+    '-DCONFIG_BT_NIMBLE_EXT_ADV=1'
+lib_deps =
+    https://github.com/h2zero/NimBLE-Arduino
+lib_ignore =
+    BLE
+    BluetoothSerial
+    SimpleBLE
+    WiFiProv
+custom_component_remove =
+    espressif/esp_hosted
+    espressif/esp_wifi_remote
+    espressif/esp-dsp
+    espressif/network_provisioning
+    espressif/esp_rainmaker
+    espressif/rmaker_common
+    espressif/esp_insights
+    espressif/esp_diag_data_store
+    espressif/esp_diagnostics
+    espressif/libsodium
+    espressif/esp-modbus
+    espressif/esp-cbor
+    espressif/esp-sr
+    espressif/esp32-camera
+
+[env:esp32s3]
+board = esp32-s3-devkitc-1
+
+[env:esp32c2]
+board = esp32-c2-devkitm-1
+
+[env:esp32c3]
+board = esp32-c3-devkitm-1
+
+[env:esp32c6]
+board = esp32-c6-devkitm-1
+
+[env:esp32h2]
+board = esp32-h2-devkitm-1

examples/espidf-arduino-h2zero-BLE_scan/lib/README renamed to examples/arduino-NimBLE-ext_client/lib/README

@@ -0,0 +1,150 @@
+
+/** NimBLE Extended Client Demo:
+ *
+ *  Demonstrates the Bluetooth 5.x client capabilities.
+ *
+ *  Created: on April 2 2022
+ *      Author: H2zero
+ *
+ */
+
+#include <Arduino.h>
+#include <NimBLEDevice.h>
+#if !CONFIG_BT_NIMBLE_EXT_ADV
+# error Must enable extended advertising, see nimconfig.h file.
+#endif
+
+#define SERVICE_UUID        "ABCD"
+#define CHARACTERISTIC_UUID "1234"
+
+static const NimBLEAdvertisedDevice* advDevice;
+static bool                          doConnect = false;
+static uint32_t                      scanTime  = 10 * 1000; // In milliseconds, 0 = scan forever
+
+/** Define the PHY's to use when connecting to peer devices, can be 1, 2, or all 3 (default).*/
+static uint8_t connectPhys = BLE_GAP_LE_PHY_CODED_MASK | BLE_GAP_LE_PHY_1M_MASK /*| BLE_GAP_LE_PHY_2M_MASK */;
+
+/** Define a class to handle the callbacks for client connection events */
+class ClientCallbacks : public NimBLEClientCallbacks {
+    void onConnect(NimBLEClient* pClient) override { Serial.printf("Connected\n"); };
+
+    void onDisconnect(NimBLEClient* pClient, int reason) override {
+        Serial.printf("%s Disconnected, reason = %d - Starting scan\n", pClient->getPeerAddress().toString().c_str(), reason);
+        NimBLEDevice::getScan()->start(scanTime);
+    }
+} clientCallbacks;
+
+/** Define a class to handle the callbacks when advertisements are received */
+class scanCallbacks : public NimBLEScanCallbacks {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) override {
+        Serial.printf("Advertised Device found: %s\n", advertisedDevice->toString().c_str());
+        if (advertisedDevice->isAdvertisingService(NimBLEUUID("ABCD"))) {
+            Serial.printf("Found Our Service\n");
+            doConnect = true;
+            /** Save the device reference in a global for the client to use*/
+            advDevice = advertisedDevice;
+            /** stop scan before connecting */
+            NimBLEDevice::getScan()->stop();
+        }
+    }
+
+    /** Callback to process the results of the completed scan or restart it */
+    void onScanEnd(const NimBLEScanResults& results, int rc) override { Serial.printf("Scan Ended\n"); }
+} scanCallbacks;
+
+/** Handles the provisioning of clients and connects / interfaces with the server */
+bool connectToServer() {
+    NimBLEClient* pClient = nullptr;
+
+    pClient = NimBLEDevice::createClient();
+    pClient->setClientCallbacks(&clientCallbacks, false);
+
+    /**
+     * Set the PHY's to use for this connection. This is a bitmask that represents the PHY's:
+     * * 0x01 BLE_GAP_LE_PHY_1M_MASK
+     * * 0x02 BLE_GAP_LE_PHY_2M_MASK
+     * * 0x04 BLE_GAP_LE_PHY_CODED_MASK
+     * Combine these with OR ("|"), eg BLE_GAP_LE_PHY_1M_MASK | BLE_GAP_LE_PHY_2M_MASK | BLE_GAP_LE_PHY_CODED_MASK;
+     */
+    pClient->setConnectPhy(connectPhys);
+
+    /** Set how long we are willing to wait for the connection to complete (milliseconds), default is 30000. */
+    pClient->setConnectTimeout(10 * 1000);
+
+    if (!pClient->connect(advDevice)) {
+        /** Created a client but failed to connect, don't need to keep it as it has no data */
+        NimBLEDevice::deleteClient(pClient);
+        Serial.printf("Failed to connect, deleted client\n");
+        return false;
+    }
+
+    Serial.printf("Connected to: %s RSSI: %d\n", pClient->getPeerAddress().toString().c_str(), pClient->getRssi());
+
+    /** Now we can read/write/subscribe the characteristics of the services we are interested in */
+    NimBLERemoteService*        pSvc = nullptr;
+    NimBLERemoteCharacteristic* pChr = nullptr;
+
+    pSvc = pClient->getService(SERVICE_UUID);
+    if (pSvc) {
+        pChr = pSvc->getCharacteristic(CHARACTERISTIC_UUID);
+        if (pChr) {
+            if (pChr->canRead()) {
+                std::string value = pChr->readValue();
+                Serial.printf("Characteristic value: %s\n", value.c_str());
+            }
+        }
+
+    } else {
+        Serial.printf("ABCD service not found.\n");
+    }
+
+    NimBLEDevice::deleteClient(pClient);
+    Serial.printf("Done with this device!\n");
+    return true;
+}
+
+void setup() {
+    Serial.begin(115200);
+    Serial.printf("Starting NimBLE Client\n");
+
+    /** Initialize NimBLE and set the device name */
+    NimBLEDevice::init("NimBLE Extended Client");
+
+    /** Create aNimBLE Scan instance and set the callbacks for scan events */
+    NimBLEScan* pScan = NimBLEDevice::getScan();
+    pScan->setScanCallbacks(&scanCallbacks);
+
+    /** Set scan interval (how often) and window (how long) in milliseconds */
+    pScan->setInterval(97);
+    pScan->setWindow(67);
+
+    /**
+     * Active scan will gather scan response data from advertisers
+     *  but will use more energy from both devices
+     */
+    pScan->setActiveScan(true);
+
+    /**
+     *  Start scanning for advertisers for the scan time specified (in milliseconds) 0 = forever
+     *  Optional callback for when scanning stops.
+     */
+    pScan->start(scanTime);
+
+    Serial.printf("Scanning for peripherals\n");
+}
+
+void loop() {
+    /** Loop here until we find a device we want to connect to */
+    if (doConnect) {
+        if (connectToServer()) {
+            Serial.printf("Success!, scanning for more!\n");
+        } else {
+            Serial.printf("Failed to connect, starting scan\n");
+        }
+
+        doConnect = false;
+        NimBLEDevice::getScan()->start(scanTime);
+    }
+
+    delay(10);
+}