Add optional Nordic UART Service

Examples still to come

Author: lemmingDev

BleGamepad.cpp

@@ -40,7 +40,7 @@ static const char *LOG_TAG = "BLEGamepad";
 #define POWER_STATE_CHARGING        3 // 0b11
 #define POWER_STATE_CRITICAL        3 // 0b11
 
-BleGamepad::BleGamepad(std::string deviceName, std::string deviceManufacturer, uint8_t batteryLevel) : _buttons(),
+BleGamepad::BleGamepad(std::string deviceName, std::string deviceManufacturer, uint8_t batteryLevel, bool delayAdvertising) : _buttons(),
   _specialButtons(0),
   _x(0),
   _y(0),
@@ -71,19 +71,23 @@ BleGamepad::BleGamepad(std::string deviceName, std::string deviceManufacturer, u
   _powerLevel(0),
   hid(0),
   pCharacteristic_Power_State(0),
-  configuration()
+  configuration(),
+  pServer(nullptr), 
+  nus(nullptr)
 {
   this->resetButtons();
   this->deviceName = deviceName;
   this->deviceManufacturer = deviceManufacturer;
   this->batteryLevel = batteryLevel;
+  this->delayAdvertising = delayAdvertising;
   this->connectionStatus = new BleConnectionStatus();
 
   hidReportDescriptorSize = 0;
   hidReportSize = 0;
   numOfButtonBytes = 0;
   enableOutputReport = false;
   outputReportLength = 64;
+  nusInitialized = false;
 }
 
 void BleGamepad::resetButtons()
@@ -1933,6 +1937,42 @@ void BleGamepad::setPowerLevel(uint8_t powerLevel)
   setPowerStateAll(_batteryPowerInformation, _dischargingState, _chargingState, _powerLevel);
 }
 
+void BleGamepad::beginNUS() 
+{
+    if (!this->nusInitialized) 
+    {
+        // Extrememly important to make sure that the pointer to server is actually valid
+        while(!NimBLEDevice::isInitialized ()){}        // Wait until the server is initialized
+        while(NimBLEDevice::getServer() == nullptr){}   // Ensure pointer to server is actually valid
+        
+        // Now server is nkown to be valid, initialise nus to new BleNUS instance
+        nus = new BleNUS(NimBLEDevice::getServer()); // Pass the existing BLE server
+        nus->begin();
+        nusInitialized = true;
+    }
+}
+
+BleNUS* BleGamepad::getNUS() 
+{
+    return nus;  // Return a pointer instead of a reference
+}
+
+void BleGamepad::sendDataOverNUS(const uint8_t* data, size_t length) 
+{
+  if (nus) 
+  {
+    nus->sendData(data, length);
+  }
+}
+
+void BleGamepad::setNUSDataReceivedCallback(void (*callback)(const uint8_t* data, size_t length)) 
+{
+  if (nus) 
+  {
+    nus->setDataReceivedCallback(callback);
+  }
+}
+
 void BleGamepad::taskServer(void *pvParameter)
 {
   BleGamepad *BleGamepadInstance = (BleGamepad *)pvParameter; // static_cast<BleGamepad *>(pvParameter);
@@ -2025,9 +2065,18 @@ void BleGamepad::taskServer(void *pvParameter)
   pAdvertising->setAppearance(HID_GAMEPAD);
   pAdvertising->setName(BleGamepadInstance->deviceName);
   pAdvertising->addServiceUUID(BleGamepadInstance->hid->getHidService()->getUUID());
-  pAdvertising->start();
+  
+  if(BleGamepadInstance->delayAdvertising)
+  {
+    NIMBLE_LOGD(LOG_TAG, "Main NimBLE server advertising delayed (until Nordic UART Service added)");
+  }
+  else
+  {
+    NIMBLE_LOGD(LOG_TAG, "Main NimBLE server advertising started!");
+    pAdvertising->start();
+  }
+  
   BleGamepadInstance->hid->setBatteryLevel(BleGamepadInstance->batteryLevel);
 
-  NIMBLE_LOGD(LOG_TAG, "Advertising started!");
   vTaskDelay(portMAX_DELAY); // delay(portMAX_DELAY);
 }

BleGamepad.h

@@ -11,6 +11,7 @@
 #include "NimBLECharacteristic.h"
 #include "BleGamepadConfiguration.h"
 #include "BleOutputReceiver.h"
+#include "BleNUS.h"
 
 class BleGamepad
 {
@@ -52,13 +53,17 @@ class BleGamepad
     uint8_t _dischargingState;
     uint8_t _chargingState;
     uint8_t _powerLevel;
-
+    bool nusInitialized;
+    
     //BleGamepadConfiguration configuration;
 
     BleConnectionStatus *connectionStatus;
 
     BleOutputReceiver *outputReceiver;
 
+    NimBLEServer *pServer;
+    BleNUS* nus;
+    
     NimBLEHIDDevice *hid;
     NimBLECharacteristic *inputGamepad;
     NimBLECharacteristic *outputGamepad;
@@ -73,7 +78,7 @@ class BleGamepad
   public:
     BleGamepadConfiguration configuration;
 
-    BleGamepad(std::string deviceName = "ESP32 BLE Gamepad", std::string deviceManufacturer = "Espressif", uint8_t batteryLevel = 100);
+    BleGamepad(std::string deviceName = "ESP32 BLE Gamepad", std::string deviceManufacturer = "Espressif", uint8_t batteryLevel = 100, bool delayAdvertising = false);
     void begin(BleGamepadConfiguration *config = new BleGamepadConfiguration());
     void end(void);
     void setAxes(int16_t x = 0, int16_t y = 0, int16_t z = 0, int16_t rX = 0, int16_t rY = 0, int16_t rZ = 0, int16_t slider1 = 0, int16_t slider2 = 0);
@@ -139,6 +144,7 @@ class BleGamepad
     void setTXPowerLevel(int8_t level = 9);
     int8_t getTXPowerLevel();
     uint8_t batteryLevel;
+    bool delayAdvertising;
     bool isOutputReceived();
     uint8_t* getOutputBuffer();
     bool deleteBond(bool resetBoard = false);
@@ -152,7 +158,10 @@ class BleGamepad
     void setGyroscope(int16_t gX = 0, int16_t gY = 0, int16_t gZ = 0);
     void setAccelerometer(int16_t aX = 0, int16_t aY = 0, int16_t aZ = 0);
     void setMotionControls(int16_t gX = 0, int16_t gY = 0, int16_t gZ = 0, int16_t aX = 0, int16_t aY = 0, int16_t aZ = 0);
-
+    void beginNUS();
+    void sendDataOverNUS(const uint8_t* data, size_t length);
+    void setNUSDataReceivedCallback(void (*callback)(const uint8_t* data, size_t length));
+    BleNUS* getNUS();
 
   protected:
     virtual void onStarted(NimBLEServer *pServer) {};

BleGamepadConfiguration.cpp

@@ -22,9 +22,10 @@ BleGamepadConfiguration::BleGamepadConfiguration() : _controllerType(CONTROLLER_
                                                      _modelNumber("1.0.0"),
                                                      _softwareRevision("1.0.0"),
                                                      _serialNumber("0123456789"),
-                                                     _firmwareRevision("0.7.3"),
+                                                     _firmwareRevision("0.7.4"),
                                                      _hardwareRevision("1.0.0"),
                                                      _enableOutputReport(false),
+                                                     _enableNordicUARTService(false),
                                                      _outputReportLength(64),
 													                           _transmitPowerLevel(9)
 {
@@ -131,6 +132,7 @@ char *BleGamepadConfiguration::getSerialNumber(){ return _serialNumber; }
 char *BleGamepadConfiguration::getFirmwareRevision(){ return _firmwareRevision; }
 char *BleGamepadConfiguration::getHardwareRevision(){ return _hardwareRevision; }
 bool BleGamepadConfiguration::getEnableOutputReport(){ return _enableOutputReport; }
+bool BleGamepadConfiguration::getEnableNordicUARTService(){ return _enableNordicUARTService; }
 uint16_t BleGamepadConfiguration::getOutputReportLength(){ return _outputReportLength; }
 int8_t BleGamepadConfiguration::getTXPowerLevel(){ return _transmitPowerLevel; }	// Returns the power level that was set as the server started
 
@@ -210,5 +212,6 @@ void BleGamepadConfiguration::setSerialNumber(char *value) { _serialNumber = val
 void BleGamepadConfiguration::setFirmwareRevision(char *value) { _firmwareRevision = value; }
 void BleGamepadConfiguration::setHardwareRevision(char *value) { _hardwareRevision = value; }
 void BleGamepadConfiguration::setEnableOutputReport(bool value) { _enableOutputReport = value; }
+void BleGamepadConfiguration::setEnableNordicUARTService(bool value) { _enableNordicUARTService = value; }
 void BleGamepadConfiguration::setOutputReportLength(uint16_t value) { _outputReportLength = value; }
 void BleGamepadConfiguration::setTXPowerLevel(int8_t value) { _transmitPowerLevel = value; }

BleGamepadConfiguration.h

@@ -238,6 +238,7 @@ class BleGamepadConfiguration
     char *_firmwareRevision;
     char *_hardwareRevision;
     bool _enableOutputReport;
+    bool _enableNordicUARTService;
     uint16_t _outputReportLength;
 	  int8_t _transmitPowerLevel;
 
@@ -296,6 +297,7 @@ class BleGamepadConfiguration
     char *getFirmwareRevision();
     char *getHardwareRevision();
     bool getEnableOutputReport();
+    bool getEnableNordicUARTService();
     uint16_t getOutputReportLength();
 	  int8_t getTXPowerLevel();
 
@@ -345,6 +347,7 @@ class BleGamepadConfiguration
     void setFirmwareRevision(char *value);
     void setHardwareRevision(char *value);
     void setEnableOutputReport(bool value);
+    void setEnableNordicUARTService(bool value);
     void setOutputReportLength(uint16_t value);
 	  void setTXPowerLevel(int8_t value);     
 };