CARLO TARALLO / BLE_API

prova invio BLE

Dependents:   BLE_HeartRate_IDB04A1

Fork of BLE_API by Bluetooth Low Energy

ble/BLE.h@1156:e1ea38b576c6, 2016-04-06 (annotated)

Committer:
vcoubard
Date:
Wed Apr 06 19:14:38 2016 +0100
Revision:
1156:e1ea38b576c6
Parent:
1155:e28c7aac64ab
Child:
1175:1d25cd85e851
Synchronized with git rev 5749d87d

Author: Andres Amaya Garcia

Add missing documentation to Gap.h and fix doxygen warnings

Who changed what in which revision?

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