Austin Blackstone / BLE_API

Fixes to BLE_API for mbedOS Alpha1 release. Mostly relating to doxygen fixes.

Fork of BLE_API by Bluetooth Low Energy

services/URIBeaconConfigService.h@219:5603d539120c, 2014-12-01 (annotated)

Committer:
rgrover1
Date:
Mon Dec 01 14:31:19 2014 +0000
Revision:
219:5603d539120c
Parent:
218:8ae02569fab9
Child:
220:e75e8ba1ff80
Synchronized with git rev 78696699

Author: Rohit Grover

add API to setup TxPowerLevels

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