BLE_API - fka mod

Users » FrancisDrake » Code » BLE_API

fka mod

Fork of BLE_API by Bluetooth Low Energy

ble/BLE.h@1175:1d25cd85e851, 2016-04-06 (annotated)

Committer:: vcoubard
Date:: Wed Apr 06 19:15:22 2016 +0100
Revision:: 1175:1d25cd85e851
Parent:: 1156:e1ea38b576c6
Child:: 1176:8b308f971420

Synchronized with git rev b0166287

Author: Andres Amaya Garcia

Remove init @note from BLE.h

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	19 Dec 2017
Imports:	6
Forks:	0
Commits:	1210
Dependents:	0
Dependencies:	0
Followers:	1

ble/BLE.h@1175:1d25cd85e851, 2016-04-06 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning