erkin yucel / mbed-os

mbed os with nrf51 internal bandgap enabled to read battery level

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

features/FEATURE_BLE/ble/UUID.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* mbed Microcontroller Library
elessair 0:f269e3021894 2 * Copyright (c) 2006-2013 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 5 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 6 * You may obtain a copy of the License at
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 9 *
elessair 0:f269e3021894 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 13 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 14 * limitations under the License.
elessair 0:f269e3021894 15 */
elessair 0:f269e3021894 16
elessair 0:f269e3021894 17 #ifndef __UUID_H__
elessair 0:f269e3021894 18 #define __UUID_H__
elessair 0:f269e3021894 19
elessair 0:f269e3021894 20 #include <stdint.h>
elessair 0:f269e3021894 21 #include <string.h>
elessair 0:f269e3021894 22 #include <algorithm>
elessair 0:f269e3021894 23
elessair 0:f269e3021894 24 #include "blecommon.h"
elessair 0:f269e3021894 25
elessair 0:f269e3021894 26 /**
elessair 0:f269e3021894 27 * A trivial converter for single hexadecimal character to an unsigned integer.
elessair 0:f269e3021894 28 *
elessair 0:f269e3021894 29 * @param c
elessair 0:f269e3021894 30 * Hexadecimal character.
elessair 0:f269e3021894 31 *
elessair 0:f269e3021894 32 * @return The corresponding value as unsigned integer.
elessair 0:f269e3021894 33 */
elessair 0:f269e3021894 34 static uint8_t char2int(char c) {
elessair 0:f269e3021894 35 if ((c >= '0') && (c <= '9')) {
elessair 0:f269e3021894 36 return c - '0';
elessair 0:f269e3021894 37 } else if ((c >= 'a') && (c <= 'f')) {
elessair 0:f269e3021894 38 return c - 'a' + 10;
elessair 0:f269e3021894 39 } else if ((c >= 'A') && (c <= 'F')) {
elessair 0:f269e3021894 40 return c - 'A' + 10;
elessair 0:f269e3021894 41 } else {
elessair 0:f269e3021894 42 return 0;
elessair 0:f269e3021894 43 }
elessair 0:f269e3021894 44 }
elessair 0:f269e3021894 45
elessair 0:f269e3021894 46 /**
elessair 0:f269e3021894 47 * An instance of this class represents a Universally Unique Identifier (UUID)
elessair 0:f269e3021894 48 * in the BLE API.
elessair 0:f269e3021894 49 */
elessair 0:f269e3021894 50 class UUID {
elessair 0:f269e3021894 51 public:
elessair 0:f269e3021894 52 /**
elessair 0:f269e3021894 53 * Enumeration of the possible types of UUIDs in BLE with regards to length.
elessair 0:f269e3021894 54 */
elessair 0:f269e3021894 55 enum UUID_Type_t {
elessair 0:f269e3021894 56 UUID_TYPE_SHORT = 0, /**< Short 16-bit UUID. */
elessair 0:f269e3021894 57 UUID_TYPE_LONG = 1 /**< Full 128-bit UUID. */
elessair 0:f269e3021894 58 };
elessair 0:f269e3021894 59
elessair 0:f269e3021894 60 /**
elessair 0:f269e3021894 61 * Enumeration to specify byte ordering of the long version of the UUID.
elessair 0:f269e3021894 62 */
elessair 0:f269e3021894 63 typedef enum {
elessair 0:f269e3021894 64 MSB, /**< Most-significant byte first (at the smallest address) */
elessair 0:f269e3021894 65 LSB /**< least-significant byte first (at the smallest address) */
elessair 0:f269e3021894 66 } ByteOrder_t;
elessair 0:f269e3021894 67
elessair 0:f269e3021894 68 /**
elessair 0:f269e3021894 69 * Type for a 16-bit UUID.
elessair 0:f269e3021894 70 */
elessair 0:f269e3021894 71 typedef uint16_t ShortUUIDBytes_t;
elessair 0:f269e3021894 72
elessair 0:f269e3021894 73 /**
elessair 0:f269e3021894 74 * Length of a long UUID in bytes.
elessair 0:f269e3021894 75 */
elessair 0:f269e3021894 76 static const unsigned LENGTH_OF_LONG_UUID = 16;
elessair 0:f269e3021894 77 /**
elessair 0:f269e3021894 78 * Type for a 128-bit UUID.
elessair 0:f269e3021894 79 */
elessair 0:f269e3021894 80 typedef uint8_t LongUUIDBytes_t[LENGTH_OF_LONG_UUID];
elessair 0:f269e3021894 81
elessair 0:f269e3021894 82 /**
elessair 0:f269e3021894 83 * Maximum length of a string representation of a UUID not including the
elessair 0:f269e3021894 84 * null termination ('\0'): two characters per
elessair 0:f269e3021894 85 * byte plus four '-' characters.
elessair 0:f269e3021894 86 */
elessair 0:f269e3021894 87 static const unsigned MAX_UUID_STRING_LENGTH = LENGTH_OF_LONG_UUID * 2 + 4;
elessair 0:f269e3021894 88
elessair 0:f269e3021894 89 public:
elessair 0:f269e3021894 90
elessair 0:f269e3021894 91 /**
elessair 0:f269e3021894 92 * Creates a new 128-bit UUID.
elessair 0:f269e3021894 93 *
elessair 0:f269e3021894 94 * @note The UUID is a unique 128-bit (16 byte) ID used to identify
elessair 0:f269e3021894 95 * different service or characteristics on the BLE device.
elessair 0:f269e3021894 96 *
elessair 0:f269e3021894 97 * @param stringUUID
elessair 0:f269e3021894 98 * The 128-bit (16-byte) UUID as a human readable const-string.
elessair 0:f269e3021894 99 * Format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
elessair 0:f269e3021894 100 * Upper and lower case supported. Hyphens are optional, but only
elessair 0:f269e3021894 101 * upto four of them. The UUID is stored internally as a 16 byte
elessair 0:f269e3021894 102 * array, LSB (little endian), which is opposite from the string.
elessair 0:f269e3021894 103 */
elessair 0:f269e3021894 104 UUID(const char* stringUUID) : type(UUID_TYPE_LONG), baseUUID(), shortUUID(0) {
elessair 0:f269e3021894 105 bool nibble = false;
elessair 0:f269e3021894 106 uint8_t byte = 0;
elessair 0:f269e3021894 107 size_t baseIndex = 0;
elessair 0:f269e3021894 108 uint8_t tempUUID[LENGTH_OF_LONG_UUID];
elessair 0:f269e3021894 109
elessair 0:f269e3021894 110 /*
elessair 0:f269e3021894 111 * Iterate through string, abort if NULL is encountered prematurely.
elessair 0:f269e3021894 112 * Ignore upto four hyphens.
elessair 0:f269e3021894 113 */
elessair 0:f269e3021894 114 for (size_t index = 0; (index < MAX_UUID_STRING_LENGTH) && (baseIndex < LENGTH_OF_LONG_UUID); index++) {
elessair 0:f269e3021894 115 if (stringUUID[index] == '\0') {
elessair 0:f269e3021894 116 /* Error abort */
elessair 0:f269e3021894 117 break;
elessair 0:f269e3021894 118 } else if (stringUUID[index] == '-') {
elessair 0:f269e3021894 119 /* Ignore hyphen */
elessair 0:f269e3021894 120 continue;
elessair 0:f269e3021894 121 } else if (nibble) {
elessair 0:f269e3021894 122 /* Got second nibble */
elessair 0:f269e3021894 123 byte |= char2int(stringUUID[index]);
elessair 0:f269e3021894 124 nibble = false;
elessair 0:f269e3021894 125
elessair 0:f269e3021894 126 /* Store copy */
elessair 0:f269e3021894 127 tempUUID[baseIndex++] = byte;
elessair 0:f269e3021894 128 } else {
elessair 0:f269e3021894 129 /* Got first nibble */
elessair 0:f269e3021894 130 byte = char2int(stringUUID[index]) << 4;
elessair 0:f269e3021894 131 nibble = true;
elessair 0:f269e3021894 132 }
elessair 0:f269e3021894 133 }
elessair 0:f269e3021894 134
elessair 0:f269e3021894 135 /* Populate internal variables if string was successfully parsed */
elessair 0:f269e3021894 136 if (baseIndex == LENGTH_OF_LONG_UUID) {
elessair 0:f269e3021894 137 setupLong(tempUUID, UUID::MSB);
elessair 0:f269e3021894 138 } else {
elessair 0:f269e3021894 139 const uint8_t sig[] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
elessair 0:f269e3021894 140 0x80, 0x00, 0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB };
elessair 0:f269e3021894 141 setupLong(sig, UUID::MSB);
elessair 0:f269e3021894 142 }
elessair 0:f269e3021894 143 }
elessair 0:f269e3021894 144
elessair 0:f269e3021894 145 /**
elessair 0:f269e3021894 146 * Creates a new 128-bit UUID.
elessair 0:f269e3021894 147 *
elessair 0:f269e3021894 148 * @param[in] longUUID
elessair 0:f269e3021894 149 * The 128-bit (16-byte) UUID value.
elessair 0:f269e3021894 150 * @param[in] order
elessair 0:f269e3021894 151 * The bit order of the UUID, MSB by default.
elessair 0:f269e3021894 152 *
elessair 0:f269e3021894 153 * @note The UUID is a unique 128-bit (16 byte) ID used to identify
elessair 0:f269e3021894 154 * different service or characteristics on the BLE device.
elessair 0:f269e3021894 155 */
elessair 0:f269e3021894 156 UUID(const LongUUIDBytes_t longUUID, ByteOrder_t order = UUID::MSB) : type(UUID_TYPE_LONG), baseUUID(), shortUUID(0) {
elessair 0:f269e3021894 157 setupLong(longUUID, order);
elessair 0:f269e3021894 158 }
elessair 0:f269e3021894 159
elessair 0:f269e3021894 160 /**
elessair 0:f269e3021894 161 * Creates a new 16-bit UUID.
elessair 0:f269e3021894 162 *
elessair 0:f269e3021894 163 * For efficiency, and because 16 bytes would take a large chunk of the
elessair 0:f269e3021894 164 * 27-byte data payload length of the Link Layer, the BLE specification adds
elessair 0:f269e3021894 165 * two additional UUID formats: 16-bit and 32-bit UUIDs. These shortened
elessair 0:f269e3021894 166 * formats can be used only with UUIDs that are defined in the Bluetooth
elessair 0:f269e3021894 167 * specification (listed by the Bluetooth SIG as standard
elessair 0:f269e3021894 168 * Bluetooth UUIDs).
elessair 0:f269e3021894 169 *
elessair 0:f269e3021894 170 * To reconstruct the full 128-bit UUID from the shortened version, insert
elessair 0:f269e3021894 171 * the 16-bit short value (indicated by xxxx, including leading zeros) into
elessair 0:f269e3021894 172 * the Bluetooth Base UUID:
elessair 0:f269e3021894 173 *
elessair 0:f269e3021894 174 * 0000xxxx-0000-1000-8000-00805F9B34FB
elessair 0:f269e3021894 175 *
elessair 0:f269e3021894 176 * @param[in] _shortUUID
elessair 0:f269e3021894 177 * The short UUID value.
elessair 0:f269e3021894 178 *
elessair 0:f269e3021894 179 * @note Shortening is not available for UUIDs that are not derived from the
elessair 0:f269e3021894 180 * Bluetooth Base UUID. Such non-standard UUIDs are commonly called
elessair 0:f269e3021894 181 * vendor-specific UUIDs. In these cases, you’ll need to use the full
elessair 0:f269e3021894 182 * 128-bit UUID value at all times.
elessair 0:f269e3021894 183 *
elessair 0:f269e3021894 184 * @note The UUID is a unique 16-bit (2 byte) ID used to identify
elessair 0:f269e3021894 185 * different service or characteristics on the BLE device.
elessair 0:f269e3021894 186 *
elessair 0:f269e3021894 187 * @note We do not yet support 32-bit shortened UUIDs.
elessair 0:f269e3021894 188 */
elessair 0:f269e3021894 189 UUID(ShortUUIDBytes_t _shortUUID) : type(UUID_TYPE_SHORT), baseUUID(), shortUUID(_shortUUID) {
elessair 0:f269e3021894 190 /* Empty */
elessair 0:f269e3021894 191 }
elessair 0:f269e3021894 192
elessair 0:f269e3021894 193 /**
elessair 0:f269e3021894 194 * Copy constructor.
elessair 0:f269e3021894 195 *
elessair 0:f269e3021894 196 * @param[in] source
elessair 0:f269e3021894 197 * The UUID to copy.
elessair 0:f269e3021894 198 */
elessair 0:f269e3021894 199 UUID(const UUID &source) {
elessair 0:f269e3021894 200 type = source.type;
elessair 0:f269e3021894 201 shortUUID = source.shortUUID;
elessair 0:f269e3021894 202 memcpy(baseUUID, source.baseUUID, LENGTH_OF_LONG_UUID);
elessair 0:f269e3021894 203 }
elessair 0:f269e3021894 204
elessair 0:f269e3021894 205 /**
elessair 0:f269e3021894 206 * The empty constructor.
elessair 0:f269e3021894 207 *
elessair 0:f269e3021894 208 * @note The type of the resulting UUID instance is UUID_TYPE_SHORT and the
elessair 0:f269e3021894 209 * value BLE_UUID_UNKNOWN.
elessair 0:f269e3021894 210 */
elessair 0:f269e3021894 211 UUID(void) : type(UUID_TYPE_SHORT), shortUUID(BLE_UUID_UNKNOWN) {
elessair 0:f269e3021894 212 /* empty */
elessair 0:f269e3021894 213 }
elessair 0:f269e3021894 214
elessair 0:f269e3021894 215 /**
elessair 0:f269e3021894 216 * Fill in a 128-bit UUID; this is useful when the UUID is not known at the
elessair 0:f269e3021894 217 * time of the object construction.
elessair 0:f269e3021894 218 *
elessair 0:f269e3021894 219 * @param[in] longUUID
elessair 0:f269e3021894 220 * The UUID value to copy.
elessair 0:f269e3021894 221 * @param[in] order
elessair 0:f269e3021894 222 * The byte ordering of the UUID at @p longUUID.
elessair 0:f269e3021894 223 */
elessair 0:f269e3021894 224 void setupLong(const LongUUIDBytes_t longUUID, ByteOrder_t order = UUID::MSB) {
elessair 0:f269e3021894 225 type = UUID_TYPE_LONG;
elessair 0:f269e3021894 226 if (order == UUID::MSB) {
elessair 0:f269e3021894 227 /*
elessair 0:f269e3021894 228 * Switch endian. Input is big-endian, internal representation
elessair 0:f269e3021894 229 * is little endian.
elessair 0:f269e3021894 230 */
elessair 0:f269e3021894 231 std::reverse_copy(longUUID, longUUID + LENGTH_OF_LONG_UUID, baseUUID);
elessair 0:f269e3021894 232 } else {
elessair 0:f269e3021894 233 std::copy(longUUID, longUUID + LENGTH_OF_LONG_UUID, baseUUID);
elessair 0:f269e3021894 234 }
elessair 0:f269e3021894 235 shortUUID = (uint16_t)((baseUUID[13] << 8) | (baseUUID[12]));
elessair 0:f269e3021894 236 }
elessair 0:f269e3021894 237
elessair 0:f269e3021894 238 public:
elessair 0:f269e3021894 239 /**
elessair 0:f269e3021894 240 * Check whether this UUID is short or long.
elessair 0:f269e3021894 241 *
elessair 0:f269e3021894 242 * @return UUID_TYPE_SHORT if the UUID is short, UUID_TYPE_LONG otherwise.
elessair 0:f269e3021894 243 */
elessair 0:f269e3021894 244 UUID_Type_t shortOrLong(void) const {
elessair 0:f269e3021894 245 return type;
elessair 0:f269e3021894 246 }
elessair 0:f269e3021894 247
elessair 0:f269e3021894 248 /**
elessair 0:f269e3021894 249 * Get a pointer to the UUID value based on the current UUID type.
elessair 0:f269e3021894 250 *
elessair 0:f269e3021894 251 * @return A pointer to the short UUID if the type is set to
elessair 0:f269e3021894 252 * UUID_TYPE_SHORT. Otherwise, a pointer to the long UUID if the
elessair 0:f269e3021894 253 * type is set to UUID_TYPE_LONG.
elessair 0:f269e3021894 254 */
elessair 0:f269e3021894 255 const uint8_t *getBaseUUID(void) const {
elessair 0:f269e3021894 256 if (type == UUID_TYPE_SHORT) {
elessair 0:f269e3021894 257 return (const uint8_t*)&shortUUID;
elessair 0:f269e3021894 258 } else {
elessair 0:f269e3021894 259 return baseUUID;
elessair 0:f269e3021894 260 }
elessair 0:f269e3021894 261 }
elessair 0:f269e3021894 262
elessair 0:f269e3021894 263 /**
elessair 0:f269e3021894 264 * Get the short UUID.
elessair 0:f269e3021894 265 *
elessair 0:f269e3021894 266 * @return The short UUID.
elessair 0:f269e3021894 267 */
elessair 0:f269e3021894 268 ShortUUIDBytes_t getShortUUID(void) const {
elessair 0:f269e3021894 269 return shortUUID;
elessair 0:f269e3021894 270 }
elessair 0:f269e3021894 271
elessair 0:f269e3021894 272 /**
elessair 0:f269e3021894 273 * Get the length (in bytes) of the UUID based on its type.
elessair 0:f269e3021894 274 *
elessair 0:f269e3021894 275 * @retval sizeof(ShortUUIDBytes_t) if the UUID type is UUID_TYPE_SHORT.
elessair 0:f269e3021894 276 * @retval LENGTH_OF_LONG_UUID if the UUID type is UUID_TYPE_LONG.
elessair 0:f269e3021894 277 */
elessair 0:f269e3021894 278 uint8_t getLen(void) const {
elessair 0:f269e3021894 279 return ((type == UUID_TYPE_SHORT) ? sizeof(ShortUUIDBytes_t) : LENGTH_OF_LONG_UUID);
elessair 0:f269e3021894 280 }
elessair 0:f269e3021894 281
elessair 0:f269e3021894 282 /**
elessair 0:f269e3021894 283 * Overload == operator to enable UUID comparisons.
elessair 0:f269e3021894 284 *
elessair 0:f269e3021894 285 * @param[in] other
elessair 0:f269e3021894 286 * The other UUID in the comparison.
elessair 0:f269e3021894 287 *
elessair 0:f269e3021894 288 * @return true if this == @p other, false otherwise.
elessair 0:f269e3021894 289 */
elessair 0:f269e3021894 290 bool operator== (const UUID &other) const {
elessair 0:f269e3021894 291 if ((this->type == UUID_TYPE_SHORT) && (other.type == UUID_TYPE_SHORT) &&
elessair 0:f269e3021894 292 (this->shortUUID == other.shortUUID)) {
elessair 0:f269e3021894 293 return true;
elessair 0:f269e3021894 294 }
elessair 0:f269e3021894 295
elessair 0:f269e3021894 296 if ((this->type == UUID_TYPE_LONG) && (other.type == UUID_TYPE_LONG) &&
elessair 0:f269e3021894 297 (memcmp(this->baseUUID, other.baseUUID, LENGTH_OF_LONG_UUID) == 0)) {
elessair 0:f269e3021894 298 return true;
elessair 0:f269e3021894 299 }
elessair 0:f269e3021894 300
elessair 0:f269e3021894 301 return false;
elessair 0:f269e3021894 302 }
elessair 0:f269e3021894 303
elessair 0:f269e3021894 304 /**
elessair 0:f269e3021894 305 * Overload != operator to enable UUID comparisons.
elessair 0:f269e3021894 306 *
elessair 0:f269e3021894 307 * @param[in] other
elessair 0:f269e3021894 308 * The other UUID in the comparison.
elessair 0:f269e3021894 309 *
elessair 0:f269e3021894 310 * @return true if this != @p other, false otherwise.
elessair 0:f269e3021894 311 */
elessair 0:f269e3021894 312 bool operator!= (const UUID &other) const {
elessair 0:f269e3021894 313 return !(*this == other);
elessair 0:f269e3021894 314 }
elessair 0:f269e3021894 315
elessair 0:f269e3021894 316 private:
elessair 0:f269e3021894 317 /**
elessair 0:f269e3021894 318 * The UUID type. Refer to UUID_Type_t.
elessair 0:f269e3021894 319 */
elessair 0:f269e3021894 320 UUID_Type_t type;
elessair 0:f269e3021894 321 /**
elessair 0:f269e3021894 322 * The long UUID value.
elessair 0:f269e3021894 323 */
elessair 0:f269e3021894 324 LongUUIDBytes_t baseUUID;
elessair 0:f269e3021894 325 /**
elessair 0:f269e3021894 326 * The short UUID value.
elessair 0:f269e3021894 327 */
elessair 0:f269e3021894 328 ShortUUIDBytes_t shortUUID;
elessair 0:f269e3021894 329 };
elessair 0:f269e3021894 330
elessair 0:f269e3021894 331 #endif // ifndef __UUID_H__