Microbug / BLE_API_FOTA

Lightly modified version of the BLE stack, that doesn't bring up a DFUService by default... as we have our own.

Fork of BLE_API by Bluetooth Low Energy

services/URIBeaconConfigService.h@242:0e9201b67e2f, 2014-12-09 (annotated)

Committer:
rgrover1
Date:
Tue Dec 09 08:18:11 2014 +0000
Revision:
242:0e9201b67e2f
Parent:
240:20df772f2374
Child:
250:6862d374e613
Synchronized with git rev c7eb83db

Author: Rohit Grover

minor white space diffs and fixes for typos.

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