Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

public/UUID.h@483:7595444f93d6, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:01 2015 +0100
Revision:
483:7595444f93d6
Parent:
480:67700bd40bd3
Child:
514:1fa338281798
Synchronized with git rev 6c94ed66

Author: Rohit Grover

add include of stdint.h to UUID.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 462:8a86b66ba4de 1 /* mbed Microcontroller Library
rgrover1 462:8a86b66ba4de 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 462:8a86b66ba4de 3 *
rgrover1 462:8a86b66ba4de 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 462:8a86b66ba4de 5 * you may not use this file except in compliance with the License.
rgrover1 462:8a86b66ba4de 6 * You may obtain a copy of the License at
rgrover1 462:8a86b66ba4de 7 *
rgrover1 462:8a86b66ba4de 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 462:8a86b66ba4de 9 *
rgrover1 462:8a86b66ba4de 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 462:8a86b66ba4de 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 462:8a86b66ba4de 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 462:8a86b66ba4de 13 * See the License for the specific language governing permissions and
rgrover1 462:8a86b66ba4de 14 * limitations under the License.
rgrover1 462:8a86b66ba4de 15 */
rgrover1 462:8a86b66ba4de 16
rgrover1 462:8a86b66ba4de 17 #ifndef __UUID_H__
rgrover1 462:8a86b66ba4de 18 #define __UUID_H__
rgrover1 462:8a86b66ba4de 19
rgrover1 483:7595444f93d6 20 #include <stdint.h>
rgrover1 462:8a86b66ba4de 21 #include <string.h>
rgrover1 462:8a86b66ba4de 22
rgrover1 462:8a86b66ba4de 23 #include "blecommon.h"
rgrover1 462:8a86b66ba4de 24
rgrover1 462:8a86b66ba4de 25 class UUID {
rgrover1 462:8a86b66ba4de 26 public:
rgrover1 462:8a86b66ba4de 27 enum UUID_Type_t {
rgrover1 462:8a86b66ba4de 28 UUID_TYPE_SHORT = 0, // Short BLE UUID
rgrover1 462:8a86b66ba4de 29 UUID_TYPE_LONG = 1 // Full 128-bit UUID
rgrover1 462:8a86b66ba4de 30 };
rgrover1 462:8a86b66ba4de 31
rgrover1 463:fd7a5b8d81bd 32 typedef uint16_t ShortUUIDBytes_t;
rgrover1 483:7595444f93d6 33
rgrover1 462:8a86b66ba4de 34 static const unsigned LENGTH_OF_LONG_UUID = 16;
rgrover1 463:fd7a5b8d81bd 35 typedef uint8_t LongUUIDBytes_t[LENGTH_OF_LONG_UUID];
rgrover1 462:8a86b66ba4de 36
rgrover1 462:8a86b66ba4de 37 public:
rgrover1 462:8a86b66ba4de 38 /**
rgrover1 462:8a86b66ba4de 39 * Creates a new 128-bit UUID
rgrover1 462:8a86b66ba4de 40 *
rgrover1 462:8a86b66ba4de 41 * @note The UUID is a unique 128-bit (16 byte) ID used to identify
rgrover1 462:8a86b66ba4de 42 * different service or characteristics on the BLE device.
rgrover1 462:8a86b66ba4de 43 *
rgrover1 462:8a86b66ba4de 44 * @param longUUID
rgrover1 462:8a86b66ba4de 45 * The 128-bit (16-byte) UUID value, MSB first (big-endian).
rgrover1 462:8a86b66ba4de 46 */
rgrover1 462:8a86b66ba4de 47 UUID(const LongUUIDBytes_t longUUID) : type(UUID_TYPE_LONG), baseUUID(), shortUUID(0) {
rgrover1 464:c99b83a7ea55 48 setupLong(longUUID);
rgrover1 462:8a86b66ba4de 49 }
rgrover1 462:8a86b66ba4de 50
rgrover1 462:8a86b66ba4de 51 /**
rgrover1 462:8a86b66ba4de 52 * Creates a new 16-bit UUID
rgrover1 462:8a86b66ba4de 53 *
rgrover1 462:8a86b66ba4de 54 * @note The UUID is a unique 16-bit (2 byte) ID used to identify
rgrover1 462:8a86b66ba4de 55 * different service or characteristics on the BLE device.
rgrover1 462:8a86b66ba4de 56 *
rgrover1 462:8a86b66ba4de 57 * For efficiency, and because 16 bytes would take a large chunk of the
rgrover1 462:8a86b66ba4de 58 * 27-byte data payload length of the Link Layer, the BLE specification adds
rgrover1 462:8a86b66ba4de 59 * two additional UUID formats: 16-bit and 32-bit UUIDs. These shortened
rgrover1 462:8a86b66ba4de 60 * formats can be used only with UUIDs that are defined in the Bluetooth
rgrover1 462:8a86b66ba4de 61 * specification (i.e., that are listed by the Bluetooth SIG as standard
rgrover1 462:8a86b66ba4de 62 * Bluetooth UUIDs).
rgrover1 462:8a86b66ba4de 63 *
rgrover1 462:8a86b66ba4de 64 * To reconstruct the full 128-bit UUID from the shortened version, insert
rgrover1 462:8a86b66ba4de 65 * the 16-bit short value (indicated by xxxx, including leading zeros) into
rgrover1 462:8a86b66ba4de 66 * the Bluetooth Base UUID:
rgrover1 462:8a86b66ba4de 67 *
rgrover1 462:8a86b66ba4de 68 * 0000xxxx-0000-1000-8000-00805F9B34FB
rgrover1 462:8a86b66ba4de 69 *
rgrover1 462:8a86b66ba4de 70 * @note Shortening is not available for UUIDs that are not derived from the
rgrover1 462:8a86b66ba4de 71 * Bluetooth Base UUID. Such non-standard UUIDs are commonly called
rgrover1 462:8a86b66ba4de 72 * vendor-specific UUIDs. In these cases, you’ll need to use the full
rgrover1 462:8a86b66ba4de 73 * 128-bit UUID value at all times.
rgrover1 462:8a86b66ba4de 74 *
rgrover1 462:8a86b66ba4de 75 * @note we don't yet support 32-bit shortened UUIDs.
rgrover1 462:8a86b66ba4de 76 */
rgrover1 462:8a86b66ba4de 77 UUID(ShortUUIDBytes_t shortUUID) : type(UUID_TYPE_SHORT), baseUUID(), shortUUID(shortUUID) {
rgrover1 462:8a86b66ba4de 78 /* empty */
rgrover1 462:8a86b66ba4de 79 }
rgrover1 462:8a86b66ba4de 80
rgrover1 462:8a86b66ba4de 81 UUID(const UUID &source) {
rgrover1 462:8a86b66ba4de 82 type = source.type;
rgrover1 462:8a86b66ba4de 83 shortUUID = source.shortUUID;
rgrover1 462:8a86b66ba4de 84 memcpy(baseUUID, source.baseUUID, LENGTH_OF_LONG_UUID);
rgrover1 462:8a86b66ba4de 85 }
rgrover1 462:8a86b66ba4de 86
rgrover1 462:8a86b66ba4de 87 UUID(void) : type(UUID_TYPE_SHORT), shortUUID(BLE_UUID_UNKNOWN) {
rgrover1 462:8a86b66ba4de 88 /* empty */
rgrover1 462:8a86b66ba4de 89 }
rgrover1 462:8a86b66ba4de 90
rgrover1 464:c99b83a7ea55 91 /**
rgrover1 464:c99b83a7ea55 92 * Fill in a 128-bit UUID; this is useful when UUID isn't known at the time of object construction.
rgrover1 464:c99b83a7ea55 93 */
rgrover1 464:c99b83a7ea55 94 void setupLong(const LongUUIDBytes_t longUUID) {
rgrover1 464:c99b83a7ea55 95 type = UUID_TYPE_LONG;
rgrover1 464:c99b83a7ea55 96 memcpy(baseUUID, longUUID, LENGTH_OF_LONG_UUID);
rgrover1 464:c99b83a7ea55 97 shortUUID = (uint16_t)((longUUID[2] << 8) | (longUUID[3]));
rgrover1 464:c99b83a7ea55 98 }
rgrover1 464:c99b83a7ea55 99
rgrover1 462:8a86b66ba4de 100 public:
rgrover1 462:8a86b66ba4de 101 UUID_Type_t shortOrLong(void) const {return type; }
rgrover1 462:8a86b66ba4de 102 const uint8_t *getBaseUUID(void) const {
rgrover1 462:8a86b66ba4de 103 if (type == UUID_TYPE_SHORT) {
rgrover1 462:8a86b66ba4de 104 return (const uint8_t*)&shortUUID;
rgrover1 462:8a86b66ba4de 105 } else {
rgrover1 462:8a86b66ba4de 106 return baseUUID;
rgrover1 462:8a86b66ba4de 107 }
rgrover1 462:8a86b66ba4de 108 }
rgrover1 462:8a86b66ba4de 109
rgrover1 462:8a86b66ba4de 110 ShortUUIDBytes_t getShortUUID(void) const {return shortUUID;}
rgrover1 462:8a86b66ba4de 111 uint8_t getLen(void) const {
rgrover1 462:8a86b66ba4de 112 return ((type == UUID_TYPE_SHORT) ? sizeof(ShortUUIDBytes_t) : LENGTH_OF_LONG_UUID);
rgrover1 462:8a86b66ba4de 113 }
rgrover1 462:8a86b66ba4de 114
rgrover1 462:8a86b66ba4de 115 bool operator== (const UUID &other) const {
rgrover1 462:8a86b66ba4de 116 if ((this->type == UUID_TYPE_SHORT) && (other.type == UUID_TYPE_SHORT) &&
rgrover1 462:8a86b66ba4de 117 (this->shortUUID == other.shortUUID)) {
rgrover1 462:8a86b66ba4de 118 return true;
rgrover1 462:8a86b66ba4de 119 }
rgrover1 462:8a86b66ba4de 120
rgrover1 462:8a86b66ba4de 121 if ((this->type == UUID_TYPE_LONG) && (other.type == UUID_TYPE_LONG) &&
rgrover1 462:8a86b66ba4de 122 (memcmp(this->baseUUID, other.baseUUID, LENGTH_OF_LONG_UUID) == 0)) {
rgrover1 462:8a86b66ba4de 123 return true;
rgrover1 462:8a86b66ba4de 124 }
rgrover1 462:8a86b66ba4de 125
rgrover1 462:8a86b66ba4de 126 return false;
rgrover1 462:8a86b66ba4de 127 }
rgrover1 462:8a86b66ba4de 128
rgrover1 480:67700bd40bd3 129 bool operator!= (const UUID &other) const {
rgrover1 480:67700bd40bd3 130 return !(*this == other);
rgrover1 480:67700bd40bd3 131 }
rgrover1 480:67700bd40bd3 132
rgrover1 462:8a86b66ba4de 133 private:
rgrover1 462:8a86b66ba4de 134 UUID_Type_t type; // UUID_TYPE_SHORT or UUID_TYPE_LONG
rgrover1 462:8a86b66ba4de 135 LongUUIDBytes_t baseUUID; /* the base of the long UUID (if
rgrover1 462:8a86b66ba4de 136 * used). Note: bytes 12 and 13 (counting from LSB)
rgrover1 462:8a86b66ba4de 137 * are zeroed out to allow comparison with other long
rgrover1 462:8a86b66ba4de 138 * UUIDs which differ only in the 16-bit relative
rgrover1 462:8a86b66ba4de 139 * part.*/
rgrover1 462:8a86b66ba4de 140 ShortUUIDBytes_t shortUUID; // 16 bit uuid (byte 2-3 using with base)
rgrover1 462:8a86b66ba4de 141 };
rgrover1 462:8a86b66ba4de 142
rgrover1 462:8a86b66ba4de 143 #endif // ifndef __UUID_H__