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

GapAdvertisingData.cpp@31:2c94f0501807, 2014-04-01 (annotated)

Committer:
bogdanm
Date:
Tue Apr 01 11:04:56 2014 +0100
Revision:
31:2c94f0501807
Parent:
27:4a83843f04b0
Child:
34:da2ea8cd6216
Synchronized with git revision fdcc1e387426ce216bc17175b73bcd5f4aececff

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ktownsend 27:4a83843f04b0 1 /* mbed Microcontroller Library
ktownsend 27:4a83843f04b0 2 * Copyright (c) 2006-2013 ARM Limited
ktownsend 27:4a83843f04b0 3 *
ktownsend 27:4a83843f04b0 4 * Licensed under the Apache License, Version 2.0 (the "License");
ktownsend 27:4a83843f04b0 5 * you may not use this file except in compliance with the License.
ktownsend 27:4a83843f04b0 6 * You may obtain a copy of the License at
ktownsend 27:4a83843f04b0 7 *
ktownsend 27:4a83843f04b0 8 * http://www.apache.org/licenses/LICENSE-2.0
ktownsend 27:4a83843f04b0 9 *
ktownsend 27:4a83843f04b0 10 * Unless required by applicable law or agreed to in writing, software
ktownsend 27:4a83843f04b0 11 * distributed under the License is distributed on an "AS IS" BASIS,
ktownsend 27:4a83843f04b0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ktownsend 27:4a83843f04b0 13 * See the License for the specific language governing permissions and
ktownsend 27:4a83843f04b0 14 * limitations under the License.
ktownsend 27:4a83843f04b0 15 */
ktownsend 27:4a83843f04b0 16
ktownsend 2:ffc5216bd2cc 17 #include <stdio.h>
ktownsend 2:ffc5216bd2cc 18 #include <string.h>
ktownsend 2:ffc5216bd2cc 19
ktownsend 2:ffc5216bd2cc 20 #include "GapAdvertisingData.h"
ktownsend 2:ffc5216bd2cc 21
ktownsend 2:ffc5216bd2cc 22 /**************************************************************************/
ktownsend 2:ffc5216bd2cc 23 /*!
ktownsend 18:86fe1e247a54 24 \brief Creates a new GapAdvertisingData instance
ktownsend 2:ffc5216bd2cc 25
ktownsend 18:86fe1e247a54 26 \par EXAMPLE
ktownsend 2:ffc5216bd2cc 27
ktownsend 18:86fe1e247a54 28 \code
ktownsend 2:ffc5216bd2cc 29
ktownsend 18:86fe1e247a54 30 \endcode
ktownsend 2:ffc5216bd2cc 31 */
ktownsend 2:ffc5216bd2cc 32 /**************************************************************************/
ktownsend 2:ffc5216bd2cc 33 GapAdvertisingData::GapAdvertisingData(void)
ktownsend 2:ffc5216bd2cc 34 {
ktownsend 3:46de446e82ed 35 memset(_payload, 0, GAP_ADVERTISING_DATA_MAX_PAYLOAD);
ktownsend 3:46de446e82ed 36 _payloadLen = 0;
bogdanm 31:2c94f0501807 37 _appearance = GENERIC_TAG;
ktownsend 2:ffc5216bd2cc 38 }
ktownsend 2:ffc5216bd2cc 39
ktownsend 2:ffc5216bd2cc 40 /**************************************************************************/
ktownsend 2:ffc5216bd2cc 41 /*!
ktownsend 2:ffc5216bd2cc 42 Destructor
ktownsend 2:ffc5216bd2cc 43 */
ktownsend 2:ffc5216bd2cc 44 /**************************************************************************/
ktownsend 2:ffc5216bd2cc 45 GapAdvertisingData::~GapAdvertisingData(void)
ktownsend 2:ffc5216bd2cc 46 {
ktownsend 2:ffc5216bd2cc 47 }
ktownsend 3:46de446e82ed 48
ktownsend 3:46de446e82ed 49 /**************************************************************************/
ktownsend 3:46de446e82ed 50 /*!
ktownsend 18:86fe1e247a54 51 \brief Adds advertising data based on the specified AD type (see
ktownsend 18:86fe1e247a54 52 DataType)
ktownsend 3:46de446e82ed 53
ktownsend 18:86fe1e247a54 54 \args[in] advDataType The Advertising 'DataType' to add
ktownsend 18:86fe1e247a54 55 \args[in] payload Pointer to the payload contents
ktownsend 18:86fe1e247a54 56 \args[in] len Size of the payload in bytes
ktownsend 3:46de446e82ed 57
ktownsend 18:86fe1e247a54 58 \returns ble_error_t
ktownsend 3:46de446e82ed 59
ktownsend 18:86fe1e247a54 60 \retval BLE_ERROR_NONE
ktownsend 3:46de446e82ed 61 Everything executed properly
ktownsend 4:50a31ff5f974 62
ktownsend 18:86fe1e247a54 63 \retval BLE_ERROR_BUFFER_OVERFLOW
ktownsend 4:50a31ff5f974 64 The specified data would cause the advertising buffer
ktownsend 4:50a31ff5f974 65 to overflow
ktownsend 4:50a31ff5f974 66
ktownsend 18:86fe1e247a54 67 \par EXAMPLE
ktownsend 4:50a31ff5f974 68
ktownsend 18:86fe1e247a54 69 \code
ktownsend 4:50a31ff5f974 70
ktownsend 18:86fe1e247a54 71 \endcode
ktownsend 4:50a31ff5f974 72 */
ktownsend 4:50a31ff5f974 73 /**************************************************************************/
ktownsend 4:50a31ff5f974 74 ble_error_t GapAdvertisingData::addData(DataType advDataType, uint8_t * payload, uint8_t len)
ktownsend 4:50a31ff5f974 75 {
ktownsend 4:50a31ff5f974 76 /* ToDo: Check if an AD type already exists and if the existing */
ktownsend 4:50a31ff5f974 77 /* value is exclusive or not (flags, etc.) */
ktownsend 4:50a31ff5f974 78
ktownsend 4:50a31ff5f974 79 /* Make sure we don't exceed the 31 byte payload limit */
ktownsend 14:6ea5d1012a64 80 if (_payloadLen + len + 2 >= GAP_ADVERTISING_DATA_MAX_PAYLOAD)
ktownsend 4:50a31ff5f974 81 return BLE_ERROR_BUFFER_OVERFLOW;
ktownsend 14:6ea5d1012a64 82
ktownsend 14:6ea5d1012a64 83 /* Field length */
ktownsend 14:6ea5d1012a64 84 memset(&_payload[_payloadLen], len+1, 1);
ktownsend 14:6ea5d1012a64 85 _payloadLen++;
ktownsend 4:50a31ff5f974 86
ktownsend 14:6ea5d1012a64 87 /* Field ID */
ktownsend 14:6ea5d1012a64 88 memset(&_payload[_payloadLen], (uint8_t)advDataType, 1);
ktownsend 14:6ea5d1012a64 89 _payloadLen++;
ktownsend 14:6ea5d1012a64 90
ktownsend 14:6ea5d1012a64 91 /* Payload */
ktownsend 4:50a31ff5f974 92 memcpy(&_payload[_payloadLen], payload, len);
ktownsend 4:50a31ff5f974 93 _payloadLen += len;
ktownsend 4:50a31ff5f974 94
ktownsend 4:50a31ff5f974 95 return BLE_ERROR_NONE;
ktownsend 4:50a31ff5f974 96 }
ktownsend 4:50a31ff5f974 97
ktownsend 4:50a31ff5f974 98 /**************************************************************************/
ktownsend 4:50a31ff5f974 99 /*!
ktownsend 18:86fe1e247a54 100 \brief Helper function to add APPEARANCE data to the advertising
ktownsend 4:50a31ff5f974 101 payload
ktownsend 4:50a31ff5f974 102
ktownsend 18:86fe1e247a54 103 \args[in] appearance The APPEARANCE value to add
ktownsend 4:50a31ff5f974 104
ktownsend 18:86fe1e247a54 105 \returns ble_error_t
ktownsend 4:50a31ff5f974 106
ktownsend 18:86fe1e247a54 107 \retval BLE_ERROR_NONE
ktownsend 4:50a31ff5f974 108 Everything executed properly
ktownsend 4:50a31ff5f974 109
ktownsend 18:86fe1e247a54 110 \retval BLE_ERROR_BUFFER_OVERFLOW
ktownsend 3:46de446e82ed 111 The specified data would cause the advertising buffer
ktownsend 3:46de446e82ed 112 to overflow
ktownsend 3:46de446e82ed 113
ktownsend 18:86fe1e247a54 114 \par EXAMPLE
ktownsend 3:46de446e82ed 115
ktownsend 18:86fe1e247a54 116 \code
ktownsend 3:46de446e82ed 117
ktownsend 18:86fe1e247a54 118 \endcode
ktownsend 3:46de446e82ed 119 */
ktownsend 3:46de446e82ed 120 /**************************************************************************/
ktownsend 4:50a31ff5f974 121 ble_error_t GapAdvertisingData::addAppearance(Appearance appearance)
ktownsend 3:46de446e82ed 122 {
bogdanm 31:2c94f0501807 123 _appearance = appearance;
ktownsend 4:50a31ff5f974 124 return addData(GapAdvertisingData::APPEARANCE, (uint8_t*)&appearance, 2);
ktownsend 4:50a31ff5f974 125 }
ktownsend 4:50a31ff5f974 126
ktownsend 4:50a31ff5f974 127 /**************************************************************************/
ktownsend 4:50a31ff5f974 128 /*!
ktownsend 18:86fe1e247a54 129 \brief Helper function to add FLAGS data to the advertising
ktownsend 4:50a31ff5f974 130 payload
ktownsend 4:50a31ff5f974 131
ktownsend 18:86fe1e247a54 132 \args[in] flag The FLAGS value to add
ktownsend 4:50a31ff5f974 133
ktownsend 18:86fe1e247a54 134 \par LE_LIMITED_DISCOVERABLE
ktownsend 18:86fe1e247a54 135 The peripheral is discoverable for a limited period of
ktownsend 18:86fe1e247a54 136 time
ktownsend 4:50a31ff5f974 137
ktownsend 18:86fe1e247a54 138 \par LE_GENERAL_DISCOVERABLE
ktownsend 18:86fe1e247a54 139 The peripheral is permanently discoverable
ktownsend 5:7635f81a8e09 140
ktownsend 18:86fe1e247a54 141 \par BREDR_NOT_SUPPORTED
ktownsend 18:86fe1e247a54 142 This peripheral is a Bluetooth Low Energy only device
ktownsend 18:86fe1e247a54 143 (no EDR support)
ktownsend 4:50a31ff5f974 144
ktownsend 18:86fe1e247a54 145 \returns ble_error_t
ktownsend 4:50a31ff5f974 146
ktownsend 18:86fe1e247a54 147 \retval BLE_ERROR_NONE
ktownsend 4:50a31ff5f974 148 Everything executed properly
ktownsend 4:50a31ff5f974 149
ktownsend 18:86fe1e247a54 150 \retval BLE_ERROR_BUFFER_OVERFLOW
ktownsend 4:50a31ff5f974 151 The specified data would cause the advertising buffer
ktownsend 4:50a31ff5f974 152 to overflow
ktownsend 3:46de446e82ed 153
ktownsend 18:86fe1e247a54 154 \par EXAMPLE
ktownsend 4:50a31ff5f974 155
ktownsend 18:86fe1e247a54 156 \code
ktownsend 4:50a31ff5f974 157
ktownsend 18:86fe1e247a54 158 \endcode
ktownsend 4:50a31ff5f974 159 */
ktownsend 4:50a31ff5f974 160 /**************************************************************************/
ktownsend 4:50a31ff5f974 161 ble_error_t GapAdvertisingData::addFlags(Flags flag)
ktownsend 4:50a31ff5f974 162 {
ktownsend 4:50a31ff5f974 163 return addData(GapAdvertisingData::FLAGS, (uint8_t*)&flag, 1);
ktownsend 4:50a31ff5f974 164 }
ktownsend 4:50a31ff5f974 165
ktownsend 4:50a31ff5f974 166 /**************************************************************************/
ktownsend 4:50a31ff5f974 167 /*!
ktownsend 18:86fe1e247a54 168 \brief Helper function to add TX_POWER_LEVEL data to the
ktownsend 4:50a31ff5f974 169 advertising payload
ktownsend 4:50a31ff5f974 170
ktownsend 18:86fe1e247a54 171 \args[in] flag The TX_POWER_LEVEL value to add
ktownsend 4:50a31ff5f974 172
ktownsend 18:86fe1e247a54 173 \returns ble_error_t
ktownsend 4:50a31ff5f974 174
ktownsend 18:86fe1e247a54 175 \retval BLE_ERROR_NONE
ktownsend 4:50a31ff5f974 176 Everything executed properly
ktownsend 4:50a31ff5f974 177
ktownsend 18:86fe1e247a54 178 \retval BLE_ERROR_BUFFER_OVERFLOW
ktownsend 4:50a31ff5f974 179 The specified data would cause the advertising buffer
ktownsend 4:50a31ff5f974 180 to overflow
ktownsend 3:46de446e82ed 181
ktownsend 18:86fe1e247a54 182 \par EXAMPLE
ktownsend 4:50a31ff5f974 183
ktownsend 18:86fe1e247a54 184 \code
ktownsend 4:50a31ff5f974 185
ktownsend 18:86fe1e247a54 186 \endcode
ktownsend 4:50a31ff5f974 187 */
ktownsend 4:50a31ff5f974 188 /**************************************************************************/
ktownsend 4:50a31ff5f974 189 ble_error_t GapAdvertisingData::addTxPower(int8_t txPower)
ktownsend 4:50a31ff5f974 190 {
ktownsend 4:50a31ff5f974 191 /* ToDo: Basic error checking to make sure txPower is in range */
ktownsend 4:50a31ff5f974 192 return addData(GapAdvertisingData::TX_POWER_LEVEL, (uint8_t*)&txPower, 1);
ktownsend 3:46de446e82ed 193 }
ktownsend 4:50a31ff5f974 194
ktownsend 4:50a31ff5f974 195 /**************************************************************************/
ktownsend 4:50a31ff5f974 196 /*!
ktownsend 18:86fe1e247a54 197 \brief Clears the payload and resets the payload length counter
ktownsend 4:50a31ff5f974 198 */
ktownsend 4:50a31ff5f974 199 /**************************************************************************/
ktownsend 4:50a31ff5f974 200 void GapAdvertisingData::clear(void)
ktownsend 4:50a31ff5f974 201 {
ktownsend 4:50a31ff5f974 202 memset(&_payload, 0, GAP_ADVERTISING_DATA_MAX_PAYLOAD);
ktownsend 4:50a31ff5f974 203 _payloadLen = 0;
ktownsend 4:50a31ff5f974 204 }
ktownsend 4:50a31ff5f974 205
ktownsend 4:50a31ff5f974 206 /**************************************************************************/
ktownsend 4:50a31ff5f974 207 /*!
ktownsend 18:86fe1e247a54 208 \brief Returns a pointer to the the current payload
ktownsend 7:5e1f0d7f7c7d 209
ktownsend 18:86fe1e247a54 210 \returns A pointer to the payload
ktownsend 7:5e1f0d7f7c7d 211 */
ktownsend 7:5e1f0d7f7c7d 212 /**************************************************************************/
ktownsend 7:5e1f0d7f7c7d 213 uint8_t * GapAdvertisingData::getPayload(void)
ktownsend 7:5e1f0d7f7c7d 214 {
bogdanm 31:2c94f0501807 215 return (_payloadLen > 0) ? _payload : NULL;
ktownsend 7:5e1f0d7f7c7d 216 }
ktownsend 7:5e1f0d7f7c7d 217
ktownsend 7:5e1f0d7f7c7d 218 /**************************************************************************/
ktownsend 7:5e1f0d7f7c7d 219 /*!
ktownsend 18:86fe1e247a54 220 \brief Returns the current payload length (0..31 bytes)
ktownsend 7:5e1f0d7f7c7d 221
ktownsend 18:86fe1e247a54 222 \returns The payload length in bytes
ktownsend 4:50a31ff5f974 223 */
ktownsend 4:50a31ff5f974 224 /**************************************************************************/
ktownsend 4:50a31ff5f974 225 uint8_t GapAdvertisingData::getPayloadLen(void)
ktownsend 4:50a31ff5f974 226 {
ktownsend 4:50a31ff5f974 227 return _payloadLen;
ktownsend 4:50a31ff5f974 228 }
bogdanm 31:2c94f0501807 229
bogdanm 31:2c94f0501807 230 /**************************************************************************/
bogdanm 31:2c94f0501807 231 /*!
bogdanm 31:2c94f0501807 232 \brief Returns the 16-bit appearance value for this device
bogdanm 31:2c94f0501807 233
bogdanm 31:2c94f0501807 234 \returns The 16-bit appearance value
bogdanm 31:2c94f0501807 235 */
bogdanm 31:2c94f0501807 236 /**************************************************************************/
bogdanm 31:2c94f0501807 237 uint16_t GapAdvertisingData::getAppearance(void)
bogdanm 31:2c94f0501807 238 {
bogdanm 31:2c94f0501807 239 return (uint16_t)_appearance;
bogdanm 31:2c94f0501807 240 }