Bill Schilit / BLE_API

Improve readability with getHandle inline

Fork of BLE_API by Bluetooth Low Energy

services/URIBeacon2Service.h@191:6710298104b0, 2014-11-28 (annotated)

Committer:
rgrover1
Date:
Fri Nov 28 14:11:24 2014 +0000
Revision:
191:6710298104b0
Parent:
190:ad1ed2b5ea52
Child:
192:3fd3dcf49005
Synchronized with git rev 1a0593dc

Author: Rohit Grover

switch to useTxPowerLevel()

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