Bill Schilit / BLE_API

Improve readability with getHandle inline

Fork of BLE_API by Bluetooth Low Energy

services/URIBeaconConfigService.h@235:4d570d99b8cb, 2014-12-08 (annotated)

Committer:
mbedAustin
Date:
Mon Dec 08 19:24:29 2014 +0000
Revision:
235:4d570d99b8cb
Parent:
234:4cfb5b8a4fb9
Child:
241:58642869879c
Added documentation to UARTService.h

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