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@47:33f605e109a2, 2014-05-23 (annotated)

Committer:
Rohit Grover
Date:
Fri May 23 17:05:53 2014 +0100
Revision:
47:33f605e109a2
Parent:
40:d405c9b1419d
Child:
58:0642c323b751
adding const to the "data" member of GapAdvertisingData::addData()

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 */
Rohit Grover 34:da2ea8cd6216 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
Rohit Grover 34:da2ea8cd6216 57
ktownsend 18:86fe1e247a54 58 \returns ble_error_t
Rohit Grover 34:da2ea8cd6216 59
ktownsend 18:86fe1e247a54 60 \retval BLE_ERROR_NONE
ktownsend 3:46de446e82ed 61 Everything executed properly
Rohit Grover 34:da2ea8cd6216 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
Rohit Grover 34:da2ea8cd6216 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 /**************************************************************************/
Rohit Grover 47:33f605e109a2 74 ble_error_t GapAdvertisingData::addData(DataType advDataType,
Rohit Grover 47:33f605e109a2 75 const uint8_t *payload,
Rohit Grover 47:33f605e109a2 76 uint8_t len)
ktownsend 4:50a31ff5f974 77 {
ktownsend 4:50a31ff5f974 78 /* ToDo: Check if an AD type already exists and if the existing */
ktownsend 4:50a31ff5f974 79 /* value is exclusive or not (flags, etc.) */
Rohit Grover 34:da2ea8cd6216 80
ktownsend 4:50a31ff5f974 81 /* Make sure we don't exceed the 31 byte payload limit */
Rohit Grover 34:da2ea8cd6216 82 if (_payloadLen + len + 2 >= GAP_ADVERTISING_DATA_MAX_PAYLOAD) {
ktownsend 4:50a31ff5f974 83 return BLE_ERROR_BUFFER_OVERFLOW;
Rohit Grover 34:da2ea8cd6216 84 }
ktownsend 14:6ea5d1012a64 85
ktownsend 14:6ea5d1012a64 86 /* Field length */
Rohit Grover 34:da2ea8cd6216 87 memset(&_payload[_payloadLen], len + 1, 1);
ktownsend 14:6ea5d1012a64 88 _payloadLen++;
Rohit Grover 34:da2ea8cd6216 89
ktownsend 14:6ea5d1012a64 90 /* Field ID */
Rohit Grover 34:da2ea8cd6216 91 memset(&_payload[_payloadLen], (uint8_t)advDataType, 1);
ktownsend 14:6ea5d1012a64 92 _payloadLen++;
Rohit Grover 34:da2ea8cd6216 93
ktownsend 14:6ea5d1012a64 94 /* Payload */
ktownsend 4:50a31ff5f974 95 memcpy(&_payload[_payloadLen], payload, len);
ktownsend 4:50a31ff5f974 96 _payloadLen += len;
Rohit Grover 34:da2ea8cd6216 97
ktownsend 4:50a31ff5f974 98 return BLE_ERROR_NONE;
ktownsend 4:50a31ff5f974 99 }
ktownsend 4:50a31ff5f974 100
ktownsend 4:50a31ff5f974 101 /**************************************************************************/
ktownsend 4:50a31ff5f974 102 /*!
ktownsend 18:86fe1e247a54 103 \brief Helper function to add APPEARANCE data to the advertising
ktownsend 4:50a31ff5f974 104 payload
ktownsend 4:50a31ff5f974 105
ktownsend 18:86fe1e247a54 106 \args[in] appearance The APPEARANCE value to add
Rohit Grover 34:da2ea8cd6216 107
ktownsend 18:86fe1e247a54 108 \returns ble_error_t
Rohit Grover 34:da2ea8cd6216 109
ktownsend 18:86fe1e247a54 110 \retval BLE_ERROR_NONE
ktownsend 4:50a31ff5f974 111 Everything executed properly
Rohit Grover 34:da2ea8cd6216 112
ktownsend 18:86fe1e247a54 113 \retval BLE_ERROR_BUFFER_OVERFLOW
ktownsend 3:46de446e82ed 114 The specified data would cause the advertising buffer
ktownsend 3:46de446e82ed 115 to overflow
Rohit Grover 34:da2ea8cd6216 116
ktownsend 18:86fe1e247a54 117 \par EXAMPLE
ktownsend 3:46de446e82ed 118
ktownsend 18:86fe1e247a54 119 \code
ktownsend 3:46de446e82ed 120
ktownsend 18:86fe1e247a54 121 \endcode
ktownsend 3:46de446e82ed 122 */
ktownsend 3:46de446e82ed 123 /**************************************************************************/
ktownsend 4:50a31ff5f974 124 ble_error_t GapAdvertisingData::addAppearance(Appearance appearance)
ktownsend 3:46de446e82ed 125 {
bogdanm 31:2c94f0501807 126 _appearance = appearance;
Rohit Grover 34:da2ea8cd6216 127 return addData(GapAdvertisingData::APPEARANCE, (uint8_t *)&appearance, 2);
ktownsend 4:50a31ff5f974 128 }
ktownsend 4:50a31ff5f974 129
ktownsend 4:50a31ff5f974 130 /**************************************************************************/
ktownsend 4:50a31ff5f974 131 /*!
ktownsend 18:86fe1e247a54 132 \brief Helper function to add FLAGS data to the advertising
ktownsend 4:50a31ff5f974 133 payload
ktownsend 4:50a31ff5f974 134
ktownsend 18:86fe1e247a54 135 \args[in] flag The FLAGS value to add
ktownsend 4:50a31ff5f974 136
ktownsend 18:86fe1e247a54 137 \par LE_LIMITED_DISCOVERABLE
ktownsend 18:86fe1e247a54 138 The peripheral is discoverable for a limited period of
ktownsend 18:86fe1e247a54 139 time
ktownsend 4:50a31ff5f974 140
ktownsend 18:86fe1e247a54 141 \par LE_GENERAL_DISCOVERABLE
ktownsend 18:86fe1e247a54 142 The peripheral is permanently discoverable
Rohit Grover 34:da2ea8cd6216 143
ktownsend 18:86fe1e247a54 144 \par BREDR_NOT_SUPPORTED
ktownsend 18:86fe1e247a54 145 This peripheral is a Bluetooth Low Energy only device
ktownsend 18:86fe1e247a54 146 (no EDR support)
ktownsend 4:50a31ff5f974 147
ktownsend 18:86fe1e247a54 148 \returns ble_error_t
Rohit Grover 34:da2ea8cd6216 149
ktownsend 18:86fe1e247a54 150 \retval BLE_ERROR_NONE
ktownsend 4:50a31ff5f974 151 Everything executed properly
Rohit Grover 34:da2ea8cd6216 152
ktownsend 18:86fe1e247a54 153 \retval BLE_ERROR_BUFFER_OVERFLOW
ktownsend 4:50a31ff5f974 154 The specified data would cause the advertising buffer
ktownsend 4:50a31ff5f974 155 to overflow
Rohit Grover 34:da2ea8cd6216 156
ktownsend 18:86fe1e247a54 157 \par EXAMPLE
ktownsend 4:50a31ff5f974 158
ktownsend 18:86fe1e247a54 159 \code
ktownsend 4:50a31ff5f974 160
ktownsend 18:86fe1e247a54 161 \endcode
ktownsend 4:50a31ff5f974 162 */
ktownsend 4:50a31ff5f974 163 /**************************************************************************/
ktownsend 4:50a31ff5f974 164 ble_error_t GapAdvertisingData::addFlags(Flags flag)
ktownsend 4:50a31ff5f974 165 {
Rohit Grover 34:da2ea8cd6216 166 return addData(GapAdvertisingData::FLAGS, (uint8_t *)&flag, 1);
ktownsend 4:50a31ff5f974 167 }
ktownsend 4:50a31ff5f974 168
ktownsend 4:50a31ff5f974 169 /**************************************************************************/
ktownsend 4:50a31ff5f974 170 /*!
ktownsend 18:86fe1e247a54 171 \brief Helper function to add TX_POWER_LEVEL data to the
ktownsend 4:50a31ff5f974 172 advertising payload
ktownsend 4:50a31ff5f974 173
ktownsend 18:86fe1e247a54 174 \args[in] flag The TX_POWER_LEVEL value to add
Rohit Grover 34:da2ea8cd6216 175
ktownsend 18:86fe1e247a54 176 \returns ble_error_t
Rohit Grover 34:da2ea8cd6216 177
ktownsend 18:86fe1e247a54 178 \retval BLE_ERROR_NONE
ktownsend 4:50a31ff5f974 179 Everything executed properly
Rohit Grover 34:da2ea8cd6216 180
ktownsend 18:86fe1e247a54 181 \retval BLE_ERROR_BUFFER_OVERFLOW
ktownsend 4:50a31ff5f974 182 The specified data would cause the advertising buffer
ktownsend 4:50a31ff5f974 183 to overflow
Rohit Grover 34:da2ea8cd6216 184
ktownsend 18:86fe1e247a54 185 \par EXAMPLE
ktownsend 4:50a31ff5f974 186
ktownsend 18:86fe1e247a54 187 \code
ktownsend 4:50a31ff5f974 188
ktownsend 18:86fe1e247a54 189 \endcode
ktownsend 4:50a31ff5f974 190 */
ktownsend 4:50a31ff5f974 191 /**************************************************************************/
ktownsend 4:50a31ff5f974 192 ble_error_t GapAdvertisingData::addTxPower(int8_t txPower)
ktownsend 4:50a31ff5f974 193 {
ktownsend 4:50a31ff5f974 194 /* ToDo: Basic error checking to make sure txPower is in range */
Rohit Grover 34:da2ea8cd6216 195 return addData(GapAdvertisingData::TX_POWER_LEVEL, (uint8_t *)&txPower, 1);
ktownsend 3:46de446e82ed 196 }
ktownsend 4:50a31ff5f974 197
ktownsend 4:50a31ff5f974 198 /**************************************************************************/
ktownsend 4:50a31ff5f974 199 /*!
ktownsend 18:86fe1e247a54 200 \brief Clears the payload and resets the payload length counter
ktownsend 4:50a31ff5f974 201 */
ktownsend 4:50a31ff5f974 202 /**************************************************************************/
ktownsend 4:50a31ff5f974 203 void GapAdvertisingData::clear(void)
ktownsend 4:50a31ff5f974 204 {
ktownsend 4:50a31ff5f974 205 memset(&_payload, 0, GAP_ADVERTISING_DATA_MAX_PAYLOAD);
ktownsend 4:50a31ff5f974 206 _payloadLen = 0;
ktownsend 4:50a31ff5f974 207 }
ktownsend 4:50a31ff5f974 208
ktownsend 4:50a31ff5f974 209 /**************************************************************************/
ktownsend 4:50a31ff5f974 210 /*!
ktownsend 18:86fe1e247a54 211 \brief Returns a pointer to the the current payload
Rohit Grover 34:da2ea8cd6216 212
ktownsend 18:86fe1e247a54 213 \returns A pointer to the payload
ktownsend 7:5e1f0d7f7c7d 214 */
ktownsend 7:5e1f0d7f7c7d 215 /**************************************************************************/
Rohit Grover 40:d405c9b1419d 216 const uint8_t *GapAdvertisingData::getPayload(void) const
ktownsend 7:5e1f0d7f7c7d 217 {
bogdanm 31:2c94f0501807 218 return (_payloadLen > 0) ? _payload : NULL;
ktownsend 7:5e1f0d7f7c7d 219 }
ktownsend 7:5e1f0d7f7c7d 220
ktownsend 7:5e1f0d7f7c7d 221 /**************************************************************************/
ktownsend 7:5e1f0d7f7c7d 222 /*!
ktownsend 18:86fe1e247a54 223 \brief Returns the current payload length (0..31 bytes)
Rohit Grover 34:da2ea8cd6216 224
ktownsend 18:86fe1e247a54 225 \returns The payload length in bytes
ktownsend 4:50a31ff5f974 226 */
ktownsend 4:50a31ff5f974 227 /**************************************************************************/
Rohit Grover 40:d405c9b1419d 228 uint8_t GapAdvertisingData::getPayloadLen(void) const
ktownsend 4:50a31ff5f974 229 {
ktownsend 4:50a31ff5f974 230 return _payloadLen;
ktownsend 4:50a31ff5f974 231 }
bogdanm 31:2c94f0501807 232
bogdanm 31:2c94f0501807 233 /**************************************************************************/
bogdanm 31:2c94f0501807 234 /*!
bogdanm 31:2c94f0501807 235 \brief Returns the 16-bit appearance value for this device
Rohit Grover 34:da2ea8cd6216 236
bogdanm 31:2c94f0501807 237 \returns The 16-bit appearance value
bogdanm 31:2c94f0501807 238 */
bogdanm 31:2c94f0501807 239 /**************************************************************************/
Rohit Grover 40:d405c9b1419d 240 uint16_t GapAdvertisingData::getAppearance(void) const
bogdanm 31:2c94f0501807 241 {
bogdanm 31:2c94f0501807 242 return (uint16_t)_appearance;
bogdanm 31:2c94f0501807 243 }