Sam Musso / BLE_API

I don't know why this is happening.

Fork of BLE_API by Bluetooth Low Energy

services/URIBeaconConfigService.h@315:943225af2cf4, 2015-03-13 (annotated)

Committer:
rgrover1
Date:
Fri Mar 13 09:57:57 2015 +0000
Revision:
315:943225af2cf4
Parent:
314:193908f2b13b
Child:
316:98e58b0c4441
Synchronized with git rev 9342504e

Author: Rohit Grover

white space diffs.

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 287:cca148e535b1 17 #ifndef SERVICES_URIBEACONCONFIGSERVICE_H_
rgrover1 287:cca148e535b1 18 #define SERVICES_URIBEACONCONFIGSERVICE_H_
rgrover1 171:6092e61690dc 19
rgrover1 314:193908f2b13b 20 #include "BLEDevice.h"
rgrover1 314:193908f2b13b 21 #include "mbed.h"
rgrover1 314:193908f2b13b 22
rgrover1 311:11417b970b12 23 #define UUID_URI_BEACON(FIRST, SECOND) { \
rgrover1 225:f6cbfd817d16 24 0xee, 0x0c, FIRST, SECOND, 0x87, 0x86, 0x40, 0xba, \
rgrover1 225:f6cbfd817d16 25 0xab, 0x96, 0x99, 0xb9, 0x1a, 0xc9, 0x81, 0xd8, \
rgrover1 171:6092e61690dc 26 }
rgrover1 287:cca148e535b1 27
rgrover1 287:cca148e535b1 28 static const uint8_t UUID_URI_BEACON_SERVICE[] = UUID_URI_BEACON(0x20, 0x80);
rgrover1 287:cca148e535b1 29 static const uint8_t UUID_LOCK_STATE_CHAR[] = UUID_URI_BEACON(0x20, 0x81);
rgrover1 287:cca148e535b1 30 static const uint8_t UUID_LOCK_CHAR[] = UUID_URI_BEACON(0x20, 0x82);
rgrover1 287:cca148e535b1 31 static const uint8_t UUID_UNLOCK_CHAR[] = UUID_URI_BEACON(0x20, 0x83);
rgrover1 287:cca148e535b1 32 static const uint8_t UUID_URI_DATA_CHAR[] = UUID_URI_BEACON(0x20, 0x84);
rgrover1 287:cca148e535b1 33 static const uint8_t UUID_FLAGS_CHAR[] = UUID_URI_BEACON(0x20, 0x85);
rgrover1 287:cca148e535b1 34 static const uint8_t UUID_ADV_POWER_LEVELS_CHAR[] = UUID_URI_BEACON(0x20, 0x86);
rgrover1 287:cca148e535b1 35 static const uint8_t UUID_TX_POWER_MODE_CHAR[] = UUID_URI_BEACON(0x20, 0x87);
rgrover1 287:cca148e535b1 36 static const uint8_t UUID_BEACON_PERIOD_CHAR[] = UUID_URI_BEACON(0x20, 0x88);
rgrover1 287:cca148e535b1 37 static const uint8_t UUID_RESET_CHAR[] = UUID_URI_BEACON(0x20, 0x89);
rgrover1 287:cca148e535b1 38 static const uint8_t BEACON_UUID[] = {0xD8, 0xFE};
rgrover1 171:6092e61690dc 39
mbedAustin 231:1c4a4fd961a5 40 /**
mbedAustin 231:1c4a4fd961a5 41 * @class URIBeaconConfigService
rgrover1 242:0e9201b67e2f 42 * @brief UriBeacon Configuration Service. Can be used to set URL, adjust power levels, and set flags.
rgrover1 287:cca148e535b1 43 * See http://uribeacon.org
rgrover1 287:cca148e535b1 44 *
mbedAustin 231:1c4a4fd961a5 45 */
rgrover1 207:e88130dc254c 46 class URIBeaconConfigService {
rgrover1 287:cca148e535b1 47 public:
mbedAustin 231:1c4a4fd961a5 48 /**
rgrover1 242:0e9201b67e2f 49 * @brief Transmission Power Modes for UriBeacon
rgrover1 242:0e9201b67e2f 50 */
rgrover1 287:cca148e535b1 51 static const uint8_t TX_POWER_MODE_LOWEST = 0; /*!< Lowest TX power mode */
rgrover1 287:cca148e535b1 52 static const uint8_t TX_POWER_MODE_LOW = 1; /*!< Low TX power mode */
rgrover1 287:cca148e535b1 53 static const uint8_t TX_POWER_MODE_MEDIUM = 2; /*!< Medium TX power mode */
rgrover1 287:cca148e535b1 54 static const uint8_t TX_POWER_MODE_HIGH = 3; /*!< High TX power mode */
rgrover1 287:cca148e535b1 55 static const unsigned int NUM_POWER_MODES = 4; /*!< Number of Power Modes defined */
rgrover1 287:cca148e535b1 56
rgrover1 312:e2e52a7477bf 57 static const int CONFIG_ADVERTISING_TIMEOUT_SECONDS = 60; // Seconds after power-on that config service is available.
rgrover1 309:bc91f7ba346d 58 static const int ADVERTISING_INTERVAL_MSEC = 1000; // Advertising interval for config service.
rgrover1 309:bc91f7ba346d 59 static const int SERVICE_DATA_MAX = 31; // Maximum size of service data in ADV packets
rgrover1 287:cca148e535b1 60
rgrover1 287:cca148e535b1 61 typedef uint8_t Lock_t[16]; /* 128 bits */
rgrover1 287:cca148e535b1 62 typedef int8_t PowerLevels_t[NUM_POWER_MODES];
rgrover1 287:cca148e535b1 63
rgrover1 287:cca148e535b1 64 static const int URI_DATA_MAX = 18;
rgrover1 287:cca148e535b1 65 typedef uint8_t UriData_t[URI_DATA_MAX];
rgrover1 287:cca148e535b1 66
rgrover1 287:cca148e535b1 67 struct Params_t {
rgrover1 311:11417b970b12 68 Lock_t lock;
rgrover1 311:11417b970b12 69 uint8_t uriDataLength;
rgrover1 311:11417b970b12 70 UriData_t uriData;
rgrover1 311:11417b970b12 71 uint8_t flags;
rgrover1 311:11417b970b12 72 PowerLevels_t advPowerLevels; // Current value of AdvertisedPowerLevels
rgrover1 311:11417b970b12 73 uint8_t txPowerMode; // Firmware power levels used with setTxPower()
rgrover1 311:11417b970b12 74 uint16_t beaconPeriod;
rgrover1 312:e2e52a7477bf 75 uint32_t persistenceSignature; /* This isn't really a parameter, but having the expected magic value in
rgrover1 312:e2e52a7477bf 76 * this field indicates persistence. */
rgrover1 312:e2e52a7477bf 77 static const uint32_t MAGIC = 0x1BEAC000; // Magic that identifies persistence
rgrover1 175:4e85f7225f8f 78 };
rgrover1 175:4e85f7225f8f 79
rgrover1 181:bbb6ce1082c3 80 /**
rgrover1 287:cca148e535b1 81 * @param[ref] ble
rgrover1 287:cca148e535b1 82 * BLEDevice object for the underlying controller.
rgrover1 287:cca148e535b1 83 * @param[in/out] paramsIn
rgrover1 287:cca148e535b1 84 * Reference to application-visible beacon state, loaded
rgrover1 287:cca148e535b1 85 * from persistent storage at startup.
rgrover1 287:cca148e535b1 86 * @param[in] defaultUriDataIn
rgrover1 309:bc91f7ba346d 87 * Default un-encoded URI; applies only if the resetToDefaultsFlag is true.
rgrover1 287:cca148e535b1 88 * @param[in] defaultAdvPowerLevelsIn
rgrover1 287:cca148e535b1 89 * Default power-levels array; applies only if the resetToDefaultsFlag is true.
rgrover1 181:bbb6ce1082c3 90 */
rgrover1 287:cca148e535b1 91 URIBeaconConfigService(BLEDevice &bleIn,
rgrover1 287:cca148e535b1 92 Params_t &paramsIn,
rgrover1 309:bc91f7ba346d 93 const char *defaultURIDataIn,
rgrover1 287:cca148e535b1 94 PowerLevels_t &defaultAdvPowerLevelsIn) :
rgrover1 192:3fd3dcf49005 95 ble(bleIn),
rgrover1 287:cca148e535b1 96 params(paramsIn),
rgrover1 309:bc91f7ba346d 97 defaultUriDataLength(),
rgrover1 309:bc91f7ba346d 98 defaultUriData(),
rgrover1 287:cca148e535b1 99 defaultAdvPowerLevels(defaultAdvPowerLevelsIn),
rgrover1 192:3fd3dcf49005 100 initSucceeded(false),
rgrover1 309:bc91f7ba346d 101 resetFlag(),
rgrover1 309:bc91f7ba346d 102 configAdvertisementTimeoutTicker(),
rgrover1 287:cca148e535b1 103 lockedStateChar(UUID_LOCK_STATE_CHAR, &lockedState),
rgrover1 287:cca148e535b1 104 lockChar(UUID_LOCK_CHAR, &params.lock),
rgrover1 300:d9a39f759a6a 105 uriDataChar(UUID_URI_DATA_CHAR, params.uriData, 0, URI_DATA_MAX,
rgrover1 287:cca148e535b1 106 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 287:cca148e535b1 107 unlockChar(UUID_UNLOCK_CHAR, &params.lock),
rgrover1 287:cca148e535b1 108 flagsChar(UUID_FLAGS_CHAR, &params.flags),
rgrover1 287:cca148e535b1 109 advPowerLevelsChar(UUID_ADV_POWER_LEVELS_CHAR, &params.advPowerLevels),
rgrover1 287:cca148e535b1 110 txPowerModeChar(UUID_TX_POWER_MODE_CHAR, &params.txPowerMode),
rgrover1 287:cca148e535b1 111 beaconPeriodChar(UUID_BEACON_PERIOD_CHAR, &params.beaconPeriod),
rgrover1 287:cca148e535b1 112 resetChar(UUID_RESET_CHAR, &resetFlag) {
rgrover1 309:bc91f7ba346d 113
rgrover1 309:bc91f7ba346d 114 encodeURI(defaultURIDataIn, defaultUriData, defaultUriDataLength);
rgrover1 309:bc91f7ba346d 115 if (defaultUriDataLength > URI_DATA_MAX) {
rgrover1 192:3fd3dcf49005 116 return;
rgrover1 192:3fd3dcf49005 117 }
rgrover1 192:3fd3dcf49005 118
rgrover1 312:e2e52a7477bf 119 bool resetToDefaultsFlag = params.persistenceSignature != Params_t::MAGIC;
rgrover1 312:e2e52a7477bf 120 if (!resetToDefaultsFlag && (params.uriDataLength > URI_DATA_MAX)) {
rgrover1 287:cca148e535b1 121 resetToDefaultsFlag = true;
rgrover1 218:8ae02569fab9 122 }
rgrover1 218:8ae02569fab9 123
rgrover1 287:cca148e535b1 124 lockedState = isLocked();
rgrover1 171:6092e61690dc 125
rgrover1 287:cca148e535b1 126 if (resetToDefaultsFlag) {
rgrover1 287:cca148e535b1 127 resetToDefaults();
rgrover1 287:cca148e535b1 128 } else {
rgrover1 287:cca148e535b1 129 updateCharacteristicValues();
rgrover1 287:cca148e535b1 130 }
rgrover1 274:f540619754bb 131
rgrover1 272:65b9d9c87ed1 132 lockChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::lockAuthorizationCallback);
rgrover1 272:65b9d9c87ed1 133 unlockChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::unlockAuthorizationCallback);
rgrover1 250:6862d374e613 134 uriDataChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::uriDataWriteAuthorizationCallback);
rgrover1 255:cdb7231f83df 135 flagsChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::flagsAuthorizationCallback);
rgrover1 287:cca148e535b1 136 advPowerLevelsChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 287:cca148e535b1 137 txPowerModeChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 250:6862d374e613 138 beaconPeriodChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 250:6862d374e613 139 resetChar.setWriteAuthorizationCallback(this, &URIBeaconConfigService::denyGATTWritesIfLocked);
rgrover1 250:6862d374e613 140
rgrover1 287:cca148e535b1 141 static GattCharacteristic *charTable[] = {
rgrover1 287:cca148e535b1 142 &lockedStateChar, &lockChar, &unlockChar, &uriDataChar,
rgrover1 287:cca148e535b1 143 &flagsChar, &advPowerLevelsChar, &txPowerModeChar, &beaconPeriodChar, &resetChar
rgrover1 287:cca148e535b1 144 };
rgrover1 182:d16f8c11816b 145
rgrover1 287:cca148e535b1 146 GattService configService(UUID_URI_BEACON_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 287:cca148e535b1 147
rgrover1 287:cca148e535b1 148 ble.addService(configService);
rgrover1 287:cca148e535b1 149 ble.onDataWritten(this, &URIBeaconConfigService::onDataWrittenCallback);
rgrover1 287:cca148e535b1 150
rgrover1 309:bc91f7ba346d 151 /* Start out by advertising the configService for a limited time after
rgrover1 309:bc91f7ba346d 152 * startup; and switch to the normal non-connectible beacon functionality
rgrover1 309:bc91f7ba346d 153 * afterwards. */
rgrover1 313:c4599a1aba23 154 setupURIBeaconConfigAdvertisements();
rgrover1 309:bc91f7ba346d 155
rgrover1 287:cca148e535b1 156 initSucceeded = true;
rgrover1 192:3fd3dcf49005 157 }
rgrover1 192:3fd3dcf49005 158
rgrover1 193:ac2feceb7e87 159 bool configuredSuccessfully(void) const {
rgrover1 192:3fd3dcf49005 160 return initSucceeded;
rgrover1 171:6092e61690dc 161 }
rgrover1 171:6092e61690dc 162
rgrover1 309:bc91f7ba346d 163 /* Start out by advertising the configService for a limited time after
rgrover1 309:bc91f7ba346d 164 * startup; and switch to the normal non-connectible beacon functionality
rgrover1 309:bc91f7ba346d 165 * afterwards. */
rgrover1 313:c4599a1aba23 166 void setupURIBeaconConfigAdvertisements()
rgrover1 309:bc91f7ba346d 167 {
rgrover1 309:bc91f7ba346d 168 char DEVICE_NAME[] = "mUriBeacon Config";
rgrover1 309:bc91f7ba346d 169
rgrover1 309:bc91f7ba346d 170 ble.clearAdvertisingPayload();
rgrover1 309:bc91f7ba346d 171
rgrover1 309:bc91f7ba346d 172 // Stops advertising the UriBeacon Config Service after a delay
rgrover1 312:e2e52a7477bf 173 configAdvertisementTimeoutTicker.attach(this, &URIBeaconConfigService::timeout, CONFIG_ADVERTISING_TIMEOUT_SECONDS);
rgrover1 309:bc91f7ba346d 174
rgrover1 309:bc91f7ba346d 175 ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
rgrover1 309:bc91f7ba346d 176
rgrover1 309:bc91f7ba346d 177 // UUID is in different order in the ADV frame (!)
rgrover1 309:bc91f7ba346d 178 uint8_t reversedServiceUUID[sizeof(UUID_URI_BEACON_SERVICE)];
rgrover1 309:bc91f7ba346d 179 for (unsigned int i = 0; i < sizeof(UUID_URI_BEACON_SERVICE); i++) {
rgrover1 309:bc91f7ba346d 180 reversedServiceUUID[i] =
rgrover1 309:bc91f7ba346d 181 UUID_URI_BEACON_SERVICE[sizeof(UUID_URI_BEACON_SERVICE) - i - 1];
rgrover1 309:bc91f7ba346d 182 }
rgrover1 309:bc91f7ba346d 183 ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_128BIT_SERVICE_IDS, reversedServiceUUID, sizeof(reversedServiceUUID));
rgrover1 309:bc91f7ba346d 184 ble.accumulateAdvertisingPayload(GapAdvertisingData::GENERIC_TAG);
rgrover1 309:bc91f7ba346d 185 ble.accumulateScanResponse(GapAdvertisingData::COMPLETE_LOCAL_NAME, reinterpret_cast<uint8_t *>(&DEVICE_NAME), sizeof(DEVICE_NAME));
rgrover1 309:bc91f7ba346d 186 ble.accumulateScanResponse(
rgrover1 309:bc91f7ba346d 187 GapAdvertisingData::TX_POWER_LEVEL,
rgrover1 309:bc91f7ba346d 188 reinterpret_cast<uint8_t *>(
rgrover1 309:bc91f7ba346d 189 &defaultAdvPowerLevels[URIBeaconConfigService::TX_POWER_MODE_LOW]),
rgrover1 309:bc91f7ba346d 190 sizeof(uint8_t));
rgrover1 309:bc91f7ba346d 191
rgrover1 314:193908f2b13b 192 ble.setTxPower(params.advPowerLevels[params.txPowerMode]);
rgrover1 309:bc91f7ba346d 193 ble.setDeviceName(reinterpret_cast<uint8_t *>(&DEVICE_NAME));
rgrover1 309:bc91f7ba346d 194 ble.setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
rgrover1 309:bc91f7ba346d 195 ble.setAdvertisingInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(ADVERTISING_INTERVAL_MSEC));
rgrover1 309:bc91f7ba346d 196 }
rgrover1 309:bc91f7ba346d 197
rgrover1 313:c4599a1aba23 198 /* Helper function to switch to the non-connectible normal mode for URIBeacon. This gets called after a timeout. */
rgrover1 313:c4599a1aba23 199 void setupURIBeaconAdvertisements()
rgrover1 309:bc91f7ba346d 200 {
rgrover1 314:193908f2b13b 201 uint8_t serviceData[SERVICE_DATA_MAX];
rgrover1 314:193908f2b13b 202 int serviceDataLen = 0;
rgrover1 309:bc91f7ba346d 203
rgrover1 314:193908f2b13b 204 /* Reinitialize the BLE stack. This will clear away the existing services and advertising state. */
rgrover1 309:bc91f7ba346d 205 ble.shutdown();
rgrover1 309:bc91f7ba346d 206 ble.init();
rgrover1 309:bc91f7ba346d 207
rgrover1 309:bc91f7ba346d 208 // Fields from the Service
rgrover1 314:193908f2b13b 209 int beaconPeriod = params.beaconPeriod;
rgrover1 314:193908f2b13b 210 int txPowerMode = params.txPowerMode;
rgrover1 314:193908f2b13b 211 int uriDataLength = params.uriDataLength;
rgrover1 314:193908f2b13b 212 URIBeaconConfigService::UriData_t &uriData = params.uriData;
rgrover1 314:193908f2b13b 213 URIBeaconConfigService::PowerLevels_t &advPowerLevels = params.advPowerLevels;
rgrover1 314:193908f2b13b 214 uint8_t flags = params.flags;
rgrover1 309:bc91f7ba346d 215
rgrover1 314:193908f2b13b 216 extern void saveURIBeaconConfigParams(Params_t *paramsP); /* forward declaration; necessary to avoid a circular dependency. */
rgrover1 314:193908f2b13b 217 saveURIBeaconConfigParams(&params);
rgrover1 309:bc91f7ba346d 218
rgrover1 314:193908f2b13b 219 ble.clearAdvertisingPayload();
rgrover1 314:193908f2b13b 220 ble.setTxPower(params.advPowerLevels[params.txPowerMode]);
rgrover1 314:193908f2b13b 221 ble.setAdvertisingType(GapAdvertisingParams::ADV_NON_CONNECTABLE_UNDIRECTED);
rgrover1 314:193908f2b13b 222 ble.setAdvertisingInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(beaconPeriod));
rgrover1 314:193908f2b13b 223 ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
rgrover1 314:193908f2b13b 224 ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, BEACON_UUID, sizeof(BEACON_UUID));
rgrover1 309:bc91f7ba346d 225
rgrover1 314:193908f2b13b 226 serviceData[serviceDataLen++] = BEACON_UUID[0];
rgrover1 314:193908f2b13b 227 serviceData[serviceDataLen++] = BEACON_UUID[1];
rgrover1 314:193908f2b13b 228 serviceData[serviceDataLen++] = flags;
rgrover1 314:193908f2b13b 229 serviceData[serviceDataLen++] = advPowerLevels[txPowerMode];
rgrover1 314:193908f2b13b 230 for (int j=0; j < uriDataLength; j++) {
rgrover1 314:193908f2b13b 231 serviceData[serviceDataLen++] = uriData[j];
rgrover1 314:193908f2b13b 232 }
rgrover1 314:193908f2b13b 233 ble.accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceData, serviceDataLen);
rgrover1 309:bc91f7ba346d 234
rgrover1 314:193908f2b13b 235 ble.startAdvertising();
rgrover1 309:bc91f7ba346d 236 }
rgrover1 309:bc91f7ba346d 237
rgrover1 309:bc91f7ba346d 238 // After advertising timeout, stop config and switch to UriBeacon
rgrover1 309:bc91f7ba346d 239 void timeout(void)
rgrover1 309:bc91f7ba346d 240 {
rgrover1 309:bc91f7ba346d 241 Gap::GapState_t state;
rgrover1 309:bc91f7ba346d 242 state = ble.getGapState();
rgrover1 314:193908f2b13b 243 if (state.advertising) {
rgrover1 313:c4599a1aba23 244 setupURIBeaconAdvertisements();
rgrover1 314:193908f2b13b 245 configAdvertisementTimeoutTicker.detach(); /* disable the timeout Ticker. */
rgrover1 309:bc91f7ba346d 246 }
rgrover1 309:bc91f7ba346d 247 }
rgrover1 287:cca148e535b1 248
rgrover1 287:cca148e535b1 249 private:
rgrover1 287:cca148e535b1 250 // True if the lock bits are non-zero
rgrover1 287:cca148e535b1 251 bool isLocked() {
rgrover1 287:cca148e535b1 252 Lock_t testLock;
rgrover1 287:cca148e535b1 253 memset(testLock, 0, sizeof(Lock_t));
rgrover1 287:cca148e535b1 254 return memcmp(params.lock, testLock, sizeof(Lock_t));
rgrover1 171:6092e61690dc 255 }
rgrover1 171:6092e61690dc 256
rgrover1 287:cca148e535b1 257 /*
rgrover1 287:cca148e535b1 258 * This callback is invoked when a GATT client attempts to modify any of the
rgrover1 287:cca148e535b1 259 * characteristics of this service. Attempts to do so are also applied to
rgrover1 287:cca148e535b1 260 * the internal state of this service object.
rgrover1 286:898ff71b9502 261 */
rgrover1 287:cca148e535b1 262 void onDataWrittenCallback(const GattCharacteristicWriteCBParams *writeParams) {
rgrover1 287:cca148e535b1 263 uint16_t handle = writeParams->charHandle;
rgrover1 286:898ff71b9502 264
rgrover1 287:cca148e535b1 265 if (handle == lockChar.getValueHandle()) {
rgrover1 287:cca148e535b1 266 // Validated earlier
rgrover1 287:cca148e535b1 267 memcpy(params.lock, writeParams->data, sizeof(Lock_t));
rgrover1 287:cca148e535b1 268 // use isLocked() in case bits are being set to all 0's
rgrover1 287:cca148e535b1 269 lockedState = isLocked();
rgrover1 287:cca148e535b1 270 } else if (handle == unlockChar.getValueHandle()) {
rgrover1 287:cca148e535b1 271 // Validated earlier
rgrover1 287:cca148e535b1 272 memset(params.lock, 0, sizeof(Lock_t));
rgrover1 287:cca148e535b1 273 lockedState = false;
rgrover1 287:cca148e535b1 274 } else if (handle == uriDataChar.getValueHandle()) {
rgrover1 287:cca148e535b1 275 params.uriDataLength = writeParams->len;
rgrover1 287:cca148e535b1 276 memcpy(params.uriData, writeParams->data, params.uriDataLength);
rgrover1 287:cca148e535b1 277 } else if (handle == flagsChar.getValueHandle()) {
rgrover1 287:cca148e535b1 278 params.flags = *(writeParams->data);
rgrover1 287:cca148e535b1 279 } else if (handle == advPowerLevelsChar.getValueHandle()) {
rgrover1 287:cca148e535b1 280 memcpy(params.advPowerLevels, writeParams->data, sizeof(PowerLevels_t));
rgrover1 287:cca148e535b1 281 } else if (handle == txPowerModeChar.getValueHandle()) {
rgrover1 287:cca148e535b1 282 params.txPowerMode = *(writeParams->data);
rgrover1 287:cca148e535b1 283 } else if (handle == beaconPeriodChar.getValueHandle()) {
rgrover1 287:cca148e535b1 284 params.beaconPeriod = *((uint16_t *)(writeParams->data));
rgrover1 287:cca148e535b1 285 } else if (handle == resetChar.getValueHandle()) {
rgrover1 287:cca148e535b1 286 resetToDefaults();
rgrover1 185:7cd70497aec8 287 }
rgrover1 185:7cd70497aec8 288 }
rgrover1 185:7cd70497aec8 289
rgrover1 287:cca148e535b1 290 /*
rgrover1 287:cca148e535b1 291 * Reset the default values.
rgrover1 242:0e9201b67e2f 292 */
rgrover1 287:cca148e535b1 293 void resetToDefaults(void) {
rgrover1 287:cca148e535b1 294 lockedState = false;
rgrover1 287:cca148e535b1 295 memset(params.lock, 0, sizeof(Lock_t));
rgrover1 287:cca148e535b1 296 memcpy(params.uriData, defaultUriData, URI_DATA_MAX);
rgrover1 287:cca148e535b1 297 params.uriDataLength = defaultUriDataLength;
rgrover1 287:cca148e535b1 298 params.flags = 0;
rgrover1 287:cca148e535b1 299 memcpy(params.advPowerLevels, defaultAdvPowerLevels, sizeof(PowerLevels_t));
rgrover1 287:cca148e535b1 300 params.txPowerMode = TX_POWER_MODE_LOW;
rgrover1 287:cca148e535b1 301 params.beaconPeriod = 1000;
rgrover1 287:cca148e535b1 302 updateCharacteristicValues();
rgrover1 211:f181effe5de3 303 }
rgrover1 211:f181effe5de3 304
mbedAustin 232:4cfb5b8a4fb9 305 /*
rgrover1 287:cca148e535b1 306 * Internal helper function used to update the GATT database following any
rgrover1 287:cca148e535b1 307 * change to the internal state of the service object.
rgrover1 242:0e9201b67e2f 308 */
rgrover1 287:cca148e535b1 309 void updateCharacteristicValues(void) {
rgrover1 287:cca148e535b1 310 ble.updateCharacteristicValue(lockedStateChar.getValueHandle(), &lockedState, 1);
rgrover1 287:cca148e535b1 311 ble.updateCharacteristicValue(uriDataChar.getValueHandle(), params.uriData, params.uriDataLength);
rgrover1 287:cca148e535b1 312 ble.updateCharacteristicValue(flagsChar.getValueHandle(), &params.flags, 1);
rgrover1 287:cca148e535b1 313 ble.updateCharacteristicValue(beaconPeriodChar.getValueHandle(),
rgrover1 287:cca148e535b1 314 reinterpret_cast<uint8_t *>(&params.beaconPeriod), sizeof(uint16_t));
rgrover1 287:cca148e535b1 315 ble.updateCharacteristicValue(txPowerModeChar.getValueHandle(), &params.txPowerMode, 1);
rgrover1 287:cca148e535b1 316 ble.updateCharacteristicValue(advPowerLevelsChar.getValueHandle(),
rgrover1 287:cca148e535b1 317 reinterpret_cast<uint8_t *>(params.advPowerLevels), sizeof(PowerLevels_t));
rgrover1 287:cca148e535b1 318 }
rgrover1 287:cca148e535b1 319
rgrover1 287:cca148e535b1 320 private:
rgrover1 287:cca148e535b1 321 void lockAuthorizationCallback(GattCharacteristicWriteAuthCBParams *authParams) {
rgrover1 287:cca148e535b1 322 authParams->authorizationReply = (authParams->len == sizeof(Lock_t)) && !lockedState;
rgrover1 287:cca148e535b1 323 }
rgrover1 287:cca148e535b1 324
rgrover1 287:cca148e535b1 325
rgrover1 287:cca148e535b1 326 void unlockAuthorizationCallback(GattCharacteristicWriteAuthCBParams *authParams) {
rgrover1 287:cca148e535b1 327 if (!lockedState || (authParams->len == sizeof(Lock_t) && (memcmp(authParams->data, params.lock, sizeof(Lock_t)) == 0))) {
rgrover1 287:cca148e535b1 328 authParams->authorizationReply = true;
rgrover1 287:cca148e535b1 329 } else {
rgrover1 287:cca148e535b1 330 authParams->authorizationReply = false;
rgrover1 287:cca148e535b1 331 }
rgrover1 287:cca148e535b1 332 }
rgrover1 287:cca148e535b1 333
rgrover1 287:cca148e535b1 334 void uriDataWriteAuthorizationCallback(GattCharacteristicWriteAuthCBParams *authParams) {
rgrover1 287:cca148e535b1 335 if (lockedState || (authParams->offset != 0) || (authParams->len > URI_DATA_MAX)) {
rgrover1 287:cca148e535b1 336 authParams->authorizationReply = false;
rgrover1 287:cca148e535b1 337 }
rgrover1 287:cca148e535b1 338 }
rgrover1 287:cca148e535b1 339
rgrover1 287:cca148e535b1 340 void flagsAuthorizationCallback(GattCharacteristicWriteAuthCBParams *authParams) {
rgrover1 287:cca148e535b1 341 if (lockedState || authParams->len != 1) {
rgrover1 287:cca148e535b1 342 authParams->authorizationReply = false;
rgrover1 287:cca148e535b1 343 }
rgrover1 287:cca148e535b1 344 }
rgrover1 287:cca148e535b1 345
rgrover1 287:cca148e535b1 346 void denyGATTWritesIfLocked(GattCharacteristicWriteAuthCBParams *authParams) {
rgrover1 287:cca148e535b1 347 if (lockedState) {
rgrover1 287:cca148e535b1 348 authParams->authorizationReply = false;
rgrover1 287:cca148e535b1 349 }
rgrover1 287:cca148e535b1 350 }
rgrover1 287:cca148e535b1 351
rgrover1 287:cca148e535b1 352 BLEDevice &ble;
rgrover1 287:cca148e535b1 353 Params_t &params;
rgrover1 287:cca148e535b1 354 // Default value that is restored on reset
rgrover1 309:bc91f7ba346d 355 size_t defaultUriDataLength;
rgrover1 309:bc91f7ba346d 356 UriData_t defaultUriData;
rgrover1 287:cca148e535b1 357 // Default value that is restored on reset
rgrover1 287:cca148e535b1 358 PowerLevels_t &defaultAdvPowerLevels;
rgrover1 287:cca148e535b1 359 uint8_t lockedState;
rgrover1 287:cca148e535b1 360 bool initSucceeded;
rgrover1 287:cca148e535b1 361 uint8_t resetFlag;
rgrover1 309:bc91f7ba346d 362 Ticker configAdvertisementTimeoutTicker;
rgrover1 287:cca148e535b1 363
rgrover1 287:cca148e535b1 364 ReadOnlyGattCharacteristic<uint8_t> lockedStateChar;
rgrover1 287:cca148e535b1 365 WriteOnlyGattCharacteristic<Lock_t> lockChar;
rgrover1 287:cca148e535b1 366 GattCharacteristic uriDataChar;
rgrover1 287:cca148e535b1 367 WriteOnlyGattCharacteristic<Lock_t> unlockChar;
rgrover1 287:cca148e535b1 368 ReadWriteGattCharacteristic<uint8_t> flagsChar;
rgrover1 287:cca148e535b1 369 ReadWriteGattCharacteristic<PowerLevels_t> advPowerLevelsChar;
rgrover1 287:cca148e535b1 370 ReadWriteGattCharacteristic<uint8_t> txPowerModeChar;
rgrover1 287:cca148e535b1 371 ReadWriteGattCharacteristic<uint16_t> beaconPeriodChar;
rgrover1 287:cca148e535b1 372 WriteOnlyGattCharacteristic<uint8_t> resetChar;
rgrover1 287:cca148e535b1 373
rgrover1 287:cca148e535b1 374 public:
rgrover1 287:cca148e535b1 375 /*
rgrover1 287:cca148e535b1 376 * Encode a human-readable URI into the binary format defined by URIBeacon spec (https://github.com/google/uribeacon/tree/master/specification).
rgrover1 287:cca148e535b1 377 */
rgrover1 287:cca148e535b1 378 static void encodeURI(const char *uriDataIn, UriData_t uriDataOut, size_t &sizeofURIDataOut) {
rgrover1 287:cca148e535b1 379 sizeofURIDataOut = 0;
rgrover1 287:cca148e535b1 380 memset(uriDataOut, 0, sizeof(UriData_t));
rgrover1 287:cca148e535b1 381
rgrover1 287:cca148e535b1 382 if ((uriDataIn == NULL) || (strlen(uriDataIn) == 0)) {
rgrover1 287:cca148e535b1 383 return;
rgrover1 284:82fefb5be8ed 384 }
rgrover1 284:82fefb5be8ed 385
rgrover1 287:cca148e535b1 386 /*
rgrover1 287:cca148e535b1 387 * handle prefix
rgrover1 287:cca148e535b1 388 */
rgrover1 284:82fefb5be8ed 389 const char *prefixes[] = {
rgrover1 284:82fefb5be8ed 390 "http://www.",
rgrover1 284:82fefb5be8ed 391 "https://www.",
rgrover1 284:82fefb5be8ed 392 "http://",
rgrover1 284:82fefb5be8ed 393 "https://",
rgrover1 284:82fefb5be8ed 394 "urn:uuid:"
rgrover1 284:82fefb5be8ed 395 };
rgrover1 315:943225af2cf4 396 const size_t NUM_PREFIXES = sizeof(prefixes) / sizeof(char *);
rgrover1 284:82fefb5be8ed 397 for (unsigned i = 0; i < NUM_PREFIXES; i++) {
rgrover1 284:82fefb5be8ed 398 size_t prefixLen = strlen(prefixes[i]);
rgrover1 287:cca148e535b1 399 if (strncmp(uriDataIn, prefixes[i], prefixLen) == 0) {
rgrover1 287:cca148e535b1 400 uriDataOut[sizeofURIDataOut++] = i;
rgrover1 287:cca148e535b1 401 uriDataIn += prefixLen;
rgrover1 284:82fefb5be8ed 402 break;
rgrover1 284:82fefb5be8ed 403 }
rgrover1 284:82fefb5be8ed 404 }
rgrover1 284:82fefb5be8ed 405
rgrover1 287:cca148e535b1 406 /*
rgrover1 287:cca148e535b1 407 * handle suffixes
rgrover1 287:cca148e535b1 408 */
rgrover1 284:82fefb5be8ed 409 const char *suffixes[] = {
rgrover1 284:82fefb5be8ed 410 ".com/",
rgrover1 284:82fefb5be8ed 411 ".org/",
rgrover1 284:82fefb5be8ed 412 ".edu/",
rgrover1 284:82fefb5be8ed 413 ".net/",
rgrover1 284:82fefb5be8ed 414 ".info/",
rgrover1 284:82fefb5be8ed 415 ".biz/",
rgrover1 284:82fefb5be8ed 416 ".gov/",
rgrover1 284:82fefb5be8ed 417 ".com",
rgrover1 284:82fefb5be8ed 418 ".org",
rgrover1 284:82fefb5be8ed 419 ".edu",
rgrover1 284:82fefb5be8ed 420 ".net",
rgrover1 284:82fefb5be8ed 421 ".info",
rgrover1 284:82fefb5be8ed 422 ".biz",
rgrover1 284:82fefb5be8ed 423 ".gov"
rgrover1 284:82fefb5be8ed 424 };
rgrover1 284:82fefb5be8ed 425 const size_t NUM_SUFFIXES = sizeof(suffixes) / sizeof(char *);
rgrover1 287:cca148e535b1 426 while (*uriDataIn && (sizeofURIDataOut < URI_DATA_MAX)) {
rgrover1 284:82fefb5be8ed 427 /* check for suffix match */
rgrover1 284:82fefb5be8ed 428 unsigned i;
rgrover1 284:82fefb5be8ed 429 for (i = 0; i < NUM_SUFFIXES; i++) {
rgrover1 284:82fefb5be8ed 430 size_t suffixLen = strlen(suffixes[i]);
rgrover1 287:cca148e535b1 431 if (suffixLen == 0) {
rgrover1 284:82fefb5be8ed 432 continue;
rgrover1 284:82fefb5be8ed 433 }
rgrover1 284:82fefb5be8ed 434
rgrover1 287:cca148e535b1 435 if (strncmp(uriDataIn, suffixes[i], suffixLen) == 0) {
rgrover1 315:943225af2cf4 436 uriDataOut[sizeofURIDataOut++] = i;
rgrover1 315:943225af2cf4 437 uriDataIn += suffixLen;
rgrover1 284:82fefb5be8ed 438 break; /* from the for loop for checking against suffixes */
rgrover1 284:82fefb5be8ed 439 }
rgrover1 284:82fefb5be8ed 440 }
rgrover1 284:82fefb5be8ed 441 /* This is the default case where we've got an ordinary character which doesn't match a suffix. */
rgrover1 284:82fefb5be8ed 442 if (i == NUM_SUFFIXES) {
rgrover1 287:cca148e535b1 443 uriDataOut[sizeofURIDataOut++] = *uriDataIn;
rgrover1 287:cca148e535b1 444 ++uriDataIn;
rgrover1 284:82fefb5be8ed 445 }
rgrover1 284:82fefb5be8ed 446 }
rgrover1 284:82fefb5be8ed 447 }
rgrover1 171:6092e61690dc 448 };
rgrover1 171:6092e61690dc 449
rgrover1 287:cca148e535b1 450 #endif // SERVICES_URIBEACONCONFIGSERVICE_H_