Microbug / BLE_API

Minor temporary patch to allow DFU packet callback

Fork of BLE_API by Bluetooth Low Energy

services/URIBeaconConfigService.h@272:65b9d9c87ed1, 2015-01-21 (annotated)

Committer:
rgrover1
Date:
Wed Jan 21 09:32:52 2015 +0000
Revision:
272:65b9d9c87ed1
Parent:
271:7f2465b7978e
Child:
273:9b82fc10574a
Synchronized with git rev e17ff552

Author: Rohit Grover

need to setup write authorization for lock and unlock characteristics.

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 272:65b9d9c87ed1 117 lockChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::lockAuthorizationCallback);
rgrover1 272:65b9d9c87ed1 118 unlockChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::unlockAuthorizationCallback);
rgrover1 250:6862d374e613 119 uriDataChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::uriDataWriteAuthorizationCallback);
rgrover1 255:cdb7231f83df 120 flagsChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::flagsAuthorizationCallback);
rgrover1 250:6862d374e613 121 txPowerLevelsChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 256:a6e651374060 122 txPowerModeChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::powerModeAuthorizationCallback);
rgrover1 250:6862d374e613 123 beaconPeriodChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 250:6862d374e613 124 resetChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 250:6862d374e613 125
rgrover1 268:bc525cdc88f7 126 GattCharacteristic *charTable[] = {&lockedStateChar, &lockChar, &unlockChar, &uriDataChar, &flagsChar, &txPowerLevelsChar, &beaconPeriodChar, &resetChar};
rgrover1 192:3fd3dcf49005 127 GattService beaconControlService(URIBeacon2ControlServiceUUID, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 182:d16f8c11816b 128
rgrover1 192:3fd3dcf49005 129 ble.addService(beaconControlService);
rgrover1 207:e88130dc254c 130 ble.onDataWritten(this, &URIBeaconConfigService::onDataWritten);
rgrover1 192:3fd3dcf49005 131 }
rgrover1 192:3fd3dcf49005 132
rgrover1 193:ac2feceb7e87 133 bool configuredSuccessfully(void) const {
rgrover1 192:3fd3dcf49005 134 return initSucceeded;
rgrover1 171:6092e61690dc 135 }
rgrover1 171:6092e61690dc 136
rgrover1 173:05c4b1cea65f 137 /**
rgrover1 196:febbd68b1095 138 * Please note that the following public APIs are offered to allow modifying
rgrover1 196:febbd68b1095 139 * the service programmatically. It is also possible to do so over BLE GATT
rgrover1 196:febbd68b1095 140 * transactions.
rgrover1 196:febbd68b1095 141 */
rgrover1 196:febbd68b1095 142 public:
rgrover1 196:febbd68b1095 143 /**
rgrover1 173:05c4b1cea65f 144 * Update flags of the URIBeacon dynamically.
rgrover1 173:05c4b1cea65f 145 *
rgrover1 173:05c4b1cea65f 146 * @param[in] flagsIn
mbedAustin 240:20df772f2374 147 * @verbatim
rgrover1 173:05c4b1cea65f 148 * ### UriBeacon Flags
rgrover1 173:05c4b1cea65f 149 * Bit | Description
rgrover1 173:05c4b1cea65f 150 * :---- | :----------
rgrover1 173:05c4b1cea65f 151 * 0 | Invisible Hint
rgrover1 173:05c4b1cea65f 152 * 1..7 | Reserved for future use. Must be zero.
mbedAustin 240:20df772f2374 153 * @endverbatim
rgrover1 173:05c4b1cea65f 154 * The `Invisible Hint` flag is a command for the user-agent that tells
rgrover1 173:05c4b1cea65f 155 * it not to access or display the UriBeacon. This is a guideline only,
rgrover1 173:05c4b1cea65f 156 * and is not a blocking method. User agents may, with user approval,
rgrover1 173:05c4b1cea65f 157 * display invisible beacons.
rgrover1 173:05c4b1cea65f 158 */
rgrover1 171:6092e61690dc 159 void setFlags(uint8_t flagsIn) {
rgrover1 171:6092e61690dc 160 flags = flagsIn;
rgrover1 210:0c14030d1bd0 161 configureGAP();
rgrover1 211:f181effe5de3 162 updateFlagsCharacteristic();
rgrover1 171:6092e61690dc 163 }
rgrover1 171:6092e61690dc 164
rgrover1 177:17f4b5924fe9 165 /**
rgrover1 242:0e9201b67e2f 166 * @brief Update the txPowerLevels table.
rgrover1 242:0e9201b67e2f 167 *
mbedAustin 239:58642869879c 168 * @param[in] powerLevelsIn
mbedAustin 239:58642869879c 169 * Array of power levels
rgrover1 177:17f4b5924fe9 170 */
rgrover1 219:5603d539120c 171 void setTxPowerLevels(const int8_t powerLevelsIn[NUM_POWER_MODES]) {
rgrover1 219:5603d539120c 172 memcpy(powerLevels, powerLevelsIn, sizeof(powerLevels));
rgrover1 223:01a71f5e0ce4 173 configureGAP();
rgrover1 219:5603d539120c 174 updateTxPowerLevelsCharacteristic();
rgrover1 177:17f4b5924fe9 175 }
rgrover1 177:17f4b5924fe9 176
rgrover1 177:17f4b5924fe9 177 /**
rgrover1 242:0e9201b67e2f 178 * @brief Set the effective power mode from one of the values in the powerLevels tables.
mbedAustin 239:58642869879c 179 *
mbedAustin 239:58642869879c 180 * @param[in] mode
mbedAustin 239:58642869879c 181 * Set the TX Power Mode.
rgrover1 177:17f4b5924fe9 182 */
rgrover1 219:5603d539120c 183 void setTxPowerMode(TXPowerModes_t mode) {
rgrover1 218:8ae02569fab9 184 txPowerMode = mode;
rgrover1 210:0c14030d1bd0 185 configureGAP();
rgrover1 218:8ae02569fab9 186 updateTxPowerModeCharacteristic();
rgrover1 171:6092e61690dc 187 }
rgrover1 171:6092e61690dc 188
rgrover1 183:41d6ffadba96 189 /**
rgrover1 183:41d6ffadba96 190 * The period in milliseconds that a UriBeacon packet is transmitted.
rgrover1 183:41d6ffadba96 191 *
mbedAustin 240:20df772f2374 192 * @note A value of zero disables UriBeacon transmissions.
mbedAustin 239:58642869879c 193 *
mbedAustin 239:58642869879c 194 * @param beaconPeriodIn
mbedAustin 239:58642869879c 195 * Beacon advertising period in milliseconds
rgrover1 183:41d6ffadba96 196 */
rgrover1 242:0e9201b67e2f 197 void setBeaconPeriod(uint16_t beaconPeriodIn) {
rgrover1 171:6092e61690dc 198 beaconPeriod = beaconPeriodIn;
rgrover1 210:0c14030d1bd0 199 configureGAP();
rgrover1 211:f181effe5de3 200 updateBeaconPeriodCharacteristic();
rgrover1 171:6092e61690dc 201 }
rgrover1 171:6092e61690dc 202
rgrover1 271:7f2465b7978e 203 protected:
rgrover1 271:7f2465b7978e 204 void updateLockBits(const LockBits_t lockBitsIn) {
rgrover1 271:7f2465b7978e 205 static const uint8_t allZeroes[SIZEOF_LOCK_BITS] = {0, 0, 0, 0, 0, 0, 0, 0,
rgrover1 271:7f2465b7978e 206 0, 0, 0, 0, 0, 0, 0, 0};
rgrover1 271:7f2465b7978e 207
rgrover1 271:7f2465b7978e 208 memcpy(lockBits, lockBitsIn, SIZEOF_LOCK_BITS);
rgrover1 271:7f2465b7978e 209 if (memcmp(lockBits, allZeroes, SIZEOF_LOCK_BITS)) {
rgrover1 271:7f2465b7978e 210 lockedState = true;
rgrover1 271:7f2465b7978e 211 }
rgrover1 271:7f2465b7978e 212 }
rgrover1 271:7f2465b7978e 213
rgrover1 271:7f2465b7978e 214 void copyLockBitsInto(LockBits_t lockBitsOut) const {
rgrover1 271:7f2465b7978e 215 memcpy(lockBitsOut, lockBits, SIZEOF_LOCK_BITS);
rgrover1 271:7f2465b7978e 216 }
rgrover1 271:7f2465b7978e 217
rgrover1 269:d818d11dca4e 218 /**
rgrover1 269:d818d11dca4e 219 * APIs around making lockBits persistent.
rgrover1 269:d818d11dca4e 220 */
rgrover1 269:d818d11dca4e 221 private:
rgrover1 269:d818d11dca4e 222 /**
rgrover1 269:d818d11dca4e 223 * Have we previously saved lockedBits? Once set, this state is expected to persist.
rgrover1 269:d818d11dca4e 224 * @return true if we've previously saved locked bits.
rgrover1 269:d818d11dca4e 225 */
rgrover1 269:d818d11dca4e 226 virtual bool storage_haveSavedLockBits() const {
rgrover1 269:d818d11dca4e 227 /* Expecting to be overridden. Left empty to allow the default URIBeacon to be instantiated if persistence isn't required. */
rgrover1 269:d818d11dca4e 228 return false;
rgrover1 269:d818d11dca4e 229 }
rgrover1 269:d818d11dca4e 230
rgrover1 269:d818d11dca4e 231 /**
rgrover1 269:d818d11dca4e 232 * 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 233 */
rgrover1 269:d818d11dca4e 234 virtual void storage_saveLockBits() {
rgrover1 269:d818d11dca4e 235 /* Expecting to be overridden. Left empty to allow the default URIBeacon to be instantiated if persistence isn't required. */
rgrover1 269:d818d11dca4e 236 }
rgrover1 269:d818d11dca4e 237
rgrover1 269:d818d11dca4e 238 /**
rgrover1 269:d818d11dca4e 239 * Retrieve the saved lockBits from persistent storage and update the class member 'lockBits'.
rgrover1 269:d818d11dca4e 240 */
rgrover1 269:d818d11dca4e 241 virtual void storage_loadLockBits() {
rgrover1 269:d818d11dca4e 242 /* Expecting to be overridden. Left empty to allow the default URIBeacon to be instantiated if persistence isn't required. */
rgrover1 269:d818d11dca4e 243 }
rgrover1 269:d818d11dca4e 244
rgrover1 196:febbd68b1095 245 private:
mbedAustin 233:4d570d99b8cb 246 /*
rgrover1 186:ce34008cea95 247 * Setup the advertisement payload and GAP settings.
rgrover1 186:ce34008cea95 248 */
rgrover1 210:0c14030d1bd0 249 void configureGAP(void) {
rgrover1 171:6092e61690dc 250 const uint8_t BEACON_UUID[] = {0xD8, 0xFE};
rgrover1 171:6092e61690dc 251
rgrover1 206:49646c933822 252 payloadIndex = 0;
rgrover1 171:6092e61690dc 253 serviceDataPayload[payloadIndex++] = BEACON_UUID[0];
rgrover1 171:6092e61690dc 254 serviceDataPayload[payloadIndex++] = BEACON_UUID[1];
rgrover1 171:6092e61690dc 255 serviceDataPayload[payloadIndex++] = flags;
rgrover1 218:8ae02569fab9 256 serviceDataPayload[payloadIndex++] = powerLevels[txPowerMode];
rgrover1 171:6092e61690dc 257
rgrover1 206:49646c933822 258 const char *urlData = reinterpret_cast<char *>(uriData);
rgrover1 206:49646c933822 259 size_t sizeofURLData = uriDataLength;
rgrover1 206:49646c933822 260 size_t encodedBytes = encodeURISchemePrefix(urlData, sizeofURLData) + encodeURI(urlData, sizeofURLData);
rgrover1 171:6092e61690dc 261
rgrover1 171:6092e61690dc 262 ble.clearAdvertisingPayload();
rgrover1 171:6092e61690dc 263 ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, BEACON_UUID, sizeof(BEACON_UUID));
rgrover1 171:6092e61690dc 264 ble.accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceDataPayload, encodedBytes + 4);
rgrover1 171:6092e61690dc 265
rgrover1 201:9bb7b3f45c20 266 ble.setAdvertisingInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(beaconPeriod));
rgrover1 218:8ae02569fab9 267 ble.setTxPower(powerLevels[txPowerMode]);
rgrover1 171:6092e61690dc 268 }
rgrover1 171:6092e61690dc 269
mbedAustin 232:4cfb5b8a4fb9 270 /*
rgrover1 242:0e9201b67e2f 271 * Encode the URI Prefix to a single byte if possible.
rgrover1 242:0e9201b67e2f 272 */
rgrover1 171:6092e61690dc 273 size_t encodeURISchemePrefix(const char *&urldata, size_t &sizeofURLData) {
rgrover1 213:ac3b745af1d0 274 if (!sizeofURLData) {
rgrover1 213:ac3b745af1d0 275 return 0;
rgrover1 213:ac3b745af1d0 276 }
rgrover1 242:0e9201b67e2f 277
mbedAustin 232:4cfb5b8a4fb9 278 /* These are the URI Prefixes that can be abbreviated.*/
rgrover1 171:6092e61690dc 279 const char *prefixes[] = {
rgrover1 171:6092e61690dc 280 "http://www.",
rgrover1 171:6092e61690dc 281 "https://www.",
rgrover1 171:6092e61690dc 282 "http://",
rgrover1 171:6092e61690dc 283 "https://",
rgrover1 171:6092e61690dc 284 "urn:uuid:"
rgrover1 171:6092e61690dc 285 };
rgrover1 171:6092e61690dc 286
rgrover1 206:49646c933822 287 size_t encodedBytes = 0;
rgrover1 171:6092e61690dc 288 const size_t NUM_PREFIXES = sizeof(prefixes) / sizeof(char *);
rgrover1 171:6092e61690dc 289 for (unsigned i = 0; i < NUM_PREFIXES; i++) {
rgrover1 171:6092e61690dc 290 size_t prefixLen = strlen(prefixes[i]);
rgrover1 171:6092e61690dc 291 if (strncmp(urldata, prefixes[i], prefixLen) == 0) {
rgrover1 171:6092e61690dc 292 serviceDataPayload[payloadIndex++] = i;
rgrover1 206:49646c933822 293 encodedBytes = 1;
rgrover1 171:6092e61690dc 294
rgrover1 206:49646c933822 295 urldata += prefixLen;
rgrover1 171:6092e61690dc 296 sizeofURLData -= prefixLen;
rgrover1 171:6092e61690dc 297 break;
rgrover1 171:6092e61690dc 298 }
rgrover1 171:6092e61690dc 299 }
rgrover1 171:6092e61690dc 300
rgrover1 171:6092e61690dc 301 return encodedBytes;
rgrover1 171:6092e61690dc 302 }
rgrover1 242:0e9201b67e2f 303
mbedAustin 232:4cfb5b8a4fb9 304 /*
rgrover1 242:0e9201b67e2f 305 * Encode the URI Suffix to a single byte if possible.
rgrover1 242:0e9201b67e2f 306 */
rgrover1 171:6092e61690dc 307 size_t encodeURI(const char *urldata, size_t sizeofURLData) {
mbedAustin 232:4cfb5b8a4fb9 308 /* These are the URI suffixes that can be abbreviated. */
rgrover1 171:6092e61690dc 309 const char *suffixes[] = {
rgrover1 171:6092e61690dc 310 ".com/",
rgrover1 171:6092e61690dc 311 ".org/",
rgrover1 171:6092e61690dc 312 ".edu/",
rgrover1 171:6092e61690dc 313 ".net/",
rgrover1 171:6092e61690dc 314 ".info/",
rgrover1 171:6092e61690dc 315 ".biz/",
rgrover1 171:6092e61690dc 316 ".gov/",
rgrover1 171:6092e61690dc 317 ".com",
rgrover1 171:6092e61690dc 318 ".org",
rgrover1 171:6092e61690dc 319 ".edu",
rgrover1 171:6092e61690dc 320 ".net",
rgrover1 171:6092e61690dc 321 ".info",
rgrover1 171:6092e61690dc 322 ".biz",
rgrover1 171:6092e61690dc 323 ".gov"
rgrover1 171:6092e61690dc 324 };
rgrover1 171:6092e61690dc 325 const size_t NUM_SUFFIXES = sizeof(suffixes) / sizeof(char *);
rgrover1 171:6092e61690dc 326
rgrover1 171:6092e61690dc 327 size_t encodedBytes = 0;
rgrover1 171:6092e61690dc 328 while (sizeofURLData && (payloadIndex < MAX_SIZEOF_SERVICE_DATA_PAYLOAD)) {
rgrover1 171:6092e61690dc 329 /* check for suffix match */
rgrover1 171:6092e61690dc 330 unsigned i;
rgrover1 171:6092e61690dc 331 for (i = 0; i < NUM_SUFFIXES; i++) {
rgrover1 171:6092e61690dc 332 size_t suffixLen = strlen(suffixes[i]);
rgrover1 171:6092e61690dc 333 if ((suffixLen == 0) || (sizeofURLData < suffixLen)) {
rgrover1 171:6092e61690dc 334 continue;
rgrover1 171:6092e61690dc 335 }
rgrover1 171:6092e61690dc 336
rgrover1 171:6092e61690dc 337 if (strncmp(urldata, suffixes[i], suffixLen) == 0) {
rgrover1 171:6092e61690dc 338 serviceDataPayload[payloadIndex++] = i;
rgrover1 171:6092e61690dc 339 ++encodedBytes;
rgrover1 171:6092e61690dc 340 urldata += suffixLen;
rgrover1 171:6092e61690dc 341 sizeofURLData -= suffixLen;
rgrover1 171:6092e61690dc 342 break; /* from the for loop for checking against suffixes */
rgrover1 171:6092e61690dc 343 }
rgrover1 171:6092e61690dc 344 }
rgrover1 171:6092e61690dc 345 /* This is the default case where we've got an ordinary character which doesn't match a suffix. */
rgrover1 171:6092e61690dc 346 if (i == NUM_SUFFIXES) {
rgrover1 171:6092e61690dc 347 serviceDataPayload[payloadIndex++] = *urldata;
rgrover1 171:6092e61690dc 348 ++encodedBytes;
rgrover1 171:6092e61690dc 349 ++urldata;
rgrover1 171:6092e61690dc 350 --sizeofURLData;
rgrover1 171:6092e61690dc 351 }
rgrover1 171:6092e61690dc 352 }
rgrover1 192:3fd3dcf49005 353 if (sizeofURLData == 0) {
rgrover1 192:3fd3dcf49005 354 initSucceeded = true;
rgrover1 182:d16f8c11816b 355 }
rgrover1 171:6092e61690dc 356
rgrover1 171:6092e61690dc 357 return encodedBytes;
rgrover1 171:6092e61690dc 358 }
rgrover1 171:6092e61690dc 359
mbedAustin 232:4cfb5b8a4fb9 360 /*
rgrover1 242:0e9201b67e2f 361 * This callback is invoked when a GATT client attempts to modify any of the
rgrover1 250:6862d374e613 362 * characteristics of this service. Attempts to do so are also applied to
rgrover1 250:6862d374e613 363 * the internal state of this service object.
rgrover1 242:0e9201b67e2f 364 */
rgrover1 203:7b5178d2fa03 365 void onDataWritten(const GattCharacteristicWriteCBParams *params) {
rgrover1 228:db043dbf26f8 366 uint16_t handle = params->charHandle;
rgrover1 268:bc525cdc88f7 367 if (handle == lockChar.getValueHandle()) {
rgrover1 271:7f2465b7978e 368 updateLockBits(params->data);
rgrover1 271:7f2465b7978e 369 storage_saveLockBits();
rgrover1 268:bc525cdc88f7 370 } else if (handle == unlockChar.getValueHandle()) {
rgrover1 268:bc525cdc88f7 371 memset(lockBits, 0, SIZEOF_LOCK_BITS);
rgrover1 268:bc525cdc88f7 372 lockedState = false;
rgrover1 269:d818d11dca4e 373
rgrover1 269:d818d11dca4e 374 storage_saveLockBits();
rgrover1 268:bc525cdc88f7 375 } else if (handle == uriDataChar.getValueHandle()) {
rgrover1 185:7cd70497aec8 376 uriDataLength = params->len;
rgrover1 187:057c547facd2 377 memcpy(uriData, params->data, uriDataLength);
rgrover1 229:6664b6c0e92b 378 } else if (handle == flagsChar.getValueHandle()) {
rgrover1 250:6862d374e613 379 flags = *(params->data);
rgrover1 229:6664b6c0e92b 380 } else if (handle == txPowerLevelsChar.getValueHandle()) {
rgrover1 250:6862d374e613 381 memcpy(powerLevels, params->data, NUM_POWER_MODES * sizeof(int8_t));
rgrover1 229:6664b6c0e92b 382 } else if (handle == txPowerModeChar.getValueHandle()) {
rgrover1 250:6862d374e613 383 txPowerMode = *reinterpret_cast<const TXPowerModes_t *>(params->data);
rgrover1 229:6664b6c0e92b 384 } else if (handle == beaconPeriodChar.getValueHandle()) {
rgrover1 250:6862d374e613 385 beaconPeriod = *((uint16_t *)(params->data));
rgrover1 229:6664b6c0e92b 386 } else if (handle == resetChar.getValueHandle()) {
rgrover1 200:80dd3e50705c 387 resetDefaults();
rgrover1 185:7cd70497aec8 388 }
rgrover1 210:0c14030d1bd0 389 configureGAP();
rgrover1 185:7cd70497aec8 390 ble.setAdvertisingPayload();
rgrover1 185:7cd70497aec8 391 }
rgrover1 185:7cd70497aec8 392
mbedAustin 232:4cfb5b8a4fb9 393 /*
rgrover1 251:6ce809c972bb 394 * Reset the default values.
rgrover1 242:0e9201b67e2f 395 */
rgrover1 200:80dd3e50705c 396 void resetDefaults(void) {
rgrover1 216:3f5e47361919 397 lockedState = false;
rgrover1 268:bc525cdc88f7 398 memset(lockBits, 0, SIZEOF_LOCK_BITS);
rgrover1 212:852d45a52016 399 uriDataLength = 0;
rgrover1 216:3f5e47361919 400 memset(uriData, 0, MAX_SIZE_URI_DATA_CHAR_VALUE);
rgrover1 212:852d45a52016 401 flags = 0;
rgrover1 216:3f5e47361919 402 memset(powerLevels, 0, sizeof(powerLevels));
rgrover1 218:8ae02569fab9 403 txPowerMode = TX_POWER_MODE_LOW;
rgrover1 212:852d45a52016 404 beaconPeriod = 0;
rgrover1 189:a23091b54ab5 405
rgrover1 269:d818d11dca4e 406 if (storage_haveSavedLockBits()) {
rgrover1 269:d818d11dca4e 407 storage_saveLockBits();
rgrover1 269:d818d11dca4e 408 }
rgrover1 269:d818d11dca4e 409
rgrover1 211:f181effe5de3 410 updateGATT();
rgrover1 211:f181effe5de3 411 }
rgrover1 211:f181effe5de3 412
mbedAustin 232:4cfb5b8a4fb9 413 /*
rgrover1 242:0e9201b67e2f 414 * Internal helper function used to update the GATT database following any
rgrover1 242:0e9201b67e2f 415 * change to the internal state of the service object.
rgrover1 242:0e9201b67e2f 416 */
rgrover1 211:f181effe5de3 417 void updateGATT(void) {
rgrover1 214:7d79fa197212 418 updateLockedStateCharacteristic();
rgrover1 211:f181effe5de3 419 updateURIDataCharacteristic();
rgrover1 211:f181effe5de3 420 updateFlagsCharacteristic();
rgrover1 211:f181effe5de3 421 updateBeaconPeriodCharacteristic();
rgrover1 220:e75e8ba1ff80 422 updateTxPowerLevelsCharacteristic();
rgrover1 220:e75e8ba1ff80 423 updateTxPowerModeCharacteristic();
rgrover1 211:f181effe5de3 424 }
rgrover1 211:f181effe5de3 425
rgrover1 214:7d79fa197212 426 void updateLockedStateCharacteristic(void) {
rgrover1 229:6664b6c0e92b 427 ble.updateCharacteristicValue(lockedStateChar.getValueHandle(), reinterpret_cast<uint8_t *>(&lockedState), sizeof(lockedState));
rgrover1 214:7d79fa197212 428 }
rgrover1 214:7d79fa197212 429
rgrover1 211:f181effe5de3 430 void updateURIDataCharacteristic(void) {
rgrover1 229:6664b6c0e92b 431 ble.updateCharacteristicValue(uriDataChar.getValueHandle(), uriData, uriDataLength);
rgrover1 211:f181effe5de3 432 }
rgrover1 211:f181effe5de3 433
rgrover1 211:f181effe5de3 434 void updateFlagsCharacteristic(void) {
rgrover1 229:6664b6c0e92b 435 ble.updateCharacteristicValue(flagsChar.getValueHandle(), &flags, 1 /* size */);
rgrover1 211:f181effe5de3 436 }
rgrover1 211:f181effe5de3 437
rgrover1 211:f181effe5de3 438 void updateBeaconPeriodCharacteristic(void) {
rgrover1 229:6664b6c0e92b 439 ble.updateCharacteristicValue(beaconPeriodChar.getValueHandle(), reinterpret_cast<uint8_t *>(&beaconPeriod), sizeof(uint16_t));
rgrover1 189:a23091b54ab5 440 }
rgrover1 189:a23091b54ab5 441
rgrover1 218:8ae02569fab9 442 void updateTxPowerModeCharacteristic(void) {
rgrover1 229:6664b6c0e92b 443 ble.updateCharacteristicValue(txPowerModeChar.getValueHandle(), reinterpret_cast<uint8_t *>(&txPowerMode), sizeof(uint8_t));
rgrover1 218:8ae02569fab9 444 }
rgrover1 218:8ae02569fab9 445
rgrover1 218:8ae02569fab9 446 void updateTxPowerLevelsCharacteristic(void) {
rgrover1 242:0e9201b67e2f 447 ble.updateCharacteristicValue(txPowerLevelsChar.getValueHandle(), reinterpret_cast<uint8_t *>(powerLevels), NUM_POWER_MODES * sizeof(int8_t));
rgrover1 218:8ae02569fab9 448 }
rgrover1 218:8ae02569fab9 449
rgrover1 242:0e9201b67e2f 450 private:
rgrover1 268:bc525cdc88f7 451 void lockedStateAuthorizationCallback(GattCharacteristicReadAuthCBParams *params) {
rgrover1 268:bc525cdc88f7 452 printf("read authorization callback: lockedState is %u\r\n", lockedState);
rgrover1 268:bc525cdc88f7 453 params->authorizationReply = true;
rgrover1 268:bc525cdc88f7 454 }
rgrover1 268:bc525cdc88f7 455
rgrover1 268:bc525cdc88f7 456 void lockAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 268:bc525cdc88f7 457 params->authorizationReply = !lockedState;
rgrover1 268:bc525cdc88f7 458 }
rgrover1 268:bc525cdc88f7 459
rgrover1 268:bc525cdc88f7 460 void unlockAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 268:bc525cdc88f7 461 if (lockedState && (memcmp(params->data, lockBits, SIZEOF_LOCK_BITS) == 0)) {
rgrover1 268:bc525cdc88f7 462 params->authorizationReply = true;
rgrover1 268:bc525cdc88f7 463 } else {
rgrover1 268:bc525cdc88f7 464 params->authorizationReply = false;
rgrover1 268:bc525cdc88f7 465 }
rgrover1 268:bc525cdc88f7 466 }
rgrover1 268:bc525cdc88f7 467
rgrover1 250:6862d374e613 468 void uriDataWriteAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 250:6862d374e613 469 if (lockedState || (params->offset != 0) || (params->len > MAX_SIZE_URI_DATA_CHAR_VALUE)) {
rgrover1 250:6862d374e613 470 params->authorizationReply = false;
rgrover1 250:6862d374e613 471 }
rgrover1 250:6862d374e613 472 }
rgrover1 250:6862d374e613 473
rgrover1 255:cdb7231f83df 474 void flagsAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 250:6862d374e613 475 if (lockedState || ((*(params->data) & 0xFE) != 0)) {
rgrover1 250:6862d374e613 476 params->authorizationReply = false;
rgrover1 250:6862d374e613 477 }
rgrover1 250:6862d374e613 478 }
rgrover1 250:6862d374e613 479
rgrover1 256:a6e651374060 480 void powerModeAuthorizationCallback(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 256:a6e651374060 481 if (lockedState || (*(params->data) >= NUM_POWER_MODES)) {
rgrover1 256:a6e651374060 482 params->authorizationReply = false;
rgrover1 256:a6e651374060 483 }
rgrover1 256:a6e651374060 484 }
rgrover1 256:a6e651374060 485
rgrover1 250:6862d374e613 486 void denyGATTWritesIfLocked(GattCharacteristicWriteAuthCBParams *params) {
rgrover1 250:6862d374e613 487 if (lockedState) {
rgrover1 250:6862d374e613 488 params->authorizationReply = false;
rgrover1 250:6862d374e613 489 }
rgrover1 250:6862d374e613 490 }
rgrover1 250:6862d374e613 491
rgrover1 250:6862d374e613 492 private:
mbedAustin 233:4d570d99b8cb 493 /**
rgrover1 242:0e9201b67e2f 494 * For debugging only. Print Hex representation of ServiceDataPayload to the console.
rgrover1 185:7cd70497aec8 495 */
rgrover1 185:7cd70497aec8 496 void dumpEncodedSeviceData() const {
rgrover1 185:7cd70497aec8 497 printf("encoded: '");
rgrover1 185:7cd70497aec8 498 for (unsigned i = 0; i < payloadIndex; i++) {
rgrover1 185:7cd70497aec8 499 printf(" %02x", serviceDataPayload[i]);
rgrover1 185:7cd70497aec8 500 }
rgrover1 185:7cd70497aec8 501 printf("'\r\n");
rgrover1 185:7cd70497aec8 502 }
rgrover1 185:7cd70497aec8 503
rgrover1 171:6092e61690dc 504 private:
rgrover1 254:fb2a891a0d98 505 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 506 * together with the 4-byte header, the service data must
rgrover1 254:fb2a891a0d98 507 * fit within 22 bytes. */
rgrover1 204:479f81fd5d3b 508 static const size_t MAX_SIZE_URI_DATA_CHAR_VALUE = 48; /* This is chosen arbitrarily. It should be large enough
rgrover1 204:479f81fd5d3b 509 * to hold any reasonable uncompressed URI. */
rgrover1 171:6092e61690dc 510 private:
rgrover1 206:49646c933822 511 BLEDevice &ble;
rgrover1 171:6092e61690dc 512
rgrover1 206:49646c933822 513 size_t payloadIndex;
rgrover1 206:49646c933822 514 uint8_t serviceDataPayload[MAX_SIZEOF_SERVICE_DATA_PAYLOAD];
rgrover1 206:49646c933822 515 bool initSucceeded;
rgrover1 182:d16f8c11816b 516
rgrover1 206:49646c933822 517 bool lockedState;
rgrover1 271:7f2465b7978e 518 uint8_t lockBits[SIZEOF_LOCK_BITS];
rgrover1 271:7f2465b7978e 519
rgrover1 206:49646c933822 520 uint16_t uriDataLength;
rgrover1 206:49646c933822 521 uint8_t uriData[MAX_SIZE_URI_DATA_CHAR_VALUE];
rgrover1 206:49646c933822 522 uint8_t flags;
rgrover1 206:49646c933822 523 int8_t powerLevels[NUM_POWER_MODES];
rgrover1 218:8ae02569fab9 524 TXPowerModes_t txPowerMode;
rgrover1 206:49646c933822 525 uint16_t beaconPeriod;
rgrover1 206:49646c933822 526 bool resetFlag;
rgrover1 171:6092e61690dc 527
rgrover1 206:49646c933822 528 GattCharacteristic lockedStateChar;
rgrover1 268:bc525cdc88f7 529 GattCharacteristic lockChar;
rgrover1 268:bc525cdc88f7 530 GattCharacteristic unlockChar;
rgrover1 206:49646c933822 531 GattCharacteristic uriDataChar;
rgrover1 206:49646c933822 532 GattCharacteristic flagsChar;
rgrover1 206:49646c933822 533 GattCharacteristic txPowerLevelsChar;
rgrover1 218:8ae02569fab9 534 GattCharacteristic txPowerModeChar;
rgrover1 206:49646c933822 535 GattCharacteristic beaconPeriodChar;
rgrover1 206:49646c933822 536 GattCharacteristic resetChar;
rgrover1 171:6092e61690dc 537 };
rgrover1 171:6092e61690dc 538
rgrover1 207:e88130dc254c 539 #endif /* #ifndef __BLE_URI_BEACON_CONFIG_SERVICE_H__*/