📝 Add Microchip Transparent UART

Author: leon0399

.github/workflows/arduino-ci.yml

@@ -31,7 +31,9 @@ jobs:
           - "esp32:esp32:esp32"
           - "esp32:esp32:esp32s3"
           - "esp32:esp32:esp32c3"
-        nimble: [ false, true ]
+        nimble:
+          - false
+          - true
       fail-fast: false
 
     steps:
@@ -40,6 +42,8 @@ jobs:
       - uses: arduino/compile-sketches@v1
         with:
           fqbn: ${{ matrix.fqbn }}
+          sketch-paths: |
+            - examples/SerialToSerialBLE
           libraries: |
             - source-path: ./
             - name: NimBLE-Arduino

.github/workflows/platformio-ci.yml

@@ -21,10 +21,18 @@ jobs:
         os: [ ubuntu-latest ]
         example:
           - "SerialToSerialBLE"
+          - "SerialToSerialBLE_TransparentUART"
+          - "SerialToSerialBLE_TransparentUART-NimBLE"
         boards:
           - [ esp32dev, esp32-s3-devkitc-1, esp32-c3-devkitm-1 ]
         nimble: [ false, true ]
 
+        exclude:
+          - example: "SerialToSerialBLE_TransparentUART"
+            nimble: true
+          - example: "SerialToSerialBLE_TransparentUART-NimBLE"
+            nimble: false
+
     steps:
       - uses: actions/checkout@v4
 

README.md

@@ -11,7 +11,7 @@ This library allows using Nordic UART Service (NUS) with ESP32 Arduino.
 [![GitHub release](https://img.shields.io/github/v/release/senseshift/arduino-ble-serial)](https://github.com/senseshift/arduino-ble-serial/releases/latest)
 
 [![PlatformIO CI](https://github.com/senseshift/arduino-ble-serial/actions/workflows/platformio-ci.yml/badge.svg)](https://github.com/senseshift/arduino-ble-serial/actions/workflows/platformio-ci.yml)
-[![PlatformIO CI](https://github.com/senseshift/arduino-ble-serial/actions/workflows/arduino-ci.yml/badge.svg)](https://github.com/senseshift/arduino-ble-serial/actions/workflows/arduino-ci.yml)
+[![Arduino CI](https://github.com/senseshift/arduino-ble-serial/actions/workflows/arduino-ci.yml/badge.svg)](https://github.com/senseshift/arduino-ble-serial/actions/workflows/arduino-ci.yml)
 
 [![MIT](https://img.shields.io/github/license/senseshift/arduino-ble-serial)](/LICENSE)
 [![GitHub contributors](https://img.shields.io/github/contributors/senseshift/arduino-ble-serial)](https://github.com/senseshift/arduino-ble-serial/graphs/contributors)

examples/SerialToSerialBLE_TransparentUART-NimBLE/SerialToSerialBLE_TransparentUART-NimBLE.ino

@@ -0,0 +1,47 @@
+#include <BLESerial.h>
+
+// FOR ETL: Uncomment the following lines
+// #include <Embedded_Template_Library.h>
+// #include <etl/queue.h>
+// #include <etl/circular_buffer.h>
+
+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 (<=std=c++17).
+// https://www.cppreference.com/w/cpp/language/ctad.html
+//
+// Uncomment the line below if you are using an older version of Arduino IDE/C++ compiler
+// 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;
+
+void setup() {
+    BLEDevice::init("ESP32-BLE-Slave");
+
+    BLEServer* pServer = BLEDevice::createServer();
+
+    // Transparent UART Service
+    // https://developerhelp.microchip.com/xwiki/bin/view/applications/ble/android-development-for-bm70rn4870/transparent-uart-service-for-bm70rn4870/
+    auto pService = pServer->createService("49535343-FE7D-4AE5-8FA9-9FAFD205E455");
+
+    auto pRxCharacteristic = pService->createCharacteristic("49535343-1E4D-4BD9-BA61-23C647249616", NIMBLE_PROPERTY::WRITE | NIMBLE_PROPERTY::WRITE_NR | NIMBLE_PROPERTY::NOTIFY);
+    auto pTxCharacteristic = pService->createCharacteristic("49535343-8841-43F4-A8D4-ECBE34729BB3", NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::NOTIFY);
+
+    SerialBLE.begin(pRxCharacteristic, pTxCharacteristic);
+
+    BLEAdvertising* pAdvertising = pServer->getAdvertising();
+    pAdvertising->start();
+}
+
+void loop() {
+    if (Serial.available()) {
+        SerialBLE.write(Serial.read());
+        SerialBLE.flush();
+    }
+    if (SerialBLE.available()) {
+        Serial.write(SerialBLE.read());
+    }
+}

examples/SerialToSerialBLE_TransparentUART/SerialToSerialBLE_TransparentUART.ino

@@ -0,0 +1,47 @@
+#include <BLESerial.h>
+
+// FOR ETL: Uncomment the following lines
+// #include <Embedded_Template_Library.h>
+// #include <etl/queue.h>
+// #include <etl/circular_buffer.h>
+
+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 (<=std=c++17).
+// https://www.cppreference.com/w/cpp/language/ctad.html
+//
+// Uncomment the line below if you are using an older version of Arduino IDE/C++ compiler
+// 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;
+
+void setup() {
+    BLEDevice::init("ESP32-BLE-Slave");
+
+    BLEServer* pServer = BLEDevice::createServer();
+
+    // Transparent UART Service
+    // https://developerhelp.microchip.com/xwiki/bin/view/applications/ble/android-development-for-bm70rn4870/transparent-uart-service-for-bm70rn4870/
+    auto pService = pServer->createService("49535343-FE7D-4AE5-8FA9-9FAFD205E455");
+
+    auto pRxCharacteristic = pService->createCharacteristic("49535343-1E4D-4BD9-BA61-23C647249616", BLECharacteristic::PROPERTY_WRITE | BLECharacteristic::PROPERTY_WRITE_NR | BLECharacteristic::PROPERTY_NOTIFY);
+    auto pTxCharacteristic = pService->createCharacteristic("49535343-8841-43F4-A8D4-ECBE34729BB3", BLECharacteristic::PROPERTY_READ | BLECharacteristic::PROPERTY_NOTIFY);
+
+    SerialBLE.begin(pRxCharacteristic, pTxCharacteristic);
+
+    BLEAdvertising* pAdvertising = pServer->getAdvertising();
+    pAdvertising->start();
+}
+
+void loop() {
+    if (Serial.available()) {
+        SerialBLE.write(Serial.read());
+        SerialBLE.flush();
+    }
+    if (SerialBLE.available()) {
+        Serial.write(SerialBLE.read());
+    }
+}