Andrew Fox / BLE_API

add "LE Device Address" 0x1B to advertising data types

Fork of BLE_API by Bluetooth Low Energy

ble/BLE.h@854:ad4ae73c2b5a, 2015-11-02 (annotated)

Committer:
rgrover1
Date:
Mon Nov 02 09:09:06 2015 +0000
Revision:
854:ad4ae73c2b5a
Parent:
853:2e829bcda785
Child:
855:98b96c377015
Synchronized with git rev 918af4fb

Author: Rohit Grover

Major change:

- There's a new type: BLE::InitializationCompleteCallback_t

- init() now takes a completion callback. This is an optional parameter, if no callback is setup the application can still determine the status of initialization using BLE::hasInitialized() (see below).

- There's a new API: BLEInstanceBase::hasInitialized() which transports need to implement.

- BLEInstanceBase.h is no longer included from BLE.h. We use a forward declaration of BLEInstanceBase instead. This is required us to move implementations of BLE methods out of the header and into BLE.cpp.

- There's a new API:  BLE::getInstanceID(), which simply returns the ID of an instance.

- There are new error types around initialization.

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