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@628:e3b648dd2e36, 2015-06-19 (annotated)

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