BLE_API - Bike service

Users » ptuytsch » Code » BLE_API

Bike service

Fork of BLE_API by Bluetooth Low Energy

ble/BLE.h@1177:8b308f971420, 2016-04-06 (annotated)

Committer:: vcoubard
Date:: Wed Apr 06 19:15:24 2016 +0100
Revision:: 1177:8b308f971420
Parent:: 1176:1d25cd85e851
Child:: 1180:4ab722f8dca0

Synchronized with git rev b117e9d0

Author: Andres Amaya Garcia

Add links to new API from deprecated message in BLE.h

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	16 Apr 2016
Imports:	0
Forks:	1
Commits:	1202
Dependents:	0
Dependencies:	0
Followers:	1

ble/BLE.h@1177:8b308f971420, 2016-04-06 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning