Scott Jenson
Button initiated config service
Dependencies: BLE_API_EddystoneConfigService_2 mbed nRF51822
Fork of
BLE_EddystoneBeaconConfigService_3
by 
URIBeacon
Diff: EddystoneConfigService.h
- Revision:
- 26:2896fbdd0450
- Parent:
- 25:e20bed9e466f
- Child:
- 27:29c6d1bb462e
--- a/EddystoneConfigService.h Fri Jul 24 02:06:57 2015 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,890 +0,0 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef SERVICES_ZIPBEACONCONFIGSERVICE_H_
-#define SERVICES_ZIPBEACONCONFIGSERVICE_H_
-
-#include "mbed.h"
-#include "ble/BLE.h"
-
-
-#define UUID_URI_BEACON(FIRST, SECOND) { \
- 0xee, 0x0c, FIRST, SECOND, 0x87, 0x86, 0x40, 0xba, \
- 0xab, 0x96, 0x99, 0xb9, 0x1a, 0xc9, 0x81, 0xd8, \
-}
-
-static const uint8_t UUID_URI_BEACON_SERVICE[] = UUID_URI_BEACON(0x20, 0x80);
-static const uint8_t UUID_LOCK_STATE_CHAR[] = UUID_URI_BEACON(0x20, 0x81);
-static const uint8_t UUID_LOCK_CHAR[] = UUID_URI_BEACON(0x20, 0x82);
-static const uint8_t UUID_UNLOCK_CHAR[] = UUID_URI_BEACON(0x20, 0x83);
-static const uint8_t UUID_URI_DATA_CHAR[] = UUID_URI_BEACON(0x20, 0x84);
-static const uint8_t UUID_FLAGS_CHAR[] = UUID_URI_BEACON(0x20, 0x85);
-static const uint8_t UUID_ADV_POWER_LEVELS_CHAR[] = UUID_URI_BEACON(0x20, 0x86);
-static const uint8_t UUID_TX_POWER_MODE_CHAR[] = UUID_URI_BEACON(0x20, 0x87);
-static const uint8_t UUID_BEACON_PERIOD_CHAR[] = UUID_URI_BEACON(0x20, 0x88);
-static const uint8_t UUID_RESET_CHAR[] = UUID_URI_BEACON(0x20, 0x89);
-static const uint8_t BEACON_EDDYSTONE[] = {0xAA, 0xFE};
-
-//Debug is disabled by default
-#if 0
-#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 DBG(x, ...) //wait_us(10);
-#define WARN(x, ...) //wait_us(10);
-#define ERR(x, ...)
-#endif
-
-/**
-* @class EddystoneConfigService
-* @brief Eddystone Configuration Service. Can be used to set URL, adjust power levels, and set flags.
-* See https://github.com/google/eddystone
-*
-*/
-class EddystoneConfigService
-{
-public:
- /**
- * @brief Transmission Power Modes for UriBeacon
- */
- static const uint8_t TX_POWER_MODE_LOWEST = 0; /*!< Lowest TX power mode */
- static const uint8_t TX_POWER_MODE_LOW = 1; /*!< Low TX power mode */
- static const uint8_t TX_POWER_MODE_MEDIUM = 2; /*!< Medium TX power mode */
- static const uint8_t TX_POWER_MODE_HIGH = 3; /*!< High TX power mode */
- static const unsigned int NUM_POWER_MODES = 4; /*!< Number of Power Modes defined */
-
- 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
-
- typedef uint8_t Lock_t[16]; /* 128 bits */
- typedef int8_t PowerLevels_t[NUM_POWER_MODES];
-
- // 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 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
- 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_TLM = 14; // TLM frame is a constant 14Bytes
- static const uint8_t FRAME_SIZE_UID = 20; // includes RFU bytes
-
- struct Params_t {
- Lock_t lock;
- uint8_t uriDataLength;
- UriData_t uriData;
- uint8_t flags;
- PowerLevels_t advPowerLevels; // Current value of AdvertisedPowerLevels
- uint8_t txPowerMode; // Firmware power levels used with setTxPower()
- uint16_t beaconPeriod;
- uint8_t tlmVersion; // version of TLM packet
- UIDNamespaceID_t uidNamespaceID; // UUID type, Namespace ID, 10B
- UIDInstanceID_t uidInstanceID; // UUID type, Instance ID, 6B
- int(*tlmGetBatt(void)); // Function Pointers for user provided functions that return the Temp and Battery Voltage data for the TLM field.
- int(*tlmGetTemp(void)); // ^^
-
- };
-
- /**
- * @param[ref] ble
- * BLEDevice object for the underlying controller.
- * @param[in/out] paramsIn
- * Reference to application-visible beacon state, loaded
- * from persistent storage at startup.
- * @paramsP[in] resetToDefaultsFlag
- * Applies to the state of the 'paramsIn' parameter.
- * If true, it indicates that paramsIn is potentially
- * un-initialized, and default values should be used
- * instead. Otherwise, paramsIn overrides the defaults.
- * @param[in] defaultUriDataIn
- * Default un-encoded URI; applies only if the resetToDefaultsFlag is true.
- * @param[in] defaultAdvPowerLevelsIn
- * Default power-levels array; applies only if the resetToDefaultsFlag is true.
- */
- EddystoneConfigService(BLEDevice &bleIn,
- Params_t ¶msIn,
- bool resetToDefaultsFlag,
- const char *defaultURIDataIn,
- PowerLevels_t &defaultAdvPowerLevelsIn) :
- ble(bleIn),
- params(paramsIn),
- defaultUriDataLength(),
- defaultUriData(),
- defaultAdvPowerLevels(defaultAdvPowerLevelsIn),
- initSucceeded(false),
- resetFlag(),
- lockedStateChar(UUID_LOCK_STATE_CHAR, &lockedState),
- lockChar(UUID_LOCK_CHAR, ¶ms.lock),
- uriDataChar(UUID_URI_DATA_CHAR, params.uriData, 0, URI_DATA_MAX,
- GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
- unlockChar(UUID_UNLOCK_CHAR, ¶ms.lock),
- flagsChar(UUID_FLAGS_CHAR, ¶ms.flags),
- advPowerLevelsChar(UUID_ADV_POWER_LEVELS_CHAR, ¶ms.advPowerLevels),
- txPowerModeChar(UUID_TX_POWER_MODE_CHAR, ¶ms.txPowerMode),
- beaconPeriodChar(UUID_BEACON_PERIOD_CHAR, ¶ms.beaconPeriod),
- resetChar(UUID_RESET_CHAR, &resetFlag) {
-
- encodeURI(defaultURIDataIn, defaultUriData, defaultUriDataLength); // encode URL to URL Formatting
- if (defaultUriDataLength > URI_DATA_MAX) {
- return;
- }
-
- if (!resetToDefaultsFlag && (params.uriDataLength > URI_DATA_MAX)) {
- resetToDefaultsFlag = true;
- }
- if (resetToDefaultsFlag) {
- resetToDefaults();
- } else {
- updateCharacteristicValues();
- }
-
- lockedState = isLocked();
-
- lockChar.setWriteAuthorizationCallback(this, &EddystoneConfigService::lockAuthorizationCallback);
- unlockChar.setWriteAuthorizationCallback(this, &EddystoneConfigService::unlockAuthorizationCallback);
- uriDataChar.setWriteAuthorizationCallback(this, &EddystoneConfigService::uriDataWriteAuthorizationCallback);
- flagsChar.setWriteAuthorizationCallback(this, &EddystoneConfigService::basicAuthorizationCallback<uint8_t>);
- advPowerLevelsChar.setWriteAuthorizationCallback(this, &EddystoneConfigService::basicAuthorizationCallback<PowerLevels_t>);
- txPowerModeChar.setWriteAuthorizationCallback(this, &EddystoneConfigService::powerModeAuthorizationCallback);
- beaconPeriodChar.setWriteAuthorizationCallback(this, &EddystoneConfigService::basicAuthorizationCallback<uint16_t>);
- resetChar.setWriteAuthorizationCallback(this, &EddystoneConfigService::basicAuthorizationCallback<uint8_t>);
-
- static GattCharacteristic *charTable[] = {
- &lockedStateChar, &lockChar, &unlockChar, &uriDataChar,
- &flagsChar, &advPowerLevelsChar, &txPowerModeChar, &beaconPeriodChar, &resetChar
- };
-
- GattService configService(UUID_URI_BEACON_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
-
- ble.addService(configService);
- ble.onDataWritten(this, &EddystoneConfigService::onDataWrittenCallback);
-
- setupEddystoneConfigAdvertisements(); /* Setup advertising for the configService. */
-
- initSucceeded = true;
- }
-
- bool configuredSuccessfully(void) const {
- return initSucceeded;
- }
-
- /* Start out by advertising the configService for a limited time after
- * startup; and switch to the normal non-connectible beacon functionality
- * afterwards. */
- void setupEddystoneConfigAdvertisements() {
- const char DEVICE_NAME[] = "eddystone Config";
-
- ble.clearAdvertisingPayload();
-
- ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
-
- // UUID is in different order in the ADV frame (!)
- uint8_t reversedServiceUUID[sizeof(UUID_URI_BEACON_SERVICE)];
- for (unsigned int i = 0; i < sizeof(UUID_URI_BEACON_SERVICE); i++) {
- reversedServiceUUID[i] = UUID_URI_BEACON_SERVICE[sizeof(UUID_URI_BEACON_SERVICE) - i - 1];
- }
- ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_128BIT_SERVICE_IDS, reversedServiceUUID, sizeof(reversedServiceUUID));
- ble.accumulateAdvertisingPayload(GapAdvertisingData::GENERIC_TAG);
- ble.accumulateScanResponse(GapAdvertisingData::COMPLETE_LOCAL_NAME, reinterpret_cast<const uint8_t *>(&DEVICE_NAME), sizeof(DEVICE_NAME));
- ble.accumulateScanResponse(
- GapAdvertisingData::TX_POWER_LEVEL,
- reinterpret_cast<uint8_t *>(&defaultAdvPowerLevels[EddystoneConfigService::TX_POWER_MODE_LOW]),
- sizeof(uint8_t));
-
- ble.setTxPower(params.advPowerLevels[params.txPowerMode]);
- ble.setDeviceName(reinterpret_cast<const uint8_t *>(&DEVICE_NAME));
- ble.setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
- ble.setAdvertisingInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(ADVERTISING_INTERVAL_MSEC));
- }
-
- /*
- * 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) {
- 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 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 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) {
-
- int index = 0;
- Data[index++] = FRAME_TYPE_UID; // 1B Type
- if(defaultUidPower > 20) {
- defaultUidPower = 20; // enforce range of vaild values.
- }
- if(defaultUidPower < -100) {
- defaultUidPower = -100;
- }
- Data[index++] = defaultUidPower; // 1B Power @ 0meter
- for(int x = 0; x < UID_NAMESPACEID_SIZE; x++) { // 10B Namespce ID
- Data[index++] = defaultUidNamespaceID[x];
- }
- for(int x = 0; x< UID_INSTANCEID_SIZE; x++) { // 6B Instance ID
- Data[index++] = defaultUidInstanceID[x];
- }
- 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;
- }
-
- /*
- * 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;
- encodeURI(url, defaultUriData, defaultUriDataLength); // encode URL to URL Formatting
- if (defaultUriDataLength > URI_DATA_MAX) {
- return true; // error, URL is too big
- }
- 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 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];
- }
- 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 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;
- TlmBatteryVoltage = batteryVoltage;
- 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 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;
- }
-
- /*
- * 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<serviceDataLen; x++) {
-// printf("%2.2x:",serviceData[x]);
-// }
-// printf("\r\n");
- ble.clearAdvertisingPayload();
- ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
- ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, BEACON_EDDYSTONE, sizeof(BEACON_EDDYSTONE));
- ble.accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceData, serviceDataLen);
-
- return true;
- }
-
- /*
- * 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.
- */
- void swapOutFrames(void) {
- uint8_t serviceData[SERVICE_DATA_MAX];
- unsigned serviceDataLen = 0;
- //hard code in the eddystone UUID
- serviceData[serviceDataLen++] = BEACON_EDDYSTONE[0];
- serviceData[serviceDataLen++] = BEACON_EDDYSTONE[1];
-
- // if certain frames are not enabled, then skip them. Worst case TLM is always enabled
- switch(frameIndex) {
- case 1:
- // URL Frame
- if(urlIsSet) {
- serviceDataLen += constructURLFrame(serviceData+serviceDataLen,20);
- DBG("\t Swapping in URL Frame: len=%d ",serviceDataLen);
- updateAdvPacket(serviceData,serviceDataLen);
- switchFlag = false;
- frameIndex++;
- break;
- }
- case 2:
- // UID Frame
- if(uidIsSet) {
- serviceDataLen += constructUIDFrame(serviceData+serviceDataLen,20);
- DBG("\t Swapping in UID Frame: len=%d",serviceDataLen);
- updateAdvPacket(serviceData,serviceDataLen);
- switchFlag = false;
- frameIndex++;
- break;
- }
- default:
- // TLM frame
- serviceDataLen += constructTLMFrame(serviceData+serviceDataLen,20);
- DBG("\t Swapping in TLM Frame: len=%d",serviceDataLen);
- updateAdvPacket(serviceData,serviceDataLen);
- frameIndex++;
- break;
- }
- }
-
- /*
- * Callback from onRadioNotification(), used to update the PDUCounter and process next state.
- */
-#define EDDYSTONE_SWAPFRAME_DELAYMS 1
- void radioNotificationCallback(bool radioActive) {
- //DBG("RadioNotificationCallback : %d, %d, %d, %d",radioActive,frameIndex,TlmPduCount,TlmTimeSinceBoot);
- // Update PDUCount
- TlmPduCount++;
- frameIndex = frameIndex % EDDYSTONE_MAX_FRAMETYPE;
-
-
- // True just before an frame is sent, fale just after a frame is sent
- if(radioActive) {
- // Do Nothing
- } else {
- // state machine to control which packet is being sent
- switch(frameIndex) {
- case 0: // TLM Frame
- switchFrame.attach_us(this, &EddystoneConfigService::swapOutFrames, EDDYSTONE_SWAPFRAME_DELAYMS);
- switchFlag = true;
- break;
- case 1: // URL Frame
- // switch out packets
- if(switchFlag) {
- switchFrame.attach_us(this, &EddystoneConfigService::swapOutFrames, EDDYSTONE_SWAPFRAME_DELAYMS);
- switchFlag = false;
- } else {
- if((TlmPduCount % 10) == 0) { // every 10 adv packets switch the frame
- switchFlag = true;
- }
- }
- break;
- case 2: // UIDFrame
- // switch out packets
- if(switchFlag ) {
- switchFrame.attach_us(this, &EddystoneConfigService::swapOutFrames, EDDYSTONE_SWAPFRAME_DELAYMS);
- switchFlag = false;
- } else {
- if((TlmPduCount % 10) == 0) { // every 10 adv packets switch the frame
- switchFlag = true;
- }
- }
- break;
- }
- }
-
- return;
- }
-
- /*
- * This function explicityly sets the parameters used by the Eddystone beacon.
- * this function should be used in leu of the config service.
- *
- * @param bleIn ble object used to broadcast eddystone information
- * @oaram beaconPeriodus is how often ble broadcasts are mde, in mili seconds
- * @param txPowerLevel sets the broadcasting power level.
- * @param uidNamespaceID 10Byte Namespace UUID
- * @param uidInstanceID 6Byte Instance UUID
- * @param url shortened URL to broadcast (pass in as a string)
- * @param urlLen length of shortened url
- * @param tlmVersion version of telemetry data field to use (default to 0x00)
- *
- */
- void setupEddystoneAdvertisements( BLEDevice &bleIn,
- uint16_t beaconPeriodus,
- uint8_t txPowerLevel,
- uint8_t * uidNamespaceID = NULL,
- uint8_t * uidInstanceID = NULL,
- const char * url = NULL,
- uint8_t urlLen = 0,
- uint8_t tlmVersion = 0x00) :
- ble(bleIn)
- {
- uint8_t serviceData[SERVICE_DATA_MAX];
- unsigned serviceDataLen = 0;
- ERR("This function is not fully implemented yet, dont use it!!");
- // Check optional frames, set their 'isSet' flags appropriately
- if((uidNamespaceID != NULL) & (uidInstanceID != NULL)) {
- uidIsSet = true;
- setUIDFrameData(txPowerLevel,uidNamespaceID, uidInstanceID);
- } else {
- uidIsSet = false;
- }
- if(url != NULL) {
- urlIsSet = true;
- setURLFrameData(txPowerLevel,url);
- } else {
- uidIsSet = false;
- }
- // Default TLM frame to version 0x00, start all values at zero to be spec compliant.
- setTLMFrameData(tlmVersion, 0x00,0x00);
-
- // Initialize Frame transition
- frameIndex = 0;
- uidRFU = 0;
- switchFlag = true;
-
- /* Reinitialize the BLE stack. This will clear away the existing services and advertising state. */
- ble.shutdown();
- ble.init();
- ble.setTxPower(txPowerLevel);
- ble.setAdvertisingType(GapAdvertisingParams::ADV_NON_CONNECTABLE_UNDIRECTED);
- ble.setAdvertisingInterval(beaconPeriodus);
-
- // Make double sure the PDUCount and TimeSinceBoot fields are set to zero at reset
- updateTlmPduCount(0);
- updateTlmTimeSinceBoot(0);
-
- // Construct TLM Frame in initial advertising.
- serviceData[serviceDataLen++] = BEACON_EDDYSTONE[0];
- serviceData[serviceDataLen++] = BEACON_EDDYSTONE[1];
- serviceDataLen += constructTLMFrame(serviceData+serviceDataLen,SERVICE_DATA_MAX);
-
- updateAdvPacket(serviceData, serviceDataLen);
- ble.gap().startAdvertising();
- ble.gap().onRadioNotification(this,&EddystoneConfigService::radioNotificationCallback);
- timeSinceBootTick.attach(this,&EddystoneConfigService::tsbCallback,0.1); // incriment the TimeSinceBoot ticker every 0.1s
-
- }
-
- /*
- * This function actually impliments the Eddystone Beacon service. It can be called with the help of the wrapper function
- * to load saved config params, or it can be called explicitly to reset the eddystone beacon to hardcoded values on each reset.
- *
- */
- void setupEddystoneAdvertisements() {
- DBG("Switching Config -> adv");
- uint8_t serviceData[SERVICE_DATA_MAX];
- unsigned serviceDataLen = 0;
- unsigned beaconPeriod = params.beaconPeriod;
-
- // Initialize Frame transition
- frameIndex = 0;
- uidRFU = 0;
- switchFlag = true;
-
-
- /* Reinitialize the BLE stack. This will clear away the existing services and advertising state. */
- ble.shutdown();
- ble.init();
- ble.setTxPower(params.advPowerLevels[params.txPowerMode]);
- ble.setAdvertisingType(GapAdvertisingParams::ADV_NON_CONNECTABLE_UNDIRECTED);
- ble.setAdvertisingInterval(beaconPeriod);
- extern void saveURIBeaconConfigParams(const Params_t *paramsP); /* forward declaration; necessary to avoid a circular dependency. */
- saveURIBeaconConfigParams(¶ms);
-
- setTLMFrameData(0x00,0x2222,0x3333,0x01,0x02); // Initialize TLM Data, for testing, remove for release
- updateTlmPduCount(0);
- updateTlmTimeSinceBoot(0);
-
- // Construct TLM Frame in initial advertising.
- serviceData[serviceDataLen++] = BEACON_EDDYSTONE[0];
- serviceData[serviceDataLen++] = BEACON_EDDYSTONE[1];
- serviceDataLen += constructURLFrame(serviceData+serviceDataLen,SERVICE_DATA_MAX);
-
- updateAdvPacket(serviceData, serviceDataLen);
- ble.gap().startAdvertising();
- ble.gap().onRadioNotification(this,&EddystoneConfigService::radioNotificationCallback);
- timeSinceBootTick.attach(this,&EddystoneConfigService::tsbCallback,0.1); // incriment the TimeSinceBoot ticker every 0.1s
- }
-
-private:
-// True if the lock bits are non-zero
- bool isLocked() {
- Lock_t testLock;
- memset(testLock, 0, sizeof(Lock_t));
- return memcmp(params.lock, testLock, sizeof(Lock_t));
- }
-
- /*
- * This callback is invoked when a GATT client attempts to modify any of the
- * characteristics of this service. Attempts to do so are also applied to
- * the internal state of this service object.
- */
- void onDataWrittenCallback(const GattWriteCallbackParams *writeParams) {
- uint16_t handle = writeParams->handle;
-
- if (handle == lockChar.getValueHandle()) {
- // Validated earlier
- memcpy(params.lock, writeParams->data, sizeof(Lock_t));
- // use isLocked() in case bits are being set to all 0's
- lockedState = isLocked();
- } else if (handle == unlockChar.getValueHandle()) {
- // Validated earlier
- memset(params.lock, 0, sizeof(Lock_t));
- lockedState = false;
- } else if (handle == uriDataChar.getValueHandle()) {
- params.uriDataLength = writeParams->len;
- memcpy(params.uriData, writeParams->data, params.uriDataLength);
- } else if (handle == flagsChar.getValueHandle()) {
- params.flags = *(writeParams->data);
- } else if (handle == advPowerLevelsChar.getValueHandle()) {
- memcpy(params.advPowerLevels, writeParams->data, sizeof(PowerLevels_t));
- } else if (handle == txPowerModeChar.getValueHandle()) {
- params.txPowerMode = *(writeParams->data);
- } else if (handle == beaconPeriodChar.getValueHandle()) {
- params.beaconPeriod = *((uint16_t *)(writeParams->data));
-
- /* Re-map beaconPeriod to within permissible bounds if necessary. */
- if (params.beaconPeriod != 0) {
- bool paramsUpdated = false;
- if (params.beaconPeriod < ble.getMinAdvertisingInterval()) {
- params.beaconPeriod = ble.getMinAdvertisingInterval();
- paramsUpdated = true;
- } else if (params.beaconPeriod > ble.getMaxAdvertisingInterval()) {
- params.beaconPeriod = ble.getMaxAdvertisingInterval();
- paramsUpdated = true;
- }
- if (paramsUpdated) {
- ble.updateCharacteristicValue(beaconPeriodChar.getValueHandle(), reinterpret_cast<uint8_t *>(¶ms.beaconPeriod), sizeof(uint16_t));
- }
- }
- } else if (handle == resetChar.getValueHandle()) {
- resetToDefaults();
- }
- }
-
- /*
- * Reset the default values.
- */
- void resetToDefaults(void) {
- lockedState = false;
- memset(params.lock, 0, sizeof(Lock_t));
- memcpy(params.uriData, defaultUriData, URI_DATA_MAX);
- params.uriDataLength = defaultUriDataLength;
- params.flags = 0;
- memcpy(params.advPowerLevels, defaultAdvPowerLevels, sizeof(PowerLevels_t));
- params.txPowerMode = TX_POWER_MODE_LOW;
- params.beaconPeriod = 1000;
- memcpy(params.uidNamespaceID, defaultUidNamespaceID, UID_NAMESPACEID_SIZE);
- memcpy(params.uidInstanceID, defaultUidInstanceID, UID_INSTANCEID_SIZE);
- params.tlmVersion = 0;
- updateCharacteristicValues();
- }
-
- /*
- * Internal helper function used to update the GATT database following any
- * change to the internal state of the service object.
- */
- void updateCharacteristicValues(void) {
- ble.updateCharacteristicValue(lockedStateChar.getValueHandle(), &lockedState, 1);
- ble.updateCharacteristicValue(uriDataChar.getValueHandle(), params.uriData, params.uriDataLength);
- ble.updateCharacteristicValue(flagsChar.getValueHandle(), ¶ms.flags, 1);
- ble.updateCharacteristicValue(beaconPeriodChar.getValueHandle(),
- reinterpret_cast<uint8_t *>(¶ms.beaconPeriod), sizeof(uint16_t));
- ble.updateCharacteristicValue(txPowerModeChar.getValueHandle(), ¶ms.txPowerMode, 1);
- ble.updateCharacteristicValue(advPowerLevelsChar.getValueHandle(),
- reinterpret_cast<uint8_t *>(params.advPowerLevels), sizeof(PowerLevels_t));
- }
-
-private:
- void lockAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
- if (lockedState) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
- } else if (authParams->len != sizeof(Lock_t)) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH;
- } else if (authParams->offset != 0) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
- } else {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
- }
- }
-
-
- void unlockAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
- if (!lockedState) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
- } else if (authParams->len != sizeof(Lock_t)) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH;
- } else if (authParams->offset != 0) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
- } else if (memcmp(authParams->data, params.lock, sizeof(Lock_t)) != 0) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
- } else {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
- }
- }
-
- void uriDataWriteAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
- if (lockedState) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
- } else if (authParams->offset != 0) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
- } else {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
- }
- }
-
- void powerModeAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
- if (lockedState) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
- } else if (authParams->len != sizeof(uint8_t)) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH;
- } else if (authParams->offset != 0) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
- } else if (*((uint8_t *)authParams->data) >= NUM_POWER_MODES) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_WRITE_NOT_PERMITTED;
- } else {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
- }
- }
-
- template <typename T>
- void basicAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
- if (lockedState) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
- } else if (authParams->len != sizeof(T)) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH;
- } else if (authParams->offset != 0) {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
- } else {
- authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
- }
- }
-
- BLEDevice &ble;
- Params_t ¶ms;
- Ticker timeSinceBootTick;
- Timeout switchFrame;
-// Default value that is restored on reset
- size_t defaultUriDataLength;
- UriData_t defaultUriData;
- UIDNamespaceID_t defaultUidNamespaceID;
- UIDInstanceID_t defaultUidInstanceID;
- int8_t defaultUidPower;
- int8_t defaultUrlPower;
- uint16_t uidRFU;
- bool uidIsSet;
- bool urlIsSet;
-// Default value that is restored on reset
- PowerLevels_t &defaultAdvPowerLevels;
- uint8_t lockedState;
- bool initSucceeded;
- uint8_t resetFlag;
- bool switchFlag;
-
-// Private Variables for Telemetry Data
- uint8_t TlmVersion;
- volatile uint16_t TlmBatteryVoltage;
- volatile uint16_t TlmBeaconTemp;
- volatile uint32_t TlmPduCount;
- volatile uint32_t TlmTimeSinceBoot;
-
- ReadOnlyGattCharacteristic<uint8_t> lockedStateChar;
- WriteOnlyGattCharacteristic<Lock_t> lockChar;
- GattCharacteristic uriDataChar;
- WriteOnlyGattCharacteristic<Lock_t> unlockChar;
- ReadWriteGattCharacteristic<uint8_t> flagsChar;
- ReadWriteGattCharacteristic<PowerLevels_t> advPowerLevelsChar;
- ReadWriteGattCharacteristic<uint8_t> txPowerModeChar;
- ReadWriteGattCharacteristic<uint16_t> beaconPeriodChar;
- WriteOnlyGattCharacteristic<uint8_t> resetChar;
-
-public:
- /*
- * Encode a human-readable URI into the binary format defined by URIBeacon spec (https://github.com/google/uribeacon/tree/master/specification).
- */
- static void encodeURI(const char *uriDataIn, UriData_t uriDataOut, size_t &sizeofURIDataOut) {
- const char *prefixes[] = {
- "http://www.",
- "https://www.",
- "http://",
- "https://",
- };
- const size_t NUM_PREFIXES = sizeof(prefixes) / sizeof(char *);
- const char *suffixes[] = {
- ".com/",
- ".org/",
- ".edu/",
- ".net/",
- ".info/",
- ".biz/",
- ".gov/",
- ".com",
- ".org",
- ".edu",
- ".net",
- ".info",
- ".biz",
- ".gov"
- };
- const size_t NUM_SUFFIXES = sizeof(suffixes) / sizeof(char *);
-
- sizeofURIDataOut = 0;
- memset(uriDataOut, 0, sizeof(UriData_t));
-
- if ((uriDataIn == NULL) || (strlen(uriDataIn) == 0)) {
- return;
- }
-
- /*
- * handle prefix
- */
- for (unsigned i = 0; i < NUM_PREFIXES; i++) {
- size_t prefixLen = strlen(prefixes[i]);
- if (strncmp(uriDataIn, prefixes[i], prefixLen) == 0) {
- uriDataOut[sizeofURIDataOut++] = i;
- uriDataIn += prefixLen;
- break;
- }
- }
-
- /*
- * handle suffixes
- */
- while (*uriDataIn && (sizeofURIDataOut < URI_DATA_MAX)) {
- /* check for suffix match */
- unsigned i;
- for (i = 0; i < NUM_SUFFIXES; i++) {
- size_t suffixLen = strlen(suffixes[i]);
- if (strncmp(uriDataIn, suffixes[i], suffixLen) == 0) {
- uriDataOut[sizeofURIDataOut++] = i;
- uriDataIn += suffixLen;
- break; /* from the for loop for checking against suffixes */
- }
- }
- /* This is the default case where we've got an ordinary character which doesn't match a suffix. */
- if (i == NUM_SUFFIXES) {
- uriDataOut[sizeofURIDataOut++] = *uriDataIn;
- ++uriDataIn;
- }
- }
- }
-};
-
-#endif // SERVICES_ZIPBEACONCONFIGSERVICE_H_