From f09b0b63074705b52a55257cbe2f599691597703 Mon Sep 17 00:00:00 2001 From: Austin Blackstone Date: Mon, 10 Aug 2015 15:00:01 -0500 Subject: [PATCH] modified eddystone service, currently blows away any associated services but it works --- ble/services/EddystoneService.h | 637 ++++++++++++++++---------------- 1 file changed, 318 insertions(+), 319 deletions(-) diff --git a/ble/services/EddystoneService.h b/ble/services/EddystoneService.h index 5e0fd1f..2d54095 100644 --- a/ble/services/EddystoneService.h +++ b/ble/services/EddystoneService.h @@ -22,17 +22,22 @@ static const uint8_t BEACON_EDDYSTONE[] = {0xAA, 0xFE}; +//Debug is disabled by default #if 0 -#define INFO(MSG, ...) printf("[EddyStone: INFO]" MSG " \t[%s,%d]\r\n", ##__VA_ARGS__, __FILE__, __LINE__); -#define DBG(MSG, ...) printf("[EddyStone: DBG]" MSG " \t[%s,%d]\r\n", ##__VA_ARGS__, __FILE__, __LINE__); -#define WARN(MSG, ...) printf("[EddyStone: WARN]" MSG " \t[%s,%d]\r\n", ##__VA_ARGS__, __FILE__, __LINE__); -#define ERR(MSG, ...) printf("[EddyStone: ERR]" MSG " \t[%s,%d]\r\n", ##__VA_ARGS__, __FILE__, __LINE__); +#define DBG(x, ...) printf("[EddyStone: DBG]"x" \t[%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); +#define WARN(x, ...) printf("[EddyStone: WARN]"x" \t[%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); +#define ERR(x, ...) printf("[EddyStone: ERR]"x" \t[%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); #else -#define INFO(MSG, ...) -#define DBG(MSG, ...) -#define WARN(MSG, ...) -#define ERR(MSG, ...) -#endif // if 0 +#define DBG(x, ...) //wait_us(10); +#define WARN(x, ...) //wait_us(10); +#define ERR(x, ...) +#endif + +#if 0 +#define INFO(x, ...) printf("[EddyStone: INFO]"x" \t[%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); +#else +#define INFO(x, ...) +#endif /** * @class Eddystone @@ -43,222 +48,94 @@ static const uint8_t BEACON_EDDYSTONE[] = {0xAA, 0xFE}; class EddystoneService { public: - static const unsigned ADVERTISING_INTERVAL_MSEC = 1000; // Advertising interval for config service. - static const size_t SERVICE_DATA_MAX = 31; // Maximum size of service data in ADV packets + /** + * @brief Transmission Power Modes for UriBeacon + */ - static const size_t URI_DATA_MAX = 18; - typedef uint8_t UriData_t[URI_DATA_MAX]; + static const int ADVERTISING_INTERVAL_MSEC = 1000; // Advertising interval for config service. + static const int SERVICE_DATA_MAX = 31; // Maximum size of service data in ADV packets + + // There are currently 3 subframes defined, URI, UID, and TLM +#define EDDYSTONE_MAX_FRAMETYPE 3 + void (*frames[EDDYSTONE_MAX_FRAMETYPE])(uint8_t *, uint32_t); + uint8_t frameIndex; + static const int URI_DATA_MAX = 18; + typedef uint8_t UriData_t[URI_DATA_MAX]; // UID Frame Type subfields - static const size_t UID_NAMESPACEID_SIZE = 10; - static const size_t UID_INSTANCEID_SIZE = 6; - typedef uint8_t UIDNamespaceID_t[UID_NAMESPACEID_SIZE]; - typedef uint8_t UIDInstanceID_t[UID_INSTANCEID_SIZE]; + static const int UID_NAMESPACEID_SIZE = 10; + typedef uint8_t UIDNamespaceID_t[UID_NAMESPACEID_SIZE]; + static const int UID_INSTANCEID_SIZE = 6; + typedef uint8_t UIDInstanceID_t[UID_INSTANCEID_SIZE]; // Eddystone Frame Type ID - enum { - FRAME_TYPE_UID = 0x00, - FRAME_TYPE_URL = 0x10, - FRAME_TYPE_TLM = 0x20, - NUM_FRAMETYPES = 3 - }; + static const uint8_t FRAME_TYPE_UID = 0x00; + static const uint8_t FRAME_TYPE_URL = 0x10; + static const uint8_t FRAME_TYPE_TLM = 0x20; - static const uint8_t FRAME_SIZE_UID = 20; // includes RFU bytes static const uint8_t FRAME_SIZE_TLM = 14; // TLM frame is a constant 14Bytes - -public: - /** - * Constructor: sets up the parameters used by the Eddystone beacon. - * This function should be used in lieu of the config service. - * - * @param bleIn - * ble object for the underlying controller. - * @oaram interval - * This is is how often broadcasts are made (in units of milliseconds). - * @param txPowerLevel - * The broadcasting power level (in dbM). - * @param UIDNamespaceID - * 10-Byte Namespace UUID. - * @param UIDInstanceID - * 6-Byte Instance UUID. - * @param url - * Shortened URL to broadcast (pass in as a string). - * @param tlmVersion - * version of telemetry data field to use (default to 0x00). - */ - EddystoneService(BLEDevice &bleIn, - uint16_t interval = 100, - uint8_t txPowerLevel = 0, - const uint8_t *UIDNamespaceID = NULL, - const uint8_t *UIDInstanceID = NULL, - const char *url = NULL, - uint8_t tlmVersion = 0) : - ble(bleIn), - uidIsSet(false), - urlIsSet(false), - frameIndex(0), - uidRFU(0), - switchFlag(true), - TlmPduCount(0), - TlmTimeSinceBoot(0) - { - // Check optional frames, set their 'isSet' flags appropriately - if ((UIDNamespaceID != NULL) & (UIDInstanceID != NULL)) { - setUIDFrameData(txPowerLevel, UIDNamespaceID, UIDInstanceID); - uidIsSet = true; - } else if (url != NULL) { - setURLFrameData(txPowerLevel, url); - urlIsSet = true; - } else { - // Default TLM frame to version 0x00, start all values at zero to be spec compliant. - setTLMFrameData(tlmVersion, 0x00, 0x00); - } - - ble.gap().setTxPower(txPowerLevel); - ble.gap().setAdvertisingType(GapAdvertisingParams::ADV_NON_CONNECTABLE_UNDIRECTED); - ble.gap().setAdvertisingInterval(interval); - - ble.gap().clearAdvertisingPayload(); - ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE); - ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, BEACON_EDDYSTONE, sizeof(BEACON_EDDYSTONE)); - - // Construct TLM Frame in initial advertising. - uint8_t serviceData[SERVICE_DATA_MAX]; - unsigned serviceDataLen = 0; - serviceData[serviceDataLen++] = BEACON_EDDYSTONE[0]; - serviceData[serviceDataLen++] = BEACON_EDDYSTONE[1]; - serviceDataLen += constructTLMFrame(serviceData + serviceDataLen, SERVICE_DATA_MAX); - ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceData, serviceDataLen); - - ble.gap().startAdvertising(); - ble.gap().onRadioNotification(this, &EddystoneService::radioNotificationCallback); - - timeSinceBootTick.attach(this, &EddystoneService::tsbCallback, 0.1); // increment the TimeSinceBoot ticker every 0.1s - } + static const uint8_t FRAME_SIZE_UID = 20; // includes RFU bytes /* - * Update the TLM frame battery voltage value - * @param[in] voltagemv Voltage to update the TLM field battery voltage with (in mV) - * @return nothing - */ - void updateTlmBatteryVoltage(uint16_t voltagemv) { - TlmBatteryVoltage = voltagemv; - } - - /* - * Update the TLM frame beacon temperature - * @param[in] temp Temperature of beacon (in 8.8fpn) - * @return nothing - */ - void updateTlmBeaconTemp(uint16_t temp) { - TlmBeaconTemp = temp; - } - - /* - * Update the TLM frame PDU Count field - * @param[in] pduCount Number of Advertising frames sent since power-up - */ - void updateTlmPduCount(uint32_t pduCount) { - TlmPduCount = pduCount; - } - - /* - * Update the TLM frame Time since boot in 0.1s increments - * @param[in] timeSinceBoot Time since boot in 0.1s increments - */ - void updateTlmTimeSinceBoot(uint32_t timeSinceBoot) { - TlmTimeSinceBoot = timeSinceBoot; - } - -protected: - /* - * callback function, called every 0.1s, increments the TimeSinceBoot field in the TLM frame - */ - virtual void tsbCallback(void) { - TlmTimeSinceBoot++; - } - -private: - /* - * Set Eddystone UID Frame information. - * - * @param[in] power TX Power in dB measured at 0 meters from the device. Range of -100 to +20 dB. - * @param namespaceID 10B namespace ID - * @param instanceID 6B instance ID - * @param RFU 2B of RFU, initialized to 0x0000 and not broadcast, included for future reference. - */ - void setUIDFrameData(int8_t power, const UIDNamespaceID_t namespaceID, const UIDInstanceID_t instanceID, uint16_t RFU = 0x0000) { - if (power > 20) { + * Set Eddystone UID Frame information. + * @param[in] power TX Power in dB measured at 0 meters from the device. Range of -100 to +20 dB. + * @param namespaceID 10B namespace ID + * @param instanceID 6B instance ID + * @param RFU 2B of RFU, initialized to 0x0000 and not broadcast, included for future reference. + * + */ + void setUIDFrameData(int8_t power, UIDNamespaceID_t namespaceID, UIDInstanceID_t instanceID, uint16_t RFU = 0x0000) { + if(power > 20) { power = 20; } - if (power < -100) { + if(power < -100) { power = -100; } defaultUidPower = power; - memcpy(defaultUidNamespaceID, namespaceID, UID_NAMESPACEID_SIZE); memcpy(defaultUidInstanceID, instanceID, UID_INSTANCEID_SIZE); - - uidRFU = (uint16_t)RFU; // this is probably bad form, but it doesn't really matter yet. + uidRFU = (uint16_t)RFU; // this is probably bad form, but it doesnt really matter yet. + return; } - /** - * Construct UID frame from private variables - * - * @param[in,out] data - * pointer to array to store constructed frame in - * @param[in] maxSize - * number of bytes left in array, effectively how much empty space is available to write to - * - * @return number of bytes used. negative number indicates error message. - */ - int constructUIDFrame(uint8_t *data, uint8_t maxSize) { - if (maxSize < FRAME_SIZE_UID) { - return -1; - } + /* + * Construct UID frame from private variables + * @param[in/out] Data pointer to array to store constructed frame in + * @param[in] maxSize number of bytes left in array, effectively how much emtpy space is available to write to + * @return number of bytes used. negative number indicates error message. + */ + int constructUIDFrame(uint8_t * Data, uint8_t maxSize) { - unsigned index = 0; - data[index++] = FRAME_TYPE_UID; // 1B Type - - if (defaultUidPower > 20) { // enforce range of valid values. - defaultUidPower = 20; + int index = 0; + Data[index++] = FRAME_TYPE_UID; // 1B Type + if(defaultUidPower > 20) { + defaultUidPower = 20; // enforce range of vaild values. } - if (defaultUidPower < -100) { + if(defaultUidPower < -100) { defaultUidPower = -100; } - data[index++] = defaultUidPower; // 1B Power @ 0meter - - for (size_t x = 0; x < UID_NAMESPACEID_SIZE; x++) { // 10B Namespce ID - data[index++] = defaultUidNamespaceID[x]; + Data[index++] = defaultUidPower; // 1B Power @ 0meter + for(int x = 0; x < UID_NAMESPACEID_SIZE; x++) { // 10B Namespce ID + Data[index++] = defaultUidNamespaceID[x]; } - - for (size_t x = 0; x< UID_INSTANCEID_SIZE; x++) { // 6B Instance ID - data[index++] = defaultUidInstanceID[x]; + for(int x = 0; x< UID_INSTANCEID_SIZE; x++) { // 6B Instance ID + Data[index++] = defaultUidInstanceID[x]; } - - if (uidRFU) { // 2B RFU, include if non-zero, otherwise ignore - data[index++] = (uint8_t)(uidRFU >> 0); - data[index++] = (uint8_t)(uidRFU >> 8); + if(0 != uidRFU) { // 2B RFU, include if non-zero, otherwise ignore + Data[index++] = (uint8_t)(uidRFU >> 0); + Data[index++] = (uint8_t)(uidRFU >> 8); } - + DBG("construcUIDFrame %d, %d",maxSize,index); return index; } /* - * Update advertising data - * @return true on success, false on failure - */ - bool updateAdvPacket(const uint8_t serviceData[], unsigned serviceDataLen) { - return (ble.gap().updateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceData, serviceDataLen) == BLE_ERROR_NONE); - } - - /* - * Set Eddystone URL Frame information. - * @param[in] power TX Power in dB measured at 0 meters from the device. - * @param url URL to encode - * @return false on success, true on failure. - */ - bool setURLFrameData(int8_t power, const char *url) { + * Set Eddystone URL Frame information. + * @param[in] power TX Power in dB measured at 0 meters from the device. + * @param url URL to encode + * @return false on success, true on failure. + */ + bool setURLFrameData(int8_t power, const char * url) { defaultUrlPower = power; encodeURL(url, defaultUriData, defaultUriDataLength); // encode URL to URL Formatting if (defaultUriDataLength > URI_DATA_MAX) { @@ -267,203 +144,325 @@ private: return false; } - /** - * Construct URL frame from private variables. - * - * @param[in,out] data - * pointer to array to store constructed frame in - * @param[in] maxSize - * number of bytes left in array, effectively how much empty space is available to write to. - * - * @return number of bytes used. negative number indicates error message. - */ - int constructURLFrame(uint8_t *data, uint8_t maxSize) { - if (maxSize < (1 + 1 + defaultUriDataLength)) { - return -1; + /* + * Construct URL frame from private variables + * @param[in/out] Data pointer to array to store constructed frame in + * @param[in] maxSize number of bytes left in array, effectively how much emtpy space is available to write to + * @return number of bytes used. negative number indicates error message. + */ + int constructURLFrame(uint8_t * Data, uint8_t maxSize) { + int index = 0; + Data[index++] = FRAME_TYPE_URL; // 1B Type + Data[index++] = defaultUrlPower; // 1B TX Power + for(int x = 0; x < defaultUriDataLength; x++) { // 18B of URL Prefix + encoded URL + Data[index++] = defaultUriData[x]; } - - unsigned index = 0; - data[index++] = FRAME_TYPE_URL; // 1B Type - data[index++] = defaultUrlPower; // 1B TX Power - for (size_t x = 0; x < defaultUriDataLength; x++) { // 18B of URL Prefix + encoded URL - data[index++] = defaultUriData[x]; - } - + DBG("constructURLFrame: %d, %d",maxSize,index); return index; } /* - * Set Eddystone TLM Frame information. - * @param[in] Version of the TLM beacon data format - * @param batteryVoltage in millivolts - * @param beaconTemp in 8.8 floating point notation - * - */ + * Set Eddystone TLM Frame information. + * @param[in] Version of the TLM beacon data format + * @param batteryVoltage in milivolts + * @param beaconTemp in 8.8 floating point notation + * + */ void setTLMFrameData(uint8_t version, uint16_t batteryVoltage, uint16_t beaconTemp, uint32_t pduCount = 0, uint32_t timeSinceBoot = 0) { - TlmVersion = version; + TlmVersion = version; TlmBatteryVoltage = batteryVoltage; - TlmBeaconTemp = beaconTemp; - TlmPduCount = pduCount; // reset - TlmTimeSinceBoot = timeSinceBoot; // reset + TlmBeaconTemp = beaconTemp; + TlmPduCount = pduCount; // reset + TlmTimeSinceBoot = timeSinceBoot; // reset + return; } /* - * Construct TLM frame from private variables - * @param[in,out] data - * pointer to array to store constructed frame in - * @param[in] maxSize - * number of bytes left in array, effectively how much empty space is available to write to. - * - * @return number of bytes used. negative number indicates error message. - */ - int constructTLMFrame(uint8_t *data, uint8_t maxSize) { - if (maxSize < FRAME_SIZE_TLM) { - return -1; - } - - unsigned index = 0; - data[index++] = FRAME_TYPE_TLM; // Eddystone frame type = Telemetry - data[index++] = TlmVersion; // TLM Version Number - data[index++] = (uint8_t)(TlmBatteryVoltage >> 8); // Battery Voltage[0] - data[index++] = (uint8_t)(TlmBatteryVoltage >> 0); // Battery Voltage[1] - data[index++] = (uint8_t)(TlmBeaconTemp >> 8); // Beacon Temp[0] - data[index++] = (uint8_t)(TlmBeaconTemp >> 0); // Beacon Temp[1] - data[index++] = (uint8_t)(TlmPduCount >> 24); // PDU Count [0] - data[index++] = (uint8_t)(TlmPduCount >> 16); // PDU Count [1] - data[index++] = (uint8_t)(TlmPduCount >> 8); // PDU Count [2] - data[index++] = (uint8_t)(TlmPduCount >> 0); // PDU Count [3] - data[index++] = (uint8_t)(TlmTimeSinceBoot >> 24); // Time Since Boot [0] - data[index++] = (uint8_t)(TlmTimeSinceBoot >> 16); // Time Since Boot [1] - data[index++] = (uint8_t)(TlmTimeSinceBoot >> 8); // Time Since Boot [2] - data[index++] = (uint8_t)(TlmTimeSinceBoot >> 0); // Time Since Boot [3] - + * Construct TLM frame from private variables + * @param[in/out] Data pointer to array to store constructed frame in + * @param[in] maxSize number of bytes left in array, effectively how much emtpy space is available to write to + * @return number of bytes used. negative number indicates error message. + */ + int constructTLMFrame(uint8_t * Data, uint8_t maxSize) { + int index = 0; + Data[index++] = FRAME_TYPE_TLM; // Eddystone frame type = Telemetry + Data[index++] = TlmVersion; // TLM Version Number + Data[index++] = (uint8_t)(TlmBatteryVoltage>>8); // Battery Voltage[0] + Data[index++] = (uint8_t)(TlmBatteryVoltage>>0); // Battery Voltage[1] + Data[index++] = (uint8_t)(TlmBeaconTemp>>8); // Beacon Temp[0] + Data[index++] = (uint8_t)(TlmBeaconTemp>>0); // Beacon Temp[1] + Data[index++] = (uint8_t)(TlmPduCount>>24); // PDU Count [0] + Data[index++] = (uint8_t)(TlmPduCount>>16); // PDU Count [1] + Data[index++] = (uint8_t)(TlmPduCount>>8); // PDU Count [2] + Data[index++] = (uint8_t)(TlmPduCount>>0); // PDU Count [3] + Data[index++] = (uint8_t)(TlmTimeSinceBoot>>24); // Time Since Boot [0] + Data[index++] = (uint8_t)(TlmTimeSinceBoot>>16); // Time Since Boot [1] + Data[index++] = (uint8_t)(TlmTimeSinceBoot>>8); // Time Since Boot [2] + Data[index++] = (uint8_t)(TlmTimeSinceBoot>>0); // Time Since Boot [3] + DBG("constructURLFrame: %d, %d",maxSize,index); return index; } /* - * State machine for switching out frames. - * This function is called by the radioNotificationCallback when a frame needs to get swapped out. - * This function exists because of time constraints in the radioNotificationCallback, so it is effectively - * broken up into two functions. - */ + * Update the TLM frame battery voltage value + * @param[in] voltagemv Voltage to update the TLM field battery voltage with (in mV) + * @return nothing + */ + void updateTlmBatteryVoltage(uint16_t voltagemv) { + TlmBatteryVoltage = voltagemv; + return; + } + + /* + * Update the TLM frame beacon temperature + * @param[in] temp Temperature of beacon (in 8.8fpn) + * @return nothing + */ + void updateTlmBeaconTemp(uint16_t temp) { + TlmBeaconTemp = temp; + return; + } + + /* + * Update the TLM frame PDU Count field + * @param[in] pduCount Number of Advertisiting frames sent since powerup + * @return nothing + */ + void updateTlmPduCount(uint32_t pduCount) { + TlmPduCount = pduCount; + return; + } + + /* + * Update the TLM frame Time since boot in 0.1s incriments + * @param[in] timeSinceBoot Time since boot in 0.1s incriments + * @return nothing + */ + void updateTlmTimeSinceBoot(uint32_t timeSinceBoot) { + TlmTimeSinceBoot = timeSinceBoot; + return; + } + + /* + * callback function, called every 0.1s, incriments the TimeSinceBoot field in the TLM frame + * @return nothing + */ + void tsbCallback(void) { + TlmTimeSinceBoot++; + } + + /* + * Update advertising data + * @return true on success, false on failure + */ + bool updateAdvPacket(uint8_t serviceData[], unsigned serviceDataLen) { + // Fields from the Service + DBG("Updating AdvFrame: %d", serviceDataLen); +// printf("\r\n"); +// for(int x = 0; x