Sam Musso / BLE_API

I don't know why this is happening.

Fork of BLE_API by Bluetooth Low Energy

services/URIBeaconConfigService.h@215:f9d0169b9c28, 2014-12-01 (annotated)

Committer:
rgrover1
Date:
Mon Dec 01 14:31:19 2014 +0000
Revision:
215:f9d0169b9c28
Parent:
214:7d79fa197212
Child:
216:3f5e47361919
Synchronized with git rev 8491673e

Author: Rohit Grover

fixed characteristic properties to match spec.

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 206:49646c933822 22 #define UUID_INITIALIZER_LIST(FIRST, SECOND) { \
rgrover1 206:49646c933822 23 0xee, 0x0c, FIRST, SECOND, 0x87, 0x86, 0x40, 0xba, \
rgrover1 206:49646c933822 24 0xab, 0x96, 0x99, 0xb9, 0x1a, 0xc9, 0x81, 0xd8, \
rgrover1 171:6092e61690dc 25 }
rgrover1 171:6092e61690dc 26 const uint8_t URIBeacon2ControlServiceUUID[] = UUID_INITIALIZER_LIST(0x20, 0x80);
rgrover1 171:6092e61690dc 27 const uint8_t lockedStateCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x81);
rgrover1 171:6092e61690dc 28 const uint8_t uriDataCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x84);
rgrover1 171:6092e61690dc 29 const uint8_t flagsCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x85);
rgrover1 178:b6d6a2a11e86 30 const uint8_t txPowerLevelsCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x86);
rgrover1 171:6092e61690dc 31 const uint8_t beaconPeriodCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x88);
rgrover1 189:a23091b54ab5 32 const uint8_t resetCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x89);
rgrover1 171:6092e61690dc 33
rgrover1 207:e88130dc254c 34 class URIBeaconConfigService {
rgrover1 180:afcd2f9c2ada 35 public:
rgrover1 175:4e85f7225f8f 36 enum TXPowerModes_t {
rgrover1 175:4e85f7225f8f 37 TX_POWER_MODE_LOWEST = 0,
rgrover1 175:4e85f7225f8f 38 TX_POWER_MODE_LOW = 1,
rgrover1 175:4e85f7225f8f 39 TX_POWER_MODE_MEDIUM = 2,
rgrover1 175:4e85f7225f8f 40 TX_POWER_MODE_HIGH = 3,
rgrover1 177:17f4b5924fe9 41 NUM_POWER_MODES
rgrover1 175:4e85f7225f8f 42 };
rgrover1 175:4e85f7225f8f 43
rgrover1 181:bbb6ce1082c3 44 /**
rgrover1 181:bbb6ce1082c3 45 * @param[ref] ble
rgrover1 181:bbb6ce1082c3 46 * BLEDevice object for the underlying controller.
rgrover1 208:88a3a58769bf 47 * @param[in] uridata
rgrover1 181:bbb6ce1082c3 48 * URI as a null-terminated string.
rgrover1 181:bbb6ce1082c3 49 * @param[in] flagsIn
rgrover1 181:bbb6ce1082c3 50 * UriBeacon Flags.
rgrover1 181:bbb6ce1082c3 51 * @param[in] effectiveTxPowerIn
rgrover1 181:bbb6ce1082c3 52 * UriBeacon Tx Power Level in dBm.
rgrover1 181:bbb6ce1082c3 53 * @param[in] beaconPeriodIn
rgrover1 181:bbb6ce1082c3 54 * The period in milliseconds that a UriBeacon packet is
rgrover1 181:bbb6ce1082c3 55 * transmitted. A value of zero disables UriBeacon
rgrover1 181:bbb6ce1082c3 56 * transmissions.
rgrover1 181:bbb6ce1082c3 57 */
rgrover1 207:e88130dc254c 58 URIBeaconConfigService(BLEDevice &bleIn, const char *uriDataIn, uint8_t flagsIn = 0, int8_t effectiveTxPowerIn = 0, uint16_t beaconPeriodIn = 1000) :
rgrover1 192:3fd3dcf49005 59 ble(bleIn),
rgrover1 192:3fd3dcf49005 60 payloadIndex(0),
rgrover1 192:3fd3dcf49005 61 serviceDataPayload(),
rgrover1 192:3fd3dcf49005 62 initSucceeded(false),
rgrover1 192:3fd3dcf49005 63 lockedState(false),
rgrover1 192:3fd3dcf49005 64 uriDataLength(0),
rgrover1 192:3fd3dcf49005 65 uriData(),
rgrover1 192:3fd3dcf49005 66 flags(flagsIn),
rgrover1 200:80dd3e50705c 67 effectiveTxPower(effectiveTxPowerIn),
rgrover1 192:3fd3dcf49005 68 powerLevels(),
rgrover1 201:9bb7b3f45c20 69 beaconPeriod(beaconPeriodIn),
rgrover1 192:3fd3dcf49005 70 lockedStateChar(lockedStateCharUUID, reinterpret_cast<uint8_t *>(&lockedState), 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 215:f9d0169b9c28 71 uriDataChar(uriDataCharUUID, uriData, MAX_SIZE_URI_DATA_CHAR_VALUE, MAX_SIZE_URI_DATA_CHAR_VALUE,
rgrover1 215:f9d0169b9c28 72 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ |GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 192:3fd3dcf49005 73 flagsChar(flagsCharUUID, &flags, 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 192:3fd3dcf49005 74 txPowerLevelsChar(txPowerLevelsCharUUID,
rgrover1 192:3fd3dcf49005 75 reinterpret_cast<uint8_t *>(powerLevels),
rgrover1 192:3fd3dcf49005 76 NUM_POWER_MODES * sizeof(int8_t),
rgrover1 192:3fd3dcf49005 77 NUM_POWER_MODES * sizeof(int8_t),
rgrover1 192:3fd3dcf49005 78 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 192:3fd3dcf49005 79 beaconPeriodChar(beaconPeriodCharUUID, reinterpret_cast<uint8_t *>(&beaconPeriod), 2, 2,
rgrover1 192:3fd3dcf49005 80 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 215:f9d0169b9c28 81 resetChar(resetCharUUID, reinterpret_cast<uint8_t *>(&resetFlag), 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE)
rgrover1 192:3fd3dcf49005 82 {
rgrover1 194:669eced4cd5e 83 if ((uriDataIn == NULL) || ((uriDataLength = strlen(uriDataIn)) == 0) || (uriDataLength > MAX_SIZE_URI_DATA_CHAR_VALUE)) {
rgrover1 192:3fd3dcf49005 84 return;
rgrover1 192:3fd3dcf49005 85 }
rgrover1 194:669eced4cd5e 86 strcpy(reinterpret_cast<char *>(uriData), uriDataIn);
rgrover1 192:3fd3dcf49005 87
rgrover1 210:0c14030d1bd0 88 configureGAP();
rgrover1 171:6092e61690dc 89
rgrover1 192:3fd3dcf49005 90 GattCharacteristic *charTable[] = {&lockedStateChar, &uriDataChar, &flagsChar, &txPowerLevelsChar, &beaconPeriodChar, &resetChar};
rgrover1 192:3fd3dcf49005 91 GattService beaconControlService(URIBeacon2ControlServiceUUID, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 182:d16f8c11816b 92
rgrover1 192:3fd3dcf49005 93 ble.addService(beaconControlService);
rgrover1 207:e88130dc254c 94 ble.onDataWritten(this, &URIBeaconConfigService::onDataWritten);
rgrover1 192:3fd3dcf49005 95 }
rgrover1 192:3fd3dcf49005 96
rgrover1 193:ac2feceb7e87 97 bool configuredSuccessfully(void) const {
rgrover1 192:3fd3dcf49005 98 return initSucceeded;
rgrover1 171:6092e61690dc 99 }
rgrover1 171:6092e61690dc 100
rgrover1 173:05c4b1cea65f 101 /**
rgrover1 196:febbd68b1095 102 * Please note that the following public APIs are offered to allow modifying
rgrover1 196:febbd68b1095 103 * the service programmatically. It is also possible to do so over BLE GATT
rgrover1 196:febbd68b1095 104 * transactions.
rgrover1 196:febbd68b1095 105 */
rgrover1 196:febbd68b1095 106 public:
rgrover1 196:febbd68b1095 107 /**
rgrover1 173:05c4b1cea65f 108 * Update flags of the URIBeacon dynamically.
rgrover1 173:05c4b1cea65f 109 *
rgrover1 173:05c4b1cea65f 110 * @param[in] flagsIn
rgrover1 173:05c4b1cea65f 111 *
rgrover1 173:05c4b1cea65f 112 * ### UriBeacon Flags
rgrover1 173:05c4b1cea65f 113 * Bit | Description
rgrover1 173:05c4b1cea65f 114 * :---- | :----------
rgrover1 173:05c4b1cea65f 115 * 0 | Invisible Hint
rgrover1 173:05c4b1cea65f 116 * 1..7 | Reserved for future use. Must be zero.
rgrover1 173:05c4b1cea65f 117 *
rgrover1 173:05c4b1cea65f 118 * The `Invisible Hint` flag is a command for the user-agent that tells
rgrover1 173:05c4b1cea65f 119 * it not to access or display the UriBeacon. This is a guideline only,
rgrover1 173:05c4b1cea65f 120 * and is not a blocking method. User agents may, with user approval,
rgrover1 173:05c4b1cea65f 121 * display invisible beacons.
rgrover1 173:05c4b1cea65f 122 */
rgrover1 171:6092e61690dc 123 void setFlags(uint8_t flagsIn) {
rgrover1 171:6092e61690dc 124 flags = flagsIn;
rgrover1 210:0c14030d1bd0 125 configureGAP();
rgrover1 211:f181effe5de3 126 updateFlagsCharacteristic();
rgrover1 171:6092e61690dc 127 }
rgrover1 171:6092e61690dc 128
rgrover1 177:17f4b5924fe9 129 /**
rgrover1 177:17f4b5924fe9 130 * Update the txPower for a particular mode in the powerLevels table.
rgrover1 177:17f4b5924fe9 131 */
rgrover1 177:17f4b5924fe9 132 void setTxPowerLevel(TXPowerModes_t mode, int8_t txPowerIn) {
rgrover1 177:17f4b5924fe9 133 powerLevels[mode] = txPowerIn;
rgrover1 177:17f4b5924fe9 134 }
rgrover1 177:17f4b5924fe9 135
rgrover1 177:17f4b5924fe9 136 /**
rgrover1 177:17f4b5924fe9 137 * Set the effective power mode from one of the values in the powerLevels tables.
rgrover1 177:17f4b5924fe9 138 */
rgrover1 191:6710298104b0 139 void useTxPowerMode(TXPowerModes_t mode) {
rgrover1 200:80dd3e50705c 140 effectiveTxPower = powerLevels[mode];
rgrover1 210:0c14030d1bd0 141 configureGAP();
rgrover1 171:6092e61690dc 142 }
rgrover1 171:6092e61690dc 143
rgrover1 183:41d6ffadba96 144 /**
rgrover1 183:41d6ffadba96 145 * The period in milliseconds that a UriBeacon packet is transmitted.
rgrover1 183:41d6ffadba96 146 *
rgrover1 183:41d6ffadba96 147 * @Note: A value of zero disables UriBeacon transmissions.
rgrover1 183:41d6ffadba96 148 */
rgrover1 171:6092e61690dc 149 void setBeaconPeriod(uint16_t beaconPeriodIn) {
rgrover1 171:6092e61690dc 150 beaconPeriod = beaconPeriodIn;
rgrover1 210:0c14030d1bd0 151 configureGAP();
rgrover1 211:f181effe5de3 152 updateBeaconPeriodCharacteristic();
rgrover1 171:6092e61690dc 153 }
rgrover1 171:6092e61690dc 154
rgrover1 196:febbd68b1095 155 private:
rgrover1 186:ce34008cea95 156 /**
rgrover1 186:ce34008cea95 157 * Setup the advertisement payload and GAP settings.
rgrover1 186:ce34008cea95 158 */
rgrover1 210:0c14030d1bd0 159 void configureGAP(void) {
rgrover1 171:6092e61690dc 160 const uint8_t BEACON_UUID[] = {0xD8, 0xFE};
rgrover1 171:6092e61690dc 161
rgrover1 206:49646c933822 162 payloadIndex = 0;
rgrover1 171:6092e61690dc 163 serviceDataPayload[payloadIndex++] = BEACON_UUID[0];
rgrover1 171:6092e61690dc 164 serviceDataPayload[payloadIndex++] = BEACON_UUID[1];
rgrover1 171:6092e61690dc 165 serviceDataPayload[payloadIndex++] = flags;
rgrover1 200:80dd3e50705c 166 serviceDataPayload[payloadIndex++] = effectiveTxPower;
rgrover1 171:6092e61690dc 167
rgrover1 206:49646c933822 168 const char *urlData = reinterpret_cast<char *>(uriData);
rgrover1 206:49646c933822 169 size_t sizeofURLData = uriDataLength;
rgrover1 206:49646c933822 170 size_t encodedBytes = encodeURISchemePrefix(urlData, sizeofURLData) + encodeURI(urlData, sizeofURLData);
rgrover1 171:6092e61690dc 171
rgrover1 171:6092e61690dc 172 ble.clearAdvertisingPayload();
rgrover1 171:6092e61690dc 173 ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, BEACON_UUID, sizeof(BEACON_UUID));
rgrover1 171:6092e61690dc 174 ble.accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceDataPayload, encodedBytes + 4);
rgrover1 171:6092e61690dc 175
rgrover1 201:9bb7b3f45c20 176 ble.setAdvertisingInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(beaconPeriod));
rgrover1 200:80dd3e50705c 177 ble.setTxPower(effectiveTxPower);
rgrover1 171:6092e61690dc 178 }
rgrover1 171:6092e61690dc 179
rgrover1 171:6092e61690dc 180 size_t encodeURISchemePrefix(const char *&urldata, size_t &sizeofURLData) {
rgrover1 213:ac3b745af1d0 181 if (!sizeofURLData) {
rgrover1 213:ac3b745af1d0 182 return 0;
rgrover1 213:ac3b745af1d0 183 }
rgrover1 213:ac3b745af1d0 184
rgrover1 171:6092e61690dc 185 const char *prefixes[] = {
rgrover1 171:6092e61690dc 186 "http://www.",
rgrover1 171:6092e61690dc 187 "https://www.",
rgrover1 171:6092e61690dc 188 "http://",
rgrover1 171:6092e61690dc 189 "https://",
rgrover1 171:6092e61690dc 190 "urn:uuid:"
rgrover1 171:6092e61690dc 191 };
rgrover1 171:6092e61690dc 192
rgrover1 206:49646c933822 193 size_t encodedBytes = 0;
rgrover1 171:6092e61690dc 194 const size_t NUM_PREFIXES = sizeof(prefixes) / sizeof(char *);
rgrover1 171:6092e61690dc 195 for (unsigned i = 0; i < NUM_PREFIXES; i++) {
rgrover1 171:6092e61690dc 196 size_t prefixLen = strlen(prefixes[i]);
rgrover1 171:6092e61690dc 197 if (strncmp(urldata, prefixes[i], prefixLen) == 0) {
rgrover1 171:6092e61690dc 198 serviceDataPayload[payloadIndex++] = i;
rgrover1 206:49646c933822 199 encodedBytes = 1;
rgrover1 171:6092e61690dc 200
rgrover1 206:49646c933822 201 urldata += prefixLen;
rgrover1 171:6092e61690dc 202 sizeofURLData -= prefixLen;
rgrover1 171:6092e61690dc 203 break;
rgrover1 171:6092e61690dc 204 }
rgrover1 171:6092e61690dc 205 }
rgrover1 171:6092e61690dc 206
rgrover1 171:6092e61690dc 207 return encodedBytes;
rgrover1 171:6092e61690dc 208 }
rgrover1 171:6092e61690dc 209
rgrover1 171:6092e61690dc 210 size_t encodeURI(const char *urldata, size_t sizeofURLData) {
rgrover1 171:6092e61690dc 211 const char *suffixes[] = {
rgrover1 171:6092e61690dc 212 ".com/",
rgrover1 171:6092e61690dc 213 ".org/",
rgrover1 171:6092e61690dc 214 ".edu/",
rgrover1 171:6092e61690dc 215 ".net/",
rgrover1 171:6092e61690dc 216 ".info/",
rgrover1 171:6092e61690dc 217 ".biz/",
rgrover1 171:6092e61690dc 218 ".gov/",
rgrover1 171:6092e61690dc 219 ".com",
rgrover1 171:6092e61690dc 220 ".org",
rgrover1 171:6092e61690dc 221 ".edu",
rgrover1 171:6092e61690dc 222 ".net",
rgrover1 171:6092e61690dc 223 ".info",
rgrover1 171:6092e61690dc 224 ".biz",
rgrover1 171:6092e61690dc 225 ".gov"
rgrover1 171:6092e61690dc 226 };
rgrover1 171:6092e61690dc 227 const size_t NUM_SUFFIXES = sizeof(suffixes) / sizeof(char *);
rgrover1 171:6092e61690dc 228
rgrover1 171:6092e61690dc 229 size_t encodedBytes = 0;
rgrover1 171:6092e61690dc 230 while (sizeofURLData && (payloadIndex < MAX_SIZEOF_SERVICE_DATA_PAYLOAD)) {
rgrover1 171:6092e61690dc 231 /* check for suffix match */
rgrover1 171:6092e61690dc 232 unsigned i;
rgrover1 171:6092e61690dc 233 for (i = 0; i < NUM_SUFFIXES; i++) {
rgrover1 171:6092e61690dc 234 size_t suffixLen = strlen(suffixes[i]);
rgrover1 171:6092e61690dc 235 if ((suffixLen == 0) || (sizeofURLData < suffixLen)) {
rgrover1 171:6092e61690dc 236 continue;
rgrover1 171:6092e61690dc 237 }
rgrover1 171:6092e61690dc 238
rgrover1 171:6092e61690dc 239 if (strncmp(urldata, suffixes[i], suffixLen) == 0) {
rgrover1 171:6092e61690dc 240 serviceDataPayload[payloadIndex++] = i;
rgrover1 171:6092e61690dc 241 ++encodedBytes;
rgrover1 171:6092e61690dc 242 urldata += suffixLen;
rgrover1 171:6092e61690dc 243 sizeofURLData -= suffixLen;
rgrover1 171:6092e61690dc 244 break; /* from the for loop for checking against suffixes */
rgrover1 171:6092e61690dc 245 }
rgrover1 171:6092e61690dc 246 }
rgrover1 171:6092e61690dc 247 /* This is the default case where we've got an ordinary character which doesn't match a suffix. */
rgrover1 171:6092e61690dc 248 if (i == NUM_SUFFIXES) {
rgrover1 171:6092e61690dc 249 serviceDataPayload[payloadIndex++] = *urldata;
rgrover1 171:6092e61690dc 250 ++encodedBytes;
rgrover1 171:6092e61690dc 251 ++urldata;
rgrover1 171:6092e61690dc 252 --sizeofURLData;
rgrover1 171:6092e61690dc 253 }
rgrover1 171:6092e61690dc 254 }
rgrover1 192:3fd3dcf49005 255 if (sizeofURLData == 0) {
rgrover1 192:3fd3dcf49005 256 initSucceeded = true;
rgrover1 182:d16f8c11816b 257 }
rgrover1 171:6092e61690dc 258
rgrover1 171:6092e61690dc 259 return encodedBytes;
rgrover1 171:6092e61690dc 260 }
rgrover1 171:6092e61690dc 261
rgrover1 203:7b5178d2fa03 262 void onDataWritten(const GattCharacteristicWriteCBParams *params) {
rgrover1 185:7cd70497aec8 263 if (params->charHandle == uriDataChar.getValueAttribute().getHandle()) {
rgrover1 185:7cd70497aec8 264 if (lockedState) { /* When locked, the device isn't allowed to update the uriData characteristic. */
rgrover1 185:7cd70497aec8 265 /* Restore GATT database with previous value. */
rgrover1 211:f181effe5de3 266 updateURIDataCharacteristic();
rgrover1 185:7cd70497aec8 267 return;
rgrover1 185:7cd70497aec8 268 }
rgrover1 185:7cd70497aec8 269
rgrover1 185:7cd70497aec8 270 /* We don't handle very large writes at the moment. */
rgrover1 185:7cd70497aec8 271 if ((params->offset != 0) || (params->len > MAX_SIZE_URI_DATA_CHAR_VALUE)) {
rgrover1 185:7cd70497aec8 272 return;
rgrover1 185:7cd70497aec8 273 }
rgrover1 185:7cd70497aec8 274
rgrover1 185:7cd70497aec8 275 uriDataLength = params->len;
rgrover1 187:057c547facd2 276 memcpy(uriData, params->data, uriDataLength);
rgrover1 185:7cd70497aec8 277 } else if (params->charHandle == flagsChar.getValueAttribute().getHandle()) {
rgrover1 185:7cd70497aec8 278 if (lockedState) { /* When locked, the device isn't allowed to update the characteristic. */
rgrover1 185:7cd70497aec8 279 /* Restore GATT database with previous value. */
rgrover1 211:f181effe5de3 280 updateFlagsCharacteristic();
rgrover1 185:7cd70497aec8 281 return;
rgrover1 185:7cd70497aec8 282 } else {
rgrover1 185:7cd70497aec8 283 flags = *(params->data);
rgrover1 185:7cd70497aec8 284 }
rgrover1 185:7cd70497aec8 285 } else if (params->charHandle == txPowerLevelsChar.getValueAttribute().getHandle()) {
rgrover1 185:7cd70497aec8 286 if (lockedState) { /* When locked, the device isn't allowed to update the characteristic. */
rgrover1 185:7cd70497aec8 287 /* Restore GATT database with previous value. */
rgrover1 185:7cd70497aec8 288 ble.updateCharacteristicValue(txPowerLevelsChar.getValueAttribute().getHandle(), reinterpret_cast<uint8_t *>(powerLevels), NUM_POWER_MODES * sizeof(int8_t));
rgrover1 185:7cd70497aec8 289 return;
rgrover1 185:7cd70497aec8 290 } else {
rgrover1 185:7cd70497aec8 291 memcpy(powerLevels, params->data, NUM_POWER_MODES * sizeof(int8_t));
rgrover1 185:7cd70497aec8 292 }
rgrover1 185:7cd70497aec8 293 } else if (params->charHandle == beaconPeriodChar.getValueAttribute().getHandle()) {
rgrover1 185:7cd70497aec8 294 if (lockedState) { /* When locked, the device isn't allowed to update the characteristic. */
rgrover1 185:7cd70497aec8 295 /* Restore GATT database with previous value. */
rgrover1 211:f181effe5de3 296 updateBeaconPeriodCharacteristic();
rgrover1 185:7cd70497aec8 297 return;
rgrover1 185:7cd70497aec8 298 } else {
rgrover1 185:7cd70497aec8 299 beaconPeriod = *((uint16_t *)(params->data));
rgrover1 185:7cd70497aec8 300 }
rgrover1 189:a23091b54ab5 301 } else if (params->charHandle == resetChar.getValueAttribute().getHandle()) {
rgrover1 200:80dd3e50705c 302 resetDefaults();
rgrover1 185:7cd70497aec8 303 }
rgrover1 210:0c14030d1bd0 304 configureGAP();
rgrover1 185:7cd70497aec8 305 ble.setAdvertisingPayload();
rgrover1 185:7cd70497aec8 306 }
rgrover1 185:7cd70497aec8 307
rgrover1 200:80dd3e50705c 308 void resetDefaults(void) {
rgrover1 212:852d45a52016 309 memset(uriData, 0, MAX_SIZE_URI_DATA_CHAR_VALUE);
rgrover1 212:852d45a52016 310 uriDataLength = 0;
rgrover1 189:a23091b54ab5 311 memset(powerLevels, 0, sizeof(powerLevels));
rgrover1 212:852d45a52016 312 flags = 0;
rgrover1 212:852d45a52016 313 effectiveTxPower = 0;
rgrover1 212:852d45a52016 314 beaconPeriod = 0;
rgrover1 214:7d79fa197212 315 lockedState = false;
rgrover1 189:a23091b54ab5 316
rgrover1 211:f181effe5de3 317 updateGATT();
rgrover1 211:f181effe5de3 318 }
rgrover1 211:f181effe5de3 319
rgrover1 211:f181effe5de3 320 void updateGATT(void) {
rgrover1 214:7d79fa197212 321 updateLockedStateCharacteristic();
rgrover1 211:f181effe5de3 322 updateURIDataCharacteristic();
rgrover1 211:f181effe5de3 323 updateFlagsCharacteristic();
rgrover1 211:f181effe5de3 324 updateBeaconPeriodCharacteristic();
rgrover1 211:f181effe5de3 325 }
rgrover1 211:f181effe5de3 326
rgrover1 214:7d79fa197212 327 void updateLockedStateCharacteristic(void) {
rgrover1 214:7d79fa197212 328 ble.updateCharacteristicValue(lockedStateChar.getValueAttribute().getHandle(), reinterpret_cast<uint8_t *>(&lockedState), sizeof(lockedState));
rgrover1 214:7d79fa197212 329 }
rgrover1 214:7d79fa197212 330
rgrover1 211:f181effe5de3 331 void updateURIDataCharacteristic(void) {
rgrover1 189:a23091b54ab5 332 ble.updateCharacteristicValue(uriDataChar.getValueAttribute().getHandle(), uriData, uriDataLength);
rgrover1 211:f181effe5de3 333 }
rgrover1 211:f181effe5de3 334
rgrover1 211:f181effe5de3 335 void updateFlagsCharacteristic(void) {
rgrover1 189:a23091b54ab5 336 ble.updateCharacteristicValue(flagsChar.getValueAttribute().getHandle(), &flags, 1 /* size */);
rgrover1 211:f181effe5de3 337 }
rgrover1 211:f181effe5de3 338
rgrover1 211:f181effe5de3 339 void updateBeaconPeriodCharacteristic(void) {
rgrover1 189:a23091b54ab5 340 ble.updateCharacteristicValue(beaconPeriodChar.getValueAttribute().getHandle(), reinterpret_cast<uint8_t *>(&beaconPeriod), sizeof(uint16_t));
rgrover1 189:a23091b54ab5 341 }
rgrover1 189:a23091b54ab5 342
rgrover1 185:7cd70497aec8 343 private:
rgrover1 185:7cd70497aec8 344 /**
rgrover1 185:7cd70497aec8 345 * For debugging only.
rgrover1 185:7cd70497aec8 346 */
rgrover1 185:7cd70497aec8 347 void dumpEncodedSeviceData() const {
rgrover1 185:7cd70497aec8 348 printf("encoded: '");
rgrover1 185:7cd70497aec8 349 for (unsigned i = 0; i < payloadIndex; i++) {
rgrover1 185:7cd70497aec8 350 printf(" %02x", serviceDataPayload[i]);
rgrover1 185:7cd70497aec8 351 }
rgrover1 185:7cd70497aec8 352 printf("'\r\n");
rgrover1 185:7cd70497aec8 353 }
rgrover1 185:7cd70497aec8 354
rgrover1 171:6092e61690dc 355 private:
rgrover1 199:6b57874115f6 356 static const size_t MAX_SIZEOF_SERVICE_DATA_PAYLOAD = 18; /* Uri Data must be between 0 and 18 bytes in length. */
rgrover1 204:479f81fd5d3b 357 static const size_t MAX_SIZE_URI_DATA_CHAR_VALUE = 48; /* This is chosen arbitrarily. It should be large enough
rgrover1 204:479f81fd5d3b 358 * to hold any reasonable uncompressed URI. */
rgrover1 171:6092e61690dc 359
rgrover1 171:6092e61690dc 360 private:
rgrover1 206:49646c933822 361 BLEDevice &ble;
rgrover1 171:6092e61690dc 362
rgrover1 206:49646c933822 363 size_t payloadIndex;
rgrover1 206:49646c933822 364 uint8_t serviceDataPayload[MAX_SIZEOF_SERVICE_DATA_PAYLOAD];
rgrover1 206:49646c933822 365 bool initSucceeded;
rgrover1 182:d16f8c11816b 366
rgrover1 206:49646c933822 367 bool lockedState;
rgrover1 206:49646c933822 368 uint16_t uriDataLength;
rgrover1 206:49646c933822 369 uint8_t uriData[MAX_SIZE_URI_DATA_CHAR_VALUE];
rgrover1 206:49646c933822 370 uint8_t flags;
rgrover1 206:49646c933822 371 int8_t effectiveTxPower;
rgrover1 206:49646c933822 372 int8_t powerLevels[NUM_POWER_MODES];
rgrover1 206:49646c933822 373 uint16_t beaconPeriod;
rgrover1 206:49646c933822 374 bool resetFlag;
rgrover1 171:6092e61690dc 375
rgrover1 206:49646c933822 376 GattCharacteristic lockedStateChar;
rgrover1 206:49646c933822 377 GattCharacteristic uriDataChar;
rgrover1 206:49646c933822 378 GattCharacteristic flagsChar;
rgrover1 206:49646c933822 379 GattCharacteristic txPowerLevelsChar;
rgrover1 206:49646c933822 380 GattCharacteristic beaconPeriodChar;
rgrover1 206:49646c933822 381 GattCharacteristic resetChar;
rgrover1 171:6092e61690dc 382 };
rgrover1 171:6092e61690dc 383
rgrover1 207:e88130dc254c 384 #endif /* #ifndef __BLE_URI_BEACON_CONFIG_SERVICE_H__*/