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@268:bc525cdc88f7, 2015-01-21 (annotated)

Committer:
rgrover1
Date:
Wed Jan 21 09:32:51 2015 +0000
Revision:
268:bc525cdc88f7
Parent:
256:a6e651374060
Child:
269:d818d11dca4e
Synchronized with git rev a367cf0f

Author: Rohit Grover

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