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@231:1c4a4fd961a5, 2014-12-08 (annotated)

Committer:
mbedAustin
Date:
Mon Dec 08 17:28:46 2014 +0000
Revision:
231:1c4a4fd961a5
Parent:
229:6664b6c0e92b
Child:
232:4cfb5b8a4fb9
Fixed UriBeacon Config Service Doxygen Comments

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