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@420:feaaae454283, 2015-06-08 (annotated)

Committer:
rgrover1
Date:
Mon Jun 08 10:41:19 2015 +0100
Revision:
420:feaaae454283
Parent:
419:0b9370f628b4
Child:
421:e8e1eb82b99e
Synchronized with git rev 27aae6bf

Author: Rohit Grover

Add a copy and default constructor for UUID.h.

add a comment to UUID constructor to explain MSB byte ordering.

Who changed what in which revision?

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