Allow advertisement to contain multiple types of data

Author: Jaakko Kangasharju

src/BLEDevice.h

@@ -11,6 +11,13 @@
 #include "BLERemoteCharacteristic.h"
 #include "BLERemoteService.h"
 
+struct BLEAdvertisementData
+{
+  unsigned char length;
+  unsigned char type;
+  unsigned char data[BLE_ADVERTISEMENT_DATA_MAX_VALUE_LENGTH];
+};
+
 class BLEDevice;
 
 class BLEDeviceEventListener
@@ -49,9 +56,8 @@ class BLEDevice
     void setConnectable(bool connectable);
     void setBondStore(BLEBondStore& bondStore);
 
-    virtual void begin(unsigned char /*advertisementDataType*/,
-                unsigned char /*advertisementDataLength*/,
-                const unsigned char* /*advertisementData*/,
+    virtual void begin(unsigned char /*advertisementDataSize*/,
+                BLEAdvertisementData * /*advertisementData*/,
                 unsigned char /*scanDataType*/,
                 unsigned char /*scanDataLength*/,
                 const unsigned char* /*scanData*/,

src/BLEPeripheral.cpp

@@ -69,39 +69,54 @@ BLEPeripheral::~BLEPeripheral() {
 }
 
 void BLEPeripheral::begin() {
-  unsigned char advertisementDataType = 0;
   unsigned char scanDataType = 0;
 
-  unsigned char advertisementDataLength = 0;
+  unsigned char advertisementDataSize = 0;
   unsigned char scanDataLength = 0;
 
-  unsigned char advertisementData[BLE_ADVERTISEMENT_DATA_MAX_VALUE_LENGTH];
+  BLEAdvertisementData advertisementData[3];
   unsigned char scanData[BLE_SCAN_DATA_MAX_VALUE_LENGTH];
 
+  unsigned char remainingAdvertisementDataLength = BLE_ADVERTISEMENT_DATA_MAX_VALUE_LENGTH + 2;
   if (this->_serviceSolicitationUuid){
     BLEUuid serviceSolicitationUuid = BLEUuid(this->_serviceSolicitationUuid);
 
-    advertisementDataLength = serviceSolicitationUuid.length();
-    advertisementDataType = (advertisementDataLength > 2) ? 0x15 : 0x14;
+    unsigned char uuidLength = serviceSolicitationUuid.length();
+    advertisementData[advertisementDataSize].length = uuidLength;
+    advertisementData[advertisementDataSize].type = (uuidLength > 2) ? 0x15 : 0x14;
 
-    memcpy(advertisementData, serviceSolicitationUuid.data(), advertisementDataLength);
-  } else if (this->_advertisedServiceUuid){
+    memcpy(advertisementData[advertisementDataSize].data, serviceSolicitationUuid.data(), uuidLength);
+    advertisementDataSize += 1;
+    remainingAdvertisementDataLength -= uuidLength + 2;
+  }
+  if (this->_advertisedServiceUuid){
     BLEUuid advertisedServiceUuid = BLEUuid(this->_advertisedServiceUuid);
 
-    advertisementDataLength = advertisedServiceUuid.length();
-    advertisementDataType = (advertisementDataLength > 2) ? 0x06 : 0x02;
-
-    memcpy(advertisementData, advertisedServiceUuid.data(), advertisementDataLength);
-  } else if (this->_manufacturerData && this->_manufacturerDataLength > 0) {
-    advertisementDataLength = this->_manufacturerDataLength;
+    unsigned char uuidLength = advertisedServiceUuid.length();
+    if (uuidLength + 2 <= remainingAdvertisementDataLength) {
+      advertisementData[advertisementDataSize].length = uuidLength;
+      advertisementData[advertisementDataSize].type = (uuidLength > 2) ? 0x06 : 0x02;
 
-    if (advertisementDataLength > sizeof(advertisementData)) {
-      advertisementDataLength = sizeof(advertisementData);
+      memcpy(advertisementData[advertisementDataSize].data, advertisedServiceUuid.data(), uuidLength);
+      advertisementDataSize += 1;
+      remainingAdvertisementDataLength -= uuidLength + 2;
     }
+  }
+  if (this->_manufacturerData && this->_manufacturerDataLength > 0) {
+    if (remainingAdvertisementDataLength >= 3) {
+      unsigned char dataLength = this->_manufacturerDataLength;
 
-    advertisementDataType = 0xff;
+      if (dataLength + 2 > remainingAdvertisementDataLength) {
+        dataLength = remainingAdvertisementDataLength - 2;
+      }
 
-    memcpy(advertisementData, this->_manufacturerData, advertisementDataLength);
+      advertisementData[advertisementDataSize].length = dataLength;
+      advertisementData[advertisementDataSize].type = 0xff;
+
+      memcpy(advertisementData[advertisementDataSize].data, this->_manufacturerData, dataLength);
+      advertisementDataSize += 1;
+      remainingAdvertisementDataLength -= dataLength + 2;
+    }
   }
 
   if (this->_localName){
@@ -144,7 +159,7 @@ void BLEPeripheral::begin() {
     this->addRemoteAttribute(this->_remoteServicesChangedCharacteristic);
   }
 
-  this->_device->begin(advertisementDataType, advertisementDataLength, advertisementData,
+  this->_device->begin(advertisementDataSize, advertisementData,
                         scanDataType, scanDataLength, scanData,
                         this->_localAttributes, this->_numLocalAttributes,
                         this->_remoteAttributes, this->_numRemoteAttributes);

src/nRF51822.cpp

@@ -76,9 +76,8 @@ nRF51822::~nRF51822() {
   this->end();
 }
 
-void nRF51822::begin(unsigned char advertisementDataType,
-                      unsigned char advertisementDataLength,
-                      const unsigned char* advertisementData,
+void nRF51822::begin(unsigned char advertisementDataSize,
+                      BLEAdvertisementData *advertisementData,
                       unsigned char scanDataType,
                       unsigned char scanDataLength,
                       const unsigned char* scanData,
@@ -196,14 +195,16 @@ void nRF51822::begin(unsigned char advertisementDataType,
 
   this->_advDataLen += 3;
 
-  if (advertisementDataType && advertisementDataLength && advertisementData) {
-    this->_advData[this->_advDataLen + 0] = advertisementDataLength + 1;
-    this->_advData[this->_advDataLen + 1] = advertisementDataType;
-    this->_advDataLen += 2;
+  if (advertisementDataSize && advertisementData) {
+    for (int i = 0; i < advertisementDataSize; i++) {
+      this->_advData[this->_advDataLen + 0] = advertisementData[i].length + 1;
+      this->_advData[this->_advDataLen + 1] = advertisementData[i].type;
+      this->_advDataLen += 2;
 
-    memcpy(&this->_advData[this->_advDataLen], advertisementData, advertisementDataLength);
+      memcpy(&this->_advData[this->_advDataLen], advertisementData[i].data, advertisementData[i].length);
 
-    this->_advDataLen += advertisementDataLength;
+      this->_advDataLen += advertisementData[i].length;
+    }
   }
 
   if (scanDataType && scanDataLength && scanData) {

src/nRF51822.h

@@ -52,9 +52,8 @@ class nRF51822 : public BLEDevice
 
     virtual ~nRF51822();
 
-    virtual void begin(unsigned char advertisementDataType,
-                unsigned char advertisementDataLength,
-                const unsigned char* advertisementData,
+    virtual void begin(unsigned char advertisementDataSize,
+                BLEAdvertisementData *advertisementData,
                 unsigned char scanDataType,
                 unsigned char scanDataLength,
                 const unsigned char* scanData,

src/nRF8001.cpp

@@ -143,9 +143,8 @@ nRF8001::~nRF8001() {
   this->end();
 }
 
-void nRF8001::begin(unsigned char advertisementDataType,
-                      unsigned char advertisementDataLength,
-                      const unsigned char* advertisementData,
+void nRF8001::begin(unsigned char advertisementDataSize,
+                      BLEAdvertisementData *advertisementData,
                       unsigned char scanDataType,
                       unsigned char scanDataLength,
                       const unsigned char* scanData,
@@ -261,7 +260,7 @@ void nRF8001::begin(unsigned char advertisementDataType,
 
   setupMsg.status_byte = 0;
 
-  bool hasAdvertisementData = advertisementDataType && advertisementDataLength && advertisementData;
+  bool hasAdvertisementData = advertisementDataSize && advertisementData;
   bool hasScanData          = scanDataType && scanDataLength && scanData;
 
   for (int i = 0; i < NB_BASE_SETUP_MESSAGES; i++) {
@@ -305,9 +304,9 @@ void nRF8001::begin(unsigned char advertisementDataType,
         setupMsgData->data[0] |= 0x01;
       }
     } else if (i == 5 && hasAdvertisementData) {
-      setupMsgData->data[0] = advertisementDataType;
-      setupMsgData->data[1] = advertisementDataLength;
-      memcpy(&setupMsgData->data[2], advertisementData, advertisementDataLength);
+      setupMsgData->data[0] = advertisementData[0].type;
+      setupMsgData->data[1] = advertisementData[0].length;
+      memcpy(&setupMsgData->data[2], advertisementData[0].data, advertisementData[0].length);
     } else if (i == 6 && hasScanData) {
       setupMsgData->data[0] = scanDataType;
       setupMsgData->data[1] = scanDataLength;

src/nRF8001.h

@@ -46,9 +46,8 @@ class nRF8001 : protected BLEDevice
 
     virtual ~nRF8001();
 
-    virtual void begin(unsigned char advertisementDataType,
-                unsigned char advertisementDataLength,
-                const unsigned char* advertisementData,
+    virtual void begin(unsigned char advertisementDataSize,
+                BLEAdvertisementData *advertisementData,
                 unsigned char scanDataType,
                 unsigned char scanDataLength,
                 const unsigned char* scanData,