Updated Eddystone classes and beacon scanner

PilnyTomas · PilnyTomas · commit 1eb082ee12f5 · 2023-07-07T11:12:14.000+02:00
diff --git a/libraries/BLE/examples/BLE_Beacon_Scanner/BLE_Beacon_Scanner.ino b/libraries/BLE/examples/BLE_Beacon_Scanner/BLE_Beacon_Scanner.ino
@@ -2,6 +2,8 @@
    Based on Neil Kolban example for IDF: https://github.com/nkolban/esp32-snippets/blob/master/cpp_utils/tests/BLE%20Tests/SampleScan.cpp
    Ported to Arduino ESP32 by Evandro Copercini
    Changed to a beacon scanner to report iBeacon, EddystoneURL and EddystoneTLM beacons by beegee-tokyo
+   Upgraded Eddystone part by Tomas Pilny on Feb 20, 2023
+
 */
 
 #include <Arduino.h>
@@ -63,62 +65,33 @@ class MyAdvertisedDeviceCallbacks : public BLEAdvertisedDeviceCallbacks
         }
       }
 
-      uint8_t *payLoad = advertisedDevice.getPayload();
-      // search for Eddystone Service Data in the advertising payload
-      // *payload shall point to eddystone data or to its end when not found
-      const uint8_t serviceDataEddystone[3] = {0x16, 0xAA, 0xFE}; // it has Eddystone BLE UUID
-      const size_t payLoadLen = advertisedDevice.getPayloadLength();
-      uint8_t *payLoadEnd = payLoad + payLoadLen - 1; // address of the end of payLoad space
-      while (payLoad < payLoadEnd) {
-        if (payLoad[1] == serviceDataEddystone[0] && payLoad[2] == serviceDataEddystone[1] && payLoad[3] == serviceDataEddystone[2]) {
-          // found!
-          payLoad += 4;
-          break;
+      if (advertisedDevice.getFrameType() == BLE_EDDYSTONE_URL_FRAME)
+      {
+        Serial.println("Found an EddystoneURL beacon!");
+        BLEEddystoneURL EddystoneURL = BLEEddystoneURL(&advertisedDevice);
+        Serial.printf("URL bytes: 0x");
+        std::string url = EddystoneURL.getURL();
+        for(auto byte : url){
+          Serial.printf("%02X", byte);
         }
-        payLoad += *payLoad + 1;  // payLoad[0] has the field Length
+        Serial.printf("\n");
+        Serial.printf("Decoded URL: %s\n", EddystoneURL.getDecodedURL().c_str());
+        Serial.printf("TX power %d (Raw 0x%02X)\n", EddystoneURL.getPower(), EddystoneURL.getPower());
+        Serial.println("\n");
       }
 
-      if (payLoad < payLoadEnd) // Eddystone Service Data and respective BLE UUID were found
+      if (advertisedDevice.getFrameType() == BLE_EDDYSTONE_TLM_FRAME)
       {
-        if (*payLoad == 0x10)
-        {
-          Serial.println("Found an EddystoneURL beacon!");
-          BLEEddystoneURL foundEddyURL = BLEEddystoneURL();
-          uint8_t URLLen = *(payLoad - 4) - 3;  // Get Field Length less 3 bytes (type and UUID) 
-          foundEddyURL.setData(std::string((char*)payLoad, URLLen));
-          std::string bareURL = foundEddyURL.getURL();
-          if (bareURL[0] == 0x00)
-          {
-            // dumps all bytes in advertising payload
-            Serial.println("DATA-->");
-            uint8_t *payLoad = advertisedDevice.getPayload();
-            for (int idx = 0; idx < payLoadLen; idx++)
-            {
-              Serial.printf("0x%02X ", payLoad[idx]);
-            }
-            Serial.println("\nInvalid Data");
-            return;
-          }
-
-          Serial.printf("Found URL: %s\n", foundEddyURL.getURL().c_str());
-          Serial.printf("Decoded URL: %s\n", foundEddyURL.getDecodedURL().c_str());
-          Serial.printf("TX power %d\n", foundEddyURL.getPower());
-          Serial.println("\n");
-        } 
-        else if (*payLoad == 0x20)
-        {
           Serial.println("Found an EddystoneTLM beacon!");
-          BLEEddystoneTLM eddystoneTLM;
-          eddystoneTLM.setData(std::string((char*)payLoad, 14));
-          Serial.printf("Reported battery voltage: %dmV\n", eddystoneTLM.getVolt());
-          Serial.printf("Reported temperature: %.2f°C (raw data=0x%04X)\n", eddystoneTLM.getTemp(), eddystoneTLM.getRawTemp());
-          Serial.printf("Reported advertise count: %lu\n", eddystoneTLM.getCount());
-          Serial.printf("Reported time since last reboot: %lus\n", eddystoneTLM.getTime());
+          BLEEddystoneTLM EddystoneTLM(&advertisedDevice);
+          Serial.printf("Reported battery voltage: %dmV\n", EddystoneTLM.getVolt());
+          Serial.printf("Reported temperature: %.2f°C (raw data=0x%04X)\n", EddystoneTLM.getTemp(), EddystoneTLM.getRawTemp());
+          Serial.printf("Reported advertise count: %d\n", EddystoneTLM.getCount());
+          Serial.printf("Reported time since last reboot: %ds\n", EddystoneTLM.getTime());
           Serial.println("\n");
-          Serial.print(eddystoneTLM.toString().c_str());
+          Serial.print(EddystoneTLM.toString().c_str());
           Serial.println("\n");
         }
-      }
     }
 };
 
diff --git a/libraries/BLE/examples/BLE_EddystoneURL_Beacon/BLE_EddystoneURL_Beacon.ino b/libraries/BLE/examples/BLE_EddystoneURL_Beacon/BLE_EddystoneURL_Beacon.ino
@@ -26,8 +26,8 @@
 #include "BLEBeacon.h"
 #include "BLEAdvertising.h"
 #include "BLEEddystoneURL.h"
-
 #include "esp_sleep.h"
+
 char unprintable[] = {0x01, 0xFF, 0xDE, 0xAD};
 String URL[] = {
   "http://www.espressif.com/", // prefix 0x00, suffix 0x00
@@ -40,6 +40,7 @@ String URL[] = {
 //  "",  // Empty string - setSmartURL() will return 0 = ERR
 //  String(unprintable), // Unprintable characters / corrupted String - setSmartURL() will return 0 = ERR
 };
+
 #define GPIO_DEEP_SLEEP_DURATION 10      // sleep x seconds and then wake up
 #define BEACON_POWER ESP_PWR_LVL_N12
 RTC_DATA_ATTR static time_t last;        // remember last boot in RTC Memory
@@ -50,15 +51,12 @@ RTC_DATA_ATTR static uint32_t bootcount; // remember number of boots in RTC Memo
 BLEAdvertising *pAdvertising;
 struct timeval now;
 
-std::string BEACON_UUID("8ec76ea3-6668-48da-9866-75be8bc86f4d"); // UUID v1 128-Bit (may use linux tool uuidgen or random numbers via https://www.uuidgenerator.net/)
-
 int setBeacon()
 {
   BLEAdvertisementData oAdvertisementData = BLEAdvertisementData();
   BLEAdvertisementData oScanResponseData = BLEAdvertisementData();
 
   BLEEddystoneURL EddystoneURL;
-  EddystoneURL.setUUID(BLEUUID(BEACON_UUID));
   EddystoneURL.setPower(BEACON_POWER); // This is only information about the power. The actual power is set by `BLEDevice::setPower(BEACON_POWER)`
   if(EddystoneURL.setSmartURL(URL[bootcount%(sizeof(URL)/sizeof(URL[0]))])){
     String frame = EddystoneURL.getFrame();
@@ -67,6 +65,7 @@ int setBeacon()
     oScanResponseData.setName("ESP32 URLBeacon");
     pAdvertising->setAdvertisementData(oAdvertisementData);
     pAdvertising->setScanResponseData(oScanResponseData);
+    Serial.printf("Advertise URL \"%s\"\n", URL[bootcount%(sizeof(URL)/sizeof(URL[0]))].c_str());
     return 1; // OK
   }else{
     Serial.println("Smart URL set ERR");
diff --git a/libraries/BLE/src/BLEAdvertisedDevice.cpp b/libraries/BLE/src/BLEAdvertisedDevice.cpp
@@ -584,6 +584,22 @@ esp_ble_addr_type_t BLEAdvertisedDevice::getAddressType() {
 	return m_addressType;
 }
 
+ble_frame_type_t BLEAdvertisedDevice::getFrameType(){
+  for(int i = 0; i < m_payloadLength; ++i){
+    log_d("check [%d]=0x%02X", i, m_payload[i]);
+    if(m_payload[i] == 0x16 && m_payloadLength >= i+3 && m_payload[i+1] == 0xAA && m_payload[i+2] == 0xFE && m_payload[i+3] == 0x00){
+      return BLE_EDDYSTONE_UUID_FRAME;
+    }
+    if(m_payload[i] == 0x16 && m_payloadLength >= i+3 && m_payload[i+1] == 0xAA && m_payload[i+2] == 0xFE && m_payload[i+3] == 0x10){
+      return BLE_EDDYSTONE_URL_FRAME;
+    }
+    if(m_payload[i] == 0x16 && m_payloadLength >= i+3 && m_payload[i+1] == 0xAA && m_payload[i+2] == 0xFE && m_payload[i+3] == 0x20){
+      return BLE_EDDYSTONE_TLM_FRAME;
+    }
+  }
+  return BLE_UNKNOWN_FRAME;
+}
+
 void BLEAdvertisedDevice::setAddressType(esp_ble_addr_type_t type) {
 	m_addressType = type;
 }
diff --git a/libraries/BLE/src/BLEAdvertisedDevice.h b/libraries/BLE/src/BLEAdvertisedDevice.h
@@ -14,12 +14,19 @@
 #include <esp_gattc_api.h>
 
 #include <map>
-#include <vector>
+//#include <vector>
 
 #include "BLEAddress.h"
 #include "BLEScan.h"
 #include "BLEUUID.h"
 
+typedef enum {
+	BLE_UNKNOWN_FRAME,
+	BLE_EDDYSTONE_UUID_FRAME,
+	BLE_EDDYSTONE_URL_FRAME,
+	BLE_EDDYSTONE_TLM_FRAME,
+	BLE_FRAME_MAX
+} ble_frame_type_t;
 
 class BLEScan;
 /**
@@ -48,9 +55,10 @@ class BLEAdvertisedDevice {
 	int         getServiceDataUUIDCount();
 	int         getServiceUUIDCount();
 	int8_t      getTXPower();
-	uint8_t* 	getPayload();
-	size_t		getPayloadLength();
+	uint8_t*    getPayload();
+	size_t      getPayloadLength();
 	esp_ble_addr_type_t getAddressType();
+	ble_frame_type_t getFrameType();
 	void setAddressType(esp_ble_addr_type_t type);
 
 
diff --git a/libraries/BLE/src/BLEEddystoneTLM.cpp b/libraries/BLE/src/BLEEddystoneTLM.cpp
@@ -22,45 +22,56 @@
 static const char LOG_TAG[] = "BLEEddystoneTLM";
 
 BLEEddystoneTLM::BLEEddystoneTLM() {
-	beaconUUID = 0xFEAA;
-	m_eddystoneData.frameType = EDDYSTONE_TLM_FRAME_TYPE;
-	m_eddystoneData.version = 0;
-	m_eddystoneData.volt = 3300; // 3300mV = 3.3V
-	m_eddystoneData.temp = (uint16_t) ((float) 23.00)/256;
-	m_eddystoneData.advCount = 0;
-	m_eddystoneData.tmil = 0;
+  beaconUUID = 0xFEAA;
+  m_eddystoneData.frameType = EDDYSTONE_TLM_FRAME_TYPE;
+  m_eddystoneData.version = 0;
+  m_eddystoneData.volt = 3300; // 3300mV = 3.3V
+  m_eddystoneData.temp = (uint16_t) ((float) 23.00)/256;
+  m_eddystoneData.advCount = 0;
+  m_eddystoneData.tmil = 0;
 } // BLEEddystoneTLM
 
+BLEEddystoneTLM::BLEEddystoneTLM(BLEAdvertisedDevice *advertisedDevice){
+  char* payload = (char*)advertisedDevice->getPayload();
+  for(int i = 0; i < advertisedDevice->getPayloadLength(); ++i){
+    if(payload[i] == 0x16 && advertisedDevice->getPayloadLength() >= i+2+sizeof(m_eddystoneData) && payload[i+1] == 0xAA && payload[i+2] == 0xFE && payload[i+3] == 0x20){
+      log_d("Eddystone TLM data frame starting at byte [%d]", i+3);
+      setData(std::string(payload+i+3, sizeof(m_eddystoneData)));
+      break;
+    }
+  }
+}
+
 std::string BLEEddystoneTLM::getData() {
-	return std::string((char*) &m_eddystoneData, sizeof(m_eddystoneData));
+  return std::string((char*) &m_eddystoneData, sizeof(m_eddystoneData));
 } // getData
 
 BLEUUID BLEEddystoneTLM::getUUID() {
-	return BLEUUID(beaconUUID);
+  return BLEUUID(beaconUUID);
 } // getUUID
 
 uint8_t BLEEddystoneTLM::getVersion() {
-	return m_eddystoneData.version;
+  return m_eddystoneData.version;
 } // getVersion
 
 uint16_t BLEEddystoneTLM::getVolt() {
-	return ENDIAN_CHANGE_U16(m_eddystoneData.volt);
+  return ENDIAN_CHANGE_U16(m_eddystoneData.volt);
 } // getVolt
 
 float BLEEddystoneTLM::getTemp() {
   return EDDYSTONE_TEMP_U16_TO_FLOAT(m_eddystoneData.temp);
 } // getTemp
 
 uint16_t BLEEddystoneTLM::getRawTemp() {
-	return ENDIAN_CHANGE_U16(m_eddystoneData.temp);
+  return ENDIAN_CHANGE_U16(m_eddystoneData.temp);
 } // getRawTemp
 
 uint32_t BLEEddystoneTLM::getCount() {
-	return ENDIAN_CHANGE_U32(m_eddystoneData.advCount);
+  return ENDIAN_CHANGE_U32(m_eddystoneData.advCount);
 } // getCount
 
 uint32_t BLEEddystoneTLM::getTime() {
-	return (ENDIAN_CHANGE_U32(m_eddystoneData.tmil)) / 10;
+  return (ENDIAN_CHANGE_U32(m_eddystoneData.tmil)) / 10;
 } // getTime
 
 std::string BLEEddystoneTLM::toString() {
@@ -116,9 +127,10 @@ std::string BLEEddystoneTLM::toString() {
 /**
  * Set the raw data for the beacon record.
  * Example:
- * uint8_t *payLoad = advertisedDevice.getPayload();
- * eddystoneTLM.setData(std::string((char*)payLoad+22, advertisedDevice.getPayloadLength() - 22));
- * Note: the offset 22 works for current implementation of example BLE_EddystoneTLM Beacon.ino, however it is not static and will be reimplemented
+ * uint8_t *payload = advertisedDevice.getPayload();
+ * eddystoneTLM.setData(std::string((char*)payload+22, advertisedDevice.getPayloadLength() - 22));
+ * Note: the offset 22 works for current implementation of example BLE_EddystoneTLM Beacon.ino, however
+ *   the position is not static and it is programmers responsibility to align the data.
  * Data frame:
  * | Field  || Len | Type | UUID        | EddyStone TLM |
  * | Offset || 0   | 1    | 2           | 4             |
@@ -132,35 +144,35 @@ std::string BLEEddystoneTLM::toString() {
  * | Data   || 0x20  | ??      | ??   | ??   | ??    | ??  |   |   |   |    |   |   |   |     |
  */
 void BLEEddystoneTLM::setData(std::string data) {
-	if (data.length() != sizeof(m_eddystoneData)) {
-		log_e("Unable to set the data ... length passed in was %d and expected %d", data.length(), sizeof(m_eddystoneData));
-		return;
-	}
+  if (data.length() != sizeof(m_eddystoneData)) {
+    log_e("Unable to set the data ... length passed in was %d and expected %d", data.length(), sizeof(m_eddystoneData));
+    return;
+  }
   memcpy(&m_eddystoneData, data.data(), data.length());
 } // setData
 
 void BLEEddystoneTLM::setUUID(BLEUUID l_uuid) {
-	beaconUUID = l_uuid.getNative()->uuid.uuid16;
+  beaconUUID = l_uuid.getNative()->uuid.uuid16;
 } // setUUID
 
 void BLEEddystoneTLM::setVersion(uint8_t version) {
-	m_eddystoneData.version = version;
+  m_eddystoneData.version = version;
 } // setVersion
 
 void BLEEddystoneTLM::setVolt(uint16_t volt) {
-	m_eddystoneData.volt = volt;
+  m_eddystoneData.volt = volt;
 } // setVolt
 
 void BLEEddystoneTLM::setTemp(float temp) {
-	m_eddystoneData.temp = EDDYSTONE_TEMP_FLOAT_TO_U16(temp);
+  m_eddystoneData.temp = EDDYSTONE_TEMP_FLOAT_TO_U16(temp);
 } // setTemp
 
 void BLEEddystoneTLM::setCount(uint32_t advCount) {
-	m_eddystoneData.advCount = advCount;
+  m_eddystoneData.advCount = advCount;
 } // setCount
 
 void BLEEddystoneTLM::setTime(uint32_t tmil) {
-	m_eddystoneData.tmil = tmil;
+  m_eddystoneData.tmil = tmil;
 } // setTime
 
 #endif
diff --git a/libraries/BLE/src/BLEEddystoneTLM.h b/libraries/BLE/src/BLEEddystoneTLM.h
@@ -11,6 +11,7 @@
 #if SOC_BLE_SUPPORTED
 
 #include "BLEUUID.h"
+#include <BLEAdvertisedDevice.h>
 
 #define EDDYSTONE_TLM_FRAME_TYPE 0x20
 #define ENDIAN_CHANGE_U16(x) ((((x)&0xFF00)>>8) + (((x)&0xFF)<<8))
@@ -26,6 +27,7 @@
 class BLEEddystoneTLM {
 public:
   BLEEddystoneTLM();
+  BLEEddystoneTLM(BLEAdvertisedDevice *advertisedDevice);
   std::string getData();
   BLEUUID   getUUID();
   uint8_t   getVersion();
diff --git a/libraries/BLE/src/BLEEddystoneURL.cpp b/libraries/BLE/src/BLEEddystoneURL.cpp
diff --git a/libraries/BLE/src/BLEEddystoneURL.h b/libraries/BLE/src/BLEEddystoneURL.h
diff --git a/libraries/BLE/src/BLEUUID.cpp b/libraries/BLE/src/BLEUUID.cpp
