Microbug / BLE_API_FOTA

Lightly modified version of the BLE stack, that doesn't bring up a DFUService by default... as we have our own.

Fork of BLE_API by Bluetooth Low Energy

services/URIBeaconConfigService.h@276:daa42f59bdb8, 2015-01-22 (annotated)

Committer:
rgrover1
Date:
Thu Jan 22 09:59:43 2015 +0000
Revision:
276:daa42f59bdb8
Parent:
275:4abc3126f1e1
Child:
277:1407d2f1ce3c
Synchronized with git rev 9dc7849c

Author: Rohit Grover

minor white space diffs.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 171:6092e61690dc 1 /* mbed Microcontroller Library
rgrover1 171:6092e61690dc 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 171:6092e61690dc 3 *
rgrover1 171:6092e61690dc 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 171:6092e61690dc 5 * you may not use this file except in compliance with the License.
rgrover1 171:6092e61690dc 6 * You may obtain a copy of the License at
rgrover1 171:6092e61690dc 7 *
rgrover1 171:6092e61690dc 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 171:6092e61690dc 9 *
rgrover1 171:6092e61690dc 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 171:6092e61690dc 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 171:6092e61690dc 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 171:6092e61690dc 13 * See the License for the specific language governing permissions and
rgrover1 171:6092e61690dc 14 * limitations under the License.
rgrover1 171:6092e61690dc 15 */
rgrover1 171:6092e61690dc 16
rgrover1 207:e88130dc254c 17 #ifndef __BLE_URI_BEACON_CONFIG_SERVICE_H__
rgrover1 207:e88130dc254c 18 #define __BLE_URI_BEACON_CONFIG_SERVICE_H__
rgrover1 171:6092e61690dc 19
rgrover1 171:6092e61690dc 20 #include "BLEDevice.h"
rgrover1 171:6092e61690dc 21
rgrover1 225:f6cbfd817d16 22 #define URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(FIRST, SECOND) { \
rgrover1 225:f6cbfd817d16 23 0xee, 0x0c, FIRST, SECOND, 0x87, 0x86, 0x40, 0xba, \
rgrover1 225:f6cbfd817d16 24 0xab, 0x96, 0x99, 0xb9, 0x1a, 0xc9, 0x81, 0xd8, \
rgrover1 171:6092e61690dc 25 }
rgrover1 225:f6cbfd817d16 26 static const uint8_t URIBeacon2ControlServiceUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x80);
rgrover1 225:f6cbfd817d16 27 static const uint8_t lockedStateCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x81);
rgrover1 268:bc525cdc88f7 28 static const uint8_t lockCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x82);
rgrover1 268:bc525cdc88f7 29 static const uint8_t unlockCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x83);
rgrover1 225:f6cbfd817d16 30 static const uint8_t uriDataCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x84);
rgrover1 225:f6cbfd817d16 31 static const uint8_t flagsCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x85);
rgrover1 225:f6cbfd817d16 32 static const uint8_t txPowerLevelsCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x86);
rgrover1 225:f6cbfd817d16 33 static const uint8_t txPowerModeCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x87);
rgrover1 225:f6cbfd817d16 34 static const uint8_t beaconPeriodCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x88);
rgrover1 225:f6cbfd817d16 35 static const uint8_t resetCharUUID[] = URI_BEACON_CONFIG_UUID_INITIALIZER_LIST(0x20, 0x89);
rgrover1 171:6092e61690dc 36
mbedAustin 231:1c4a4fd961a5 37 /**
mbedAustin 231:1c4a4fd961a5 38 * @class URIBeaconConfigService
rgrover1 242:0e9201b67e2f 39 * @brief UriBeacon Configuration Service. Can be used to set URL, adjust power levels, and set flags.
mbedAustin 231:1c4a4fd961a5 40 */
rgrover1 207:e88130dc254c 41 class URIBeaconConfigService {
rgrover1 180:afcd2f9c2ada 42 public:
mbedAustin 231:1c4a4fd961a5 43 /**
rgrover1 242:0e9201b67e2f 44 * @enum TXPowerModes_t
rgrover1 242:0e9201b67e2f 45 * @brief Transmission Power Modes for UriBeacon
rgrover1 242:0e9201b67e2f 46 */
rgrover1 175:4e85f7225f8f 47 enum TXPowerModes_t {
mbedAustin 231:1c4a4fd961a5 48 TX_POWER_MODE_LOWEST = 0, /*!< Lowest TX power mode */
mbedAustin 231:1c4a4fd961a5 49 TX_POWER_MODE_LOW = 1, /*!< Low TX power mode */
mbedAustin 231:1c4a4fd961a5 50 TX_POWER_MODE_MEDIUM = 2, /*!< Medium TX power mode */
mbedAustin 231:1c4a4fd961a5 51 TX_POWER_MODE_HIGH = 3, /*!< High TX power mode */
mbedAustin 231:1c4a4fd961a5 52 NUM_POWER_MODES /*!< Number of Power Modes defined */
rgrover1 175:4e85f7225f8f 53 };
rgrover1 175:4e85f7225f8f 54
rgrover1 269:d818d11dca4e 55 static const size_t SIZEOF_LOCK_BITS = 16; /* uint128 */
rgrover1 269:d818d11dca4e 56 typedef uint8_t LockBits_t[SIZEOF_LOCK_BITS];
rgrover1 269:d818d11dca4e 57
rgrover1 181:bbb6ce1082c3 58 /**
rgrover1 181:bbb6ce1082c3 59 * @param[ref] ble
rgrover1 181:bbb6ce1082c3 60 * BLEDevice object for the underlying controller.
rgrover1 208:88a3a58769bf 61 * @param[in] uridata
rgrover1 181:bbb6ce1082c3 62 * URI as a null-terminated string.
rgrover1 181:bbb6ce1082c3 63 * @param[in] flagsIn
rgrover1 181:bbb6ce1082c3 64 * UriBeacon Flags.
rgrover1 218:8ae02569fab9 65 * @param[in] powerLevels[]
rgrover1 218:8ae02569fab9 66 * Table of UriBeacon Tx Power Levels in dBm.
rgrover1 218:8ae02569fab9 67 * @param[in] powerMode
rgrover1 218:8ae02569fab9 68 * Currently effective power mode.
rgrover1 181:bbb6ce1082c3 69 * @param[in] beaconPeriodIn
rgrover1 181:bbb6ce1082c3 70 * The period in milliseconds that a UriBeacon packet is
rgrover1 181:bbb6ce1082c3 71 * transmitted. A value of zero disables UriBeacon
rgrover1 181:bbb6ce1082c3 72 * transmissions.
rgrover1 181:bbb6ce1082c3 73 */
rgrover1 218:8ae02569fab9 74 URIBeaconConfigService(BLEDevice &bleIn,
rgrover1 218:8ae02569fab9 75 const char *uriDataIn,
rgrover1 222:33b04c693e83 76 uint8_t flagsIn = 0,
rgrover1 218:8ae02569fab9 77 const int8_t powerLevelsIn[NUM_POWER_MODES] = NULL,
rgrover1 222:33b04c693e83 78 TXPowerModes_t powerModeIn = TX_POWER_MODE_LOW,
rgrover1 222:33b04c693e83 79 uint16_t beaconPeriodIn = 1000) :
rgrover1 192:3fd3dcf49005 80 ble(bleIn),
rgrover1 192:3fd3dcf49005 81 payloadIndex(0),
rgrover1 192:3fd3dcf49005 82 serviceDataPayload(),
rgrover1 192:3fd3dcf49005 83 initSucceeded(false),
rgrover1 192:3fd3dcf49005 84 lockedState(false),
rgrover1 271:7f2465b7978e 85 lockBits(),
rgrover1 192:3fd3dcf49005 86 uriDataLength(0),
rgrover1 192:3fd3dcf49005 87 uriData(),
rgrover1 192:3fd3dcf49005 88 flags(flagsIn),
rgrover1 192:3fd3dcf49005 89 powerLevels(),
rgrover1 201:9bb7b3f45c20 90 beaconPeriod(beaconPeriodIn),
rgrover1 192:3fd3dcf49005 91 lockedStateChar(lockedStateCharUUID, reinterpret_cast<uint8_t *>(&lockedState), 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 268:bc525cdc88f7 92 lockChar(lockCharUUID, lockBits, SIZEOF_LOCK_BITS, SIZEOF_LOCK_BITS, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 268:bc525cdc88f7 93 unlockChar(unlockCharUUID, lockBits, SIZEOF_LOCK_BITS, SIZEOF_LOCK_BITS, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 215:f9d0169b9c28 94 uriDataChar(uriDataCharUUID, uriData, MAX_SIZE_URI_DATA_CHAR_VALUE, MAX_SIZE_URI_DATA_CHAR_VALUE,
rgrover1 225:f6cbfd817d16 95 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 192:3fd3dcf49005 96 flagsChar(flagsCharUUID, &flags, 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 224:c55213f24647 97 txPowerLevelsChar(txPowerLevelsCharUUID, reinterpret_cast<uint8_t *>(powerLevels), sizeof(powerLevels), sizeof(powerLevels),
rgrover1 192:3fd3dcf49005 98 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 218:8ae02569fab9 99 txPowerModeChar(txPowerModeCharUUID, reinterpret_cast<uint8_t *>(&txPowerMode), sizeof(uint8_t), sizeof(uint8_t),
rgrover1 218:8ae02569fab9 100 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 192:3fd3dcf49005 101 beaconPeriodChar(beaconPeriodCharUUID, reinterpret_cast<uint8_t *>(&beaconPeriod), 2, 2,
rgrover1 192:3fd3dcf49005 102 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 271:7f2465b7978e 103 resetChar(resetCharUUID, reinterpret_cast<uint8_t *>(&resetFlag), 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE)
rgrover1 192:3fd3dcf49005 104 {
rgrover1 194:669eced4cd5e 105 if ((uriDataIn == NULL) || ((uriDataLength = strlen(uriDataIn)) == 0) || (uriDataLength > MAX_SIZE_URI_DATA_CHAR_VALUE)) {
rgrover1 192:3fd3dcf49005 106 return;
rgrover1 192:3fd3dcf49005 107 }
rgrover1 194:669eced4cd5e 108 strcpy(reinterpret_cast<char *>(uriData), uriDataIn);
rgrover1 192:3fd3dcf49005 109
rgrover1 226:ec436a9ceb31 110 if (powerLevelsIn != NULL) {
rgrover1 218:8ae02569fab9 111 memcpy(powerLevels, powerLevelsIn, sizeof(powerLevels));
rgrover1 218:8ae02569fab9 112 updateTxPowerLevelsCharacteristic();
rgrover1 218:8ae02569fab9 113 }
rgrover1 218:8ae02569fab9 114
rgrover1 210:0c14030d1bd0 115 configureGAP();
rgrover1 171:6092e61690dc 116
rgrover1 274:f540619754bb 117 // enable the following for debugging the state of the lock
rgrover1 274:f540619754bb 118 // lockedStateChar.setReadAuthorizationCallback(this, &URIBeaconConfigService::lockedStateAuthorizationCallback);
rgrover1 274:f540619754bb 119
rgrover1 272:65b9d9c87ed1 120 lockChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::lockAuthorizationCallback);
rgrover1 272:65b9d9c87ed1 121 unlockChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::unlockAuthorizationCallback);
rgrover1 250:6862d374e613 122 uriDataChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::uriDataWriteAuthorizationCallback);
rgrover1 255:cdb7231f83df 123 flagsChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::flagsAuthorizationCallback);
rgrover1 250:6862d374e613 124 txPowerLevelsChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 256:a6e651374060 125 txPowerModeChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::powerModeAuthorizationCallback);
rgrover1 250:6862d374e613 126 beaconPeriodChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 250:6862d374e613 127 resetChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 250:6862d374e613 128
rgrover1 273:9b82fc10574a 129 GattCharacteristic *charTable[] = {&lockedStateChar,
rgrover1 273:9b82fc10574a 130 &lockChar,
rgrover1 273:9b82fc10574a 131 &unlockChar,
rgrover1 273:9b82fc10574a 132 &uriDataChar,
rgrover1 273:9b82fc10574a 133 &flagsChar,
rgrover1 273:9b82fc10574a 134 &txPowerLevelsChar,
rgrover1 273:9b82fc10574a 135 &beaconPeriodChar,
rgrover1 273:9b82fc10574a 136 &resetChar};
rgrover1 192:3fd3dcf49005 137 GattService beaconControlService(URIBeacon2ControlServiceUUID, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 276:daa42f59bdb8 138 ble.addService(beaconControlService);
rgrover1 182:d16f8c11816b 139
rgrover1 207:e88130dc254c 140 ble.onDataWritten(this, &URIBeaconConfigService::onDataWritten);
rgrover1 192:3fd3dcf49005 141 }
rgrover1 192:3fd3dcf49005 142
rgrover1 193:ac2feceb7e87 143 bool configuredSuccessfully(void) const {
rgrover1 192:3fd3dcf49005 144 return initSucceeded;
rgrover1 171:6092e61690dc 145 }
rgrover1 171:6092e61690dc 146
rgrover1 173:05c4b1cea65f 147 /**
rgrover1 196:febbd68b1095 148 * Please note that the following public APIs are offered to allow modifying
rgrover1 196:febbd68b1095 149 * the service programmatically. It is also possible to do so over BLE GATT
rgrover1 196:febbd68b1095 150 * transactions.
rgrover1 196:febbd68b1095 151 */
rgrover1 196:febbd68b1095 152 public:
rgrover1 196:febbd68b1095 153 /**
rgrover1 173:05c4b1cea65f 154 * Update flags of the URIBeacon dynamically.
rgrover1 173:05c4b1cea65f 155 *
rgrover1 173:05c4b1cea65f 156 * @param[in] flagsIn
mbedAustin 240:20df772f2374 157 * @verbatim
rgrover1 173:05c4b1cea65f 158 * ### UriBeacon Flags
rgrover1 173:05c4b1cea65f 159 * Bit | Description
rgrover1 173:05c4b1cea65f 160 * :---- | :----------
rgrover1 173:05c4b1cea65f 161 * 0 | Invisible Hint
rgrover1 173:05c4b1cea65f 162 * 1..7 | Reserved for future use. Must be zero.
mbedAustin 240:20df772f2374 163 * @endverbatim
rgrover1 173:05c4b1cea65f 164 * The `Invisible Hint` flag is a command for the user-agent that tells
rgrover1 173:05c4b1cea65f 165 * it not to access or display the UriBeacon. This is a guideline only,
rgrover1 173:05c4b1cea65f 166 * and is not a blocking method. User agents may, with user approval,
rgrover1 173:05c4b1cea65f 167 * display invisible beacons.
rgrover1 173:05c4b1cea65f 168 */
rgrover1 171:6092e61690dc 169 void setFlags(uint8_t flagsIn) {
rgrover1 171:6092e61690dc 170 flags = flagsIn;
rgrover1 210:0c14030d1bd0 171 configureGAP();
rgrover1 211:f181effe5de3 172 updateFlagsCharacteristic();
rgrover1 171:6092e61690dc 173 }
rgrover1 171:6092e61690dc 174
rgrover1 177:17f4b5924fe9 175 /**
rgrover1 242:0e9201b67e2f 176 * @brief Update the txPowerLevels table.
rgrover1 242:0e9201b67e2f 177 *
mbedAustin 239:58642869879c 178 * @param[in] powerLevelsIn
mbedAustin 239:58642869879c 179 * Array of power levels
rgrover1 177:17f4b5924fe9 180 */
rgrover1 219:5603d539120c 181 void setTxPowerLevels(const int8_t powerLevelsIn[NUM_POWER_MODES]) {
rgrover1 219:5603d539120c 182 memcpy(powerLevels, powerLevelsIn, sizeof(powerLevels));
rgrover1 223:01a71f5e0ce4 183 configureGAP();
rgrover1 219:5603d539120c 184 updateTxPowerLevelsCharacteristic();
rgrover1 177:17f4b5924fe9 185 }
rgrover1 177:17f4b5924fe9 186
rgrover1 177:17f4b5924fe9 187 /**
rgrover1 242:0e9201b67e2f 188 * @brief Set the effective power mode from one of the values in the powerLevels tables.
mbedAustin 239:58642869879c 189 *
mbedAustin 239:58642869879c 190 * @param[in] mode
mbedAustin 239:58642869879c 191 * Set the TX Power Mode.
rgrover1 177:17f4b5924fe9 192 */
rgrover1 219:5603d539120c 193 void setTxPowerMode(TXPowerModes_t mode) {
rgrover1 218:8ae02569fab9 194 txPowerMode = mode;
rgrover1 210:0c14030d1bd0 195 configureGAP();
rgrover1 218:8ae02569fab9 196 updateTxPowerModeCharacteristic();
rgrover1 171:6092e61690dc 197 }
rgrover1 171:6092e61690dc 198
rgrover1 183:41d6ffadba96 199 /**
rgrover1 183:41d6ffadba96 200 * The period in milliseconds that a UriBeacon packet is transmitted.
rgrover1 183:41d6ffadba96 201 *
mbedAustin 240:20df772f2374 202 * @note A value of zero disables UriBeacon transmissions.
mbedAustin 239:58642869879c 203 *
mbedAustin 239:58642869879c 204 * @param beaconPeriodIn
mbedAustin 239:58642869879c 205 * Beacon advertising period in milliseconds
rgrover1 183:41d6ffadba96 206 */
rgrover1 242:0e9201b67e2f 207 void setBeaconPeriod(uint16_t beaconPeriodIn) {
rgrover1 171:6092e61690dc 208 beaconPeriod = beaconPeriodIn;
rgrover1 210:0c14030d1bd0 209 configureGAP();
rgrover1 211:f181effe5de3 210 updateBeaconPeriodCharacteristic();
rgrover1 171:6092e61690dc 211 }
rgrover1 171:6092e61690dc 212
rgrover1 271:7f2465b7978e 213 protected:
rgrover1 271:7f2465b7978e 214 void updateLockBits(const LockBits_t lockBitsIn) {
rgrover1 271:7f2465b7978e 215 static const uint8_t allZeroes[SIZEOF_LOCK_BITS] = {0, 0, 0, 0, 0, 0, 0, 0,
rgrover1 271:7f2465b7978e 216 0, 0, 0, 0, 0, 0, 0, 0};
rgrover1 271:7f2465b7978e 217
rgrover1 271:7f2465b7978e 218 memcpy(lockBits, lockBitsIn, SIZEOF_LOCK_BITS);
rgrover1 271:7f2465b7978e 219 if (memcmp(lockBits, allZeroes, SIZEOF_LOCK_BITS)) {
rgrover1 271:7f2465b7978e 220 lockedState = true;
rgrover1 271:7f2465b7978e 221 }
rgrover1 271:7f2465b7978e 222 }
rgrover1 271:7f2465b7978e 223
rgrover1 271:7f2465b7978e 224 void copyLockBitsInto(LockBits_t lockBitsOut) const {
rgrover1 271:7f2465b7978e 225 memcpy(lockBitsOut, lockBits, SIZEOF_LOCK_BITS);
rgrover1 271:7f2465b7978e 226 }
rgrover1 271:7f2465b7978e 227
rgrover1 275:4abc3126f1e1 228 void resetLockBits(void) {
rgrover1 275:4abc3126f1e1 229 lockedState = false;
rgrover1 275:4abc3126f1e1 230 memset(lockBits, 0, SIZEOF_LOCK_BITS);
rgrover1 275:4abc3126f1e1 231 storage_saveLockBits();
rgrover1 275:4abc3126f1e1 232 }
rgrover1 275:4abc3126f1e1 233
rgrover1 269:d818d11dca4e 234 /**
rgrover1 269:d818d11dca4e 235 * APIs around making lockBits persistent.
rgrover1 269:d818d11dca4e 236 */
rgrover1 269:d818d11dca4e 237 private:
rgrover1 269:d818d11dca4e 238 /**
rgrover1 269:d818d11dca4e 239 * Have we previously saved lockedBits? Once set, this state is expected to persist.
rgrover1 269:d818d11dca4e 240 * @return true if we've previously saved locked bits.
rgrover1 269:d818d11dca4e 241 */
rgrover1 269:d818d11dca4e 242 virtual bool storage_haveSavedLockBits() const {
rgrover1 269:d818d11dca4e 243 /* Expecting to be overridden. Left empty to allow the default URIBeacon to be instantiated if persistence isn't required. */
rgrover1 269:d818d11dca4e 244 return false;
rgrover1 269:d818d11dca4e 245 }
rgrover1 269:d818d11dca4e 246
rgrover1 269:d818d11dca4e 247 /**
rgrover1 269:d818d11dca4e 248 * Save the current value of lockBits into persistent storage; this value is then retrievable by lockLockBits() until a subsequent call to saveLockBits().
rgrover1 269:d818d11dca4e 249 */
rgrover1 269:d818d11dca4e 250 virtual void storage_saveLockBits() {
rgrover1 269:d818d11dca4e 251 /* Expecting to be overridden. Left empty to allow the default URIBeacon to be instantiated if persistence isn't required. */
rgrover1 269:d818d11dca4e 252 }
rgrover1 269:d818d11dca4e 253
rgrover1 269:d818d11dca4e 254 /**
rgrover1 269:d818d11dca4e 255 * Retrieve the saved lockBits from persistent storage and update the class member 'lockBits'.
rgrover1 269:d818d11dca4e 256 */
rgrover1 269:d818d11dca4e 257 virtual void storage_loadLockBits() {
rgrover1 269:d818d11dca4e 258 /* Expecting to be overridden. Left empty to allow the default URIBeacon to be instantiated if persistence isn't required. */
rgrover1 269:d818d11dca4e 259 }
rgrover1 269:d818d11dca4e 260
rgrover1 196:febbd68b1095 261 private:
mbedAustin 233:4d570d99b8cb 262 /*
rgrover1 186:ce34008cea95 263 * Setup the advertisement payload and GAP settings.
rgrover1 186:ce34008cea95 264 */
rgrover1 210:0c14030d1bd0 265 void configureGAP(void) {
rgrover1 171:6092e61690dc 266 const uint8_t BEACON_UUID[] = {0xD8, 0xFE};
rgrover1 171:6092e61690dc 267
rgrover1 206:49646c933822 268 payloadIndex = 0;
rgrover1 171:6092e61690dc 269 serviceDataPayload[payloadIndex++] = BEACON_UUID[0];
rgrover1 171:6092e61690dc 270 serviceDataPayload[payloadIndex++] = BEACON_UUID[1];
rgrover1 171:6092e61690dc 271 serviceDataPayload[payloadIndex++] = flags;
rgrover1 218:8ae02569fab9 272 serviceDataPayload[payloadIndex++] = powerLevels[txPowerMode];
rgrover1 171:6092e61690dc 273
rgrover1 206:49646c933822 274 const char *urlData = reinterpret_cast<char *>(uriData);
rgrover1 206:49646c933822 275 size_t sizeofURLData = uriDataLength;
rgrover1 206:49646c933822 276 size_t encodedBytes = encodeURISchemePrefix(urlData, sizeofURLData) + encodeURI(urlData, sizeofURLData);
rgrover1 171:6092e61690dc 277
rgrover1 171:6092e61690dc 278 ble.clearAdvertisingPayload();
rgrover1 171:6092e61690dc 279 ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, BEACON_UUID, sizeof(BEACON_UUID));
rgrover1 171:6092e61690dc 280 ble.accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceDataPayload, encodedBytes + 4);
rgrover1 171:6092e61690dc 281
rgrover1 201:9bb7b3f45c20 282 ble.setAdvertisingInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(beaconPeriod));
rgrover1 218:8ae02569fab9 283 ble.setTxPower(powerLevels[txPowerMode]);
rgrover1 171:6092e61690dc 284 }
rgrover1 171:6092e61690dc 285
mbedAustin 232:4cfb5b8a4fb9 286 /*
rgrover1 242:0e9201b67e2f 287 * Encode the URI Prefix to a single byte if possible.
rgrover1 242:0e9201b67e2f 288 */
rgrover1 171:6092e61690dc 289 size_t encodeURISchemePrefix(const char *&urldata, size_t &sizeofURLData) {
rgrover1 213:ac3b745af1d0 290 if (!sizeofURLData) {
rgrover1 213:ac3b745af1d0 291 return 0;
rgrover1 213:ac3b745af1d0 292 }
rgrover1 242:0e9201b67e2f 293
mbedAustin 232:4cfb5b8a4fb9 294 /* These are the URI Prefixes that can be abbreviated.*/
rgrover1 171:6092e61690dc 295 const char *prefixes[] = {
rgrover1 171:6092e61690dc 296 "http://www.",
rgrover1 171:6092e61690dc 297 "https://www.",
rgrover1 171:6092e61690dc 298 "http://",
rgrover1 171:6092e61690dc 299 "https://",
rgrover1 171:6092e61690dc 300 "urn:uuid:"
rgrover1 171:6092e61690dc 301 };
rgrover1 171:6092e61690dc 302
rgrover1 206:49646c933822 303 size_t encodedBytes = 0;
rgrover1 171:6092e61690dc 304 const size_t NUM_PREFIXES = sizeof(prefixes) / sizeof(char *);
rgrover1 171:6092e61690dc 305 for (unsigned i = 0; i < NUM_PREFIXES; i++) {
rgrover1 171:6092e61690dc 306 size_t prefixLen = strlen(prefixes[i]);
rgrover1 171:6092e61690dc 307 if (strncmp(urldata, prefixes[i], prefixLen) == 0) {
rgrover1 171:6092e61690dc 308 serviceDataPayload[payloadIndex++] = i;
rgrover1 206:49646c933822 309 encodedBytes = 1;
rgrover1 171:6092e61690dc 310
rgrover1 206:49646c933822 311 urldata += prefixLen;
rgrover1 171:6092e61690dc 312 sizeofURLData -= prefixLen;
rgrover1 171:6092e61690dc 313 break;
rgrover1 171:6092e61690dc 314 }
rgrover1 171:6092e61690dc 315 }
rgrover1 171:6092e61690dc 316
rgrover1 171:6092e61690dc 317 return encodedBytes;
rgrover1 171:6092e61690dc 318 }
rgrover1 242:0e9201b67e2f 319
mbedAustin 232:4cfb5b8a4fb9 320 /*
rgrover1 242:0e9201b67e2f 321 * Encode the URI Suffix to a single byte if possible.
rgrover1 242:0e9201b67e2f 322 */
rgrover1 171:6092e61690dc 323 size_t encodeURI(const char *urldata, size_t sizeofURLData) {
mbedAustin 232:4cfb5b8a4fb9 324 /* These are the URI suffixes that can be abbreviated. */
rgrover1 171:6092e61690dc 325 const char *suffixes[] = {
rgrover1 171:6092e61690dc 326 ".com/",
rgrover1 171:6092e61690dc 327 ".org/",
rgrover1 171:6092e61690dc 328 ".edu/",
rgrover1 171:6092e61690dc 329 ".net/",
rgrover1 171:6092e61690dc 330 ".info/",
rgrover1 171:6092e61690dc 331 ".biz/",
rgrover1 171:6092e61690dc 332 ".gov/",
rgrover1 171:6092e61690dc 333 ".com",
rgrover1 171:6092e61690dc 334 ".org",
rgrover1 171:6092e61690dc 335 ".edu",
rgrover1 171:6092e61690dc 336 ".net",
rgrover1 171:6092e61690dc 337 ".info",
rgrover1 171:6092e61690dc 338 ".biz",
rgrover1 171:6092e61690dc 339 ".gov"
rgrover1 171:6092e61690dc 340 };
rgrover1 171:6092e61690dc 341 const size_t NUM_SUFFIXES = sizeof(suffixes) / sizeof(char *);
rgrover1 171:6092e61690dc 342
rgrover1 171:6092e61690dc 343 size_t encodedBytes = 0;
rgrover1 171:6092e61690dc 344 while (sizeofURLData && (payloadIndex < MAX_SIZEOF_SERVICE_DATA_PAYLOAD)) {
rgrover1 171:6092e61690dc 345 /* check for suffix match */
rgrover1 171:6092e61690dc 346 unsigned i;
rgrover1 171:6092e61690dc 347 for (i = 0; i < NUM_SUFFIXES; i++) {
rgrover1 171:6092e61690dc 348 size_t suffixLen = strlen(suffixes[i]);
rgrover1 171:6092e61690dc 349 if ((suffixLen == 0) || (sizeofURLData < suffixLen)) {
rgrover1 171:6092e61690dc 350 continue;
rgrover1 171:6092e61690dc 351 }
rgrover1 171:6092e61690dc 352
rgrover1 171:6092e61690dc 353 if (strncmp(urldata, suffixes[i], suffixLen) == 0) {
rgrover1 171:6092e61690dc 354 serviceDataPayload[payloadIndex++] = i;
rgrover1 171:6092e61690dc 355 ++encodedBytes;
rgrover1 171:6092e61690dc 356 urldata += suffixLen;
rgrover1 171:6092e61690dc 357 sizeofURLData -= suffixLen;
rgrover1 171:6092e61690dc 358 break; /* from the for loop for checking against suffixes */
rgrover1 171:6092e61690dc 359 }
rgrover1 171:6092e61690dc 360 }
rgrover1 171:6092e61690dc 361 /* This is the default case where we've got an ordinary character which doesn't match a suffix. */
rgrover1 171:6092e61690dc 362 if (i == NUM_SUFFIXES) {
rgrover1 171:6092e61690dc 363 serviceDataPayload[payloadIndex++] = *urldata;
rgrover1 171:6092e61690dc 364 ++encodedBytes;
rgrover1 171:6092e61690dc 365 ++urldata;
rgrover1 171:6092e61690dc 366 --sizeofURLData;
rgrover1 171:6092e61690dc 367 }
rgrover1 171:6092e61690dc 368 }
rgrover1 192:3fd3dcf49005 369 if (sizeofURLData == 0) {
rgrover1 192:3fd3dcf49005 370 initSucceeded = true;
rgrover1 182:d16f8c11816b 371 }
rgrover1 171:6092e61690dc 372
rgrover1 171:6092e61690dc 373 return encodedBytes;
rgrover1 171:6092e61690dc 374 }
rgrover1 171:6092e61690dc 375
mbedAustin 232:4cfb5b8a4fb9 376 /*
rgrover1 242:0e9201b67e2f 377 * This callback is invoked when a GATT client attempts to modify any of the
rgrover1 250:6862d374e613 378 * characteristics of this service. Attempts to do so are also applied to
rgrover1 250:6862d374e613 379 * the internal state of this service object.
rgrover1 242:0e9201b67e2f 380 */
rgrover1 203:7b5178d2fa03 381 void onDataWritten(const GattCharacteristicWriteCBParams *params) {
rgrover1 228:db043dbf26f8 382 uint16_t handle = params->charHandle;
rgrover1 268:bc525cdc88f7 383 if (handle == lockChar.getValueHandle()) {
rgrover1 271:7f2465b7978e 384 updateLockBits(params->data);
rgrover1 271:7f2465b7978e 385 storage_saveLockBits();
rgrover1 268:bc525cdc88f7 386 } else if (handle == unlockChar.getValueHandle()) {
rgrover1 268:bc525cdc88f7 387 memset(lockBits, 0, SIZEOF_LOCK_BITS);
rgrover1 268:bc525cdc88f7 388 lockedState = false;
rgrover1 269:d818d11dca4e 389 storage_saveLockBits();
rgrover1 268:bc525cdc88f7 390 } else if (handle == uriDataChar.getValueHandle()) {
rgrover1 185:7cd70497aec8 391 uriDataLength = params->len;
rgrover1 187:057c547facd2 392 memcpy(uriData, params->data, uriDataLength);
rgrover1 229:6664b6c0e92b 393 } else if (handle == flagsChar.getValueHandle()) {
rgrover1 250:6862d374e613 394 flags = *(params->data);
rgrover1 229:6664b6c0e92b 395 } else if (handle == txPowerLevelsChar.getValueHandle()) {
rgrover1 250:6862d374e613 396 memcpy(powerLevels, params->data, NUM_POWER_MODES * sizeof(int8_t));
rgrover1 229:6664b6c0e92b 397 } else if (handle == txPowerModeChar.getValueHandle()) {
rgrover1 250:6862d374e613 398 txPowerMode = *reinterpret_cast<const TXPowerModes_t *>(params->data);
rgrover1 229:6664b6c0e92b 399 } else if (handle == beaconPeriodChar.getValueHandle()) {
rgrover1 250:6862d374e613 400 beaconPeriod = *((uint16_t *)(params->data));
rgrover1 229:6664b6c0e92b 401 } else if (handle == resetChar.getValueHandle()) {
rgrover1 200:80dd3e50705c 402 resetDefaults();
rgrover1 185:7cd70497aec8 403 }
rgrover1 210:0c14030d1bd0 404 configureGAP();
rgrover1 185:7cd70497aec8 405 ble.setAdvertisingPayload();
rgrover1 185:7cd70497aec8 406 }
rgrover1 185:7cd70497aec8 407
mbedAustin 232:4cfb5b8a4fb9 408 /*
rgrover1 251:6ce809c972bb 409 * Reset the default values.
rgrover1 242:0e9201b67e2f 410 */
rgrover1 200:80dd3e50705c 411 void resetDefaults(void) {
rgrover1 212:852d45a52016 412 uriDataLength = 0;
rgrover1 216:3f5e47361919 413 memset(uriData, 0, MAX_SIZE_URI_DATA_CHAR_VALUE);
rgrover1 212:852d45a52016 414 flags = 0;
rgrover1 216:3f5e47361919 415 memset(powerLevels, 0, sizeof(powerLevels));
rgrover1 218:8ae02569fab9 416 txPowerMode = TX_POWER_MODE_LOW;
rgrover1 212:852d45a52016 417 beaconPeriod = 0;
rgrover1 275:4abc3126f1e1 418 resetLockBits();
rgrover1 269:d818d11dca4e 419
rgrover1 211:f181effe5de3 420 updateGATT();
rgrover1 211:f181effe5de3 421 }
rgrover1 211:f181effe5de3 422
mbedAustin 232:4cfb5b8a4fb9 423 /*
rgrover1 242:0e9201b67e2f 424 * Internal helper function used to update the GATT database following any
rgrover1 242:0e9201b67e2f 425 * change to the internal state of the service object.
rgrover1 242:0e9201b67e2f 426 */
rgrover1 211:f181effe5de3 427 void updateGATT(void) {
rgrover1 214:7d79fa197212 428 updateLockedStateCharacteristic();
rgrover1 211:f181effe5de3 429 updateURIDataCharacteristic();
rgrover1 211:f181effe5de3 430 updateFlagsCharacteristic();
rgrover1 211:f181effe5de3 431 updateBeaconPeriodCharacteristic();
rgrover1 220:e75e8ba1ff80 432 updateTxPowerLevelsCharacteristic();
rgrover1 220:e75e8ba1ff80 433 updateTxPowerModeCharacteristic();
rgrover1 211:f181effe5de3 434 }
rgrover1 211:f181effe5de3 435
rgrover1 214:7d79fa197212 436 void updateLockedStateCharacteristic(void) {
rgrover1 229:6664b6c0e92b 437 ble.updateCharacteristicValue(lockedStateChar.getValueHandle(), reinterpret_cast<uint8_t *>(&lockedState), sizeof(lockedState));
rgrover1 214:7d79fa197212 438 }
rgrover1 214:7d79fa197212 439
rgrover1 211:f181effe5de3 440 void updateURIDataCharacteristic(void) {
rgrover1 229:6664b6c0e92b 441 ble.updateCharacteristicValue(uriDataChar.getValueHandle(), uriData, uriDataLength);
rgrover1 211:f181effe5de3 442 }
rgrover1 211:f181effe5de3 443
rgrover1 211:f181effe5de3 444 void updateFlagsCharacteristic(void) {
rgrover1 229:6664b6c0e92b 445 ble.updateCharacteristicValue(flagsChar.getValueHandle(), &flags, 1 /* size */);
rgrover1 211:f181effe5de3 446 }
rgrover1 211:f181effe5de3 447
rgrover1 211:f181effe5de3 448 void updateBeaconPeriodCharacteristic(void) {
rgrover1 229:6664b6c0e92b 449 ble.updateCharacteristicValue(beaconPeriodChar.getValueHandle(), reinterpret_cast<uint8_t *>(&beaconPeriod), sizeof(uint16_t));
rgrover1 189:a23091b54ab5 450 }
rgrover1 189:a23091b54ab5 451
rgrover1 218:8ae02569fab9 452 void updateTxPowerModeCharacteristic(void) {
rgrover1 229:6664b6c0e92b 453 ble.updateCharacteristicValue(txPowerModeChar.getValueHandle(), reinterpret_cast<uint8_t *>(&txPowerMode), sizeof(uint8_t));
rgrover1 218:8ae02569fab9 454 }
rgrover1 218:8ae02569fab9 455
rgrover1 218:8ae02569fab9 456 void updateTxPowerLevelsCharacteristic(void) {
rgrover1 242:0e9201b67e2f 457 ble.updateCharacteristicValue(txPowerLevelsChar.getValueHandle(), reinterpret_cast<uint8_t *>(powerLevels), NUM_POWER_MODES * sizeof(int8_t));
rgrover1 218:8ae02569fab9 458 }
rgrover1 218:8ae02569fab9 459
rgrover1 242:0e9201b67e2f 460 private:
rgrover1 274:f540619754bb 461 // enable the following for debugging the state of the lock
rgrover1 274:f540619754bb 462 // void lockedStateAuthorizationCallback(GattCharacteristicReadAuthCBParams *params) {
rgrover1 274:f540619754bb 463 // printf("read authorization callback: lockedState is %u\r\n", lockedState);
rgrover1 274:f540619754bb 464 // params->authorizationReply = true;
rgrover1 274:f540619754bb 465 // }
rgrover1 268:bc525cdc88f7 466
rgrover1 268:bc525cdc88f7 467 void lockAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 268:bc525cdc88f7 468 params->authorizationReply = !lockedState;
rgrover1 268:bc525cdc88f7 469 }
rgrover1 268:bc525cdc88f7 470
rgrover1 268:bc525cdc88f7 471 void unlockAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 268:bc525cdc88f7 472 if (lockedState && (memcmp(params->data, lockBits, SIZEOF_LOCK_BITS) == 0)) {
rgrover1 268:bc525cdc88f7 473 params->authorizationReply = true;
rgrover1 268:bc525cdc88f7 474 } else {
rgrover1 268:bc525cdc88f7 475 params->authorizationReply = false;
rgrover1 268:bc525cdc88f7 476 }
rgrover1 268:bc525cdc88f7 477 }
rgrover1 268:bc525cdc88f7 478
rgrover1 250:6862d374e613 479 void uriDataWriteAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 250:6862d374e613 480 if (lockedState || (params->offset != 0) || (params->len > MAX_SIZE_URI_DATA_CHAR_VALUE)) {
rgrover1 250:6862d374e613 481 params->authorizationReply = false;
rgrover1 250:6862d374e613 482 }
rgrover1 250:6862d374e613 483 }
rgrover1 250:6862d374e613 484
rgrover1 255:cdb7231f83df 485 void flagsAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 250:6862d374e613 486 if (lockedState || ((*(params->data) & 0xFE) != 0)) {
rgrover1 250:6862d374e613 487 params->authorizationReply = false;
rgrover1 250:6862d374e613 488 }
rgrover1 250:6862d374e613 489 }
rgrover1 250:6862d374e613 490
rgrover1 256:a6e651374060 491 void powerModeAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 256:a6e651374060 492 if (lockedState || (*(params->data) >= NUM_POWER_MODES)) {
rgrover1 256:a6e651374060 493 params->authorizationReply = false;
rgrover1 256:a6e651374060 494 }
rgrover1 256:a6e651374060 495 }
rgrover1 256:a6e651374060 496
rgrover1 250:6862d374e613 497 void denyGATTWritesIfLocked(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 250:6862d374e613 498 if (lockedState) {
rgrover1 250:6862d374e613 499 params->authorizationReply = false;
rgrover1 250:6862d374e613 500 }
rgrover1 250:6862d374e613 501 }
rgrover1 250:6862d374e613 502
rgrover1 250:6862d374e613 503 private:
mbedAustin 233:4d570d99b8cb 504 /**
rgrover1 242:0e9201b67e2f 505 * For debugging only. Print Hex representation of ServiceDataPayload to the console.
rgrover1 185:7cd70497aec8 506 */
rgrover1 274:f540619754bb 507 // void dumpEncodedSeviceData() const {
rgrover1 274:f540619754bb 508 // printf("encoded: '");
rgrover1 274:f540619754bb 509 // for (unsigned i = 0; i < payloadIndex; i++) {
rgrover1 274:f540619754bb 510 // printf(" %02x", serviceDataPayload[i]);
rgrover1 274:f540619754bb 511 // }
rgrover1 274:f540619754bb 512 // printf("'\r\n");
rgrover1 274:f540619754bb 513 // }
rgrover1 185:7cd70497aec8 514
rgrover1 171:6092e61690dc 515 private:
rgrover1 254:fb2a891a0d98 516 static const size_t MAX_SIZEOF_SERVICE_DATA_PAYLOAD = 22; /* Uri Data must be between 0 and 18 bytes in length; and
rgrover1 254:fb2a891a0d98 517 * together with the 4-byte header, the service data must
rgrover1 254:fb2a891a0d98 518 * fit within 22 bytes. */
rgrover1 204:479f81fd5d3b 519 static const size_t MAX_SIZE_URI_DATA_CHAR_VALUE = 48; /* This is chosen arbitrarily. It should be large enough
rgrover1 204:479f81fd5d3b 520 * to hold any reasonable uncompressed URI. */
rgrover1 171:6092e61690dc 521 private:
rgrover1 206:49646c933822 522 BLEDevice &ble;
rgrover1 171:6092e61690dc 523
rgrover1 206:49646c933822 524 size_t payloadIndex;
rgrover1 206:49646c933822 525 uint8_t serviceDataPayload[MAX_SIZEOF_SERVICE_DATA_PAYLOAD];
rgrover1 206:49646c933822 526 bool initSucceeded;
rgrover1 182:d16f8c11816b 527
rgrover1 206:49646c933822 528 bool lockedState;
rgrover1 271:7f2465b7978e 529 uint8_t lockBits[SIZEOF_LOCK_BITS];
rgrover1 271:7f2465b7978e 530
rgrover1 206:49646c933822 531 uint16_t uriDataLength;
rgrover1 206:49646c933822 532 uint8_t uriData[MAX_SIZE_URI_DATA_CHAR_VALUE];
rgrover1 206:49646c933822 533 uint8_t flags;
rgrover1 206:49646c933822 534 int8_t powerLevels[NUM_POWER_MODES];
rgrover1 218:8ae02569fab9 535 TXPowerModes_t txPowerMode;
rgrover1 206:49646c933822 536 uint16_t beaconPeriod;
rgrover1 206:49646c933822 537 bool resetFlag;
rgrover1 171:6092e61690dc 538
rgrover1 206:49646c933822 539 GattCharacteristic lockedStateChar;
rgrover1 268:bc525cdc88f7 540 GattCharacteristic lockChar;
rgrover1 268:bc525cdc88f7 541 GattCharacteristic unlockChar;
rgrover1 206:49646c933822 542 GattCharacteristic uriDataChar;
rgrover1 206:49646c933822 543 GattCharacteristic flagsChar;
rgrover1 206:49646c933822 544 GattCharacteristic txPowerLevelsChar;
rgrover1 218:8ae02569fab9 545 GattCharacteristic txPowerModeChar;
rgrover1 206:49646c933822 546 GattCharacteristic beaconPeriodChar;
rgrover1 206:49646c933822 547 GattCharacteristic resetChar;
rgrover1 171:6092e61690dc 548 };
rgrover1 171:6092e61690dc 549
rgrover1 207:e88130dc254c 550 #endif /* #ifndef __BLE_URI_BEACON_CONFIG_SERVICE_H__*/