Oscar Ariza / BLE_API

BLE

Fork of BLE_API by Bluetooth Low Energy

ble/UUID.h@1036:d8ba3cb5a39a, 2015-12-10 (annotated)

Committer:
rgrover1
Date:
Thu Dec 10 09:15:04 2015 +0000
Revision:
1036:d8ba3cb5a39a
Parent:
1024:a072b59caddb
Child:
1038:ec64da75c9ee
Synchronized with git rev 01eaeeee

Author: Marcus Chang

Added bit ordering parameter to UUID construction.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 711:b2e1a2660ec2 1 /* mbed Microcontroller Library
rgrover1 711:b2e1a2660ec2 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 711:b2e1a2660ec2 3 *
rgrover1 711:b2e1a2660ec2 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 711:b2e1a2660ec2 5 * you may not use this file except in compliance with the License.
rgrover1 711:b2e1a2660ec2 6 * You may obtain a copy of the License at
rgrover1 711:b2e1a2660ec2 7 *
rgrover1 711:b2e1a2660ec2 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 711:b2e1a2660ec2 9 *
rgrover1 711:b2e1a2660ec2 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 711:b2e1a2660ec2 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 711:b2e1a2660ec2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 711:b2e1a2660ec2 13 * See the License for the specific language governing permissions and
rgrover1 711:b2e1a2660ec2 14 * limitations under the License.
rgrover1 711:b2e1a2660ec2 15 */
rgrover1 711:b2e1a2660ec2 16
rgrover1 711:b2e1a2660ec2 17 #ifndef __UUID_H__
rgrover1 711:b2e1a2660ec2 18 #define __UUID_H__
rgrover1 711:b2e1a2660ec2 19
rgrover1 711:b2e1a2660ec2 20 #include <stdint.h>
rgrover1 711:b2e1a2660ec2 21 #include <string.h>
rgrover1 711:b2e1a2660ec2 22
rgrover1 711:b2e1a2660ec2 23 #include "blecommon.h"
rgrover1 711:b2e1a2660ec2 24
rgrover1 1036:d8ba3cb5a39a 25 static uint8_t char2int(char c) {
rgrover1 1036:d8ba3cb5a39a 26 if ((c >= '0') && (c <= '9')) {
rgrover1 1036:d8ba3cb5a39a 27 return c - '0';
rgrover1 1036:d8ba3cb5a39a 28 } else if ((c >= 'a') && (c <= 'f')) {
rgrover1 1036:d8ba3cb5a39a 29 return c - 'a' + 10;
rgrover1 1036:d8ba3cb5a39a 30 } else if ((c >= 'A') && (c <= 'F')) {
rgrover1 1036:d8ba3cb5a39a 31 return c - 'A' + 10;
rgrover1 1036:d8ba3cb5a39a 32 } else {
rgrover1 1036:d8ba3cb5a39a 33 return 0;
rgrover1 1036:d8ba3cb5a39a 34 }
rgrover1 1036:d8ba3cb5a39a 35 }
rgrover1 1036:d8ba3cb5a39a 36
rgrover1 711:b2e1a2660ec2 37 class UUID {
rgrover1 711:b2e1a2660ec2 38 public:
rgrover1 711:b2e1a2660ec2 39 enum UUID_Type_t {
rgrover1 994:4d62b7967c11 40 UUID_TYPE_SHORT = 0, // Short BLE UUID.
rgrover1 994:4d62b7967c11 41 UUID_TYPE_LONG = 1 // Full 128-bit UUID.
rgrover1 711:b2e1a2660ec2 42 };
rgrover1 711:b2e1a2660ec2 43
rgrover1 1036:d8ba3cb5a39a 44 typedef enum {
rgrover1 1036:d8ba3cb5a39a 45 MSB,
rgrover1 1036:d8ba3cb5a39a 46 LSB
rgrover1 1036:d8ba3cb5a39a 47 } BitOrder_t;
rgrover1 1036:d8ba3cb5a39a 48
rgrover1 711:b2e1a2660ec2 49 typedef uint16_t ShortUUIDBytes_t;
rgrover1 711:b2e1a2660ec2 50
rgrover1 711:b2e1a2660ec2 51 static const unsigned LENGTH_OF_LONG_UUID = 16;
rgrover1 711:b2e1a2660ec2 52 typedef uint8_t LongUUIDBytes_t[LENGTH_OF_LONG_UUID];
rgrover1 711:b2e1a2660ec2 53
rgrover1 1036:d8ba3cb5a39a 54 static const unsigned MAX_UUID_STRING_LENGTH = LENGTH_OF_LONG_UUID * 2 + 4;
rgrover1 1036:d8ba3cb5a39a 55
rgrover1 711:b2e1a2660ec2 56 public:
rgrover1 1036:d8ba3cb5a39a 57
rgrover1 1036:d8ba3cb5a39a 58 /**
rgrover1 1036:d8ba3cb5a39a 59 * Creates a new 128-bit UUID.
rgrover1 1036:d8ba3cb5a39a 60 *
rgrover1 1036:d8ba3cb5a39a 61 * @note The UUID is a unique 128-bit (16 byte) ID used to identify
rgrover1 1036:d8ba3cb5a39a 62 * different service or characteristics on the BLE device.
rgrover1 1036:d8ba3cb5a39a 63 *
rgrover1 1036:d8ba3cb5a39a 64 * @param stringUUID
rgrover1 1036:d8ba3cb5a39a 65 * The 128-bit (16-byte) UUID as a human readable const-string.
rgrover1 1036:d8ba3cb5a39a 66 * Format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
rgrover1 1036:d8ba3cb5a39a 67 * Upper and lower case supported. Hyphens are optional, but only
rgrover1 1036:d8ba3cb5a39a 68 * upto four of them. The UUID is stored internally as a 16 byte
rgrover1 1036:d8ba3cb5a39a 69 * array, LSB (little endian), which is opposite from the string.
rgrover1 1036:d8ba3cb5a39a 70 */
rgrover1 1036:d8ba3cb5a39a 71 UUID(const char* stringUUID) : type(UUID_TYPE_LONG), baseUUID(), shortUUID(0) {
rgrover1 1036:d8ba3cb5a39a 72 bool nibble = false;
rgrover1 1036:d8ba3cb5a39a 73 uint8_t byte = 0;
rgrover1 1036:d8ba3cb5a39a 74 size_t baseIndex = 0;
rgrover1 1036:d8ba3cb5a39a 75 uint8_t tempUUID[LENGTH_OF_LONG_UUID];
rgrover1 1036:d8ba3cb5a39a 76
rgrover1 1036:d8ba3cb5a39a 77 // Iterate through string, abort if NULL is encountered prematurely.
rgrover1 1036:d8ba3cb5a39a 78 // Ignore upto four hyphens.
rgrover1 1036:d8ba3cb5a39a 79 for (size_t index = 0; (index < MAX_UUID_STRING_LENGTH) && (baseIndex < LENGTH_OF_LONG_UUID); index++) {
rgrover1 1036:d8ba3cb5a39a 80 if (stringUUID[index] == '\0') {
rgrover1 1036:d8ba3cb5a39a 81 // error abort
rgrover1 1036:d8ba3cb5a39a 82 break;
rgrover1 1036:d8ba3cb5a39a 83 } else if (stringUUID[index] == '-') {
rgrover1 1036:d8ba3cb5a39a 84 // ignore hyphen
rgrover1 1036:d8ba3cb5a39a 85 continue;
rgrover1 1036:d8ba3cb5a39a 86 } else if (nibble) {
rgrover1 1036:d8ba3cb5a39a 87 // got second nibble
rgrover1 1036:d8ba3cb5a39a 88 byte |= char2int(stringUUID[index]);
rgrover1 1036:d8ba3cb5a39a 89 nibble = false;
rgrover1 1036:d8ba3cb5a39a 90
rgrover1 1036:d8ba3cb5a39a 91 // store copy
rgrover1 1036:d8ba3cb5a39a 92 tempUUID[baseIndex++] = byte;
rgrover1 1036:d8ba3cb5a39a 93 } else {
rgrover1 1036:d8ba3cb5a39a 94 // got first nibble
rgrover1 1036:d8ba3cb5a39a 95 byte = char2int(stringUUID[index]) << 4;
rgrover1 1036:d8ba3cb5a39a 96 nibble = true;
rgrover1 1036:d8ba3cb5a39a 97 }
rgrover1 1036:d8ba3cb5a39a 98 }
rgrover1 1036:d8ba3cb5a39a 99
rgrover1 1036:d8ba3cb5a39a 100 // populate internal variables if string was successfully parsed
rgrover1 1036:d8ba3cb5a39a 101 if (baseIndex == LENGTH_OF_LONG_UUID) {
rgrover1 1036:d8ba3cb5a39a 102 setupLong(tempUUID, UUID::MSB);
rgrover1 1036:d8ba3cb5a39a 103 } else {
rgrover1 1036:d8ba3cb5a39a 104 const uint8_t sig[] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
rgrover1 1036:d8ba3cb5a39a 105 0x80, 0x00, 0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB };
rgrover1 1036:d8ba3cb5a39a 106 setupLong(sig, UUID::MSB);
rgrover1 1036:d8ba3cb5a39a 107 }
rgrover1 1036:d8ba3cb5a39a 108 }
rgrover1 1036:d8ba3cb5a39a 109
rgrover1 711:b2e1a2660ec2 110 /**
rgrover1 994:4d62b7967c11 111 * Creates a new 128-bit UUID.
rgrover1 711:b2e1a2660ec2 112 *
rgrover1 711:b2e1a2660ec2 113 * @note The UUID is a unique 128-bit (16 byte) ID used to identify
rgrover1 711:b2e1a2660ec2 114 * different service or characteristics on the BLE device.
rgrover1 711:b2e1a2660ec2 115 *
rgrover1 711:b2e1a2660ec2 116 * @param longUUID
rgrover1 1036:d8ba3cb5a39a 117 * The 128-bit (16-byte) UUID value.
rgrover1 1036:d8ba3cb5a39a 118 * @param order
rgrover1 1036:d8ba3cb5a39a 119 * The bit order of the UUID, MSB by default.
rgrover1 711:b2e1a2660ec2 120 */
rgrover1 1036:d8ba3cb5a39a 121 UUID(const LongUUIDBytes_t longUUID, BitOrder_t order = UUID::MSB) : type(UUID_TYPE_LONG), baseUUID(), shortUUID(0) {
rgrover1 1036:d8ba3cb5a39a 122 setupLong(longUUID, order);
rgrover1 711:b2e1a2660ec2 123 }
rgrover1 711:b2e1a2660ec2 124
rgrover1 711:b2e1a2660ec2 125 /**
rgrover1 994:4d62b7967c11 126 * Creates a new 16-bit UUID.
rgrover1 711:b2e1a2660ec2 127 *
rgrover1 711:b2e1a2660ec2 128 * @note The UUID is a unique 16-bit (2 byte) ID used to identify
rgrover1 711:b2e1a2660ec2 129 * different service or characteristics on the BLE device.
rgrover1 711:b2e1a2660ec2 130 *
rgrover1 711:b2e1a2660ec2 131 * For efficiency, and because 16 bytes would take a large chunk of the
rgrover1 711:b2e1a2660ec2 132 * 27-byte data payload length of the Link Layer, the BLE specification adds
rgrover1 711:b2e1a2660ec2 133 * two additional UUID formats: 16-bit and 32-bit UUIDs. These shortened
rgrover1 711:b2e1a2660ec2 134 * formats can be used only with UUIDs that are defined in the Bluetooth
rgrover1 994:4d62b7967c11 135 * specification (listed by the Bluetooth SIG as standard
rgrover1 711:b2e1a2660ec2 136 * Bluetooth UUIDs).
rgrover1 711:b2e1a2660ec2 137 *
rgrover1 711:b2e1a2660ec2 138 * To reconstruct the full 128-bit UUID from the shortened version, insert
rgrover1 711:b2e1a2660ec2 139 * the 16-bit short value (indicated by xxxx, including leading zeros) into
rgrover1 711:b2e1a2660ec2 140 * the Bluetooth Base UUID:
rgrover1 711:b2e1a2660ec2 141 *
rgrover1 711:b2e1a2660ec2 142 * 0000xxxx-0000-1000-8000-00805F9B34FB
rgrover1 711:b2e1a2660ec2 143 *
rgrover1 711:b2e1a2660ec2 144 * @note Shortening is not available for UUIDs that are not derived from the
rgrover1 711:b2e1a2660ec2 145 * Bluetooth Base UUID. Such non-standard UUIDs are commonly called
rgrover1 711:b2e1a2660ec2 146 * vendor-specific UUIDs. In these cases, you’ll need to use the full
rgrover1 711:b2e1a2660ec2 147 * 128-bit UUID value at all times.
rgrover1 711:b2e1a2660ec2 148 *
rgrover1 994:4d62b7967c11 149 * @note We don't yet support 32-bit shortened UUIDs.
rgrover1 711:b2e1a2660ec2 150 */
rgrover1 912:885ee648c6ab 151 UUID(ShortUUIDBytes_t _shortUUID) : type(UUID_TYPE_SHORT), baseUUID(), shortUUID(_shortUUID) {
rgrover1 994:4d62b7967c11 152 /* Empty */
rgrover1 711:b2e1a2660ec2 153 }
rgrover1 711:b2e1a2660ec2 154
rgrover1 711:b2e1a2660ec2 155 UUID(const UUID &source) {
rgrover1 711:b2e1a2660ec2 156 type = source.type;
rgrover1 711:b2e1a2660ec2 157 shortUUID = source.shortUUID;
rgrover1 711:b2e1a2660ec2 158 memcpy(baseUUID, source.baseUUID, LENGTH_OF_LONG_UUID);
rgrover1 711:b2e1a2660ec2 159 }
rgrover1 711:b2e1a2660ec2 160
rgrover1 711:b2e1a2660ec2 161 UUID(void) : type(UUID_TYPE_SHORT), shortUUID(BLE_UUID_UNKNOWN) {
rgrover1 711:b2e1a2660ec2 162 /* empty */
rgrover1 711:b2e1a2660ec2 163 }
rgrover1 711:b2e1a2660ec2 164
rgrover1 711:b2e1a2660ec2 165 /**
rgrover1 994:4d62b7967c11 166 * Fill in a 128-bit UUID; this is useful when the UUID isn't known at the time of the object construction.
rgrover1 711:b2e1a2660ec2 167 */
rgrover1 1036:d8ba3cb5a39a 168 void setupLong(const LongUUIDBytes_t longUUID, BitOrder_t order = UUID::MSB) {
rgrover1 711:b2e1a2660ec2 169 type = UUID_TYPE_LONG;
rgrover1 1036:d8ba3cb5a39a 170 if (order == UUID::MSB) {
rgrover1 1036:d8ba3cb5a39a 171 // Switch endian. Input is big-endian, internal representation is little endian.
rgrover1 1036:d8ba3cb5a39a 172 for (size_t index = 0; index < LENGTH_OF_LONG_UUID; index++) {
rgrover1 1036:d8ba3cb5a39a 173 baseUUID[LENGTH_OF_LONG_UUID - 1 - index] = longUUID[index];
rgrover1 1036:d8ba3cb5a39a 174 }
rgrover1 1036:d8ba3cb5a39a 175 } else {
rgrover1 1036:d8ba3cb5a39a 176 memcpy(baseUUID, longUUID, LENGTH_OF_LONG_UUID);
rgrover1 1036:d8ba3cb5a39a 177 }
rgrover1 1036:d8ba3cb5a39a 178 shortUUID = (uint16_t)((baseUUID[13] << 8) | (baseUUID[12]));
rgrover1 711:b2e1a2660ec2 179 }
rgrover1 711:b2e1a2660ec2 180
rgrover1 711:b2e1a2660ec2 181 public:
rgrover1 711:b2e1a2660ec2 182 UUID_Type_t shortOrLong(void) const {return type; }
rgrover1 711:b2e1a2660ec2 183 const uint8_t *getBaseUUID(void) const {
rgrover1 711:b2e1a2660ec2 184 if (type == UUID_TYPE_SHORT) {
rgrover1 711:b2e1a2660ec2 185 return (const uint8_t*)&shortUUID;
rgrover1 711:b2e1a2660ec2 186 } else {
rgrover1 711:b2e1a2660ec2 187 return baseUUID;
rgrover1 711:b2e1a2660ec2 188 }
rgrover1 711:b2e1a2660ec2 189 }
rgrover1 711:b2e1a2660ec2 190
rgrover1 711:b2e1a2660ec2 191 ShortUUIDBytes_t getShortUUID(void) const {return shortUUID;}
rgrover1 711:b2e1a2660ec2 192 uint8_t getLen(void) const {
rgrover1 711:b2e1a2660ec2 193 return ((type == UUID_TYPE_SHORT) ? sizeof(ShortUUIDBytes_t) : LENGTH_OF_LONG_UUID);
rgrover1 711:b2e1a2660ec2 194 }
rgrover1 711:b2e1a2660ec2 195
rgrover1 711:b2e1a2660ec2 196 bool operator== (const UUID &other) const {
rgrover1 711:b2e1a2660ec2 197 if ((this->type == UUID_TYPE_SHORT) && (other.type == UUID_TYPE_SHORT) &&
rgrover1 711:b2e1a2660ec2 198 (this->shortUUID == other.shortUUID)) {
rgrover1 711:b2e1a2660ec2 199 return true;
rgrover1 711:b2e1a2660ec2 200 }
rgrover1 711:b2e1a2660ec2 201
rgrover1 711:b2e1a2660ec2 202 if ((this->type == UUID_TYPE_LONG) && (other.type == UUID_TYPE_LONG) &&
rgrover1 711:b2e1a2660ec2 203 (memcmp(this->baseUUID, other.baseUUID, LENGTH_OF_LONG_UUID) == 0)) {
rgrover1 711:b2e1a2660ec2 204 return true;
rgrover1 711:b2e1a2660ec2 205 }
rgrover1 711:b2e1a2660ec2 206
rgrover1 711:b2e1a2660ec2 207 return false;
rgrover1 711:b2e1a2660ec2 208 }
rgrover1 711:b2e1a2660ec2 209
rgrover1 711:b2e1a2660ec2 210 bool operator!= (const UUID &other) const {
rgrover1 711:b2e1a2660ec2 211 return !(*this == other);
rgrover1 711:b2e1a2660ec2 212 }
rgrover1 711:b2e1a2660ec2 213
rgrover1 711:b2e1a2660ec2 214 private:
rgrover1 711:b2e1a2660ec2 215 UUID_Type_t type; // UUID_TYPE_SHORT or UUID_TYPE_LONG
rgrover1 1036:d8ba3cb5a39a 216 LongUUIDBytes_t baseUUID; // The long UUID
rgrover1 1036:d8ba3cb5a39a 217 ShortUUIDBytes_t shortUUID; // 16 bit UUID
rgrover1 711:b2e1a2660ec2 218 };
rgrover1 711:b2e1a2660ec2 219
rgrover1 711:b2e1a2660ec2 220 #endif // ifndef __UUID_H__