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

Users » cordonn2 » Code » BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Fork of BLE_API by Bluetooth Low Energy

ble/BLE.h@884:37599305e7b6, 2015-11-26 (annotated)

Committer:: rgrover1
Date:: Thu Nov 26 12:51:59 2015 +0000
Revision:: 884:37599305e7b6
Parent:: 882:a4e00d3d7bcb
Child:: 886:0a45c67b2301

Synchronized with git rev 9c001d27

Author: Rohit Grover

Merge branch 'develop'

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

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	28 Mar 2017
Imports:	0
Forks:	0
Commits:	1210
Dependents:	0
Dependencies:	0
Followers:	1

ble/BLE.h@884:37599305e7b6, 2015-11-26 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning