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@458:5546ebd25359, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:51:58 2015 +0100
Revision:
458:5546ebd25359
Parent:
430:0c0ebeb98576
Child:
462:8a86b66ba4de
Synchronized with git rev 081ceb5c

Author: Rohit Grover

Move certain UUID related declarations within the UUID namespace.

Who changed what in which revision?

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