📝 Add BLESecurity example

Author: leon0399

.github/workflows/platformio-ci.yml

@@ -21,6 +21,7 @@ jobs:
         os: [ ubuntu-latest ]
         example:
           - "SerialToSerialBLE"
+          - "SerialToSerialBLE_Secure"
         boards:
           - [ esp32dev, esp32-s3-devkitc-1, esp32-c3-devkitm-1 ]
         nimble: [ false, true ]
@@ -65,6 +66,6 @@ jobs:
           PLATFORMIO_CI_SRC: "./examples/${{ matrix.example }}/*.ino"
           PLATFORMIO_BUILD_FLAGS: |
             -D BLESERIAL_USE_NIMBLE=${{ matrix.nimble }}
-            -Wall
-            -Wextra
-            -Wpedantic
+          #  -Wall
+          #  -Wextra
+          #  -Wpedantic

examples/SerialToSerialBLE/SerialToSerialBLE.ino

@@ -7,9 +7,11 @@
 
 String device_name = "ESP32-BLE-Slave";
 
-// Mind the empty template argument (<>), it is required for
-// the code to compile with the current Arduino C++ compiler version
-BLESerial<> SerialBLE;
+BLESerial SerialBLE;
+// If you are using older version of Arduino IDE, you may need to use
+// empty template argument (<>), due to the old C++ compiler version.
+// Uncomment the line below if you are using an older version of Arduino IDE
+// BLESerial<> SerialBLE;
 
 // FOR ETL: Uncomment one of the following lines
 // BLESerial<etl::queue<uint8_t, 255, etl::memory_model::MEMORY_MODEL_SMALL>> SerialBLE;

examples/SerialToSerialBLE_Secure/SerialToSerialBLE_Secure.ino

@@ -0,0 +1,87 @@
+#include <BLESerial.h>
+
+// FOR ETL: Uncomment the following lines
+// #include <Embedded_Template_Library.h>
+// #include <etl/queue.h>
+// #include <etl/circular_buffer.h>
+
+String device_name = "ESP32-BLE-Slave";
+
+BLESerial SerialBLE;
+// If you are using older version of Arduino IDE, you may need to use
+// empty template argument (<>), due to the old C++ compiler version.
+// Uncomment the line below if you are using an older version of Arduino IDE
+// BLESerial<> SerialBLE;
+
+// FOR ETL: Uncomment one of the following lines
+// BLESerial<etl::queue<uint8_t, 255, etl::memory_model::MEMORY_MODEL_SMALL>> SerialBLE;
+// OR
+// BLESerial<etl::circular_buffer<uint8_t, 255>> SerialBLE;
+
+uint32_t passKey;
+
+class AppSecurityCallbacks : public BLESecurityCallbacks {
+  public:
+    AppSecurityCallbacks() {
+        this->passKey = random(111111, 999999);
+    }
+
+    uint32_t onPassKeyRequest(){
+        ESP_LOGI(LOG_TAG, "PassKeyRequest");
+
+        // Generate a random passkey
+        this->passKey = random(111111, 999999);
+
+        return this->passKey;
+    }
+
+    void onPassKeyNotify(uint32_t pass_key){
+        ESP_LOGI(LOG_TAG, "The passkey Notify number: %d", pass_key);
+    }
+
+    bool onConfirmPIN(uint32_t pass_key){
+        ESP_LOGI(LOG_TAG, "The passkey YES/NO number: %d", pass_key);
+        vTaskDelay(5000);
+        return true;
+    }
+
+    bool onSecurityRequest(){
+        ESP_LOGI(LOG_TAG, "SecurityRequest");
+        return true;
+    }
+
+    void onAuthenticationComplete(esp_ble_auth_cmpl_t cmpl){
+        ESP_LOGI(LOG_TAG, "Starting BLE work!");
+    }
+
+  private:
+    uint32_t passKey;
+};
+
+void setup() {
+    BLEDevice::init(device_name);
+    BLEDevice::setEncryptionLevel(ESP_BLE_SEC_ENCRYPT);
+    BLEDevice::setSecurityCallbacks(new AppSecurityCallbacks());
+
+    BLEServer* pServer = BLEDevice::createServer();
+
+    BLESecurity *pSecurity = new BLESecurity();
+    pSecurity->setKeySize();
+    pSecurity->setAuthenticationMode(ESP_LE_AUTH_REQ_SC_ONLY);
+    pSecurity->setCapability(ESP_IO_CAP_IO);
+    pSecurity->setInitEncryptionKey(ESP_BLE_ENC_KEY_MASK | ESP_BLE_ID_KEY_MASK);
+
+    Serial.begin(9600);
+    SerialBLE.begin(pServer);
+}
+
+void loop() {
+    if (Serial.available()) {
+        SerialBLE.write(Serial.read());
+        SerialBLE.flush();
+    }
+
+    if (SerialBLE.available()) {
+        Serial.write(SerialBLE.read());
+    }
+}

library.json

@@ -46,6 +46,6 @@
         "srcDir": "src"
     },
     "dependencies": {
-        "ESP32 BLE Arduino": "^2.0.0"
+        "BLE": "^3.0.0"
     }
 }