/ BLE_API

aa

Dependents:   Peripheral_1_serial_copy Peripheral_1_serial 151006_1st_Scenario_normal

Fork of BLE_API by Bluetooth Low Energy

ble/BLE.h@822:86038b69609c, 2015-09-29 (annotated)

Committer:
rgrover1
Date:
Tue Sep 29 09:49:24 2015 +0100
Revision:
822:86038b69609c
Parent:
821:3cb854c7f930
Child:
823:a0f080d1e836
Synchronized with git rev cc3db850

Author: Rohit Grover

minor improvement to comment header for GattServer::onDataRead()

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 716:11b41f651697 1 /* mbed Microcontroller Library
rgrover1 716:11b41f651697 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 716:11b41f651697 3 *
rgrover1 716:11b41f651697 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 716:11b41f651697 5 * you may not use this file except in compliance with the License.
rgrover1 716:11b41f651697 6 * You may obtain a copy of the License at
rgrover1 716:11b41f651697 7 *
rgrover1 716:11b41f651697 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 716:11b41f651697 9 *
rgrover1 716:11b41f651697 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 716:11b41f651697 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 716:11b41f651697 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 716:11b41f651697 13 * See the License for the specific language governing permissions and
rgrover1 716:11b41f651697 14 * limitations under the License.
rgrover1 716:11b41f651697 15 */
rgrover1 716:11b41f651697 16
rgrover1 716:11b41f651697 17 #ifndef __BLE_H__
rgrover1 716:11b41f651697 18 #define __BLE_H__
rgrover1 716:11b41f651697 19
rgrover1 716:11b41f651697 20 #include "blecommon.h"
rgrover1 716:11b41f651697 21 #include "Gap.h"
rgrover1 716:11b41f651697 22 #include "GattServer.h"
rgrover1 716:11b41f651697 23 #include "GattClient.h"
rgrover1 716:11b41f651697 24 #include "BLEInstanceBase.h"
rgrover1 716:11b41f651697 25
rgrover1 819:61c62a287194 26 #include "mbed_error.h"
rgrover1 819:61c62a287194 27
rgrover1 716:11b41f651697 28 /**
rgrover1 716:11b41f651697 29 * The base class used to abstract away BLE capable radio transceivers or SOCs,
rgrover1 716:11b41f651697 30 * to enable this BLE API to work with any radio transparently.
rgrover1 716:11b41f651697 31 */
rgrover1 716:11b41f651697 32 class BLE
rgrover1 716:11b41f651697 33 {
rgrover1 716:11b41f651697 34 public:
rgrover1 716:11b41f651697 35 /**
rgrover1 716:11b41f651697 36 * Initialize the BLE controller. This should be called before using
rgrover1 716:11b41f651697 37 * anything else in the BLE_API.
rgrover1 716:11b41f651697 38 *
rgrover1 716:11b41f651697 39 * init() hands control to the underlying BLE module to accomplish
rgrover1 716:11b41f651697 40 * initialization. This initialization may tacitly depend on other hardware
rgrover1 716:11b41f651697 41 * setup (such as clocks or power-modes) which happens early on during
rgrover1 716:11b41f651697 42 * system startup. It may not be safe to call init() from global static
rgrover1 716:11b41f651697 43 * context where ordering is compiler specific and can't be guaranteed--it
rgrover1 716:11b41f651697 44 * is safe to call BLE::init() from within main().
rgrover1 716:11b41f651697 45 */
rgrover1 716:11b41f651697 46 ble_error_t init();
rgrover1 716:11b41f651697 47
rgrover1 716:11b41f651697 48 /**
rgrover1 716:11b41f651697 49 * Purge the BLE stack of GATT and GAP state. init() must be called
rgrover1 716:11b41f651697 50 * afterwards to re-instate services and GAP state. This API offers a way to
rgrover1 716:11b41f651697 51 * repopulate the GATT database with new services and characteristics.
rgrover1 716:11b41f651697 52 */
rgrover1 716:11b41f651697 53 ble_error_t shutdown(void) {
rgrover1 716:11b41f651697 54 clearAdvertisingPayload();
rgrover1 819:61c62a287194 55 if (!transport) {
rgrover1 819:61c62a287194 56 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 57 }
rgrover1 716:11b41f651697 58 return transport->shutdown();
rgrover1 716:11b41f651697 59 }
rgrover1 716:11b41f651697 60
rgrover1 716:11b41f651697 61 /**
rgrover1 716:11b41f651697 62 * This call allows the application to get the BLE stack version information.
rgrover1 716:11b41f651697 63 *
rgrover1 716:11b41f651697 64 * @return A pointer to a const string representing the version.
rgrover1 716:11b41f651697 65 * Note: The string is owned by the BLE_API.
rgrover1 716:11b41f651697 66 */
rgrover1 716:11b41f651697 67 const char *getVersion(void) {
rgrover1 819:61c62a287194 68 if (!transport) {
rgrover1 819:61c62a287194 69 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 70 }
rgrover1 716:11b41f651697 71 return transport->getVersion();
rgrover1 716:11b41f651697 72 }
rgrover1 716:11b41f651697 73
rgrover1 716:11b41f651697 74 /*
rgrover1 716:11b41f651697 75 * Accessors to GAP. Please refer to Gap.h. All GAP related functionality requires
rgrover1 716:11b41f651697 76 * going through this accessor.
rgrover1 716:11b41f651697 77 */
rgrover1 716:11b41f651697 78 const Gap &gap() const {
rgrover1 819:61c62a287194 79 if (!transport) {
rgrover1 819:61c62a287194 80 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 81 }
rgrover1 716:11b41f651697 82 return transport->getGap();
rgrover1 716:11b41f651697 83 }
rgrover1 716:11b41f651697 84 Gap &gap() {
rgrover1 819:61c62a287194 85 if (!transport) {
rgrover1 819:61c62a287194 86 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 87 }
rgrover1 716:11b41f651697 88 return transport->getGap();
rgrover1 716:11b41f651697 89 }
rgrover1 716:11b41f651697 90
rgrover1 716:11b41f651697 91 /*
rgrover1 716:11b41f651697 92 * Accessors to GATT Server. Please refer to GattServer.h. All GATTServer related
rgrover1 716:11b41f651697 93 * functionality requires going through this accessor.
rgrover1 716:11b41f651697 94 */
rgrover1 716:11b41f651697 95 const GattServer& gattServer() const {
rgrover1 819:61c62a287194 96 if (!transport) {
rgrover1 819:61c62a287194 97 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 98 }
rgrover1 716:11b41f651697 99 return transport->getGattServer();
rgrover1 716:11b41f651697 100 }
rgrover1 716:11b41f651697 101 GattServer& gattServer() {
rgrover1 819:61c62a287194 102 if (!transport) {
rgrover1 819:61c62a287194 103 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 104 }
rgrover1 716:11b41f651697 105 return transport->getGattServer();
rgrover1 716:11b41f651697 106 }
rgrover1 716:11b41f651697 107
rgrover1 716:11b41f651697 108 /*
rgrover1 716:11b41f651697 109 * Accessors to GATT Client. Please refer to GattClient.h. All GATTClient related
rgrover1 716:11b41f651697 110 * functionality requires going through this accessor.
rgrover1 716:11b41f651697 111 */
rgrover1 716:11b41f651697 112 const GattClient& gattClient() const {
rgrover1 819:61c62a287194 113 if (!transport) {
rgrover1 819:61c62a287194 114 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 115 }
rgrover1 716:11b41f651697 116 return transport->getGattClient();
rgrover1 716:11b41f651697 117 }
rgrover1 716:11b41f651697 118 GattClient& gattClient() {
rgrover1 819:61c62a287194 119 if (!transport) {
rgrover1 819:61c62a287194 120 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 121 }
rgrover1 716:11b41f651697 122 return transport->getGattClient();
rgrover1 716:11b41f651697 123 }
rgrover1 716:11b41f651697 124
rgrover1 716:11b41f651697 125 /*
rgrover1 716:11b41f651697 126 * Accessors to Security Manager. Please refer to SecurityManager.h. All
rgrover1 716:11b41f651697 127 * SecurityManager related functionality requires going through this
rgrover1 716:11b41f651697 128 * accessor.
rgrover1 716:11b41f651697 129 */
rgrover1 716:11b41f651697 130 const SecurityManager& securityManager() const {
rgrover1 819:61c62a287194 131 if (!transport) {
rgrover1 819:61c62a287194 132 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 133 }
rgrover1 716:11b41f651697 134 return transport->getSecurityManager();
rgrover1 716:11b41f651697 135 }
rgrover1 716:11b41f651697 136 SecurityManager& securityManager() {
rgrover1 819:61c62a287194 137 if (!transport) {
rgrover1 819:61c62a287194 138 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 139 }
rgrover1 716:11b41f651697 140 return transport->getSecurityManager();
rgrover1 716:11b41f651697 141 }
rgrover1 716:11b41f651697 142
rgrover1 716:11b41f651697 143 /**
rgrover1 716:11b41f651697 144 * Yield control to the BLE stack or to other tasks waiting for events. This
rgrover1 716:11b41f651697 145 * is a sleep function which will return when there is an application
rgrover1 716:11b41f651697 146 * specific interrupt, but the MCU might wake up several times before
rgrover1 716:11b41f651697 147 * returning (to service the stack). This is not always interchangeable with
rgrover1 716:11b41f651697 148 * WFE().
rgrover1 716:11b41f651697 149 */
rgrover1 716:11b41f651697 150 void waitForEvent(void) {
rgrover1 819:61c62a287194 151 if (!transport) {
rgrover1 819:61c62a287194 152 error("bad handle to underlying transport");
rgrover1 819:61c62a287194 153 }
rgrover1 716:11b41f651697 154 transport->waitForEvent();
rgrover1 716:11b41f651697 155 }
rgrover1 716:11b41f651697 156
rgrover1 716:11b41f651697 157 /*
rgrover1 716:11b41f651697 158 * Deprecation alert!
rgrover1 716:11b41f651697 159 * All of the following are deprecated and may be dropped in a future
rgrover1 716:11b41f651697 160 * release. Documentation should refer to alternative APIs.
rgrover1 716:11b41f651697 161 */
rgrover1 716:11b41f651697 162
rgrover1 716:11b41f651697 163 /* GAP specific APIs. */
rgrover1 716:11b41f651697 164 public:
rgrover1 716:11b41f651697 165 /**
rgrover1 716:11b41f651697 166 * Set the BTLE MAC address and type.
rgrover1 716:11b41f651697 167 * @return BLE_ERROR_NONE on success.
rgrover1 716:11b41f651697 168 *
rgrover1 716:11b41f651697 169 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 170 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 171 * ble.setAddress(...) should be replaced with
rgrover1 716:11b41f651697 172 * ble.gap().setAddress(...).
rgrover1 716:11b41f651697 173 */
rgrover1 716:11b41f651697 174 ble_error_t setAddress(Gap::AddressType_t type, const Gap::Address_t address) {
rgrover1 716:11b41f651697 175 return gap().setAddress(type, address);
rgrover1 716:11b41f651697 176 }
rgrover1 716:11b41f651697 177
rgrover1 716:11b41f651697 178 /**
rgrover1 716:11b41f651697 179 * Fetch the BTLE MAC address and type.
rgrover1 716:11b41f651697 180 * @return BLE_ERROR_NONE on success.
rgrover1 716:11b41f651697 181 *
rgrover1 716:11b41f651697 182 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 183 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 184 * ble.getAddress(...) should be replaced with
rgrover1 716:11b41f651697 185 * ble.gap().getAddress(...).
rgrover1 716:11b41f651697 186 */
rgrover1 716:11b41f651697 187 ble_error_t getAddress(Gap::AddressType_t *typeP, Gap::Address_t address) {
rgrover1 716:11b41f651697 188 return gap().getAddress(typeP, address);
rgrover1 716:11b41f651697 189 }
rgrover1 716:11b41f651697 190
rgrover1 716:11b41f651697 191 /**
rgrover1 716:11b41f651697 192 * Set the GAP advertising mode to use for this device.
rgrover1 716:11b41f651697 193 *
rgrover1 716:11b41f651697 194 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 195 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 196 * ble.setAdvertisingType(...) should be replaced with
rgrover1 716:11b41f651697 197 * ble.gap().setAdvertisingType(...).
rgrover1 716:11b41f651697 198 */
rgrover1 716:11b41f651697 199 void setAdvertisingType(GapAdvertisingParams::AdvertisingType advType) {
rgrover1 716:11b41f651697 200 gap().setAdvertisingType(advType);
rgrover1 716:11b41f651697 201 }
rgrover1 716:11b41f651697 202
rgrover1 716:11b41f651697 203 /**
rgrover1 716:11b41f651697 204 * @param[in] interval
rgrover1 716:11b41f651697 205 * Advertising interval in units of milliseconds. Advertising
rgrover1 716:11b41f651697 206 * is disabled if interval is 0. If interval is smaller than
rgrover1 716:11b41f651697 207 * the minimum supported value, then the minimum supported
rgrover1 716:11b41f651697 208 * value is used instead. This minimum value can be discovered
rgrover1 716:11b41f651697 209 * using getMinAdvertisingInterval().
rgrover1 716:11b41f651697 210 *
rgrover1 716:11b41f651697 211 * This field must be set to 0 if connectionMode is equal
rgrover1 716:11b41f651697 212 * to ADV_CONNECTABLE_DIRECTED.
rgrover1 716:11b41f651697 213 *
rgrover1 716:11b41f651697 214 * @note: Decreasing this value will allow central devices to detect a
rgrover1 716:11b41f651697 215 * peripheral faster at the expense of more power being used by the radio
rgrover1 716:11b41f651697 216 * due to the higher data transmit rate.
rgrover1 716:11b41f651697 217 *
rgrover1 716:11b41f651697 218 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 219 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 220 * ble.setAdvertisingInterval(...) should be replaced with
rgrover1 716:11b41f651697 221 * ble.gap().setAdvertisingInterval(...).
rgrover1 716:11b41f651697 222 *
rgrover1 716:11b41f651697 223 * @note: [WARNING] This API previously used 0.625ms as the unit for its
rgrover1 716:11b41f651697 224 * 'interval' argument. That required an explicit conversion from
rgrover1 716:11b41f651697 225 * milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
rgrover1 716:11b41f651697 226 * no longer required as the new units are milliseconds. Any application
rgrover1 716:11b41f651697 227 * code depending on the old semantics would need to be updated accordingly.
rgrover1 716:11b41f651697 228 */
rgrover1 716:11b41f651697 229 void setAdvertisingInterval(uint16_t interval) {
rgrover1 716:11b41f651697 230 gap().setAdvertisingInterval(interval);
rgrover1 716:11b41f651697 231 }
rgrover1 716:11b41f651697 232
rgrover1 716:11b41f651697 233 /**
rgrover1 716:11b41f651697 234 * @return Minimum Advertising interval in milliseconds.
rgrover1 716:11b41f651697 235 *
rgrover1 716:11b41f651697 236 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 237 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 238 * ble.getMinAdvertisingInterval(...) should be replaced with
rgrover1 716:11b41f651697 239 * ble.gap().getMinAdvertisingInterval(...).
rgrover1 716:11b41f651697 240 */
rgrover1 716:11b41f651697 241 uint16_t getMinAdvertisingInterval(void) const {
rgrover1 716:11b41f651697 242 return gap().getMinAdvertisingInterval();
rgrover1 716:11b41f651697 243 }
rgrover1 716:11b41f651697 244
rgrover1 716:11b41f651697 245 /**
rgrover1 716:11b41f651697 246 * @return Minimum Advertising interval in milliseconds for non-connectible mode.
rgrover1 716:11b41f651697 247 *
rgrover1 716:11b41f651697 248 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 249 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 250 * ble.getMinNonConnectableAdvertisingInterval(...) should be replaced with
rgrover1 716:11b41f651697 251 * ble.gap().getMinNonConnectableAdvertisingInterval(...).
rgrover1 716:11b41f651697 252 */
rgrover1 716:11b41f651697 253 uint16_t getMinNonConnectableAdvertisingInterval(void) const {
rgrover1 716:11b41f651697 254 return gap().getMinNonConnectableAdvertisingInterval();
rgrover1 716:11b41f651697 255 }
rgrover1 716:11b41f651697 256
rgrover1 716:11b41f651697 257 /**
rgrover1 716:11b41f651697 258 * @return Maximum Advertising interval in milliseconds.
rgrover1 716:11b41f651697 259 *
rgrover1 716:11b41f651697 260 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 261 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 262 * ble.getMaxAdvertisingInterval(...) should be replaced with
rgrover1 716:11b41f651697 263 * ble.gap().getMaxAdvertisingInterval(...).
rgrover1 716:11b41f651697 264 */
rgrover1 716:11b41f651697 265 uint16_t getMaxAdvertisingInterval(void) const {
rgrover1 716:11b41f651697 266 return gap().getMaxAdvertisingInterval();
rgrover1 716:11b41f651697 267 }
rgrover1 716:11b41f651697 268
rgrover1 716:11b41f651697 269 /**
rgrover1 716:11b41f651697 270 * @param[in] timeout
rgrover1 716:11b41f651697 271 * Advertising timeout (in seconds) between 0x1 and 0x3FFF (1
rgrover1 716:11b41f651697 272 * and 16383). Use 0 to disable the advertising timeout.
rgrover1 716:11b41f651697 273 *
rgrover1 716:11b41f651697 274 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 275 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 276 * ble.setAdvertisingTimeout(...) should be replaced with
rgrover1 716:11b41f651697 277 * ble.gap().setAdvertisingTimeout(...).
rgrover1 716:11b41f651697 278 */
rgrover1 716:11b41f651697 279 void setAdvertisingTimeout(uint16_t timeout) {
rgrover1 716:11b41f651697 280 gap().setAdvertisingTimeout(timeout);
rgrover1 716:11b41f651697 281 }
rgrover1 716:11b41f651697 282
rgrover1 716:11b41f651697 283 /**
rgrover1 716:11b41f651697 284 * Setup a particular, user-constructed set of advertisement parameters for
rgrover1 716:11b41f651697 285 * the underlying stack. It would be uncommon for this API to be used
rgrover1 716:11b41f651697 286 * directly; there are other APIs to tweak advertisement parameters
rgrover1 716:11b41f651697 287 * individually (see above).
rgrover1 716:11b41f651697 288 *
rgrover1 716:11b41f651697 289 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 290 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 291 * ble.setAdvertisingParams(...) should be replaced with
rgrover1 716:11b41f651697 292 * ble.gap().setAdvertisingParams(...).
rgrover1 716:11b41f651697 293 */
rgrover1 716:11b41f651697 294 void setAdvertisingParams(const GapAdvertisingParams &advParams) {
rgrover1 716:11b41f651697 295 gap().setAdvertisingParams(advParams);
rgrover1 716:11b41f651697 296 }
rgrover1 716:11b41f651697 297
rgrover1 716:11b41f651697 298 /**
rgrover1 716:11b41f651697 299 * @return Read back advertising parameters. Useful for storing and
rgrover1 716:11b41f651697 300 * restoring parameters rapidly.
rgrover1 716:11b41f651697 301 *
rgrover1 716:11b41f651697 302 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 303 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 304 * ble.getAdvertisingParams(...) should be replaced with
rgrover1 716:11b41f651697 305 * ble.gap().getAdvertisingParams(...).
rgrover1 716:11b41f651697 306 */
rgrover1 716:11b41f651697 307 const GapAdvertisingParams &getAdvertisingParams(void) const {
rgrover1 716:11b41f651697 308 return gap().getAdvertisingParams();
rgrover1 716:11b41f651697 309 }
rgrover1 716:11b41f651697 310
rgrover1 716:11b41f651697 311 /**
rgrover1 716:11b41f651697 312 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 716:11b41f651697 313 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 716:11b41f651697 314 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 716:11b41f651697 315 * small.
rgrover1 716:11b41f651697 316 *
rgrover1 716:11b41f651697 317 * @param[in] flags
rgrover1 716:11b41f651697 318 * The flags to be added. Please refer to
rgrover1 716:11b41f651697 319 * GapAdvertisingData::Flags for valid flags. Multiple
rgrover1 716:11b41f651697 320 * flags may be specified in combination.
rgrover1 716:11b41f651697 321 *
rgrover1 716:11b41f651697 322 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 323 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 324 * ble.accumulateAdvertisingPayload(flags) should be replaced with
rgrover1 716:11b41f651697 325 * ble.gap().accumulateAdvertisingPayload(flags).
rgrover1 716:11b41f651697 326 */
rgrover1 716:11b41f651697 327 ble_error_t accumulateAdvertisingPayload(uint8_t flags) {
rgrover1 716:11b41f651697 328 return gap().accumulateAdvertisingPayload(flags);
rgrover1 716:11b41f651697 329 }
rgrover1 716:11b41f651697 330
rgrover1 716:11b41f651697 331 /**
rgrover1 716:11b41f651697 332 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 716:11b41f651697 333 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 716:11b41f651697 334 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 716:11b41f651697 335 * small.
rgrover1 716:11b41f651697 336 *
rgrover1 716:11b41f651697 337 * @param[in] app
rgrover1 716:11b41f651697 338 * The appearance of the peripheral.
rgrover1 716:11b41f651697 339 *
rgrover1 716:11b41f651697 340 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 341 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 342 * ble.accumulateAdvertisingPayload(appearance) should be replaced with
rgrover1 716:11b41f651697 343 * ble.gap().accumulateAdvertisingPayload(appearance).
rgrover1 716:11b41f651697 344 */
rgrover1 716:11b41f651697 345 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app) {
rgrover1 716:11b41f651697 346 return gap().accumulateAdvertisingPayload(app);
rgrover1 716:11b41f651697 347 }
rgrover1 716:11b41f651697 348
rgrover1 716:11b41f651697 349 /**
rgrover1 716:11b41f651697 350 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 716:11b41f651697 351 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 716:11b41f651697 352 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 716:11b41f651697 353 * small.
rgrover1 716:11b41f651697 354 *
rgrover1 716:11b41f651697 355 * @param[in] app
rgrover1 716:11b41f651697 356 * The max transmit power to be used by the controller. This
rgrover1 716:11b41f651697 357 * is only a hint.
rgrover1 716:11b41f651697 358 *
rgrover1 716:11b41f651697 359 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 360 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 361 * ble.accumulateAdvertisingPayloadTxPower(txPower) should be replaced with
rgrover1 716:11b41f651697 362 * ble.gap().accumulateAdvertisingPayloadTxPower(txPower).
rgrover1 716:11b41f651697 363 */
rgrover1 716:11b41f651697 364 ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power) {
rgrover1 716:11b41f651697 365 return gap().accumulateAdvertisingPayloadTxPower(power);
rgrover1 716:11b41f651697 366 }
rgrover1 716:11b41f651697 367
rgrover1 716:11b41f651697 368 /**
rgrover1 716:11b41f651697 369 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 716:11b41f651697 370 * advertising payload. Please note that the payload is limited to 31 bytes.
rgrover1 716:11b41f651697 371 * The SCAN_RESPONSE message may be used as an additional 31 bytes if the
rgrover1 716:11b41f651697 372 * advertising payload proves to be too small.
rgrover1 716:11b41f651697 373 *
rgrover1 716:11b41f651697 374 * @param type The type which describes the variable length data.
rgrover1 716:11b41f651697 375 * @param data data bytes.
rgrover1 716:11b41f651697 376 * @param len length of data.
rgrover1 716:11b41f651697 377 *
rgrover1 716:11b41f651697 378 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 379 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 380 * ble.accumulateAdvertisingPayload(...) should be replaced with
rgrover1 716:11b41f651697 381 * ble.gap().accumulateAdvertisingPayload(...).
rgrover1 716:11b41f651697 382 */
rgrover1 716:11b41f651697 383 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1 716:11b41f651697 384 return gap().accumulateAdvertisingPayload(type, data, len);
rgrover1 716:11b41f651697 385 }
rgrover1 716:11b41f651697 386
rgrover1 716:11b41f651697 387 /**
rgrover1 716:11b41f651697 388 * Setup a particular, user-constructed advertisement payload for the
rgrover1 716:11b41f651697 389 * underlying stack. It would be uncommon for this API to be used directly;
rgrover1 716:11b41f651697 390 * there are other APIs to build an advertisement payload (see above).
rgrover1 716:11b41f651697 391 *
rgrover1 716:11b41f651697 392 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 393 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 394 * ble.setAdvertisingData(...) should be replaced with
rgrover1 716:11b41f651697 395 * ble.gap().setAdvertisingPayload(...).
rgrover1 716:11b41f651697 396 */
rgrover1 716:11b41f651697 397 ble_error_t setAdvertisingData(const GapAdvertisingData &advData) {
rgrover1 716:11b41f651697 398 return gap().setAdvertisingPayload(advData);
rgrover1 716:11b41f651697 399 }
rgrover1 716:11b41f651697 400
rgrover1 716:11b41f651697 401 /**
rgrover1 716:11b41f651697 402 * @return Read back advertising data. Useful for storing and
rgrover1 716:11b41f651697 403 * restoring payload.
rgrover1 716:11b41f651697 404 *
rgrover1 716:11b41f651697 405 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 406 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 407 * ble.getAdvertisingData(...) should be replaced with
rgrover1 716:11b41f651697 408 * ble.gap().getAdvertisingPayload()(...).
rgrover1 716:11b41f651697 409 */
rgrover1 716:11b41f651697 410 const GapAdvertisingData &getAdvertisingData(void) const {
rgrover1 716:11b41f651697 411 return gap().getAdvertisingPayload();
rgrover1 716:11b41f651697 412 }
rgrover1 716:11b41f651697 413
rgrover1 716:11b41f651697 414 /**
rgrover1 716:11b41f651697 415 * Reset any advertising payload prepared from prior calls to
rgrover1 716:11b41f651697 416 * accumulateAdvertisingPayload(). This automatically propagates the re-
rgrover1 716:11b41f651697 417 * initialized adv payload to the underlying stack.
rgrover1 716:11b41f651697 418 *
rgrover1 716:11b41f651697 419 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 420 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 421 * ble.clearAdvertisingPayload(...) should be replaced with
rgrover1 716:11b41f651697 422 * ble.gap().clearAdvertisingPayload(...).
rgrover1 716:11b41f651697 423 */
rgrover1 716:11b41f651697 424 void clearAdvertisingPayload(void) {
rgrover1 716:11b41f651697 425 gap().clearAdvertisingPayload();
rgrover1 716:11b41f651697 426 }
rgrover1 716:11b41f651697 427
rgrover1 716:11b41f651697 428 /**
rgrover1 716:11b41f651697 429 * This API is *deprecated* and resolves to a no-operation. It is left here
rgrover1 716:11b41f651697 430 * to allow older code to compile. Please avoid using this API in new code.
rgrover1 716:11b41f651697 431 * This API will be dropped in a future release.
rgrover1 716:11b41f651697 432 *
rgrover1 716:11b41f651697 433 * Formerly, it would be used to dynamically reset the accumulated advertising
rgrover1 716:11b41f651697 434 * payload and scanResponse; to do this, the application would clear and re-
rgrover1 716:11b41f651697 435 * accumulate a new advertising payload (and scanResponse) before using this
rgrover1 716:11b41f651697 436 * API. Updates to the underlying advertisement payload now happen
rgrover1 716:11b41f651697 437 * implicitly.
rgrover1 716:11b41f651697 438 */
rgrover1 716:11b41f651697 439 ble_error_t setAdvertisingPayload(void) {
rgrover1 716:11b41f651697 440 return BLE_ERROR_NONE;
rgrover1 716:11b41f651697 441 }
rgrover1 716:11b41f651697 442
rgrover1 716:11b41f651697 443 /**
rgrover1 716:11b41f651697 444 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 716:11b41f651697 445 * scanResponse payload.
rgrover1 716:11b41f651697 446 *
rgrover1 716:11b41f651697 447 * @param[in] type The type which describes the variable length data.
rgrover1 716:11b41f651697 448 * @param[in] data data bytes.
rgrover1 716:11b41f651697 449 * @param[in] len length of data.
rgrover1 716:11b41f651697 450 *
rgrover1 716:11b41f651697 451 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 452 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 453 * ble.accumulateScanResponse(...) should be replaced with
rgrover1 716:11b41f651697 454 * ble.gap().accumulateScanResponse(...).
rgrover1 716:11b41f651697 455 */
rgrover1 716:11b41f651697 456 ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1 716:11b41f651697 457 return gap().accumulateScanResponse(type, data, len);
rgrover1 716:11b41f651697 458 }
rgrover1 716:11b41f651697 459
rgrover1 716:11b41f651697 460 /**
rgrover1 716:11b41f651697 461 * Reset any scan response prepared from prior calls to
rgrover1 716:11b41f651697 462 * accumulateScanResponse().
rgrover1 716:11b41f651697 463 *
rgrover1 716:11b41f651697 464 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 465 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 466 * ble.clearScanResponse(...) should be replaced with
rgrover1 716:11b41f651697 467 * ble.gap().clearScanResponse(...).
rgrover1 716:11b41f651697 468 */
rgrover1 716:11b41f651697 469 void clearScanResponse(void) {
rgrover1 716:11b41f651697 470 gap().clearScanResponse();
rgrover1 716:11b41f651697 471 }
rgrover1 716:11b41f651697 472
rgrover1 716:11b41f651697 473 /**
rgrover1 716:11b41f651697 474 * Start advertising.
rgrover1 716:11b41f651697 475 *
rgrover1 716:11b41f651697 476 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 477 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 478 * ble.startAdvertising(...) should be replaced with
rgrover1 716:11b41f651697 479 * ble.gap().startAdvertising(...).
rgrover1 716:11b41f651697 480 */
rgrover1 716:11b41f651697 481 ble_error_t startAdvertising(void) {
rgrover1 716:11b41f651697 482 return gap().startAdvertising();
rgrover1 716:11b41f651697 483 }
rgrover1 716:11b41f651697 484
rgrover1 716:11b41f651697 485 /**
rgrover1 716:11b41f651697 486 * Stop advertising.
rgrover1 716:11b41f651697 487 *
rgrover1 716:11b41f651697 488 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 489 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 490 * ble.stopAdvertising(...) should be replaced with
rgrover1 716:11b41f651697 491 * ble.gap().stopAdvertising(...).
rgrover1 716:11b41f651697 492 */
rgrover1 716:11b41f651697 493 ble_error_t stopAdvertising(void) {
rgrover1 716:11b41f651697 494 return gap().stopAdvertising();
rgrover1 716:11b41f651697 495 }
rgrover1 716:11b41f651697 496
rgrover1 716:11b41f651697 497 /**
rgrover1 716:11b41f651697 498 * Setup parameters for GAP scanning--i.e. observer mode.
rgrover1 716:11b41f651697 499 * @param[in] interval
rgrover1 716:11b41f651697 500 * Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 716:11b41f651697 501 * @param[in] window
rgrover1 716:11b41f651697 502 * Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 716:11b41f651697 503 * @param[in] timeout
rgrover1 716:11b41f651697 504 * Scan timeout (in seconds) between 0x0001 and 0xFFFF, 0x0000 disables timeout.
rgrover1 716:11b41f651697 505 * @param[in] activeScanning
rgrover1 716:11b41f651697 506 * Set to True if active-scanning is required. This is used to fetch the
rgrover1 716:11b41f651697 507 * scan response from a peer if possible.
rgrover1 716:11b41f651697 508 *
rgrover1 716:11b41f651697 509 * The scanning window divided by the interval determines the duty cycle for
rgrover1 716:11b41f651697 510 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 716:11b41f651697 511 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 716:11b41f651697 512 * to have the interval and window set to the same value. In this case,
rgrover1 716:11b41f651697 513 * scanning is continuous, with a change of scanning frequency once every
rgrover1 716:11b41f651697 514 * interval.
rgrover1 716:11b41f651697 515 *
rgrover1 716:11b41f651697 516 * Once the scanning parameters have been configured, scanning can be
rgrover1 716:11b41f651697 517 * enabled by using startScan().
rgrover1 716:11b41f651697 518 *
rgrover1 716:11b41f651697 519 * @Note: The scan interval and window are recommendations to the BLE stack.
rgrover1 716:11b41f651697 520 *
rgrover1 716:11b41f651697 521 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 522 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 523 * ble.setScanParams(...) should be replaced with
rgrover1 716:11b41f651697 524 * ble.gap().setScanParams(...).
rgrover1 716:11b41f651697 525 */
rgrover1 716:11b41f651697 526 ble_error_t setScanParams(uint16_t interval = GapScanningParams::SCAN_INTERVAL_MAX,
rgrover1 716:11b41f651697 527 uint16_t window = GapScanningParams::SCAN_WINDOW_MAX,
rgrover1 716:11b41f651697 528 uint16_t timeout = 0,
rgrover1 716:11b41f651697 529 bool activeScanning = false) {
rgrover1 716:11b41f651697 530 return gap().setScanParams(interval, window, timeout, activeScanning);
rgrover1 716:11b41f651697 531 }
rgrover1 716:11b41f651697 532
rgrover1 716:11b41f651697 533 /**
rgrover1 716:11b41f651697 534 * Setup the scanInterval parameter for GAP scanning--i.e. observer mode.
rgrover1 716:11b41f651697 535 * @param[in] interval
rgrover1 716:11b41f651697 536 * Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 716:11b41f651697 537 *
rgrover1 716:11b41f651697 538 * The scanning window divided by the interval determines the duty cycle for
rgrover1 716:11b41f651697 539 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 716:11b41f651697 540 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 716:11b41f651697 541 * to have the interval and window set to the same value. In this case,
rgrover1 716:11b41f651697 542 * scanning is continuous, with a change of scanning frequency once every
rgrover1 716:11b41f651697 543 * interval.
rgrover1 716:11b41f651697 544 *
rgrover1 716:11b41f651697 545 * Once the scanning parameters have been configured, scanning can be
rgrover1 716:11b41f651697 546 * enabled by using startScan().
rgrover1 716:11b41f651697 547 *
rgrover1 716:11b41f651697 548 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 549 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 550 * ble.setScanInterval(interval) should be replaced with
rgrover1 716:11b41f651697 551 * ble.gap().setScanInterval(interval).
rgrover1 716:11b41f651697 552 */
rgrover1 716:11b41f651697 553 ble_error_t setScanInterval(uint16_t interval) {
rgrover1 716:11b41f651697 554 return gap().setScanInterval(interval);
rgrover1 716:11b41f651697 555 }
rgrover1 716:11b41f651697 556
rgrover1 716:11b41f651697 557 /**
rgrover1 716:11b41f651697 558 * Setup the scanWindow parameter for GAP scanning--i.e. observer mode.
rgrover1 716:11b41f651697 559 * @param[in] window
rgrover1 716:11b41f651697 560 * Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 716:11b41f651697 561 *
rgrover1 716:11b41f651697 562 * The scanning window divided by the interval determines the duty cycle for
rgrover1 716:11b41f651697 563 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 716:11b41f651697 564 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 716:11b41f651697 565 * to have the interval and window set to the same value. In this case,
rgrover1 716:11b41f651697 566 * scanning is continuous, with a change of scanning frequency once every
rgrover1 716:11b41f651697 567 * interval.
rgrover1 716:11b41f651697 568 *
rgrover1 716:11b41f651697 569 * Once the scanning parameters have been configured, scanning can be
rgrover1 716:11b41f651697 570 * enabled by using startScan().
rgrover1 716:11b41f651697 571 *
rgrover1 716:11b41f651697 572 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 573 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 574 * ble.setScanWindow(window) should be replaced with
rgrover1 716:11b41f651697 575 * ble.gap().setScanWindow(window).
rgrover1 716:11b41f651697 576 */
rgrover1 716:11b41f651697 577 ble_error_t setScanWindow(uint16_t window) {
rgrover1 716:11b41f651697 578 return gap().setScanWindow(window);
rgrover1 716:11b41f651697 579 }
rgrover1 716:11b41f651697 580
rgrover1 716:11b41f651697 581 /**
rgrover1 716:11b41f651697 582 * Setup parameters for GAP scanning--i.e. observer mode.
rgrover1 716:11b41f651697 583 * @param[in] timeout
rgrover1 716:11b41f651697 584 * Scan timeout (in seconds) between 0x0001 and 0xFFFF, 0x0000 disables timeout.
rgrover1 716:11b41f651697 585 *
rgrover1 716:11b41f651697 586 * The scanning window divided by the interval determines the duty cycle for
rgrover1 716:11b41f651697 587 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 716:11b41f651697 588 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 716:11b41f651697 589 * to have the interval and window set to the same value. In this case,
rgrover1 716:11b41f651697 590 * scanning is continuous, with a change of scanning frequency once every
rgrover1 716:11b41f651697 591 * interval.
rgrover1 716:11b41f651697 592 *
rgrover1 716:11b41f651697 593 * Once the scanning parameters have been configured, scanning can be
rgrover1 716:11b41f651697 594 * enabled by using startScan().
rgrover1 716:11b41f651697 595 *
rgrover1 716:11b41f651697 596 * @Note: The scan interval and window are recommendations to the BLE stack.
rgrover1 716:11b41f651697 597 *
rgrover1 716:11b41f651697 598 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 599 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 600 * ble.setScanTimeout(...) should be replaced with
rgrover1 716:11b41f651697 601 * ble.gap().setScanTimeout(...).
rgrover1 716:11b41f651697 602 */
rgrover1 716:11b41f651697 603 ble_error_t setScanTimeout(uint16_t timeout) {
rgrover1 716:11b41f651697 604 return gap().setScanTimeout(timeout);
rgrover1 716:11b41f651697 605 }
rgrover1 716:11b41f651697 606
rgrover1 716:11b41f651697 607 /**
rgrover1 716:11b41f651697 608 * Setup parameters for GAP scanning--i.e. observer mode.
rgrover1 716:11b41f651697 609 * @param[in] activeScanning
rgrover1 716:11b41f651697 610 * Set to True if active-scanning is required. This is used to fetch the
rgrover1 716:11b41f651697 611 * scan response from a peer if possible.
rgrover1 716:11b41f651697 612 *
rgrover1 716:11b41f651697 613 * Once the scanning parameters have been configured, scanning can be
rgrover1 716:11b41f651697 614 * enabled by using startScan().
rgrover1 716:11b41f651697 615 *
rgrover1 716:11b41f651697 616 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 617 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 618 * ble.setActiveScan(...) should be replaced with
rgrover1 716:11b41f651697 619 * ble.gap().setActiveScanning(...).
rgrover1 716:11b41f651697 620 */
rgrover1 716:11b41f651697 621 void setActiveScan(bool activeScanning) {
rgrover1 716:11b41f651697 622 gap().setActiveScanning(activeScanning);
rgrover1 716:11b41f651697 623 }
rgrover1 716:11b41f651697 624
rgrover1 716:11b41f651697 625 /**
rgrover1 716:11b41f651697 626 * Start scanning (Observer Procedure) based on the parameters currently in
rgrover1 716:11b41f651697 627 * effect.
rgrover1 716:11b41f651697 628 *
rgrover1 716:11b41f651697 629 * @param[in] callback
rgrover1 716:11b41f651697 630 * The application specific callback to be invoked upon
rgrover1 716:11b41f651697 631 * receiving every advertisement report. This can be passed in
rgrover1 716:11b41f651697 632 * as NULL, in which case scanning may not be enabled at all.
rgrover1 716:11b41f651697 633 *
rgrover1 716:11b41f651697 634 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 635 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 636 * ble.startScan(callback) should be replaced with
rgrover1 716:11b41f651697 637 * ble.gap().startScan(callback).
rgrover1 716:11b41f651697 638 */
rgrover1 716:11b41f651697 639 ble_error_t startScan(void (*callback)(const Gap::AdvertisementCallbackParams_t *params)) {
rgrover1 716:11b41f651697 640 return gap().startScan(callback);
rgrover1 716:11b41f651697 641 }
rgrover1 716:11b41f651697 642
rgrover1 716:11b41f651697 643 /**
rgrover1 716:11b41f651697 644 * Same as above, but this takes an (object, method) pair for a callback.
rgrover1 716:11b41f651697 645 *
rgrover1 716:11b41f651697 646 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 647 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 648 * ble.startScan(callback) should be replaced with
rgrover1 716:11b41f651697 649 * ble.gap().startScan(object, callback).
rgrover1 716:11b41f651697 650 */
rgrover1 716:11b41f651697 651 template<typename T>
rgrover1 716:11b41f651697 652 ble_error_t startScan(T *object, void (T::*memberCallback)(const Gap::AdvertisementCallbackParams_t *params));
rgrover1 716:11b41f651697 653
rgrover1 716:11b41f651697 654 /**
rgrover1 716:11b41f651697 655 * Stop scanning. The current scanning parameters remain in effect.
rgrover1 716:11b41f651697 656 *
rgrover1 716:11b41f651697 657 * @retval BLE_ERROR_NONE if successfully stopped scanning procedure.
rgrover1 716:11b41f651697 658 *
rgrover1 716:11b41f651697 659 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 660 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 661 * ble.stopScan() should be replaced with
rgrover1 716:11b41f651697 662 * ble.gap().stopScan().
rgrover1 716:11b41f651697 663 */
rgrover1 716:11b41f651697 664 ble_error_t stopScan(void) {
rgrover1 716:11b41f651697 665 return gap().stopScan();
rgrover1 716:11b41f651697 666 }
rgrover1 716:11b41f651697 667
rgrover1 716:11b41f651697 668 /**
rgrover1 716:11b41f651697 669 * Create a connection (GAP Link Establishment).
rgrover1 716:11b41f651697 670 * @param peerAddr
rgrover1 716:11b41f651697 671 * 48-bit address, LSB format.
rgrover1 716:11b41f651697 672 * @param peerAddrType
rgrover1 716:11b41f651697 673 * Address type of the peer.
rgrover1 716:11b41f651697 674 * @param connectionParams
rgrover1 716:11b41f651697 675 * Connection parameters.
rgrover1 716:11b41f651697 676 * @param scanParams
rgrover1 716:11b41f651697 677 * Paramters to be used while scanning for the peer.
rgrover1 716:11b41f651697 678 * @return BLE_ERROR_NONE if connection establishment procedure is started
rgrover1 716:11b41f651697 679 * successfully. The onConnection callback (if set) will be invoked upon
rgrover1 716:11b41f651697 680 * a connection event.
rgrover1 716:11b41f651697 681 *
rgrover1 716:11b41f651697 682 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 683 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 684 * ble.connect(...) should be replaced with
rgrover1 716:11b41f651697 685 * ble.gap().connect(...).
rgrover1 716:11b41f651697 686 */
rgrover1 716:11b41f651697 687 ble_error_t connect(const Gap::Address_t peerAddr,
rgrover1 716:11b41f651697 688 Gap::AddressType_t peerAddrType = Gap::ADDR_TYPE_RANDOM_STATIC,
rgrover1 716:11b41f651697 689 const Gap::ConnectionParams_t *connectionParams = NULL,
rgrover1 716:11b41f651697 690 const GapScanningParams *scanParams = NULL) {
rgrover1 716:11b41f651697 691 return gap().connect(peerAddr, peerAddrType, connectionParams, scanParams);
rgrover1 716:11b41f651697 692 }
rgrover1 716:11b41f651697 693
rgrover1 716:11b41f651697 694 /**
rgrover1 716:11b41f651697 695 * This call initiates the disconnection procedure, and its completion will
rgrover1 716:11b41f651697 696 * be communicated to the application with an invocation of the
rgrover1 716:11b41f651697 697 * onDisconnection callback.
rgrover1 716:11b41f651697 698 *
rgrover1 716:11b41f651697 699 * @param[in] connectionHandle
rgrover1 716:11b41f651697 700 * @param[in] reason
rgrover1 716:11b41f651697 701 * The reason for disconnection to be sent back to the peer.
rgrover1 716:11b41f651697 702 */
rgrover1 716:11b41f651697 703 ble_error_t disconnect(Gap::Handle_t connectionHandle, Gap::DisconnectionReason_t reason) {
rgrover1 716:11b41f651697 704 return gap().disconnect(connectionHandle, reason);
rgrover1 716:11b41f651697 705 }
rgrover1 716:11b41f651697 706
rgrover1 716:11b41f651697 707 /**
rgrover1 716:11b41f651697 708 * This call initiates the disconnection procedure, and its completion will
rgrover1 716:11b41f651697 709 * be communicated to the application with an invocation of the
rgrover1 716:11b41f651697 710 * onDisconnection callback.
rgrover1 716:11b41f651697 711 *
rgrover1 716:11b41f651697 712 * @param reason
rgrover1 716:11b41f651697 713 * The reason for disconnection to be sent back to the peer.
rgrover1 716:11b41f651697 714 *
rgrover1 716:11b41f651697 715 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 716 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 717 * ble.disconnect(reason) should be replaced with
rgrover1 716:11b41f651697 718 * ble.gap().disconnect(reason).
rgrover1 716:11b41f651697 719 *
rgrover1 716:11b41f651697 720 * @note: this version of disconnect() doesn't take a connection handle. It
rgrover1 716:11b41f651697 721 * will work reliably only for stacks which are limited to a single
rgrover1 716:11b41f651697 722 * connection. This API should be considered *deprecated* in favour of the
rgrover1 716:11b41f651697 723 * alternative which takes a connection handle. It will be dropped in the future.
rgrover1 716:11b41f651697 724 */
rgrover1 716:11b41f651697 725 ble_error_t disconnect(Gap::DisconnectionReason_t reason) {
rgrover1 716:11b41f651697 726 return gap().disconnect(reason);
rgrover1 716:11b41f651697 727 }
rgrover1 716:11b41f651697 728
rgrover1 716:11b41f651697 729 /**
rgrover1 716:11b41f651697 730 * Returns the current GAP state of the device using a bitmask which
rgrover1 716:11b41f651697 731 * describes whether the device is advertising and/or connected.
rgrover1 716:11b41f651697 732 *
rgrover1 716:11b41f651697 733 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 734 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 735 * ble.getGapState() should be replaced with
rgrover1 716:11b41f651697 736 * ble.gap().getState().
rgrover1 716:11b41f651697 737 */
rgrover1 716:11b41f651697 738 Gap::GapState_t getGapState(void) const {
rgrover1 716:11b41f651697 739 return gap().getState();
rgrover1 716:11b41f651697 740 }
rgrover1 716:11b41f651697 741
rgrover1 716:11b41f651697 742 /**
rgrover1 716:11b41f651697 743 * Get the GAP peripheral preferred connection parameters. These are the
rgrover1 716:11b41f651697 744 * defaults that the peripheral would like to have in a connection. The
rgrover1 716:11b41f651697 745 * choice of the connection parameters is eventually up to the central.
rgrover1 716:11b41f651697 746 *
rgrover1 716:11b41f651697 747 * @param[out] params
rgrover1 716:11b41f651697 748 * The structure where the parameters will be stored. Memory
rgrover1 716:11b41f651697 749 * for this is owned by the caller.
rgrover1 716:11b41f651697 750 *
rgrover1 716:11b41f651697 751 * @return BLE_ERROR_NONE if the parameters were successfully filled into
rgrover1 716:11b41f651697 752 * the given structure pointed to by params.
rgrover1 716:11b41f651697 753 *
rgrover1 716:11b41f651697 754 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 755 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 756 * ble.getPreferredConnectionParams() should be replaced with
rgrover1 716:11b41f651697 757 * ble.gap().getPreferredConnectionParams().
rgrover1 716:11b41f651697 758 */
rgrover1 716:11b41f651697 759 ble_error_t getPreferredConnectionParams(Gap::ConnectionParams_t *params) {
rgrover1 716:11b41f651697 760 return gap().getPreferredConnectionParams(params);
rgrover1 716:11b41f651697 761 }
rgrover1 716:11b41f651697 762
rgrover1 716:11b41f651697 763 /**
rgrover1 716:11b41f651697 764 * Set the GAP peripheral preferred connection parameters. These are the
rgrover1 716:11b41f651697 765 * defaults that the peripheral would like to have in a connection. The
rgrover1 716:11b41f651697 766 * choice of the connection parameters is eventually up to the central.
rgrover1 716:11b41f651697 767 *
rgrover1 716:11b41f651697 768 * @param[in] params
rgrover1 716:11b41f651697 769 * The structure containing the desired parameters.
rgrover1 716:11b41f651697 770 *
rgrover1 716:11b41f651697 771 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 772 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 773 * ble.setPreferredConnectionParams() should be replaced with
rgrover1 716:11b41f651697 774 * ble.gap().setPreferredConnectionParams().
rgrover1 716:11b41f651697 775 */
rgrover1 716:11b41f651697 776 ble_error_t setPreferredConnectionParams(const Gap::ConnectionParams_t *params) {
rgrover1 716:11b41f651697 777 return gap().setPreferredConnectionParams(params);
rgrover1 716:11b41f651697 778 }
rgrover1 716:11b41f651697 779
rgrover1 716:11b41f651697 780 /**
rgrover1 716:11b41f651697 781 * Update connection parameters while in the peripheral role.
rgrover1 716:11b41f651697 782 * @details In the peripheral role, this will send the corresponding L2CAP request to the connected peer and wait for
rgrover1 716:11b41f651697 783 * the central to perform the procedure.
rgrover1 716:11b41f651697 784 * @param[in] handle
rgrover1 716:11b41f651697 785 * Connection Handle
rgrover1 716:11b41f651697 786 * @param[in] params
rgrover1 716:11b41f651697 787 * Pointer to desired connection parameters. If NULL is provided on a peripheral role,
rgrover1 716:11b41f651697 788 * the parameters in the PPCP characteristic of the GAP service will be used instead.
rgrover1 716:11b41f651697 789 *
rgrover1 716:11b41f651697 790 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 791 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 792 * ble.updateConnectionParams() should be replaced with
rgrover1 716:11b41f651697 793 * ble.gap().updateConnectionParams().
rgrover1 716:11b41f651697 794 */
rgrover1 716:11b41f651697 795 ble_error_t updateConnectionParams(Gap::Handle_t handle, const Gap::ConnectionParams_t *params) {
rgrover1 716:11b41f651697 796 return gap().updateConnectionParams(handle, params);
rgrover1 716:11b41f651697 797 }
rgrover1 716:11b41f651697 798
rgrover1 716:11b41f651697 799 /**
rgrover1 716:11b41f651697 800 * Set the device name characteristic in the GAP service.
rgrover1 716:11b41f651697 801 * @param[in] deviceName
rgrover1 716:11b41f651697 802 * The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
rgrover1 716:11b41f651697 803 *
rgrover1 716:11b41f651697 804 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 805 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 806 * ble.setDeviceName() should be replaced with
rgrover1 716:11b41f651697 807 * ble.gap().setDeviceName().
rgrover1 716:11b41f651697 808 */
rgrover1 716:11b41f651697 809 ble_error_t setDeviceName(const uint8_t *deviceName) {
rgrover1 716:11b41f651697 810 return gap().setDeviceName(deviceName);
rgrover1 716:11b41f651697 811 }
rgrover1 716:11b41f651697 812
rgrover1 716:11b41f651697 813 /**
rgrover1 716:11b41f651697 814 * Get the value of the device name characteristic in the GAP service.
rgrover1 716:11b41f651697 815 * @param[out] deviceName
rgrover1 716:11b41f651697 816 * Pointer to an empty buffer where the UTF-8 *non NULL-
rgrover1 716:11b41f651697 817 * terminated* string will be placed. Set this
rgrover1 716:11b41f651697 818 * value to NULL in order to obtain the deviceName-length
rgrover1 716:11b41f651697 819 * from the 'length' parameter.
rgrover1 716:11b41f651697 820 *
rgrover1 716:11b41f651697 821 * @param[in/out] lengthP
rgrover1 716:11b41f651697 822 * (on input) Length of the buffer pointed to by deviceName;
rgrover1 716:11b41f651697 823 * (on output) the complete device name length (without the
rgrover1 716:11b41f651697 824 * null terminator).
rgrover1 716:11b41f651697 825 *
rgrover1 716:11b41f651697 826 * @note If the device name is longer than the size of the supplied buffer,
rgrover1 716:11b41f651697 827 * length will return the complete device name length, and not the
rgrover1 716:11b41f651697 828 * number of bytes actually returned in deviceName. The application may
rgrover1 716:11b41f651697 829 * use this information to retry with a suitable buffer size.
rgrover1 716:11b41f651697 830 *
rgrover1 716:11b41f651697 831 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 832 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 833 * ble.getDeviceName() should be replaced with
rgrover1 716:11b41f651697 834 * ble.gap().getDeviceName().
rgrover1 716:11b41f651697 835 */
rgrover1 716:11b41f651697 836 ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) {
rgrover1 716:11b41f651697 837 return gap().getDeviceName(deviceName, lengthP);
rgrover1 716:11b41f651697 838 }
rgrover1 716:11b41f651697 839
rgrover1 716:11b41f651697 840 /**
rgrover1 716:11b41f651697 841 * Set the appearance characteristic in the GAP service.
rgrover1 716:11b41f651697 842 * @param[in] appearance
rgrover1 716:11b41f651697 843 * The new value for the device-appearance.
rgrover1 716:11b41f651697 844 *
rgrover1 716:11b41f651697 845 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 846 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 847 * ble.setAppearance() should be replaced with
rgrover1 716:11b41f651697 848 * ble.gap().setAppearance().
rgrover1 716:11b41f651697 849 */
rgrover1 716:11b41f651697 850 ble_error_t setAppearance(GapAdvertisingData::Appearance appearance) {
rgrover1 716:11b41f651697 851 return gap().setAppearance(appearance);
rgrover1 716:11b41f651697 852 }
rgrover1 716:11b41f651697 853
rgrover1 716:11b41f651697 854 /**
rgrover1 716:11b41f651697 855 * Get the appearance characteristic in the GAP service.
rgrover1 716:11b41f651697 856 * @param[out] appearance
rgrover1 716:11b41f651697 857 * The new value for the device-appearance.
rgrover1 716:11b41f651697 858 *
rgrover1 716:11b41f651697 859 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 860 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 861 * ble.getAppearance() should be replaced with
rgrover1 716:11b41f651697 862 * ble.gap().getAppearance().
rgrover1 716:11b41f651697 863 */
rgrover1 716:11b41f651697 864 ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP) {
rgrover1 716:11b41f651697 865 return gap().getAppearance(appearanceP);
rgrover1 716:11b41f651697 866 }
rgrover1 716:11b41f651697 867
rgrover1 716:11b41f651697 868 /**
rgrover1 716:11b41f651697 869 * Set the radio's transmit power.
rgrover1 716:11b41f651697 870 * @param[in] txPower Radio transmit power in dBm.
rgrover1 716:11b41f651697 871 *
rgrover1 716:11b41f651697 872 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 873 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 874 * ble.setTxPower() should be replaced with
rgrover1 716:11b41f651697 875 * ble.gap().setTxPower().
rgrover1 716:11b41f651697 876 */
rgrover1 716:11b41f651697 877 ble_error_t setTxPower(int8_t txPower) {
rgrover1 716:11b41f651697 878 return gap().setTxPower(txPower);
rgrover1 716:11b41f651697 879 }
rgrover1 716:11b41f651697 880
rgrover1 716:11b41f651697 881 /**
rgrover1 716:11b41f651697 882 * Query the underlying stack for permitted arguments for setTxPower().
rgrover1 716:11b41f651697 883 *
rgrover1 716:11b41f651697 884 * @param[out] valueArrayPP
rgrover1 716:11b41f651697 885 * Out parameter to receive the immutable array of Tx values.
rgrover1 716:11b41f651697 886 * @param[out] countP
rgrover1 716:11b41f651697 887 * Out parameter to receive the array's size.
rgrover1 716:11b41f651697 888 *
rgrover1 716:11b41f651697 889 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 890 * You should use the parallel API from Gap directly. A former call to
rgrover1 716:11b41f651697 891 * ble.getPermittedTxPowerValues() should be replaced with
rgrover1 716:11b41f651697 892 * ble.gap().getPermittedTxPowerValues().
rgrover1 716:11b41f651697 893 */
rgrover1 716:11b41f651697 894 void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP) {
rgrover1 716:11b41f651697 895 gap().getPermittedTxPowerValues(valueArrayPP, countP);
rgrover1 716:11b41f651697 896 }
rgrover1 716:11b41f651697 897
rgrover1 716:11b41f651697 898 /**
rgrover1 716:11b41f651697 899 * Add a service declaration to the local server ATT table. Also add the
rgrover1 716:11b41f651697 900 * characteristics contained within.
rgrover1 716:11b41f651697 901 *
rgrover1 716:11b41f651697 902 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 903 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 904 * to ble.addService() should be replaced with
rgrover1 716:11b41f651697 905 * ble.gattServer().addService().
rgrover1 716:11b41f651697 906 */
rgrover1 716:11b41f651697 907 ble_error_t addService(GattService &service) {
rgrover1 716:11b41f651697 908 return gattServer().addService(service);
rgrover1 716:11b41f651697 909 }
rgrover1 716:11b41f651697 910
rgrover1 716:11b41f651697 911 /**
rgrover1 716:11b41f651697 912 * Read the value of a characteristic from the local GattServer
rgrover1 716:11b41f651697 913 * @param[in] attributeHandle
rgrover1 716:11b41f651697 914 * Attribute handle for the value attribute of the characteristic.
rgrover1 716:11b41f651697 915 * @param[out] buffer
rgrover1 716:11b41f651697 916 * A buffer to hold the value being read.
rgrover1 716:11b41f651697 917 * @param[in/out] lengthP
rgrover1 716:11b41f651697 918 * Length of the buffer being supplied. If the attribute
rgrover1 716:11b41f651697 919 * value is longer than the size of the supplied buffer,
rgrover1 716:11b41f651697 920 * this variable will hold upon return the total attribute value length
rgrover1 716:11b41f651697 921 * (excluding offset). The application may use this
rgrover1 716:11b41f651697 922 * information to allocate a suitable buffer size.
rgrover1 716:11b41f651697 923 *
rgrover1 716:11b41f651697 924 * @return BLE_ERROR_NONE if a value was read successfully into the buffer.
rgrover1 716:11b41f651697 925 *
rgrover1 716:11b41f651697 926 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 927 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 928 * to ble.readCharacteristicValue() should be replaced with
rgrover1 716:11b41f651697 929 * ble.gattServer().read().
rgrover1 716:11b41f651697 930 */
rgrover1 716:11b41f651697 931 ble_error_t readCharacteristicValue(GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP) {
rgrover1 716:11b41f651697 932 return gattServer().read(attributeHandle, buffer, lengthP);
rgrover1 716:11b41f651697 933 }
rgrover1 716:11b41f651697 934
rgrover1 716:11b41f651697 935 /**
rgrover1 716:11b41f651697 936 * Read the value of a characteristic from the local GattServer
rgrover1 716:11b41f651697 937 * @param[in] connectionHandle
rgrover1 716:11b41f651697 938 * Connection Handle.
rgrover1 716:11b41f651697 939 * @param[in] attributeHandle
rgrover1 716:11b41f651697 940 * Attribute handle for the value attribute of the characteristic.
rgrover1 716:11b41f651697 941 * @param[out] buffer
rgrover1 716:11b41f651697 942 * A buffer to hold the value being read.
rgrover1 716:11b41f651697 943 * @param[in/out] lengthP
rgrover1 716:11b41f651697 944 * Length of the buffer being supplied. If the attribute
rgrover1 716:11b41f651697 945 * value is longer than the size of the supplied buffer,
rgrover1 716:11b41f651697 946 * this variable will hold upon return the total attribute value length
rgrover1 716:11b41f651697 947 * (excluding offset). The application may use this
rgrover1 716:11b41f651697 948 * information to allocate a suitable buffer size.
rgrover1 716:11b41f651697 949 *
rgrover1 716:11b41f651697 950 * @return BLE_ERROR_NONE if a value was read successfully into the buffer.
rgrover1 716:11b41f651697 951 *
rgrover1 716:11b41f651697 952 * @note This API is a version of above with an additional connection handle
rgrover1 716:11b41f651697 953 * parameter to allow fetches for connection-specific multivalued
rgrover1 733:718a3566b4ce 954 * attributes (such as the CCCDs).
rgrover1 716:11b41f651697 955 *
rgrover1 716:11b41f651697 956 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 957 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 958 * to ble.readCharacteristicValue() should be replaced with
rgrover1 716:11b41f651697 959 * ble.gattServer().read().
rgrover1 716:11b41f651697 960 */
rgrover1 716:11b41f651697 961 ble_error_t readCharacteristicValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP) {
rgrover1 716:11b41f651697 962 return gattServer().read(connectionHandle, attributeHandle, buffer, lengthP);
rgrover1 716:11b41f651697 963 }
rgrover1 716:11b41f651697 964
rgrover1 716:11b41f651697 965 /**
rgrover1 716:11b41f651697 966 * Update the value of a characteristic on the local GattServer.
rgrover1 716:11b41f651697 967 *
rgrover1 716:11b41f651697 968 * @param[in] attributeHandle
rgrover1 716:11b41f651697 969 * Handle for the value attribute of the Characteristic.
rgrover1 716:11b41f651697 970 * @param[in] value
rgrover1 716:11b41f651697 971 * A pointer to a buffer holding the new value
rgrover1 716:11b41f651697 972 * @param[in] size
rgrover1 716:11b41f651697 973 * Size of the new value (in bytes).
rgrover1 716:11b41f651697 974 * @param[in] localOnly
rgrover1 716:11b41f651697 975 * Should this update be kept on the local
rgrover1 716:11b41f651697 976 * GattServer regardless of the state of the
rgrover1 716:11b41f651697 977 * notify/indicate flag in the CCCD for this
rgrover1 716:11b41f651697 978 * Characteristic? If set to true, no notification
rgrover1 716:11b41f651697 979 * or indication is generated.
rgrover1 716:11b41f651697 980 *
rgrover1 716:11b41f651697 981 * @return BLE_ERROR_NONE if we have successfully set the value of the attribute.
rgrover1 716:11b41f651697 982 *
rgrover1 716:11b41f651697 983 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 984 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 985 * to ble.updateCharacteristicValue() should be replaced with
rgrover1 716:11b41f651697 986 * ble.gattServer().write().
rgrover1 716:11b41f651697 987 */
rgrover1 716:11b41f651697 988 ble_error_t updateCharacteristicValue(GattAttribute::Handle_t attributeHandle,
rgrover1 716:11b41f651697 989 const uint8_t *value,
rgrover1 716:11b41f651697 990 uint16_t size,
rgrover1 716:11b41f651697 991 bool localOnly = false) {
rgrover1 716:11b41f651697 992 return gattServer().write(attributeHandle, value, size, localOnly);
rgrover1 716:11b41f651697 993 }
rgrover1 716:11b41f651697 994
rgrover1 716:11b41f651697 995 /**
rgrover1 716:11b41f651697 996 * Update the value of a characteristic on the local GattServer. A version
rgrover1 716:11b41f651697 997 * of the same as above with connection handle parameter to allow updates
rgrover1 733:718a3566b4ce 998 * for connection-specific multivalued attributes (such as the CCCDs).
rgrover1 716:11b41f651697 999 *
rgrover1 716:11b41f651697 1000 * @param[in] connectionHandle
rgrover1 716:11b41f651697 1001 * Connection Handle.
rgrover1 716:11b41f651697 1002 * @param[in] attributeHandle
rgrover1 716:11b41f651697 1003 * Handle for the value attribute of the Characteristic.
rgrover1 716:11b41f651697 1004 * @param[in] value
rgrover1 716:11b41f651697 1005 * A pointer to a buffer holding the new value
rgrover1 716:11b41f651697 1006 * @param[in] size
rgrover1 716:11b41f651697 1007 * Size of the new value (in bytes).
rgrover1 716:11b41f651697 1008 * @param[in] localOnly
rgrover1 716:11b41f651697 1009 * Should this update be kept on the local
rgrover1 716:11b41f651697 1010 * GattServer regardless of the state of the
rgrover1 716:11b41f651697 1011 * notify/indicate flag in the CCCD for this
rgrover1 716:11b41f651697 1012 * Characteristic? If set to true, no notification
rgrover1 716:11b41f651697 1013 * or indication is generated.
rgrover1 716:11b41f651697 1014 *
rgrover1 716:11b41f651697 1015 * @return BLE_ERROR_NONE if we have successfully set the value of the attribute.
rgrover1 716:11b41f651697 1016 *
rgrover1 716:11b41f651697 1017 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1018 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 1019 * to ble.updateCharacteristicValue() should be replaced with
rgrover1 716:11b41f651697 1020 * ble.gattServer().write().
rgrover1 716:11b41f651697 1021 */
rgrover1 716:11b41f651697 1022 ble_error_t updateCharacteristicValue(Gap::Handle_t connectionHandle,
rgrover1 716:11b41f651697 1023 GattAttribute::Handle_t attributeHandle,
rgrover1 716:11b41f651697 1024 const uint8_t *value,
rgrover1 716:11b41f651697 1025 uint16_t size,
rgrover1 716:11b41f651697 1026 bool localOnly = false) {
rgrover1 716:11b41f651697 1027 return gattServer().write(connectionHandle, attributeHandle, value, size, localOnly);
rgrover1 716:11b41f651697 1028 }
rgrover1 716:11b41f651697 1029
rgrover1 716:11b41f651697 1030 /**
rgrover1 716:11b41f651697 1031 * Enable the BLE stack's Security Manager. The Security Manager implements
rgrover1 716:11b41f651697 1032 * the actual cryptographic algorithms and protocol exchanges that allow two
rgrover1 716:11b41f651697 1033 * devices to securely exchange data and privately detect each other.
rgrover1 716:11b41f651697 1034 * Calling this API is a prerequisite for encryption and pairing (bonding).
rgrover1 716:11b41f651697 1035 *
rgrover1 716:11b41f651697 1036 * @param[in] enableBonding Allow for bonding.
rgrover1 716:11b41f651697 1037 * @param[in] requireMITM Require protection for man-in-the-middle attacks.
rgrover1 716:11b41f651697 1038 * @param[in] iocaps To specify IO capabilities of this peripheral,
rgrover1 716:11b41f651697 1039 * such as availability of a display or keyboard to
rgrover1 716:11b41f651697 1040 * support out-of-band exchanges of security data.
rgrover1 716:11b41f651697 1041 * @param[in] passkey To specify a static passkey.
rgrover1 716:11b41f651697 1042 *
rgrover1 716:11b41f651697 1043 * @return BLE_ERROR_NONE on success.
rgrover1 716:11b41f651697 1044 *
rgrover1 716:11b41f651697 1045 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1046 * You should use the parallel API from SecurityManager directly. A former
rgrover1 716:11b41f651697 1047 * call to ble.initializeSecurity(...) should be replaced with
rgrover1 716:11b41f651697 1048 * ble.securityManager().init(...).
rgrover1 716:11b41f651697 1049 */
rgrover1 716:11b41f651697 1050 ble_error_t initializeSecurity(bool enableBonding = true,
rgrover1 716:11b41f651697 1051 bool requireMITM = true,
rgrover1 716:11b41f651697 1052 SecurityManager::SecurityIOCapabilities_t iocaps = SecurityManager::IO_CAPS_NONE,
rgrover1 716:11b41f651697 1053 const SecurityManager::Passkey_t passkey = NULL) {
rgrover1 716:11b41f651697 1054 return securityManager().init(enableBonding, requireMITM, iocaps, passkey);
rgrover1 716:11b41f651697 1055 }
rgrover1 716:11b41f651697 1056
rgrover1 716:11b41f651697 1057 /**
rgrover1 716:11b41f651697 1058 * Get the security status of a connection.
rgrover1 716:11b41f651697 1059 *
rgrover1 716:11b41f651697 1060 * @param[in] connectionHandle Handle to identify the connection.
rgrover1 716:11b41f651697 1061 * @param[out] securityStatusP security status.
rgrover1 716:11b41f651697 1062 *
rgrover1 716:11b41f651697 1063 * @return BLE_SUCCESS Or appropriate error code indicating reason for failure.
rgrover1 716:11b41f651697 1064 *
rgrover1 716:11b41f651697 1065 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1066 * You should use the parallel API from SecurityManager directly. A former
rgrover1 716:11b41f651697 1067 * call to ble.getLinkSecurity(...) should be replaced with
rgrover1 716:11b41f651697 1068 * ble.securityManager().getLinkSecurity(...).
rgrover1 716:11b41f651697 1069 */
rgrover1 716:11b41f651697 1070 ble_error_t getLinkSecurity(Gap::Handle_t connectionHandle, SecurityManager::LinkSecurityStatus_t *securityStatusP) {
rgrover1 716:11b41f651697 1071 return securityManager().getLinkSecurity(connectionHandle, securityStatusP);
rgrover1 716:11b41f651697 1072 }
rgrover1 716:11b41f651697 1073
rgrover1 716:11b41f651697 1074 /**
rgrover1 716:11b41f651697 1075 * Delete all peer device context and all related bonding information from
rgrover1 716:11b41f651697 1076 * the database within the security manager.
rgrover1 716:11b41f651697 1077 *
rgrover1 716:11b41f651697 1078 * @retval BLE_ERROR_NONE On success, else an error code indicating reason for failure.
rgrover1 716:11b41f651697 1079 * @retval BLE_ERROR_INVALID_STATE If the API is called without module initialization and/or
rgrover1 716:11b41f651697 1080 * application registration.
rgrover1 716:11b41f651697 1081 *
rgrover1 716:11b41f651697 1082 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1083 * You should use the parallel API from SecurityManager directly. A former
rgrover1 716:11b41f651697 1084 * call to ble.purgeAllBondingState() should be replaced with
rgrover1 716:11b41f651697 1085 * ble.securityManager().purgeAllBondingState().
rgrover1 716:11b41f651697 1086 */
rgrover1 716:11b41f651697 1087 ble_error_t purgeAllBondingState(void) {
rgrover1 716:11b41f651697 1088 return securityManager().purgeAllBondingState();
rgrover1 716:11b41f651697 1089 }
rgrover1 716:11b41f651697 1090
rgrover1 716:11b41f651697 1091 /**
rgrover1 716:11b41f651697 1092 * Setup a callback for timeout events. Refer to Gap::TimeoutSource_t for
rgrover1 716:11b41f651697 1093 * possible event types.
rgrover1 716:11b41f651697 1094 *
rgrover1 716:11b41f651697 1095 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 751:868b6dd7a6bf 1096 * You should use the parallel API from Gap directly. A former call
rgrover1 716:11b41f651697 1097 * to ble.onTimeout(callback) should be replaced with
rgrover1 716:11b41f651697 1098 * ble.gap().onTimeout(callback).
rgrover1 716:11b41f651697 1099 */
rgrover1 716:11b41f651697 1100 void onTimeout(Gap::TimeoutEventCallback_t timeoutCallback) {
rgrover1 716:11b41f651697 1101 gap().onTimeout(timeoutCallback);
rgrover1 716:11b41f651697 1102 }
rgrover1 716:11b41f651697 1103
rgrover1 716:11b41f651697 1104 /**
rgrover1 716:11b41f651697 1105 * Setup a callback for connection events. Refer to Gap::ConnectionEventCallback_t.
rgrover1 716:11b41f651697 1106 *
rgrover1 716:11b41f651697 1107 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 751:868b6dd7a6bf 1108 * You should use the parallel API from Gap directly. A former call
rgrover1 716:11b41f651697 1109 * to ble.onConnection(callback) should be replaced with
rgrover1 716:11b41f651697 1110 * ble.gap().onConnection(callback).
rgrover1 716:11b41f651697 1111 */
rgrover1 716:11b41f651697 1112 void onConnection(Gap::ConnectionEventCallback_t connectionCallback) {
rgrover1 716:11b41f651697 1113 gap().onConnection(connectionCallback);
rgrover1 716:11b41f651697 1114 }
rgrover1 716:11b41f651697 1115
rgrover1 716:11b41f651697 1116 /**
rgrover1 716:11b41f651697 1117 * Used to setup a callback for GAP disconnection.
rgrover1 716:11b41f651697 1118 *
rgrover1 716:11b41f651697 1119 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 751:868b6dd7a6bf 1120 * You should use the parallel API from Gap directly. A former call
rgrover1 716:11b41f651697 1121 * to ble.onDisconnection(callback) should be replaced with
rgrover1 716:11b41f651697 1122 * ble.gap().onDisconnection(callback).
rgrover1 716:11b41f651697 1123 */
rgrover1 716:11b41f651697 1124 void onDisconnection(Gap::DisconnectionEventCallback_t disconnectionCallback) {
rgrover1 716:11b41f651697 1125 gap().onDisconnection(disconnectionCallback);
rgrover1 716:11b41f651697 1126 }
rgrover1 716:11b41f651697 1127
rgrover1 716:11b41f651697 1128 /**
rgrover1 716:11b41f651697 1129 * Append to a chain of callbacks to be invoked upon disconnection; these
rgrover1 716:11b41f651697 1130 * callbacks receive no context and are therefore different from the
rgrover1 716:11b41f651697 1131 * onDisconnection callback.
rgrover1 716:11b41f651697 1132 *
rgrover1 716:11b41f651697 1133 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 751:868b6dd7a6bf 1134 * You should use the parallel API from Gap directly. A former call
rgrover1 716:11b41f651697 1135 * to ble.addToDisconnectionCallchain(...) should be replaced with
rgrover1 716:11b41f651697 1136 * ble.gap().addToDisconnectionCallchain(...).
rgrover1 716:11b41f651697 1137 */
rgrover1 716:11b41f651697 1138 template<typename T>
rgrover1 716:11b41f651697 1139 void addToDisconnectionCallChain(T *tptr, void (T::*mptr)(void)) {
rgrover1 716:11b41f651697 1140 gap().addToDisconnectionCallChain(tptr, mptr);
rgrover1 716:11b41f651697 1141 }
rgrover1 716:11b41f651697 1142
rgrover1 716:11b41f651697 1143 /**
rgrover1 716:11b41f651697 1144 * Radio Notification is a feature that enables ACTIVE and INACTIVE
rgrover1 716:11b41f651697 1145 * (nACTIVE) signals from the stack that notify the application when the
rgrover1 716:11b41f651697 1146 * radio is in use. The signal is sent using software interrupt.
rgrover1 716:11b41f651697 1147 *
rgrover1 716:11b41f651697 1148 * The ACTIVE signal is sent before the Radio Event starts. The nACTIVE
rgrover1 716:11b41f651697 1149 * signal is sent at the end of the Radio Event. These signals can be used
rgrover1 716:11b41f651697 1150 * by the application programmer to synchronize application logic with radio
rgrover1 716:11b41f651697 1151 * activity. For example, the ACTIVE signal can be used to shut off external
rgrover1 716:11b41f651697 1152 * devices to manage peak current drawn during periods when the radio is on,
rgrover1 716:11b41f651697 1153 * or to trigger sensor data collection for transmission in the Radio Event.
rgrover1 716:11b41f651697 1154 *
rgrover1 716:11b41f651697 1155 * @param callback
rgrover1 716:11b41f651697 1156 * The application handler to be invoked in response to a radio
rgrover1 716:11b41f651697 1157 * ACTIVE/INACTIVE event.
rgrover1 716:11b41f651697 1158 *
rgrover1 716:11b41f651697 1159 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 751:868b6dd7a6bf 1160 * You should use the parallel API from Gap directly. A former call
rgrover1 716:11b41f651697 1161 * to ble.onRadioNotification(...) should be replaced with
rgrover1 716:11b41f651697 1162 * ble.gap().onRadioNotification(...).
rgrover1 716:11b41f651697 1163 */
rgrover1 752:424c2ae44553 1164 void onRadioNotification(void (*callback)(bool)) {
rgrover1 716:11b41f651697 1165 gap().onRadioNotification(callback);
rgrover1 716:11b41f651697 1166 }
rgrover1 716:11b41f651697 1167
rgrover1 716:11b41f651697 1168 /**
rgrover1 716:11b41f651697 1169 * Add a callback for the GATT event DATA_SENT (which is triggered when
rgrover1 716:11b41f651697 1170 * updates are sent out by GATT in the form of notifications).
rgrover1 716:11b41f651697 1171 *
rgrover1 716:11b41f651697 1172 * @Note: it is possible to chain together multiple onDataSent callbacks
rgrover1 716:11b41f651697 1173 * (potentially from different modules of an application) to receive updates
rgrover1 716:11b41f651697 1174 * to characteristics.
rgrover1 716:11b41f651697 1175 *
rgrover1 716:11b41f651697 1176 * @Note: it is also possible to setup a callback into a member function of
rgrover1 716:11b41f651697 1177 * some object.
rgrover1 716:11b41f651697 1178 *
rgrover1 716:11b41f651697 1179 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1180 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 1181 * to ble.onDataSent(...) should be replaced with
rgrover1 716:11b41f651697 1182 * ble.gattServer().onDataSent(...).
rgrover1 716:11b41f651697 1183 */
rgrover1 716:11b41f651697 1184 void onDataSent(void (*callback)(unsigned count)) {
rgrover1 716:11b41f651697 1185 gattServer().onDataSent(callback);
rgrover1 716:11b41f651697 1186 }
rgrover1 716:11b41f651697 1187 template <typename T> void onDataSent(T * objPtr, void (T::*memberPtr)(unsigned count)) {
rgrover1 716:11b41f651697 1188 gattServer().onDataSent(objPtr, memberPtr);
rgrover1 716:11b41f651697 1189 }
rgrover1 716:11b41f651697 1190
rgrover1 716:11b41f651697 1191 /**
rgrover1 716:11b41f651697 1192 * Setup a callback for when an attribute has its value updated by or at the
rgrover1 716:11b41f651697 1193 * connected peer. For a peripheral, this callback triggered when the local
rgrover1 716:11b41f651697 1194 * GATT server has an attribute updated by a write command from the peer.
rgrover1 716:11b41f651697 1195 * For a Central, this callback is triggered when a response is received for
rgrover1 716:11b41f651697 1196 * a write request.
rgrover1 716:11b41f651697 1197 *
rgrover1 716:11b41f651697 1198 * @Note: it is possible to chain together multiple onDataWritten callbacks
rgrover1 716:11b41f651697 1199 * (potentially from different modules of an application) to receive updates
rgrover1 716:11b41f651697 1200 * to characteristics. Many services, such as DFU and UART add their own
rgrover1 716:11b41f651697 1201 * onDataWritten callbacks behind the scenes to trap interesting events.
rgrover1 716:11b41f651697 1202 *
rgrover1 716:11b41f651697 1203 * @Note: it is also possible to setup a callback into a member function of
rgrover1 716:11b41f651697 1204 * some object.
rgrover1 716:11b41f651697 1205 *
rgrover1 716:11b41f651697 1206 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1207 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 1208 * to ble.onDataWritten(...) should be replaced with
rgrover1 716:11b41f651697 1209 * ble.gattServer().onDataWritten(...).
rgrover1 716:11b41f651697 1210 */
rgrover1 716:11b41f651697 1211 void onDataWritten(void (*callback)(const GattWriteCallbackParams *eventDataP)) {
rgrover1 716:11b41f651697 1212 gattServer().onDataWritten(callback);
rgrover1 716:11b41f651697 1213 }
rgrover1 716:11b41f651697 1214 template <typename T> void onDataWritten(T * objPtr, void (T::*memberPtr)(const GattWriteCallbackParams *context)) {
rgrover1 716:11b41f651697 1215 gattServer().onDataWritten(objPtr, memberPtr);
rgrover1 716:11b41f651697 1216 }
rgrover1 716:11b41f651697 1217
rgrover1 716:11b41f651697 1218 /**
rgrover1 716:11b41f651697 1219 * Setup a callback to be invoked on the peripheral when an attribute is
rgrover1 716:11b41f651697 1220 * being read by a remote client.
rgrover1 716:11b41f651697 1221 *
rgrover1 716:11b41f651697 1222 * @Note: this functionality may not be available on all underlying stacks.
rgrover1 716:11b41f651697 1223 * You could use GattCharacteristic::setReadAuthorizationCallback() as an
rgrover1 716:11b41f651697 1224 * alternative.
rgrover1 716:11b41f651697 1225 *
rgrover1 716:11b41f651697 1226 * @Note: it is possible to chain together multiple onDataRead callbacks
rgrover1 716:11b41f651697 1227 * (potentially from different modules of an application) to receive updates
rgrover1 716:11b41f651697 1228 * to characteristics. Services may add their own onDataRead callbacks
rgrover1 716:11b41f651697 1229 * behind the scenes to trap interesting events.
rgrover1 716:11b41f651697 1230 *
rgrover1 716:11b41f651697 1231 * @Note: it is also possible to setup a callback into a member function of
rgrover1 716:11b41f651697 1232 * some object.
rgrover1 716:11b41f651697 1233 *
rgrover1 716:11b41f651697 1234 * @return BLE_ERROR_NOT_IMPLEMENTED if this functionality isn't available;
rgrover1 716:11b41f651697 1235 * else BLE_ERROR_NONE.
rgrover1 716:11b41f651697 1236 *
rgrover1 716:11b41f651697 1237 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1238 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 1239 * to ble.onDataRead(...) should be replaced with
rgrover1 716:11b41f651697 1240 * ble.gattServer().onDataRead(...).
rgrover1 716:11b41f651697 1241 */
rgrover1 716:11b41f651697 1242 ble_error_t onDataRead(void (*callback)(const GattReadCallbackParams *eventDataP)) {
rgrover1 716:11b41f651697 1243 return gattServer().onDataRead(callback);
rgrover1 716:11b41f651697 1244 }
rgrover1 716:11b41f651697 1245 template <typename T> ble_error_t onDataRead(T * objPtr, void (T::*memberPtr)(const GattReadCallbackParams *context)) {
rgrover1 716:11b41f651697 1246 return gattServer().onDataRead(objPtr, memberPtr);
rgrover1 716:11b41f651697 1247 }
rgrover1 716:11b41f651697 1248
rgrover1 716:11b41f651697 1249 /**
rgrover1 716:11b41f651697 1250 * Setup a callback for when notifications/indications are enabled for a
rgrover1 716:11b41f651697 1251 * characteristic on the local GattServer.
rgrover1 716:11b41f651697 1252 *
rgrover1 716:11b41f651697 1253 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1254 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 1255 * to ble.onUpdatesEnabled(callback) should be replaced with
rgrover1 716:11b41f651697 1256 * ble.gattServer().onUpdatesEnabled(callback).
rgrover1 716:11b41f651697 1257 */
rgrover1 716:11b41f651697 1258 void onUpdatesEnabled(GattServer::EventCallback_t callback) {
rgrover1 716:11b41f651697 1259 gattServer().onUpdatesEnabled(callback);
rgrover1 716:11b41f651697 1260 }
rgrover1 716:11b41f651697 1261
rgrover1 716:11b41f651697 1262 /**
rgrover1 716:11b41f651697 1263 * Setup a callback for when notifications/indications are disabled for a
rgrover1 716:11b41f651697 1264 * characteristic on the local GattServer.
rgrover1 716:11b41f651697 1265 *
rgrover1 716:11b41f651697 1266 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1267 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 1268 * to ble.onUpdatesEnabled(callback) should be replaced with
rgrover1 716:11b41f651697 1269 * ble.gattServer().onUpdatesEnabled(callback).
rgrover1 716:11b41f651697 1270 */
rgrover1 716:11b41f651697 1271 void onUpdatesDisabled(GattServer::EventCallback_t callback) {
rgrover1 716:11b41f651697 1272 gattServer().onUpdatesDisabled(callback);
rgrover1 716:11b41f651697 1273 }
rgrover1 716:11b41f651697 1274
rgrover1 716:11b41f651697 1275 /**
rgrover1 716:11b41f651697 1276 * Setup a callback for when the GATT server receives a response for an
rgrover1 716:11b41f651697 1277 * indication event sent previously.
rgrover1 716:11b41f651697 1278 *
rgrover1 716:11b41f651697 1279 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1280 * You should use the parallel API from GattServer directly. A former call
rgrover1 716:11b41f651697 1281 * to ble.onConfirmationReceived(callback) should be replaced with
rgrover1 716:11b41f651697 1282 * ble.gattServer().onConfirmationReceived(callback).
rgrover1 716:11b41f651697 1283 */
rgrover1 716:11b41f651697 1284 void onConfirmationReceived(GattServer::EventCallback_t callback) {
rgrover1 716:11b41f651697 1285 gattServer().onConfirmationReceived(callback);
rgrover1 716:11b41f651697 1286 }
rgrover1 716:11b41f651697 1287
rgrover1 716:11b41f651697 1288 /**
rgrover1 716:11b41f651697 1289 * Setup a callback for when the security setup procedure (key generation
rgrover1 716:11b41f651697 1290 * and exchange) for a link has started. This will be skipped for bonded
rgrover1 716:11b41f651697 1291 * devices. The callback is passed in parameters received from the peer's
rgrover1 716:11b41f651697 1292 * security request: bool allowBonding, bool requireMITM, and
rgrover1 716:11b41f651697 1293 * SecurityIOCapabilities_t.
rgrover1 716:11b41f651697 1294 *
rgrover1 716:11b41f651697 1295 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1296 * You should use the parallel API from SecurityManager directly. A former
rgrover1 716:11b41f651697 1297 * call to ble.onSecuritySetupInitiated(callback) should be replaced with
rgrover1 716:11b41f651697 1298 * ble.securityManager().onSecuritySetupInitiated(callback).
rgrover1 716:11b41f651697 1299 */
rgrover1 716:11b41f651697 1300 void onSecuritySetupInitiated(SecurityManager::SecuritySetupInitiatedCallback_t callback) {
rgrover1 716:11b41f651697 1301 securityManager().onSecuritySetupInitiated(callback);
rgrover1 716:11b41f651697 1302 }
rgrover1 716:11b41f651697 1303
rgrover1 716:11b41f651697 1304 /**
rgrover1 716:11b41f651697 1305 * Setup a callback for when the security setup procedure (key generation
rgrover1 716:11b41f651697 1306 * and exchange) for a link has completed. This will be skipped for bonded
rgrover1 716:11b41f651697 1307 * devices. The callback is passed in the success/failure status of the
rgrover1 716:11b41f651697 1308 * security setup procedure.
rgrover1 716:11b41f651697 1309 *
rgrover1 716:11b41f651697 1310 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1311 * You should use the parallel API from SecurityManager directly. A former
rgrover1 716:11b41f651697 1312 * call to ble.onSecuritySetupCompleted(callback) should be replaced with
rgrover1 716:11b41f651697 1313 * ble.securityManager().onSecuritySetupCompleted(callback).
rgrover1 716:11b41f651697 1314 */
rgrover1 716:11b41f651697 1315 void onSecuritySetupCompleted(SecurityManager::SecuritySetupCompletedCallback_t callback) {
rgrover1 716:11b41f651697 1316 securityManager().onSecuritySetupCompleted(callback);
rgrover1 716:11b41f651697 1317 }
rgrover1 716:11b41f651697 1318
rgrover1 716:11b41f651697 1319 /**
rgrover1 716:11b41f651697 1320 * Setup a callback for when a link with the peer is secured. For bonded
rgrover1 716:11b41f651697 1321 * devices, subsequent reconnections with bonded peer will result only in
rgrover1 716:11b41f651697 1322 * this callback when the link is secured and setup procedures will not
rgrover1 716:11b41f651697 1323 * occur unless the bonding information is either lost or deleted on either
rgrover1 716:11b41f651697 1324 * or both sides. The callback is passed in a SecurityManager::SecurityMode_t according
rgrover1 716:11b41f651697 1325 * to the level of security in effect for the secured link.
rgrover1 716:11b41f651697 1326 *
rgrover1 716:11b41f651697 1327 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1328 * You should use the parallel API from SecurityManager directly. A former
rgrover1 716:11b41f651697 1329 * call to ble.onLinkSecured(callback) should be replaced with
rgrover1 716:11b41f651697 1330 * ble.securityManager().onLinkSecured(callback).
rgrover1 716:11b41f651697 1331 */
rgrover1 716:11b41f651697 1332 void onLinkSecured(SecurityManager::LinkSecuredCallback_t callback) {
rgrover1 716:11b41f651697 1333 securityManager().onLinkSecured(callback);
rgrover1 716:11b41f651697 1334 }
rgrover1 716:11b41f651697 1335
rgrover1 716:11b41f651697 1336 /**
rgrover1 716:11b41f651697 1337 * Setup a callback for successful bonding; i.e. that link-specific security
rgrover1 716:11b41f651697 1338 * context is stored persistently for a peer device.
rgrover1 716:11b41f651697 1339 *
rgrover1 716:11b41f651697 1340 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1341 * You should use the parallel API from SecurityManager directly. A former
rgrover1 716:11b41f651697 1342 * call to ble.onSecurityContextStored(callback) should be replaced with
rgrover1 716:11b41f651697 1343 * ble.securityManager().onSecurityContextStored(callback).
rgrover1 716:11b41f651697 1344 */
rgrover1 716:11b41f651697 1345 void onSecurityContextStored(SecurityManager::HandleSpecificEvent_t callback) {
rgrover1 716:11b41f651697 1346 securityManager().onSecurityContextStored(callback);
rgrover1 716:11b41f651697 1347 }
rgrover1 716:11b41f651697 1348
rgrover1 716:11b41f651697 1349 /**
rgrover1 716:11b41f651697 1350 * Setup a callback for when the passkey needs to be displayed on a
rgrover1 716:11b41f651697 1351 * peripheral with DISPLAY capability. This happens when security is
rgrover1 716:11b41f651697 1352 * configured to prevent Man-In-The-Middle attacks, and a PIN (or passkey)
rgrover1 716:11b41f651697 1353 * needs to be exchanged between the peers to authenticate the connection
rgrover1 716:11b41f651697 1354 * attempt.
rgrover1 716:11b41f651697 1355 *
rgrover1 716:11b41f651697 1356 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 716:11b41f651697 1357 * You should use the parallel API from SecurityManager directly. A former
rgrover1 716:11b41f651697 1358 * call to ble.onPasskeyDisplay(callback) should be replaced with
rgrover1 716:11b41f651697 1359 * ble.securityManager().onPasskeyDisplay(callback).
rgrover1 716:11b41f651697 1360 */
rgrover1 716:11b41f651697 1361 void onPasskeyDisplay(SecurityManager::PasskeyDisplayCallback_t callback) {
rgrover1 716:11b41f651697 1362 return securityManager().onPasskeyDisplay(callback);
rgrover1 716:11b41f651697 1363 }
rgrover1 716:11b41f651697 1364
rgrover1 822:86038b69609c 1365 public:
rgrover1 822:86038b69609c 1366 BLE() : transport(createBLEInstance()) {
rgrover1 822:86038b69609c 1367 /* empty */
rgrover1 822:86038b69609c 1368 }
rgrover1 822:86038b69609c 1369
rgrover1 716:11b41f651697 1370 private:
rgrover1 807:50c121156a71 1371 BLE(const BLE&);
rgrover1 807:50c121156a71 1372 BLE &operator=(const BLE &);
rgrover1 807:50c121156a71 1373
rgrover1 807:50c121156a71 1374 private:
rgrover1 822:86038b69609c 1375 BLEInstanceBase *const transport; /* the device specific backend */
rgrover1 716:11b41f651697 1376 };
rgrover1 716:11b41f651697 1377
rgrover1 716:11b41f651697 1378 typedef BLE BLEDevice; /* DEPRECATED. This type alias is retained for the sake of compatibility with older
rgrover1 716:11b41f651697 1379 * code. Will be dropped at some point soon.*/
rgrover1 716:11b41f651697 1380
rgrover1 716:11b41f651697 1381 #endif // ifndef __BLE_H__