Austin Blackstone / BLE_API

Fixes to BLE_API for mbedOS Alpha1 release. Mostly relating to doxygen fixes.

Fork of BLE_API by Bluetooth Low Energy

services/URIBeacon2Service.h@172:fb95afa93697, 2014-11-28 (annotated)

Committer:
rgrover1
Date:
Fri Nov 28 14:11:22 2014 +0000
Revision:
172:fb95afa93697
Parent:
171:6092e61690dc
Child:
173:05c4b1cea65f
Synchronized with git rev 4f8178b0

Author: Rohit Grover

add a comment block for the constructor.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 171:6092e61690dc 1 /* mbed Microcontroller Library
rgrover1 171:6092e61690dc 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 171:6092e61690dc 3 *
rgrover1 171:6092e61690dc 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 171:6092e61690dc 5 * you may not use this file except in compliance with the License.
rgrover1 171:6092e61690dc 6 * You may obtain a copy of the License at
rgrover1 171:6092e61690dc 7 *
rgrover1 171:6092e61690dc 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 171:6092e61690dc 9 *
rgrover1 171:6092e61690dc 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 171:6092e61690dc 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 171:6092e61690dc 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 171:6092e61690dc 13 * See the License for the specific language governing permissions and
rgrover1 171:6092e61690dc 14 * limitations under the License.
rgrover1 171:6092e61690dc 15 */
rgrover1 171:6092e61690dc 16
rgrover1 171:6092e61690dc 17 #ifndef __BLE_URI_BEACON_2_SERVICE_H__
rgrover1 171:6092e61690dc 18 #define __BLE_URI_BEACON_2_SERVICE_H__
rgrover1 171:6092e61690dc 19
rgrover1 171:6092e61690dc 20 #include "BLEDevice.h"
rgrover1 171:6092e61690dc 21
rgrover1 171:6092e61690dc 22 #define UUID_INITIALIZER_LIST(FIRST, SECOND) { \
rgrover1 171:6092e61690dc 23 0xee, 0x0c, FIRST, SECOND, 0x87, 0x86, 0x40, 0xba, \
rgrover1 171:6092e61690dc 24 0xab, 0x96, 0x99, 0xb9, 0x1a, 0xc9, 0x81, 0xd8, \
rgrover1 171:6092e61690dc 25 }
rgrover1 171:6092e61690dc 26 const uint8_t URIBeacon2ControlServiceUUID[] = UUID_INITIALIZER_LIST(0x20, 0x80);
rgrover1 171:6092e61690dc 27 const uint8_t lockedStateCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x81);
rgrover1 171:6092e61690dc 28 const uint8_t uriDataCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x84);
rgrover1 171:6092e61690dc 29 const uint8_t flagsCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x85);
rgrover1 171:6092e61690dc 30 const uint8_t txPowerCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x86);
rgrover1 171:6092e61690dc 31 const uint8_t beaconPeriodCharUUID[] = UUID_INITIALIZER_LIST(0x20, 0x88);
rgrover1 171:6092e61690dc 32
rgrover1 171:6092e61690dc 33 class URIBeacon2Service {
rgrover1 171:6092e61690dc 34 public:
rgrover1 172:fb95afa93697 35 /**
rgrover1 172:fb95afa93697 36 * @param[ref] ble
rgrover1 172:fb95afa93697 37 * BLEDevice object for the underlying controller.
rgrover1 172:fb95afa93697 38 * @param[in] urldata
rgrover1 172:fb95afa93697 39 * URI as a null-terminated string.
rgrover1 172:fb95afa93697 40 * @param[in] flagsIn
rgrover1 172:fb95afa93697 41 * UriBeacon Flags.
rgrover1 172:fb95afa93697 42 * @param[in] txPowerIn
rgrover1 172:fb95afa93697 43 * UriBeacon Tx Power Level.
rgrover1 172:fb95afa93697 44 * @param[in] beaconPeriodIn
rgrover1 172:fb95afa93697 45 * The period in milliseconds that a UriBeacon packet is
rgrover1 172:fb95afa93697 46 * transmitted. A value of zero disables UriBeacon
rgrover1 172:fb95afa93697 47 * transmissions.
rgrover1 172:fb95afa93697 48 */
rgrover1 171:6092e61690dc 49 URIBeacon2Service(BLEDevice &ble_, const char *urldata, uint8_t flagsIn = 0, uint8_t txPowerIn = 0, uint16_t beaconPeriodIn = 1000) :
rgrover1 171:6092e61690dc 50 ble(ble_), payloadIndex(0), serviceDataPayload(),
rgrover1 171:6092e61690dc 51 lockedState(false),
rgrover1 171:6092e61690dc 52 uriDataLength(0),
rgrover1 171:6092e61690dc 53 uriDataValue(),
rgrover1 171:6092e61690dc 54 flags(flagsIn),
rgrover1 171:6092e61690dc 55 power(txPowerIn),
rgrover1 171:6092e61690dc 56 beaconPeriod(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(beaconPeriodIn)),
rgrover1 171:6092e61690dc 57 lockedStateChar(lockedStateCharUUID, (uint8_t *)&lockedState, 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 171:6092e61690dc 58 uriDataChar(uriDataCharUUID,
rgrover1 171:6092e61690dc 59 uriDataValue,
rgrover1 171:6092e61690dc 60 MAX_SIZE_URI_DATA_CHAR_VALUE,
rgrover1 171:6092e61690dc 61 MAX_SIZE_URI_DATA_CHAR_VALUE,
rgrover1 171:6092e61690dc 62 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE),
rgrover1 171:6092e61690dc 63 flagsChar(flagsCharUUID, &flags, 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
rgrover1 171:6092e61690dc 64 // txPowerChar(txPowerCharUUID, &power, 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE)
rgrover1 171:6092e61690dc 65 beaconPeriodChar(beaconPeriodCharUUID, (uint8_t *)&beaconPeriod, 2, 2,
rgrover1 171:6092e61690dc 66 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE)
rgrover1 171:6092e61690dc 67 {
rgrover1 171:6092e61690dc 68 if ((urldata == NULL) || ((uriDataLength = strlen(urldata)) == 0)) {
rgrover1 171:6092e61690dc 69 return;
rgrover1 171:6092e61690dc 70 }
rgrover1 171:6092e61690dc 71 strncpy(reinterpret_cast<char *>(uriDataValue), urldata, MAX_SIZE_URI_DATA_CHAR_VALUE);
rgrover1 171:6092e61690dc 72
rgrover1 171:6092e61690dc 73 setup();
rgrover1 171:6092e61690dc 74
rgrover1 171:6092e61690dc 75 static bool serviceAdded = false; /* We should only ever need to add the heart rate service once. */
rgrover1 171:6092e61690dc 76 if (serviceAdded) {
rgrover1 171:6092e61690dc 77 return;
rgrover1 171:6092e61690dc 78 }
rgrover1 171:6092e61690dc 79
rgrover1 171:6092e61690dc 80 GattCharacteristic *charTable[] = {&lockedStateChar, &uriDataChar, &flagsChar, &beaconPeriodChar};
rgrover1 171:6092e61690dc 81 GattService beaconControlService(URIBeacon2ControlServiceUUID, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 171:6092e61690dc 82
rgrover1 171:6092e61690dc 83 ble.addService(beaconControlService);
rgrover1 171:6092e61690dc 84 serviceAdded = true;
rgrover1 171:6092e61690dc 85
rgrover1 171:6092e61690dc 86 ble.onDataWritten(this, &URIBeacon2Service::onDataWritten);
rgrover1 171:6092e61690dc 87 }
rgrover1 171:6092e61690dc 88
rgrover1 171:6092e61690dc 89 void setFlags(uint8_t flagsIn) {
rgrover1 171:6092e61690dc 90 flags = flagsIn;
rgrover1 171:6092e61690dc 91 setup();
rgrover1 171:6092e61690dc 92 }
rgrover1 171:6092e61690dc 93
rgrover1 171:6092e61690dc 94 void setTxPower(uint8_t txPowerIn) {
rgrover1 171:6092e61690dc 95 power = txPowerIn;
rgrover1 171:6092e61690dc 96 setup();
rgrover1 171:6092e61690dc 97 }
rgrover1 171:6092e61690dc 98
rgrover1 171:6092e61690dc 99 void setBeaconPeriod(uint16_t beaconPeriodIn) {
rgrover1 171:6092e61690dc 100 beaconPeriod = beaconPeriodIn;
rgrover1 171:6092e61690dc 101 setup();
rgrover1 171:6092e61690dc 102 }
rgrover1 171:6092e61690dc 103
rgrover1 171:6092e61690dc 104 protected:
rgrover1 171:6092e61690dc 105 /**
rgrover1 171:6092e61690dc 106 * This callback allows the DFU service to receive the initial trigger to
rgrover1 171:6092e61690dc 107 * handover control to the bootloader; but first the application is given a
rgrover1 171:6092e61690dc 108 * chance to clean up.
rgrover1 171:6092e61690dc 109 */
rgrover1 171:6092e61690dc 110 virtual void onDataWritten(const GattCharacteristicWriteCBParams *params) {
rgrover1 171:6092e61690dc 111 if (params->charHandle == uriDataChar.getValueAttribute().getHandle()) {
rgrover1 171:6092e61690dc 112 if (lockedState) { /* When locked, the device isn't allowed to update the uriData characteristic. */
rgrover1 171:6092e61690dc 113 /* Restore GATT database with previous value. */
rgrover1 171:6092e61690dc 114 ble.updateCharacteristicValue(uriDataChar.getValueAttribute().getHandle(), uriDataValue, uriDataLength);
rgrover1 171:6092e61690dc 115 return;
rgrover1 171:6092e61690dc 116 }
rgrover1 171:6092e61690dc 117
rgrover1 171:6092e61690dc 118 /* We don't handle very large writes at the moment. */
rgrover1 171:6092e61690dc 119 if ((params->offset != 0) || (params->len > MAX_SIZE_URI_DATA_CHAR_VALUE)) {
rgrover1 171:6092e61690dc 120 return;
rgrover1 171:6092e61690dc 121 }
rgrover1 171:6092e61690dc 122
rgrover1 171:6092e61690dc 123 uriDataLength = params->len;
rgrover1 171:6092e61690dc 124 memcpy(uriDataValue, params->data, uriDataLength);
rgrover1 171:6092e61690dc 125 } else if (params->charHandle == flagsChar.getValueAttribute().getHandle()) {
rgrover1 171:6092e61690dc 126 if (lockedState) { /* When locked, the device isn't allowed to update the flags characteristic. */
rgrover1 171:6092e61690dc 127 /* Restore GATT database with previous value. */
rgrover1 171:6092e61690dc 128 ble.updateCharacteristicValue(flagsChar.getValueAttribute().getHandle(), &flags, 1 /* size */);
rgrover1 171:6092e61690dc 129 return;
rgrover1 171:6092e61690dc 130 } else {
rgrover1 171:6092e61690dc 131 flags = *(params->data);
rgrover1 171:6092e61690dc 132 }
rgrover1 171:6092e61690dc 133 } else if (params->charHandle == beaconPeriodChar.getValueAttribute().getHandle()) {
rgrover1 171:6092e61690dc 134 if (lockedState) { /* When locked, the device isn't allowed to update the flags characteristic. */
rgrover1 171:6092e61690dc 135 /* Restore GATT database with previous value. */
rgrover1 171:6092e61690dc 136 ble.updateCharacteristicValue(beaconPeriodChar.getValueAttribute().getHandle(), (uint8_t *)&beaconPeriod, 2 /* size */);
rgrover1 171:6092e61690dc 137 return;
rgrover1 171:6092e61690dc 138 } else {
rgrover1 171:6092e61690dc 139 beaconPeriod = *((uint16_t *)(params->data));
rgrover1 171:6092e61690dc 140 }
rgrover1 171:6092e61690dc 141 }
rgrover1 171:6092e61690dc 142 setup();
rgrover1 171:6092e61690dc 143 ble.setAdvertisingPayload();
rgrover1 171:6092e61690dc 144 }
rgrover1 171:6092e61690dc 145
rgrover1 171:6092e61690dc 146 /**
rgrover1 171:6092e61690dc 147 * For debugging only.
rgrover1 171:6092e61690dc 148 */
rgrover1 171:6092e61690dc 149 void dumpEncodedSeviceData() const {
rgrover1 171:6092e61690dc 150 printf("encoded: '");
rgrover1 171:6092e61690dc 151 for (unsigned i = 0; i < payloadIndex; i++) {
rgrover1 171:6092e61690dc 152 printf(" %02x", serviceDataPayload[i]);
rgrover1 171:6092e61690dc 153 }
rgrover1 171:6092e61690dc 154 printf("'\r\n");
rgrover1 171:6092e61690dc 155 }
rgrover1 171:6092e61690dc 156
rgrover1 171:6092e61690dc 157 private:
rgrover1 171:6092e61690dc 158 void setup(void) {
rgrover1 171:6092e61690dc 159 const uint8_t BEACON_UUID[] = {0xD8, 0xFE};
rgrover1 171:6092e61690dc 160
rgrover1 171:6092e61690dc 161 payloadIndex = 0;
rgrover1 171:6092e61690dc 162 serviceDataPayload[payloadIndex++] = BEACON_UUID[0];
rgrover1 171:6092e61690dc 163 serviceDataPayload[payloadIndex++] = BEACON_UUID[1];
rgrover1 171:6092e61690dc 164 serviceDataPayload[payloadIndex++] = flags;
rgrover1 171:6092e61690dc 165 serviceDataPayload[payloadIndex++] = power;
rgrover1 171:6092e61690dc 166
rgrover1 171:6092e61690dc 167 const char *urlData = reinterpret_cast<char *>(uriDataValue);
rgrover1 171:6092e61690dc 168 size_t sizeofURLData = uriDataLength;
rgrover1 171:6092e61690dc 169 size_t encodedBytes = encodeURISchemePrefix(urlData, sizeofURLData) + encodeURI(urlData, sizeofURLData);
rgrover1 171:6092e61690dc 170
rgrover1 171:6092e61690dc 171 ble.clearAdvertisingPayload();
rgrover1 171:6092e61690dc 172 ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, BEACON_UUID, sizeof(BEACON_UUID));
rgrover1 171:6092e61690dc 173 ble.accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceDataPayload, encodedBytes + 4);
rgrover1 171:6092e61690dc 174
rgrover1 171:6092e61690dc 175 ble.setAdvertisingInterval(beaconPeriod);
rgrover1 171:6092e61690dc 176 ble.setTxPower(power);
rgrover1 171:6092e61690dc 177 }
rgrover1 171:6092e61690dc 178
rgrover1 171:6092e61690dc 179 size_t encodeURISchemePrefix(const char *&urldata, size_t &sizeofURLData) {
rgrover1 171:6092e61690dc 180 const char *prefixes[] = {
rgrover1 171:6092e61690dc 181 "http://www.",
rgrover1 171:6092e61690dc 182 "https://www.",
rgrover1 171:6092e61690dc 183 "http://",
rgrover1 171:6092e61690dc 184 "https://",
rgrover1 171:6092e61690dc 185 "urn:uuid:"
rgrover1 171:6092e61690dc 186 };
rgrover1 171:6092e61690dc 187
rgrover1 171:6092e61690dc 188 size_t encodedBytes = 0;
rgrover1 171:6092e61690dc 189 const size_t NUM_PREFIXES = sizeof(prefixes) / sizeof(char *);
rgrover1 171:6092e61690dc 190 for (unsigned i = 0; i < NUM_PREFIXES; i++) {
rgrover1 171:6092e61690dc 191 size_t prefixLen = strlen(prefixes[i]);
rgrover1 171:6092e61690dc 192 if (strncmp(urldata, prefixes[i], prefixLen) == 0) {
rgrover1 171:6092e61690dc 193 serviceDataPayload[payloadIndex++] = i;
rgrover1 171:6092e61690dc 194 encodedBytes = 1;
rgrover1 171:6092e61690dc 195
rgrover1 171:6092e61690dc 196 urldata += prefixLen;
rgrover1 171:6092e61690dc 197 sizeofURLData -= prefixLen;
rgrover1 171:6092e61690dc 198 break;
rgrover1 171:6092e61690dc 199 }
rgrover1 171:6092e61690dc 200 }
rgrover1 171:6092e61690dc 201
rgrover1 171:6092e61690dc 202 return encodedBytes;
rgrover1 171:6092e61690dc 203 }
rgrover1 171:6092e61690dc 204
rgrover1 171:6092e61690dc 205 size_t encodeURI(const char *urldata, size_t sizeofURLData) {
rgrover1 171:6092e61690dc 206 const char *suffixes[] = {
rgrover1 171:6092e61690dc 207 ".com/",
rgrover1 171:6092e61690dc 208 ".org/",
rgrover1 171:6092e61690dc 209 ".edu/",
rgrover1 171:6092e61690dc 210 ".net/",
rgrover1 171:6092e61690dc 211 ".info/",
rgrover1 171:6092e61690dc 212 ".biz/",
rgrover1 171:6092e61690dc 213 ".gov/",
rgrover1 171:6092e61690dc 214 ".com",
rgrover1 171:6092e61690dc 215 ".org",
rgrover1 171:6092e61690dc 216 ".edu",
rgrover1 171:6092e61690dc 217 ".net",
rgrover1 171:6092e61690dc 218 ".info",
rgrover1 171:6092e61690dc 219 ".biz",
rgrover1 171:6092e61690dc 220 ".gov"
rgrover1 171:6092e61690dc 221 };
rgrover1 171:6092e61690dc 222 const size_t NUM_SUFFIXES = sizeof(suffixes) / sizeof(char *);
rgrover1 171:6092e61690dc 223
rgrover1 171:6092e61690dc 224 size_t encodedBytes = 0;
rgrover1 171:6092e61690dc 225 while (sizeofURLData && (payloadIndex < MAX_SIZEOF_SERVICE_DATA_PAYLOAD)) {
rgrover1 171:6092e61690dc 226 /* check for suffix match */
rgrover1 171:6092e61690dc 227 unsigned i;
rgrover1 171:6092e61690dc 228 for (i = 0; i < NUM_SUFFIXES; i++) {
rgrover1 171:6092e61690dc 229 size_t suffixLen = strlen(suffixes[i]);
rgrover1 171:6092e61690dc 230 if ((suffixLen == 0) || (sizeofURLData < suffixLen)) {
rgrover1 171:6092e61690dc 231 continue;
rgrover1 171:6092e61690dc 232 }
rgrover1 171:6092e61690dc 233
rgrover1 171:6092e61690dc 234 if (strncmp(urldata, suffixes[i], suffixLen) == 0) {
rgrover1 171:6092e61690dc 235 serviceDataPayload[payloadIndex++] = i;
rgrover1 171:6092e61690dc 236 ++encodedBytes;
rgrover1 171:6092e61690dc 237 urldata += suffixLen;
rgrover1 171:6092e61690dc 238 sizeofURLData -= suffixLen;
rgrover1 171:6092e61690dc 239 break; /* from the for loop for checking against suffixes */
rgrover1 171:6092e61690dc 240 }
rgrover1 171:6092e61690dc 241 }
rgrover1 171:6092e61690dc 242 /* This is the default case where we've got an ordinary character which doesn't match a suffix. */
rgrover1 171:6092e61690dc 243 if (i == NUM_SUFFIXES) {
rgrover1 171:6092e61690dc 244 serviceDataPayload[payloadIndex++] = *urldata;
rgrover1 171:6092e61690dc 245 ++encodedBytes;
rgrover1 171:6092e61690dc 246 ++urldata;
rgrover1 171:6092e61690dc 247 --sizeofURLData;
rgrover1 171:6092e61690dc 248 }
rgrover1 171:6092e61690dc 249 }
rgrover1 171:6092e61690dc 250
rgrover1 171:6092e61690dc 251 return encodedBytes;
rgrover1 171:6092e61690dc 252 }
rgrover1 171:6092e61690dc 253
rgrover1 171:6092e61690dc 254 private:
rgrover1 171:6092e61690dc 255 static const size_t MAX_SIZEOF_SERVICE_DATA_PAYLOAD = 27;
rgrover1 171:6092e61690dc 256 static const size_t MAX_SIZE_URI_DATA_CHAR_VALUE = 48;
rgrover1 171:6092e61690dc 257
rgrover1 171:6092e61690dc 258 private:
rgrover1 171:6092e61690dc 259 BLEDevice &ble;
rgrover1 171:6092e61690dc 260
rgrover1 171:6092e61690dc 261 size_t payloadIndex;
rgrover1 171:6092e61690dc 262 uint8_t serviceDataPayload[MAX_SIZEOF_SERVICE_DATA_PAYLOAD];
rgrover1 171:6092e61690dc 263 bool lockedState;
rgrover1 171:6092e61690dc 264 uint16_t uriDataLength;
rgrover1 171:6092e61690dc 265 uint8_t uriDataValue[MAX_SIZE_URI_DATA_CHAR_VALUE];
rgrover1 171:6092e61690dc 266 uint8_t flags;
rgrover1 171:6092e61690dc 267 uint8_t power;
rgrover1 171:6092e61690dc 268 uint16_t beaconPeriod;
rgrover1 171:6092e61690dc 269
rgrover1 171:6092e61690dc 270 GattCharacteristic lockedStateChar;
rgrover1 171:6092e61690dc 271 GattCharacteristic uriDataChar;
rgrover1 171:6092e61690dc 272 GattCharacteristic flagsChar;
rgrover1 171:6092e61690dc 273 // GattCharacteristic txPowerChar;
rgrover1 171:6092e61690dc 274 GattCharacteristic beaconPeriodChar;
rgrover1 171:6092e61690dc 275 };
rgrover1 171:6092e61690dc 276
rgrover1 171:6092e61690dc 277 #endif /* #ifndef __BLE_URI_BEACON_2_SERVICE_H__*/