Bluetooth Low Energy
High level Bluetooth Low Energy API and radio abstraction layer
Dependents: BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more
Overview
The BLE_API is a high level abstraction for using Bluetooth Low Energy on multiple platforms. For details and examples using the BLE_API please see the BLE_API Summary Page. Or click on the API Documentation tab above.
Supported Services
Supported services can be found in the BLE_API/services folder.
Revision 917:e8b69bf06f24, committed 2015-11-26
- Comitter:
- rgrover1
- Date:
- Thu Nov 26 12:52:04 2015 +0000
- Parent:
- 916:c5e3bf7d038f
- Child:
- 918:2b12b53101ea
- Commit message:
- Synchronized with git rev b76d50ad
Author: Andres Amaya Garcia
Remove Eddystone implementation in ble/services
The files EddystoneService.h and EddystoneConfigService.h have been removed
from ble/services since the implementation is not part of the API. Furthermore
a new implementation to replace this one has been developed and is available
in ble-examples repo.
Changed in this revision
| ble/services/EddystoneConfigService.h | Show diff for this revision Revisions of this file |
| ble/services/EddystoneService.h | Show diff for this revision Revisions of this file |
--- a/ble/services/EddystoneConfigService.h Thu Nov 26 12:52:03 2015 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,540 +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_EDDYSTONE_BEACON_CONFIG_SERVICE_H_
-#define SERVICES_EDDYSTONE_BEACON_CONFIG_SERVICE_H_
-
-#include "mbed.h"
-#include "ble/BLE.h"
-#include "ble/services/EddystoneService.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);
-extern const uint8_t BEACON_EDDYSTONE[2];
-
-/**
-* @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
- */
- enum {
- TX_POWER_MODE_LOWEST,
- TX_POWER_MODE_LOW,
- TX_POWER_MODE_MEDIUM,
- TX_POWER_MODE_HIGH,
- NUM_POWER_MODES
- };
-
- static const unsigned ADVERTISING_INTERVAL_MSEC = 1000; // Advertising interval for config service.
- static const unsigned 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
- static const unsigned URI_DATA_MAX = 18;
- typedef uint8_t UriData_t[URI_DATA_MAX];
-
- // UID Frame Type subfields
- static const size_t UID_NAMESPACEID_SIZE = 10;
- typedef uint8_t UIDNamespaceID_t[UID_NAMESPACEID_SIZE];
- static const size_t 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 {
- // Config Data
- bool isConfigured; // Flag for configuration being complete,
- // True = configured, false = not configured. Reset at instantiation, used for external callbacks.
- uint8_t lockedState;
- Lock_t lock;
- uint8_t flags;
- PowerLevels_t advPowerLevels; // Current value of AdvertisedPowerLevels
- uint8_t txPowerMode; // Firmware power levels used with setTxPower()
- uint16_t beaconPeriod;
- // TLM Frame Data
- uint8_t tlmVersion; // version of TLM packet
- bool tlmEnabled;
- float tlmBeaconPeriod; // how often to broadcat TLM frame, in seconds.
- // URI Frame Data
- uint8_t uriDataLength;
- UriData_t uriData;
- bool uriEnabled;
- float uriBeaconPeriod; // how often to broadcast URIFrame, in seconds.
- // UID Frame Data
- UIDNamespaceID_t uidNamespaceID; // UUID type, Namespace ID, 10B
- UIDInstanceID_t uidInstanceID; // UUID type, Instance ID, 6B
- bool uidEnabled;
- float uidBeaconPeriod; // how often to broadcast UID Frame, in seconds.
- };
-
- /**
- * @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.
- * @param[in] defaultAdvPowerLevelsIn
- * Default power-levels array; applies only if the resetToDefaultsFlag is true.
- */
- EddystoneConfigService(BLEDevice &bleIn,
- Params_t ¶msIn,
- PowerLevels_t &defaultAdvPowerLevelsIn,
- PowerLevels_t &radioPowerLevelsIn) :
- ble(bleIn),
- params(paramsIn), // Initialize URL Data
- defaultAdvPowerLevels(defaultAdvPowerLevelsIn),
- radioPowerLevels(radioPowerLevelsIn),
- initSucceeded(false),
- resetFlag(),
- defaultUidNamespaceID(), // Initialize UID Data
- defaultUidInstanceID(),
- defaultUidPower(defaultAdvPowerLevelsIn[params.txPowerMode]),
- uidIsSet(false),
- defaultUriDataLength(),
- defaultUriData(),
- defaultUrlPower(defaultAdvPowerLevelsIn[params.txPowerMode]),
- urlIsSet(false),
- tlmIsSet(false),
- lockedStateChar(UUID_LOCK_STATE_CHAR, ¶ms.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) {
- // set eddystone as not configured yet. Used to exit config before timeout if GATT services are written to.
- params.isConfigured = false;
-
- 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);
- }
-
- /**
- * @brief Start EddystoneConfig advertising. This function should be called
- * after the EddystoneConfig constructor and after all the frames have been added.
- *
- * @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.
- */
- void start(bool resetToDefaultsFlag){
- INFO("reset to defaults flag = %d", resetToDefaultsFlag);
- if (!resetToDefaultsFlag && (params.uriDataLength > URI_DATA_MAX)) {
- INFO("Reset to Defaults triggered");
- resetToDefaultsFlag = true;
- }
-
- if (resetToDefaultsFlag) {
- resetToDefaults();
- } else {
- updateCharacteristicValues();
- }
-
- setupEddystoneConfigAdvertisements(); /* Setup advertising for the configService. */
- initSucceeded = true;
- }
-
- /*
- * Check if eddystone initialized successfully
- */
- bool initSuccessfully(void) const {
- return initSucceeded;
- }
-
- /*
- * @brief Function to update the default values for the TLM frame. Only applied if Reset Defaults is applied.
- *
- * @param[in] tlmVersionIn Version of the TLM frame being used
- * @param[in] advPeriodInMin how long between TLM frames being advertised, this is measured in minutes.
- *
- */
- void setDefaultTLMFrameData(uint8_t tlmVersionIn = 0, float advPeriodInSec = 60){
- DBG("Setting Default TLM Data, version = %d, advPeriodInMind= %f", tlmVersionIn, advPeriodInSec);
- defaultTlmVersion = tlmVersionIn;
- TlmBatteryVoltage = 0;
- TlmBeaconTemp = 0x8000;
- TlmPduCount = 0;
- TlmTimeSinceBoot = 0;
- defaultTlmAdvPeriod = advPeriodInSec;
- tlmIsSet = true; // flag to add this to eddystone service when config is done
- }
-
- /*
- * @brief Function to update the default values for the URI frame. Only applied if Reset Defaults is applied.
- *
- * @param[in] uriIn url to advertise
- * @param[in] advPeriod how long to advertise the url for, measured in number of ADV frames.
- *
- */
- void setDefaultURIFrameData(const char *uriIn, float advPeriod = 1){
- DBG("Setting Default URI Data");
- // Set URL Frame
- EddystoneService::encodeURL(uriIn, defaultUriData, defaultUriDataLength); // encode URL to URL Formatting
- if (defaultUriDataLength > URI_DATA_MAX) {
- return;
- }
- INFO("\t URI input = %s : %d", uriIn, defaultUriDataLength);
- INFO("\t default URI = %s : %d ", defaultUriData, defaultUriDataLength );
- defaultUriAdvPeriod = advPeriod;
- urlIsSet = true; // flag to add this to eddystone service when config is done
- }
-
- /*
- * @brief Function to update the default values for the UID frame. Only applied if Reset Defaults is applied.
- *
- * @param[in] namespaceID 10Byte Namespace ID
- * @param[in] instanceID 6Byte Instance ID
- * @param[in] advPeriod how long to advertise the URL for, measured in the number of adv frames.
- *
- */
- void setDefaultUIDFrameData(UIDNamespaceID_t *namespaceID, UIDInstanceID_t *instanceID, float advPeriod = 10){
- //Set UID frame
- DBG("Setting default UID Data");
- memcpy(defaultUidNamespaceID, namespaceID, UID_NAMESPACEID_SIZE);
- memcpy(defaultUidInstanceID, instanceID, UID_INSTANCEID_SIZE);
- defaultUidAdvPeriod = advPeriod;
- uidIsSet = true; // flag to add this to eddystone service when config is done
- }
-
- /* 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(radioPowerLevels[params.txPowerMode]);
- ble.setDeviceName(reinterpret_cast<const uint8_t *>(&DEVICE_NAME));
- ble.setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
- ble.setAdvertisingInterval(ADVERTISING_INTERVAL_MSEC);
- }
-
- /*
- * 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");
- // Save params to storage
- extern void saveURIBeaconConfigParams(const Params_t *paramsP); /* forward declaration; necessary to avoid a circular dependency. */
- saveURIBeaconConfigParams(¶ms);
- INFO("Saved Params to Memory.")
- // Setup Eddystone Service
- static EddystoneService eddyServ(ble, params.beaconPeriod, radioPowerLevels[params.txPowerMode]);
- // Set configured frames (TLM,UID,URI...etc)
- if (params.tlmEnabled) {
- eddyServ.setTLMFrameData(params.tlmVersion, params.tlmBeaconPeriod);
- }
- if (params.uriEnabled) {
- eddyServ.setURLFrameEncodedData(params.advPowerLevels[params.txPowerMode], (const char *) params.uriData, params.uriDataLength, params.uriBeaconPeriod);
- }
- if (params.uidEnabled) {
- eddyServ.setUIDFrameData(params.advPowerLevels[params.txPowerMode],
- (uint8_t *)params.uidNamespaceID,
- (uint8_t *)params.uidInstanceID,
- params.uidBeaconPeriod);
- }
- // Start Advertising the eddystone service.
- eddyServ.start();
- }
-
-private:
- /*
- * 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));
- // Set the state to be locked by the lock code (note: zeros are a valid lock)
- params.lockedState = true;
- INFO("Device Locked");
- } else if (handle == unlockChar.getValueHandle()) {
- // Validated earlier
- params.lockedState = false;
- INFO("Device Unlocked");
- } else if (handle == uriDataChar.getValueHandle()) {
- params.uriDataLength = writeParams->len;
- memset(params.uriData, 0x00, URI_DATA_MAX); // clear URI string
- memcpy(params.uriData, writeParams->data, writeParams->len); // set URI string
- params.uriEnabled = true;
- INFO("URI = %s, URILen = %d", writeParams->data, writeParams->len);
- } else if (handle == flagsChar.getValueHandle()) {
- params.flags = *(writeParams->data);
- INFO("flagsChar = 0x%x", params.flags);
- } else if (handle == advPowerLevelsChar.getValueHandle()) {
- memcpy(params.advPowerLevels, writeParams->data, sizeof(PowerLevels_t));
- INFO("PowerLevelsChar = %4x", params.advPowerLevels);
- } else if (handle == txPowerModeChar.getValueHandle()) {
- params.txPowerMode = *(writeParams->data);
- INFO("TxPowerModeChar = %d", params.txPowerMode);
- } else if (handle == beaconPeriodChar.getValueHandle()) {
- params.beaconPeriod = *((uint16_t *)(writeParams->data));
- INFO("BeaconPeriod = %d", params.beaconPeriod);
-
- /* 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()) {
- INFO("Reset triggered from Config Service, resetting to defaults");
- resetToDefaults();
- }
- updateCharacteristicValues();
- params.isConfigured = true; // some configuration data has been passed, on disconnect switch to advertising mode.
- }
-
- /*
- * Reset the default values.
- */
- void resetToDefaults(void) {
- INFO("Resetting to defaults");
- // General
- params.lockedState = false;
- memset(params.lock, 0, sizeof(Lock_t));
- params.flags = 0x10;
- memcpy(params.advPowerLevels, defaultAdvPowerLevels, sizeof(PowerLevels_t));
- params.txPowerMode = TX_POWER_MODE_LOW;
- params.beaconPeriod = (uint16_t) defaultUriAdvPeriod * 1000;
-
- // TLM Frame
- params.tlmVersion = defaultTlmVersion;
- params.tlmBeaconPeriod = defaultTlmAdvPeriod;
- params.tlmEnabled = tlmIsSet;
-
- // URL Frame
- memcpy(params.uriData, defaultUriData, URI_DATA_MAX);
- params.uriDataLength = defaultUriDataLength;
- params.uriBeaconPeriod = defaultUriAdvPeriod;
- params.uriEnabled = urlIsSet;
-
- // UID Frame
- memcpy(params.uidNamespaceID, defaultUidNamespaceID, UID_NAMESPACEID_SIZE);
- memcpy(params.uidInstanceID, defaultUidInstanceID, UID_INSTANCEID_SIZE);
- params.uidBeaconPeriod = defaultUidAdvPeriod;
- params.uidEnabled = uidIsSet;
-
- 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(), ¶ms.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 (params.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 ((!params.lockedState) && (authParams->len == sizeof(Lock_t))) {
- 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 (params.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 (params.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 (params.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
- PowerLevels_t &defaultAdvPowerLevels; // this goes into the advertising frames (radio power measured at 1m from device)
- PowerLevels_t &radioPowerLevels; // this configures the power levels of the radio
- uint8_t lockedState;
- bool initSucceeded;
- uint8_t resetFlag;
- bool switchFlag;
-
- //UID Default value that is restored on reset
- UIDNamespaceID_t defaultUidNamespaceID;
- UIDInstanceID_t defaultUidInstanceID;
- float defaultUidAdvPeriod;
- int8_t defaultUidPower;
- uint16_t uidRFU;
- bool uidIsSet;
-
- //URI Default value that is restored on reset
- uint8_t defaultUriDataLength;
- UriData_t defaultUriData;
- int8_t defaultUrlPower;
- float defaultUriAdvPeriod;
- bool urlIsSet;
-
- //TLM Default value that is restored on reset
- uint8_t defaultTlmVersion;
- float defaultTlmAdvPeriod;
- volatile uint16_t TlmBatteryVoltage;
- volatile uint16_t TlmBeaconTemp;
- volatile uint32_t TlmPduCount;
- volatile uint32_t TlmTimeSinceBoot;
- bool tlmIsSet;
-
- 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;
-};
-
-#endif // SERVICES_EDDYSTONE_BEACON_CONFIG_SERVICE_H_
\ No newline at end of file
--- a/ble/services/EddystoneService.h Thu Nov 26 12:52:03 2015 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,651 +0,0 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2015 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_EDDYSTONEBEACON_H_
-#define SERVICES_EDDYSTONEBEACON_H_
-
-#include "ble/BLE.h"
-#include "mbed.h"
-#include "CircularBuffer.h"
-static const uint8_t BEACON_EDDYSTONE[] = {0xAA, 0xFE};
-
-//Debug is disabled by default
-#if 0
-#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__);
-#else // if 0
-#define DBG(x, ...) //wait_us(10);
-#define WARN(x, ...) //wait_us(10);
-#define ERR(x, ...)
-#endif // if 0
-
-#if 0
-#define INFO(x, ...) printf("[EddyStone: INFO]"x " \t[%s,%d]\r\n", \
- ## __VA_ARGS__, \
- __FILE__, \
- __LINE__);
-#else // if 0
-#define INFO(x, ...)
-#endif // if 0
-
-/**
-* @class Eddystone
-* @brief Eddystone Configuration Service. Can be used to set URL, adjust power levels, and set flags.
-* See https://github.com/google/eddystone
-*
-*/
-class EddystoneService
-{
-public:
- enum FrameTypes {
- NONE,
- url,
- uid,
- tlm
- };
-
- 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);
- static const int URI_DATA_MAX = 18;
- typedef uint8_t UriData_t[URI_DATA_MAX];
- CircularBuffer<FrameTypes, EDDYSTONE_MAX_FRAMETYPE> overflow;
-
- // 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
-
- /**
- * 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[in] namespaceID 10B namespace ID
- * @param[in] instanceID 6B instance ID
- * @param[in] 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,
- float uidAdvPeriodIn,
- uint16_t RFU = 0x0000) {
- if (0.0f == uidAdvPeriodIn) {
- uidIsSet = false;
- return;
- }
- 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 doesn't really matter yet.
- uidAdvPeriod = uidAdvPeriodIn;
- uidIsSet = true; // set toggle to advertise UID frames
- }
-
- /*
- * 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.
- */
- unsigned constructUIDFrame(uint8_t *Data, uint8_t maxSize) {
- unsigned 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
-
- DBG("UID NamespaceID = '0x");
- for (size_t x = 0; x < UID_NAMESPACEID_SIZE; x++) { // 10B Namespace ID
- Data[index++] = defaultUidNamespaceID[x];
- DBG("%x,", defaultUidNamespaceID[x]);
- }
- DBG("'\r\n");
-
- DBG("UID InstanceID = '0x");
- for (size_t x = 0; x< UID_INSTANCEID_SIZE; x++) { // 6B Instance ID
- Data[index++] = defaultUidInstanceID[x];
- DBG("%x,", defaultUidInstanceID[x]);
- }
- DBG("'\r\n");
-
- 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[in] url URL to encode
- * @param[in] urlAdvPeriodIn How long to advertise the URL frame (measured in # of adv periods)
- * @return false on success, true on failure.
- */
- bool setURLFrameData(int8_t power, const char *urlIn, float urlAdvPeriodIn) {
- if (0.0f == urlAdvPeriodIn) {
- urlIsSet = false;
- return false;
- }
- encodeURL(urlIn, defaultUriData, defaultUriDataLength); // encode URL to URL Formatting
- if (defaultUriDataLength > URI_DATA_MAX) {
- return true; // error, URL is too big
- }
- defaultUrlPower = power;
- urlAdvPeriod = urlAdvPeriodIn;
- urlIsSet = true;
- return false;
- }
-
- /**
- * Set Eddystone URL Frame information.
- * @param[in] power TX Power in dB measured at 0 meters from the device.
- * @param[in] encodedUrlIn Encoded URL
- * @param[in] encodedUrlInLength Length of the encoded URL
- * @param[in] urlAdvPeriodIn How long to advertise the URL frame (measured in # of adv periods)
- * @return false on success, true on failure.
- */
- bool setURLFrameEncodedData(int8_t power, const char *encodedUrlIn, uint8_t encodedUrlInLength, float urlAdvPeriodIn) {
- if (0.0f == urlAdvPeriodIn) {
- urlIsSet = false;
- return false;
- }
- memcpy(defaultUriData, encodedUrlIn, encodedUrlInLength);
- if (defaultUriDataLength > URI_DATA_MAX) {
- return true; // error, URL is too big
- }
- defaultUrlPower = power;
- defaultUriDataLength = encodedUrlInLength;
- urlAdvPeriod = urlAdvPeriodIn;
- urlIsSet = true;
- 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[in] advPeriod how often to advertise the TLM frame for (in minutes)
- * @param batteryVoltage in milivolts
- * @param beaconTemp in 8.8 floating point notation
- *
- */
- void setTLMFrameData(uint8_t version = 0,
- float advPeriod = 60.0f,
- uint16_t batteryVoltage = 0,
- uint16_t beaconTemp = 0x8000,
- uint32_t pduCount = 0,
- uint32_t timeSinceBoot = 0) {
- if (0.0f == advPeriod) {
- tlmIsSet = false;
- return;
- }
- TlmVersion = version;
- TlmBatteryVoltage = batteryVoltage;
- TlmBeaconTemp = beaconTemp;
- TlmPduCount = pduCount; // reset
- TlmTimeSinceBoot = timeSinceBoot; // reset
- TlmAdvPeriod = advPeriod;
- tlmIsSet = true; // TLM Data has been enabled
- }
-
- /*
- * 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) {
- uint32_t now = timeSinceBootTimer.read_ms();
- TlmTimeSinceBoot += (now - lastBootTimerRead) / 100;
- lastBootTimerRead = now;
-
- 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;
- }
-
- /*
- * 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 Advertisiting frames sent since powerup
- * @return nothing
- */
- void updateTlmPduCount(uint32_t pduCount) {
- TlmPduCount = pduCount;
- }
-
- /*
- * 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;
- }
-
- /*
- * 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);
-
- ble.clearAdvertisingPayload();
- ble.setAdvertisingType(GapAdvertisingParams::ADV_NON_CONNECTABLE_UNDIRECTED);
- ble.setAdvertisingInterval(100);
- 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(FrameTypes frameType) {
- 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 (frameType) {
- case tlm:
- // TLM frame
- if (tlmIsSet) {
- DBG("Swapping in TLM Frame: version=%x, Batt=%d, Temp = %d, PDUCnt = %d, TimeSinceBoot=%d",
- TlmVersion,
- TlmBatteryVoltage,
- TlmBeaconTemp,
- TlmPduCount,
- TlmTimeSinceBoot);
- serviceDataLen += constructTLMFrame(serviceData + serviceDataLen, 20);
- DBG("\t Swapping in TLM Frame: len=%d", serviceDataLen);
- updateAdvPacket(serviceData, serviceDataLen);
- }
- break;
- case url:
- // URL Frame
- if (urlIsSet) {
- DBG("Swapping in URL Frame: Power: %d", defaultUrlPower);
- serviceDataLen += constructURLFrame(serviceData + serviceDataLen, 20);
- DBG("\t Swapping in URL Frame: len=%d ", serviceDataLen);
- updateAdvPacket(serviceData, serviceDataLen);
- //switchFlag = false;
- }
- break;
- case uid:
- // UID Frame
- if (uidIsSet) {
- DBG("Swapping in UID Frame: Power: %d", defaultUidPower);
- serviceDataLen += constructUIDFrame(serviceData + serviceDataLen, 20);
- DBG("\t Swapping in UID Frame: len=%d", serviceDataLen);
- updateAdvPacket(serviceData, serviceDataLen);
- //switchFlag = false;
- }
- break;
- default:
- ERR("You have not initialized a Frame yet, please initialize one before starting a beacon");
- ERR("uidIsSet = %d, urlIsSet = %d, tlmIsSet = %d", uidIsSet, urlIsSet, tlmIsSet);
- }
- }
-
- /*
- * Callback to swap in URL frame
- */
- void urlCallback(void) {
- DBG("urlCallback");
- if (false == advLock) {
- advLock = true;
- DBG("advLock = url")
- frameIndex = url;
- swapOutFrames(frameIndex);
- ble.startAdvertising();
- } else {
- // Someone else is broadcasting, toss it into the overflow buffer to retransmit when free
- INFO("URI(%d) cannot complete, %d is currently broadcasting", url, frameIndex);
- FrameTypes x = url;
- overflow.push(x);
- }
- }
-
- /*
- * Callback to swap in UID frame
- */
- void uidCallback(void) {
- DBG("uidCallback");
- if (false == advLock) {
- advLock = true;
- DBG("advLock = uid")
- frameIndex = uid;
- swapOutFrames(frameIndex);
- ble.startAdvertising();
- } else {
- // Someone else is broadcasting, toss it into the overflow buffer to retransmit when free
- INFO("UID(%d) cannot complete, %d is currently broadcasting", uid, frameIndex);
- FrameTypes x = uid; // have to do this to satisfy cont vs volatile keywords... sigh...
- overflow.push(x);
- }
- }
-
- /*
- * Callback to swap in TLM frame
- */
- void tlmCallback(void) {
- DBG("tlmCallback");
- if (false == advLock) {
- // OK to broadcast
- advLock = true;
- DBG("advLock = tlm")
- frameIndex = tlm;
- swapOutFrames(frameIndex);
- ble.startAdvertising();
- } else {
- // Someone else is broadcasting, toss it into the overflow buffer to retransmit when free
- INFO("TLM(%d) cannot complete, %d is currently broadcasting", tlm, frameIndex);
- FrameTypes x = tlm;
- overflow.push(x);
- }
- }
-
- void stopAdvCallback(void) {
- if (overflow.empty()) {
- // if nothing left to transmit, stop
- ble.stopAdvertising();
- advLock = false; // unlock lock
- } else {
- // transmit other packets at current time index
- FrameTypes x = NONE;
- overflow.pop(x);
- INFO("Re-Transmitting %d", x);
- swapOutFrames(x);
- }
- }
-
- /*
- * Callback from onRadioNotification(), used to update the PDUCounter and process next state.
- */
-#define EDDYSTONE_SWAPFRAME_DELAYMS 1
- void radioNotificationCallback(bool radioActive) {
- // Update PDUCount
- TlmPduCount++;
- // True just before an frame is sent, false just after a frame is sent
- if (radioActive) {
- // Do Nothing
- } else {
- // Packet has been sent, disable advertising
- stopAdv.attach_us(this, &EddystoneService::stopAdvCallback, 1);
- }
- }
-
- /*
- * 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
- * @param beaconPeriodus is how often ble broadcasts are mde, in mili seconds
- * @param txPowerLevel sets the broadcasting power level.
- *
- */
- EddystoneService(BLEDevice &bleIn,
- uint16_t beaconPeriodus = 100,
- uint8_t txPowerIn = 0) :
- ble(bleIn),
- advPeriodus(beaconPeriodus),
- txPower(txPowerIn),
- advLock(false),
- frameIndex(NONE) {
- }
-
- /*
- * @breif this function starts eddystone advertising based on configured frames.
- */
- void start(void) {
- // Initialize Frame transition, start with URL to pass eddystone validator app on first try
- if (urlIsSet) {
- frameIndex = url;
- urlTicker.attach(this, &EddystoneService::urlCallback, (float) advPeriodus / 1000.0f);
- DBG("attached urlCallback every %d seconds", urlAdvPeriod);
- }
- if (uidIsSet) {
- frameIndex = uid;
- uidTicker.attach(this, &EddystoneService::uidCallback, uidAdvPeriod);
- DBG("attached uidCallback every %d seconds", uidAdvPeriod);
- }
- if (tlmIsSet) {
- frameIndex = tlm;
- // Make double sure the PDUCount and TimeSinceBoot fields are set to zero at reset
- updateTlmPduCount(0);
- updateTlmTimeSinceBoot(0);
- lastBootTimerRead = 0;
- timeSinceBootTimer.start();
- tlmTicker.attach(this, &EddystoneService::tlmCallback, TlmAdvPeriod);
- DBG("attached tlmCallback every %d seconds", TlmAdvPeriod);
- }
- if (NONE == frameIndex) {
- error("No Frames were Initialized! Please initialize a frame before starting an eddystone beacon.");
- }
- //uidRFU = 0;
-
- ble.setTxPower(txPower);
- ble.gap().onRadioNotification(this, &EddystoneService::radioNotificationCallback);
- }
-
-private:
-
- // Eddystone Variables
- BLEDevice &ble;
- uint16_t advPeriodus;
- uint8_t txPower;
- Timer timeSinceBootTimer;
- volatile uint32_t lastBootTimerRead;
- volatile bool advLock;
- volatile FrameTypes frameIndex;
- Timeout stopAdv;
-
-
- // URI Frame Variables
- uint8_t defaultUriDataLength;
- UriData_t defaultUriData;
- int8_t defaultUrlPower;
- bool urlIsSet; // flag that enables / disable URI Frames
- float urlAdvPeriod; // how long the url frame will be advertised for
- Ticker urlTicker;
-
- // UID Frame Variables
- UIDNamespaceID_t defaultUidNamespaceID;
- UIDInstanceID_t defaultUidInstanceID;
- int8_t defaultUidPower;
- uint16_t uidRFU;
- bool uidIsSet; // flag that enables / disable UID Frames
- float uidAdvPeriod; // how long the uid frame will be advertised for
- Ticker uidTicker;
-
- // TLM Frame Variables
- uint8_t TlmVersion;
- volatile uint16_t TlmBatteryVoltage;
- volatile uint16_t TlmBeaconTemp;
- volatile uint32_t TlmPduCount;
- volatile uint32_t TlmTimeSinceBoot;
- bool tlmIsSet; // flag that enables / disables TLM frames
- float TlmAdvPeriod; // number of minutes between adv frames
- Ticker tlmTicker;
-
-public:
- /*
- * Encode a human-readable URI into the binary format defined by URIBeacon spec (https://github.com/google/uribeacon/tree/master/specification).
- */
- static void encodeURL(const char *uriDataIn, UriData_t uriDataOut, uint8_t &sizeofURIDataOut) {
- DBG("Encode URL = %s", uriDataIn);
- 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. */
- INFO("Encoding URI: No Suffix Found");
- if (i == NUM_SUFFIXES) {
- uriDataOut[sizeofURIDataOut++] = *uriDataIn;
- ++uriDataIn;
- }
- }
- }
-};
-
-#endif // SERVICES_EDDYSTONEBEACON_H_
\ No newline at end of file