BLE_API - High level Bluetooth Low Energy API and radio abs…

Users » luzai » Code » BLE_API

Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies: nRF51822

Dependents: LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

ble/BLE.h@852:f0de1349300c, 2015-11-02 (annotated)

Committer:: rgrover1
Date:: Mon Nov 02 09:09:06 2015 +0000
Revision:: 852:f0de1349300c
Parent:: 851:802f445cc195
Child:: 853:2e829bcda785

Synchronized with git rev da3d9f81

Author: Andres Amaya Garcia

Fixed include problem in HealthThermometer header



Modified the HealthThermometer header file to include BLE.h from

ble/BLE.h.

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	11 May 2016
Imports:	8
Forks:	0
Commits:	1202
Dependents:	1
Dependencies:	1
Followers:	1

ble/BLE.h@852:f0de1349300c, 2015-11-02 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning