Qi Yao / LinkNode---test123

test code 123

Dependencies:   mbed

Fork of LinkNode-Test by Qi Yao

nRF51822_Science_Journal/BLE_API/ble/UUID.h@0:1ad0e04b1bc5, 2016-09-01 (annotated)

Committer:
youkee
Date:
Thu Sep 01 05:14:03 2016 +0000
Revision:
0:1ad0e04b1bc5
change internal time from 1s to 200ms

Who changed what in which revision?

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