xiao sun / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

public/UUID.h@424:370d5f1f292f, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:51:54 2015 +0100
Revision:
424:370d5f1f292f
Parent:
422:b45d7dc06a41
Child:
430:0c0ebeb98576
Synchronized with git rev 8d3e0929

Author: Rohit Grover

add a missing include for GapScanningParams.h

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 const unsigned LENGTH_OF_LONG_UUID = 16;
rgrover1 424:370d5f1f292f 25 typedef uint16_t ShortUUIDBytes_t;
rgrover1 424:370d5f1f292f 26 typedef uint8_t LongUUIDBytes_t[LENGTH_OF_LONG_UUID];
rgrover1 424:370d5f1f292f 27
rgrover1 424:370d5f1f292f 28 class UUID {
rgrover1 424:370d5f1f292f 29 public:
rgrover1 424:370d5f1f292f 30 enum UUID_Type_t {
rgrover1 424:370d5f1f292f 31 UUID_TYPE_SHORT = 0, // Short BLE UUID
rgrover1 424:370d5f1f292f 32 UUID_TYPE_LONG = 1 // Full 128-bit UUID
rgrover1 424:370d5f1f292f 33 };
rgrover1 424:370d5f1f292f 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 424:370d5f1f292f 80 public:
rgrover1 424:370d5f1f292f 81 UUID_Type_t shortOrLong(void) const {return type; }
rgrover1 424:370d5f1f292f 82 const uint8_t *getBaseUUID(void) const {
rgrover1 424:370d5f1f292f 83 if (type == UUID_TYPE_SHORT) {
rgrover1 424:370d5f1f292f 84 return (const uint8_t*)&shortUUID;
rgrover1 424:370d5f1f292f 85 } else {
rgrover1 424:370d5f1f292f 86 return baseUUID;
rgrover1 424:370d5f1f292f 87 }
rgrover1 424:370d5f1f292f 88 }
rgrover1 424:370d5f1f292f 89
rgrover1 424:370d5f1f292f 90 ShortUUIDBytes_t getShortUUID(void) const {return shortUUID;}
rgrover1 424:370d5f1f292f 91 uint8_t getLen(void) const {
rgrover1 424:370d5f1f292f 92 return ((type == UUID_TYPE_SHORT) ? sizeof(ShortUUIDBytes_t) : LENGTH_OF_LONG_UUID);
rgrover1 424:370d5f1f292f 93 }
rgrover1 424:370d5f1f292f 94
rgrover1 424:370d5f1f292f 95 bool operator== (const UUID &other) const {
rgrover1 424:370d5f1f292f 96 if ((this->type == UUID_TYPE_SHORT) && (other.type == UUID_TYPE_SHORT) &&
rgrover1 424:370d5f1f292f 97 (this->shortUUID == other.shortUUID)) {
rgrover1 424:370d5f1f292f 98 return true;
rgrover1 424:370d5f1f292f 99 }
rgrover1 424:370d5f1f292f 100
rgrover1 424:370d5f1f292f 101 if ((this->type == UUID_TYPE_LONG) && (other.type == UUID_TYPE_LONG) &&
rgrover1 424:370d5f1f292f 102 (memcmp(this->baseUUID, other.baseUUID, LENGTH_OF_LONG_UUID) == 0)) {
rgrover1 424:370d5f1f292f 103 return true;
rgrover1 424:370d5f1f292f 104 }
rgrover1 424:370d5f1f292f 105
rgrover1 424:370d5f1f292f 106 return false;
rgrover1 424:370d5f1f292f 107 }
rgrover1 424:370d5f1f292f 108
rgrover1 424:370d5f1f292f 109 private:
rgrover1 424:370d5f1f292f 110 UUID_Type_t type; // UUID_TYPE_SHORT or UUID_TYPE_LONG
rgrover1 424:370d5f1f292f 111 LongUUIDBytes_t baseUUID; /* the base of the long UUID (if
rgrover1 424:370d5f1f292f 112 * used). Note: bytes 12 and 13 (counting from LSB)
rgrover1 424:370d5f1f292f 113 * are zeroed out to allow comparison with other long
rgrover1 424:370d5f1f292f 114 * UUIDs which differ only in the 16-bit relative
rgrover1 424:370d5f1f292f 115 * part.*/
rgrover1 424:370d5f1f292f 116 ShortUUIDBytes_t shortUUID; // 16 bit uuid (byte 2-3 using with base)
rgrover1 424:370d5f1f292f 117 };
rgrover1 424:370d5f1f292f 118
rgrover1 424:370d5f1f292f 119 #endif // ifndef __UUID_H__