BLE_API - fka mod

Users » FrancisDrake » Code » BLE_API

fka mod

Fork of BLE_API by Bluetooth Low Energy

ble/Gap.h@1116:9cb51490b3f7, 2016-01-11 (annotated)

Committer:: vcoubard
Date:: Mon Jan 11 08:52:02 2016 +0000
Revision:: 1116:9cb51490b3f7
Parent:: 1115:82d4a8a56d91
Child:: 1117:421bdb7c5711

Synchronized with git rev 54977ed9

Author: Andres Amaya Garcia

Merge branch 'develop' of github.com:ARMmbed/ble into whitelisting

Who changed what in which revision?

User	Revision	Line number	New contents of line
rgrover1	710:b2e1a2660ec2	1	/* mbed Microcontroller Library
rgrover1	710:b2e1a2660ec2	2	* Copyright (c) 2006-2013 ARM Limited
rgrover1	710:b2e1a2660ec2	3	*
rgrover1	710:b2e1a2660ec2	4	* Licensed under the Apache License, Version 2.0 (the "License");
rgrover1	710:b2e1a2660ec2	5	* you may not use this file except in compliance with the License.
rgrover1	710:b2e1a2660ec2	6	* You may obtain a copy of the License at
rgrover1	710:b2e1a2660ec2	7	*
rgrover1	710:b2e1a2660ec2	8	* http://www.apache.org/licenses/LICENSE-2.0
rgrover1	710:b2e1a2660ec2	9	*
rgrover1	710:b2e1a2660ec2	10	* Unless required by applicable law or agreed to in writing, software
rgrover1	710:b2e1a2660ec2	11	* distributed under the License is distributed on an "AS IS" BASIS,
rgrover1	710:b2e1a2660ec2	12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1	710:b2e1a2660ec2	13	* See the License for the specific language governing permissions and
rgrover1	710:b2e1a2660ec2	14	* limitations under the License.
rgrover1	710:b2e1a2660ec2	15	*/
rgrover1	710:b2e1a2660ec2	16
rgrover1	710:b2e1a2660ec2	17	#ifndef __GAP_H__
rgrover1	710:b2e1a2660ec2	18	#define __GAP_H__
rgrover1	710:b2e1a2660ec2	19
vcoubard	1078:79c089630b38	20	#include "ble/BLEProtocol.h"
rgrover1	710:b2e1a2660ec2	21	#include "GapAdvertisingData.h"
rgrover1	710:b2e1a2660ec2	22	#include "GapAdvertisingParams.h"
rgrover1	710:b2e1a2660ec2	23	#include "GapScanningParams.h"
rgrover1	710:b2e1a2660ec2	24	#include "GapEvents.h"
rgrover1	829:9072de50087b	25	#include "CallChainOfFunctionPointersWithContext.h"
rgrover1	710:b2e1a2660ec2	26	#include "FunctionPointerWithContext.h"
vcoubard	1115:82d4a8a56d91	27	#include <set>
vcoubard	1116:9cb51490b3f7	28	#include "deprecate.h"
rgrover1	710:b2e1a2660ec2	29
vcoubard	1048:efb29faf12fc	30	/* Forward declarations for classes that will only be used for pointers or references in the following. */
rgrover1	710:b2e1a2660ec2	31	class GapAdvertisingParams;
rgrover1	710:b2e1a2660ec2	32	class GapScanningParams;
rgrover1	710:b2e1a2660ec2	33	class GapAdvertisingData;
rgrover1	710:b2e1a2660ec2	34
rgrover1	710:b2e1a2660ec2	35	class Gap {
vcoubard	1078:79c089630b38	36	/*
vcoubard	1078:79c089630b38	37	* DEPRECATION ALERT: all of the APIs in this `public` block are deprecated.
vcoubard	1078:79c089630b38	38	* They have been relocated to the class BLEProtocol.
vcoubard	1078:79c089630b38	39	*/
rgrover1	710:b2e1a2660ec2	40	public:
vcoubard	1078:79c089630b38	41	/**
vcoubard	1078:79c089630b38	42	* Address-type for BLEProtocol addresses.
vcoubard	1091:58b2dac13261	43	*
vcoubard	1086:75d4e8ce277d	44	* @note: deprecated. Use BLEProtocol::AddressType_t instead.
vcoubard	1078:79c089630b38	45	*/
vcoubard	1086:75d4e8ce277d	46	typedef BLEProtocol::AddressType_t AddressType_t;
vcoubard	1086:75d4e8ce277d	47
vcoubard	1086:75d4e8ce277d	48	/**
vcoubard	1086:75d4e8ce277d	49	* Address-type for BLEProtocol addresses.
vcoubard	1086:75d4e8ce277d	50	* @note: deprecated. Use BLEProtocol::AddressType_t instead.
vcoubard	1087:4c6e11878033	51	*/
vcoubard	1087:4c6e11878033	52	typedef BLEProtocol::AddressType_t addr_type_t;
vcoubard	1087:4c6e11878033	53
vcoubard	1091:58b2dac13261	54	/**
vcoubard	1091:58b2dac13261	55	* Address-type for BLEProtocol addresses.
vcoubard	1116:9cb51490b3f7	56	* \deprecated: Use BLEProtocol::AddressType_t instead.
vcoubard	1091:58b2dac13261	57	*
vcoubard	1091:58b2dac13261	58	* DEPRECATION ALERT: The following constants have been left in their
vcoubard	1091:58b2dac13261	59	* deprecated state to transparenly support existing applications which may
vcoubard	1091:58b2dac13261	60	* have used Gap::ADDR_TYPE_*.
vcoubard	1091:58b2dac13261	61	*/
vcoubard	1116:9cb51490b3f7	62	enum DeprecatedAddressType_t {
vcoubard	1091:58b2dac13261	63	ADDR_TYPE_PUBLIC = BLEProtocol::AddressType::PUBLIC,
vcoubard	1091:58b2dac13261	64	ADDR_TYPE_RANDOM_STATIC = BLEProtocol::AddressType::RANDOM_STATIC,
vcoubard	1091:58b2dac13261	65	ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE = BLEProtocol::AddressType::RANDOM_PRIVATE_RESOLVABLE,
vcoubard	1091:58b2dac13261	66	ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE = BLEProtocol::AddressType::RANDOM_PRIVATE_NON_RESOLVABLE
vcoubard	1091:58b2dac13261	67	};
vcoubard	1091:58b2dac13261	68
vcoubard	1078:79c089630b38	69	static const unsigned ADDR_LEN = BLEProtocol::ADDR_LEN; /*< Length (in octets) of the BLE MAC address. /
vcoubard	1115:82d4a8a56d91	70	typedef BLEProtocol::AddressBytes_t Address_t; /*< 48-bit address, LSB format. @Note: Deprecated. Use BLEProtocol::Address_t instead. /
vcoubard	1115:82d4a8a56d91	71	typedef BLEProtocol::AddressBytes_t address_t; /*< 48-bit address, LSB format. @Note: Deprecated. Use BLEProtocol::Address_t instead. /
vcoubard	1078:79c089630b38	72
vcoubard	1078:79c089630b38	73	public:
rgrover1	710:b2e1a2660ec2	74	enum TimeoutSource_t {
rgrover1	710:b2e1a2660ec2	75	TIMEOUT_SRC_ADVERTISING = 0x00, /*< Advertising timeout. /
rgrover1	710:b2e1a2660ec2	76	TIMEOUT_SRC_SECURITY_REQUEST = 0x01, /*< Security request timeout. /
rgrover1	710:b2e1a2660ec2	77	TIMEOUT_SRC_SCAN = 0x02, /*< Scanning timeout. /
rgrover1	710:b2e1a2660ec2	78	TIMEOUT_SRC_CONN = 0x03, /*< Connection timeout. /
rgrover1	710:b2e1a2660ec2	79	};
rgrover1	710:b2e1a2660ec2	80
rgrover1	710:b2e1a2660ec2	81	/**
rgrover1	710:b2e1a2660ec2	82	* Enumeration for disconnection reasons. The values for these reasons are
vcoubard	1048:efb29faf12fc	83	* derived from Nordic's implementation, but the reasons are meant to be
vcoubard	1048:efb29faf12fc	84	* independent of the transport. If you are returned a reason that is not
vcoubard	1048:efb29faf12fc	85	* covered by this enumeration, please refer to the underlying
rgrover1	710:b2e1a2660ec2	86	* transport library.
rgrover1	710:b2e1a2660ec2	87	*/
rgrover1	710:b2e1a2660ec2	88	enum DisconnectionReason_t {
rgrover1	710:b2e1a2660ec2	89	CONNECTION_TIMEOUT = 0x08,
rgrover1	710:b2e1a2660ec2	90	REMOTE_USER_TERMINATED_CONNECTION = 0x13,
vcoubard	1048:efb29faf12fc	91	REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES = 0x14, /*< Remote device terminated connection due to low resources./
vcoubard	1048:efb29faf12fc	92	REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF = 0x15, /*< Remote device terminated connection due to power off. /
rgrover1	710:b2e1a2660ec2	93	LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
rgrover1	710:b2e1a2660ec2	94	CONN_INTERVAL_UNACCEPTABLE = 0x3B,
rgrover1	710:b2e1a2660ec2	95	};
rgrover1	710:b2e1a2660ec2	96
vcoubard	1048:efb29faf12fc	97	/* Describes the current state of the device (more than one bit can be set). */
rgrover1	710:b2e1a2660ec2	98	struct GapState_t {
vcoubard	1048:efb29faf12fc	99	unsigned advertising : 1; /*< Peripheral is currently advertising. /
vcoubard	1048:efb29faf12fc	100	unsigned connected : 1; /*< Peripheral is connected to a central. /
rgrover1	710:b2e1a2660ec2	101	};
rgrover1	710:b2e1a2660ec2	102
rgrover1	710:b2e1a2660ec2	103	typedef uint16_t Handle_t; /* Type for connection handle. */
rgrover1	710:b2e1a2660ec2	104
rgrover1	710:b2e1a2660ec2	105	typedef struct {
rgrover1	710:b2e1a2660ec2	106	uint16_t minConnectionInterval; /*< Minimum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS./
rgrover1	710:b2e1a2660ec2	107	uint16_t maxConnectionInterval; /*< Maximum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS./
rgrover1	710:b2e1a2660ec2	108	uint16_t slaveLatency; /*< Slave Latency in number of connection events, see @ref BLE_GAP_CP_LIMITS./
rgrover1	710:b2e1a2660ec2	109	uint16_t connectionSupervisionTimeout; /*< Connection Supervision Timeout in 10 ms units, see @ref BLE_GAP_CP_LIMITS./
rgrover1	710:b2e1a2660ec2	110	} ConnectionParams_t;
rgrover1	710:b2e1a2660ec2	111
rgrover1	710:b2e1a2660ec2	112	enum Role_t {
rgrover1	710:b2e1a2660ec2	113	PERIPHERAL = 0x1, /*< Peripheral Role. /
rgrover1	710:b2e1a2660ec2	114	CENTRAL = 0x2, /*< Central Role. /
rgrover1	710:b2e1a2660ec2	115	};
rgrover1	710:b2e1a2660ec2	116
rgrover1	710:b2e1a2660ec2	117	struct AdvertisementCallbackParams_t {
vcoubard	1115:82d4a8a56d91	118	BLEProtocol::AddressBytes_t peerAddr;
vcoubard	1079:6e2d9514f3df	119	int8_t rssi;
vcoubard	1079:6e2d9514f3df	120	bool isScanResponse;
vcoubard	1079:6e2d9514f3df	121	GapAdvertisingParams::AdvertisingType_t type;
vcoubard	1079:6e2d9514f3df	122	uint8_t advertisingDataLen;
vcoubard	1079:6e2d9514f3df	123	const uint8_t *advertisingData;
rgrover1	710:b2e1a2660ec2	124	};
rgrover1	710:b2e1a2660ec2	125	typedef FunctionPointerWithContext<const AdvertisementCallbackParams_t *> AdvertisementReportCallback_t;
rgrover1	710:b2e1a2660ec2	126
rgrover1	710:b2e1a2660ec2	127	struct ConnectionCallbackParams_t {
vcoubard	1078:79c089630b38	128	Handle_t handle;
vcoubard	1078:79c089630b38	129	Role_t role;
vcoubard	1078:79c089630b38	130	BLEProtocol::AddressType_t peerAddrType;
vcoubard	1115:82d4a8a56d91	131	BLEProtocol::AddressBytes_t peerAddr;
vcoubard	1078:79c089630b38	132	BLEProtocol::AddressType_t ownAddrType;
vcoubard	1115:82d4a8a56d91	133	BLEProtocol::AddressBytes_t ownAddr;
vcoubard	1078:79c089630b38	134	const ConnectionParams_t *connectionParams;
rgrover1	710:b2e1a2660ec2	135
vcoubard	1078:79c089630b38	136	ConnectionCallbackParams_t(Handle_t handleIn,
vcoubard	1078:79c089630b38	137	Role_t roleIn,
vcoubard	1078:79c089630b38	138	BLEProtocol::AddressType_t peerAddrTypeIn,
vcoubard	1078:79c089630b38	139	const uint8_t *peerAddrIn,
vcoubard	1078:79c089630b38	140	BLEProtocol::AddressType_t ownAddrTypeIn,
vcoubard	1078:79c089630b38	141	const uint8_t *ownAddrIn,
vcoubard	1078:79c089630b38	142	const ConnectionParams_t *connectionParamsIn) :
rgrover1	710:b2e1a2660ec2	143	handle(handleIn),
rgrover1	710:b2e1a2660ec2	144	role(roleIn),
rgrover1	710:b2e1a2660ec2	145	peerAddrType(peerAddrTypeIn),
rgrover1	710:b2e1a2660ec2	146	peerAddr(),
rgrover1	710:b2e1a2660ec2	147	ownAddrType(ownAddrTypeIn),
rgrover1	710:b2e1a2660ec2	148	ownAddr(),
rgrover1	710:b2e1a2660ec2	149	connectionParams(connectionParamsIn) {
rgrover1	710:b2e1a2660ec2	150	memcpy(peerAddr, peerAddrIn, ADDR_LEN);
rgrover1	710:b2e1a2660ec2	151	memcpy(ownAddr, ownAddrIn, ADDR_LEN);
rgrover1	710:b2e1a2660ec2	152	}
rgrover1	710:b2e1a2660ec2	153	};
rgrover1	710:b2e1a2660ec2	154
rgrover1	829:9072de50087b	155	struct DisconnectionCallbackParams_t {
rgrover1	829:9072de50087b	156	Handle_t handle;
rgrover1	829:9072de50087b	157	DisconnectionReason_t reason;
rgrover1	829:9072de50087b	158
rgrover1	829:9072de50087b	159	DisconnectionCallbackParams_t(Handle_t handleIn,
rgrover1	829:9072de50087b	160	DisconnectionReason_t reasonIn) :
rgrover1	829:9072de50087b	161	handle(handleIn),
rgrover1	829:9072de50087b	162	reason(reasonIn)
rgrover1	829:9072de50087b	163	{}
rgrover1	829:9072de50087b	164	};
rgrover1	829:9072de50087b	165
rgrover1	710:b2e1a2660ec2	166	static const uint16_t UNIT_1_25_MS = 1250; /*< Number of microseconds in 1.25 milliseconds. /
rgrover1	710:b2e1a2660ec2	167	static uint16_t MSEC_TO_GAP_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1	710:b2e1a2660ec2	168	return (durationInMillis * 1000) / UNIT_1_25_MS;
rgrover1	710:b2e1a2660ec2	169	}
rgrover1	766:03f1a26f132f	170
vcoubard	1052:b55e1ad3e1b3	171	typedef FunctionPointerWithContext<TimeoutSource_t> TimeoutEventCallback_t;
vcoubard	1052:b55e1ad3e1b3	172	typedef CallChainOfFunctionPointersWithContext<TimeoutSource_t> TimeoutEventCallbackChain_t;
rgrover1	710:b2e1a2660ec2	173
vcoubard	1052:b55e1ad3e1b3	174	typedef FunctionPointerWithContext<const ConnectionCallbackParams_t *> ConnectionEventCallback_t;
vcoubard	1052:b55e1ad3e1b3	175	typedef CallChainOfFunctionPointersWithContext<const ConnectionCallbackParams_t *> ConnectionEventCallbackChain_t;
vcoubard	1052:b55e1ad3e1b3	176
vcoubard	1052:b55e1ad3e1b3	177	typedef FunctionPointerWithContext<const DisconnectionCallbackParams_t*> DisconnectionEventCallback_t;
vcoubard	1054:f59e5d9a992a	178	typedef CallChainOfFunctionPointersWithContext<const DisconnectionCallbackParams_t*> DisconnectionEventCallbackChain_t;
vcoubard	1052:b55e1ad3e1b3	179
rgrover1	753:0f60274cd3ad	180	typedef FunctionPointerWithContext<bool> RadioNotificationEventCallback_t;
rgrover1	710:b2e1a2660ec2	181
vcoubard	1090:148d8b9b56a5	182	typedef FunctionPointerWithContext<const Gap *> GapShutdownCallback_t;
vcoubard	1090:148d8b9b56a5	183	typedef CallChainOfFunctionPointersWithContext<const Gap *> GapShutdownCallbackChain_t;
vcoubard	1090:148d8b9b56a5	184
rgrover1	710:b2e1a2660ec2	185	/*
rgrover1	710:b2e1a2660ec2	186	* The following functions are meant to be overridden in the platform-specific sub-class.
rgrover1	710:b2e1a2660ec2	187	*/
rgrover1	710:b2e1a2660ec2	188	public:
rgrover1	710:b2e1a2660ec2	189	/**
rgrover1	710:b2e1a2660ec2	190	* Set the BTLE MAC address and type. Please note that the address format is
vcoubard	1079:6e2d9514f3df	191	* least significant byte first (LSB). Please refer to BLEProtocol::Address_t.
rgrover1	710:b2e1a2660ec2	192	*
rgrover1	710:b2e1a2660ec2	193	* @return BLE_ERROR_NONE on success.
rgrover1	710:b2e1a2660ec2	194	*/
vcoubard	1115:82d4a8a56d91	195	virtual ble_error_t setAddress(BLEProtocol::AddressType_t type, const BLEProtocol::AddressBytes_t address) {
rgrover1	734:4872b70437ce	196	/* avoid compiler warnings about unused variables */
rgrover1	734:4872b70437ce	197	(void)type;
rgrover1	734:4872b70437ce	198	(void)address;
rgrover1	734:4872b70437ce	199
rgrover1	728:997ba5e7b3b6	200	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	201	}
rgrover1	710:b2e1a2660ec2	202
rgrover1	710:b2e1a2660ec2	203	/**
rgrover1	710:b2e1a2660ec2	204	* Fetch the BTLE MAC address and type.
rgrover1	710:b2e1a2660ec2	205	*
rgrover1	710:b2e1a2660ec2	206	* @return BLE_ERROR_NONE on success.
rgrover1	710:b2e1a2660ec2	207	*/
vcoubard	1115:82d4a8a56d91	208	virtual ble_error_t getAddress(BLEProtocol::AddressType_t *typeP, BLEProtocol::AddressBytes_t address) {
vcoubard	1048:efb29faf12fc	209	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	210	(void)typeP;
rgrover1	734:4872b70437ce	211	(void)address;
rgrover1	734:4872b70437ce	212
rgrover1	728:997ba5e7b3b6	213	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	214	}
rgrover1	710:b2e1a2660ec2	215
rgrover1	710:b2e1a2660ec2	216	/**
vcoubard	1056:ce2fb3d09929	217	* @return Minimum Advertising interval in milliseconds for connectable
vcoubard	1056:ce2fb3d09929	218	* undirected and connectable directed event types.
rgrover1	710:b2e1a2660ec2	219	*/
rgrover1	710:b2e1a2660ec2	220	virtual uint16_t getMinAdvertisingInterval(void) const {
rgrover1	742:861ed7eb186d	221	return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	222	}
rgrover1	710:b2e1a2660ec2	223
rgrover1	710:b2e1a2660ec2	224	/**
vcoubard	1056:ce2fb3d09929	225	* @return Minimum Advertising interval in milliseconds for scannable
vcoubard	1056:ce2fb3d09929	226	* undirected and non-connectable undirected event types.
rgrover1	710:b2e1a2660ec2	227	*/
rgrover1	710:b2e1a2660ec2	228	virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {
rgrover1	742:861ed7eb186d	229	return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	230	}
rgrover1	710:b2e1a2660ec2	231
rgrover1	710:b2e1a2660ec2	232	/**
rgrover1	710:b2e1a2660ec2	233	* @return Maximum Advertising interval in milliseconds.
rgrover1	710:b2e1a2660ec2	234	*/
rgrover1	710:b2e1a2660ec2	235	virtual uint16_t getMaxAdvertisingInterval(void) const {
rgrover1	742:861ed7eb186d	236	return 0xFFFF; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	237	}
rgrover1	710:b2e1a2660ec2	238
rgrover1	710:b2e1a2660ec2	239	virtual ble_error_t stopAdvertising(void) {
rgrover1	728:997ba5e7b3b6	240	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	241	}
rgrover1	710:b2e1a2660ec2	242
rgrover1	710:b2e1a2660ec2	243	/**
rgrover1	710:b2e1a2660ec2	244	* Stop scanning. The current scanning parameters remain in effect.
rgrover1	710:b2e1a2660ec2	245	*
rgrover1	710:b2e1a2660ec2	246	* @retval BLE_ERROR_NONE if successfully stopped scanning procedure.
rgrover1	710:b2e1a2660ec2	247	*/
rgrover1	710:b2e1a2660ec2	248	virtual ble_error_t stopScan() {
rgrover1	728:997ba5e7b3b6	249	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	250	}
rgrover1	710:b2e1a2660ec2	251
rgrover1	710:b2e1a2660ec2	252	/**
rgrover1	710:b2e1a2660ec2	253	* Create a connection (GAP Link Establishment).
rgrover1	710:b2e1a2660ec2	254	*
rgrover1	710:b2e1a2660ec2	255	* @param peerAddr
rgrover1	710:b2e1a2660ec2	256	* 48-bit address, LSB format.
rgrover1	710:b2e1a2660ec2	257	* @param peerAddrType
rgrover1	710:b2e1a2660ec2	258	* Address type of the peer.
rgrover1	710:b2e1a2660ec2	259	* @param connectionParams
rgrover1	710:b2e1a2660ec2	260	* Connection parameters.
rgrover1	710:b2e1a2660ec2	261	* @param scanParams
rgrover1	710:b2e1a2660ec2	262	* Paramters to be used while scanning for the peer.
rgrover1	710:b2e1a2660ec2	263	* @return BLE_ERROR_NONE if connection establishment procedure is started
rgrover1	829:9072de50087b	264	* successfully. The connectionCallChain (if set) will be invoked upon
rgrover1	710:b2e1a2660ec2	265	* a connection event.
rgrover1	710:b2e1a2660ec2	266	*/
vcoubard	1115:82d4a8a56d91	267	virtual ble_error_t connect(const BLEProtocol::AddressBytes_t peerAddr,
vcoubard	1079:6e2d9514f3df	268	BLEProtocol::AddressType_t peerAddrType,
vcoubard	1079:6e2d9514f3df	269	const ConnectionParams_t *connectionParams,
vcoubard	1079:6e2d9514f3df	270	const GapScanningParams *scanParams) {
vcoubard	1048:efb29faf12fc	271	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	272	(void)peerAddr;
rgrover1	734:4872b70437ce	273	(void)peerAddrType;
rgrover1	734:4872b70437ce	274	(void)connectionParams;
rgrover1	734:4872b70437ce	275	(void)scanParams;
rgrover1	734:4872b70437ce	276
rgrover1	728:997ba5e7b3b6	277	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	278	}
rgrover1	710:b2e1a2660ec2	279
rgrover1	710:b2e1a2660ec2	280	/**
vcoubard	1116:9cb51490b3f7	281	* Create a connection (GAP Link Establishment).
vcoubard	1116:9cb51490b3f7	282	*
vcoubard	1116:9cb51490b3f7	283	* \deprecated: This funtion overloads Gap::connect(const BLEProtocol::Address_t peerAddr,
vcoubard	1116:9cb51490b3f7	284	BLEProtocol::AddressType_t peerAddrType,
vcoubard	1116:9cb51490b3f7	285	const ConnectionParams_t *connectionParams,
vcoubard	1116:9cb51490b3f7	286	const GapScanningParams *scanParams)
vcoubard	1116:9cb51490b3f7	287	* to maintain backward compatibility for change from Gap::AddressType_t to BLEProtocol::AddressType_t
vcoubard	1116:9cb51490b3f7	288	*/
vcoubard	1116:9cb51490b3f7	289	ble_error_t connect(const BLEProtocol::Address_t peerAddr,
vcoubard	1116:9cb51490b3f7	290	DeprecatedAddressType_t peerAddrType,
vcoubard	1116:9cb51490b3f7	291	const ConnectionParams_t *connectionParams,
vcoubard	1116:9cb51490b3f7	292	const GapScanningParams *scanParams)
vcoubard	1116:9cb51490b3f7	293	__deprecated_message("Gap::DeprecatedAddressType_t is deprecated, use BLEProtocol::AddressType_t instead") {
vcoubard	1116:9cb51490b3f7	294	return connect(peerAddr, (BLEProtocol::AddressType_t) peerAddrType, connectionParams, scanParams);
vcoubard	1116:9cb51490b3f7	295	}
vcoubard	1116:9cb51490b3f7	296
vcoubard	1116:9cb51490b3f7	297	/**
rgrover1	710:b2e1a2660ec2	298	* This call initiates the disconnection procedure, and its completion will
rgrover1	710:b2e1a2660ec2	299	* be communicated to the application with an invocation of the
rgrover1	710:b2e1a2660ec2	300	* disconnectionCallback.
rgrover1	710:b2e1a2660ec2	301	*
rgrover1	710:b2e1a2660ec2	302	* @param reason
vcoubard	1048:efb29faf12fc	303	* The reason for disconnection; to be sent back to the peer.
rgrover1	710:b2e1a2660ec2	304	*/
rgrover1	710:b2e1a2660ec2	305	virtual ble_error_t disconnect(Handle_t connectionHandle, DisconnectionReason_t reason) {
rgrover1	734:4872b70437ce	306	/* avoid compiler warnings about unused variables */
rgrover1	734:4872b70437ce	307	(void)connectionHandle;
rgrover1	734:4872b70437ce	308	(void)reason;
rgrover1	734:4872b70437ce	309
rgrover1	728:997ba5e7b3b6	310	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	311	}
rgrover1	710:b2e1a2660ec2	312
rgrover1	710:b2e1a2660ec2	313	/**
rgrover1	710:b2e1a2660ec2	314	* This call initiates the disconnection procedure, and its completion will
rgrover1	710:b2e1a2660ec2	315	* be communicated to the application with an invocation of the
rgrover1	710:b2e1a2660ec2	316	* disconnectionCallback.
rgrover1	710:b2e1a2660ec2	317	*
rgrover1	710:b2e1a2660ec2	318	* @param reason
vcoubard	1048:efb29faf12fc	319	* The reason for disconnection; to be sent back to the peer.
rgrover1	710:b2e1a2660ec2	320	*
vcoubard	1048:efb29faf12fc	321	* @note: This version of disconnect() doesn't take a connection handle. It
vcoubard	1048:efb29faf12fc	322	* works reliably only for stacks that are limited to a single
rgrover1	710:b2e1a2660ec2	323	* connection. This API should be considered deprecated in favour of the
vcoubard	1048:efb29faf12fc	324	* alternative, which takes a connection handle. It will be dropped in the future.
rgrover1	710:b2e1a2660ec2	325	*/
rgrover1	710:b2e1a2660ec2	326	virtual ble_error_t disconnect(DisconnectionReason_t reason) {
vcoubard	1048:efb29faf12fc	327	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	328	(void)reason;
rgrover1	734:4872b70437ce	329
rgrover1	728:997ba5e7b3b6	330	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	331	}
rgrover1	710:b2e1a2660ec2	332
rgrover1	710:b2e1a2660ec2	333	/**
rgrover1	710:b2e1a2660ec2	334	* Get the GAP peripheral preferred connection parameters. These are the
rgrover1	710:b2e1a2660ec2	335	* defaults that the peripheral would like to have in a connection. The
rgrover1	710:b2e1a2660ec2	336	* choice of the connection parameters is eventually up to the central.
rgrover1	710:b2e1a2660ec2	337	*
rgrover1	710:b2e1a2660ec2	338	* @param[out] params
rgrover1	710:b2e1a2660ec2	339	* The structure where the parameters will be stored. Memory
rgrover1	710:b2e1a2660ec2	340	* for this is owned by the caller.
rgrover1	710:b2e1a2660ec2	341	*
rgrover1	710:b2e1a2660ec2	342	* @return BLE_ERROR_NONE if the parameters were successfully filled into
rgrover1	710:b2e1a2660ec2	343	* the given structure pointed to by params.
rgrover1	710:b2e1a2660ec2	344	*/
rgrover1	710:b2e1a2660ec2	345	virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) {
vcoubard	1048:efb29faf12fc	346	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	347	(void)params;
rgrover1	734:4872b70437ce	348
rgrover1	728:997ba5e7b3b6	349	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	350	}
rgrover1	710:b2e1a2660ec2	351
rgrover1	710:b2e1a2660ec2	352	/**
rgrover1	710:b2e1a2660ec2	353	* Set the GAP peripheral preferred connection parameters. These are the
rgrover1	710:b2e1a2660ec2	354	* defaults that the peripheral would like to have in a connection. The
rgrover1	710:b2e1a2660ec2	355	* choice of the connection parameters is eventually up to the central.
rgrover1	710:b2e1a2660ec2	356	*
rgrover1	710:b2e1a2660ec2	357	* @param[in] params
rgrover1	710:b2e1a2660ec2	358	* The structure containing the desired parameters.
rgrover1	710:b2e1a2660ec2	359	*/
rgrover1	710:b2e1a2660ec2	360	virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) {
vcoubard	1048:efb29faf12fc	361	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	362	(void)params;
rgrover1	734:4872b70437ce	363
rgrover1	728:997ba5e7b3b6	364	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	365	}
rgrover1	710:b2e1a2660ec2	366
rgrover1	710:b2e1a2660ec2	367	/**
rgrover1	816:2b4f0ef8c06e	368	* Update connection parameters.
vcoubard	1048:efb29faf12fc	369	* In the central role this will initiate a Link Layer connection parameter update procedure.
vcoubard	1048:efb29faf12fc	370	* In the peripheral role, this will send the corresponding L2CAP request and wait for
rgrover1	816:2b4f0ef8c06e	371	* the central to perform the procedure.
rgrover1	816:2b4f0ef8c06e	372	*
rgrover1	710:b2e1a2660ec2	373	* @param[in] handle
vcoubard	1048:efb29faf12fc	374	* Connection Handle.
rgrover1	710:b2e1a2660ec2	375	* @param[in] params
rgrover1	710:b2e1a2660ec2	376	* Pointer to desired connection parameters. If NULL is provided on a peripheral role,
rgrover1	710:b2e1a2660ec2	377	* the parameters in the PPCP characteristic of the GAP service will be used instead.
rgrover1	710:b2e1a2660ec2	378	*/
rgrover1	710:b2e1a2660ec2	379	virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) {
rgrover1	734:4872b70437ce	380	/* avoid compiler warnings about unused variables */
rgrover1	734:4872b70437ce	381	(void)handle;
rgrover1	734:4872b70437ce	382	(void)params;
rgrover1	734:4872b70437ce	383
rgrover1	728:997ba5e7b3b6	384	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	385	}
rgrover1	710:b2e1a2660ec2	386
rgrover1	710:b2e1a2660ec2	387	/**
rgrover1	710:b2e1a2660ec2	388	* Set the device name characteristic in the GAP service.
rgrover1	710:b2e1a2660ec2	389	* @param[in] deviceName
rgrover1	710:b2e1a2660ec2	390	* The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
rgrover1	710:b2e1a2660ec2	391	*/
rgrover1	710:b2e1a2660ec2	392	virtual ble_error_t setDeviceName(const uint8_t *deviceName) {
vcoubard	1048:efb29faf12fc	393	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	394	(void)deviceName;
rgrover1	734:4872b70437ce	395
rgrover1	728:997ba5e7b3b6	396	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	397	}
rgrover1	710:b2e1a2660ec2	398
rgrover1	710:b2e1a2660ec2	399	/**
rgrover1	710:b2e1a2660ec2	400	* Get the value of the device name characteristic in the GAP service.
rgrover1	710:b2e1a2660ec2	401	* @param[out] deviceName
rgrover1	710:b2e1a2660ec2	402	* Pointer to an empty buffer where the UTF-8 *non NULL-
rgrover1	710:b2e1a2660ec2	403	* terminated* string will be placed. Set this
rgrover1	710:b2e1a2660ec2	404	* value to NULL in order to obtain the deviceName-length
rgrover1	710:b2e1a2660ec2	405	* from the 'length' parameter.
rgrover1	710:b2e1a2660ec2	406	*
rgrover1	710:b2e1a2660ec2	407	* @param[in/out] lengthP
rgrover1	710:b2e1a2660ec2	408	* (on input) Length of the buffer pointed to by deviceName;
rgrover1	710:b2e1a2660ec2	409	* (on output) the complete device name length (without the
rgrover1	710:b2e1a2660ec2	410	* null terminator).
rgrover1	710:b2e1a2660ec2	411	*
rgrover1	710:b2e1a2660ec2	412	* @note If the device name is longer than the size of the supplied buffer,
rgrover1	710:b2e1a2660ec2	413	* length will return the complete device name length, and not the
rgrover1	710:b2e1a2660ec2	414	* number of bytes actually returned in deviceName. The application may
rgrover1	710:b2e1a2660ec2	415	* use this information to retry with a suitable buffer size.
rgrover1	710:b2e1a2660ec2	416	*/
rgrover1	710:b2e1a2660ec2	417	virtual ble_error_t getDeviceName(uint8_t deviceName, unsigned lengthP) {
rgrover1	734:4872b70437ce	418	/* avoid compiler warnings about unused variables */
rgrover1	734:4872b70437ce	419	(void)deviceName;
rgrover1	734:4872b70437ce	420	(void)lengthP;
rgrover1	734:4872b70437ce	421
rgrover1	728:997ba5e7b3b6	422	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	423	}
rgrover1	710:b2e1a2660ec2	424
rgrover1	710:b2e1a2660ec2	425	/**
rgrover1	710:b2e1a2660ec2	426	* Set the appearance characteristic in the GAP service.
rgrover1	710:b2e1a2660ec2	427	* @param[in] appearance
rgrover1	710:b2e1a2660ec2	428	* The new value for the device-appearance.
rgrover1	710:b2e1a2660ec2	429	*/
rgrover1	710:b2e1a2660ec2	430	virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance) {
vcoubard	1048:efb29faf12fc	431	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	432	(void)appearance;
rgrover1	734:4872b70437ce	433
rgrover1	728:997ba5e7b3b6	434	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	435	}
rgrover1	710:b2e1a2660ec2	436
rgrover1	710:b2e1a2660ec2	437	/**
rgrover1	710:b2e1a2660ec2	438	* Get the appearance characteristic in the GAP service.
rgrover1	710:b2e1a2660ec2	439	* @param[out] appearance
rgrover1	710:b2e1a2660ec2	440	* The new value for the device-appearance.
rgrover1	710:b2e1a2660ec2	441	*/
rgrover1	710:b2e1a2660ec2	442	virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP) {
vcoubard	1048:efb29faf12fc	443	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	444	(void)appearanceP;
rgrover1	734:4872b70437ce	445
rgrover1	728:997ba5e7b3b6	446	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	447	}
rgrover1	710:b2e1a2660ec2	448
rgrover1	710:b2e1a2660ec2	449	/**
rgrover1	710:b2e1a2660ec2	450	* Set the radio's transmit power.
rgrover1	710:b2e1a2660ec2	451	* @param[in] txPower Radio transmit power in dBm.
rgrover1	710:b2e1a2660ec2	452	*/
rgrover1	710:b2e1a2660ec2	453	virtual ble_error_t setTxPower(int8_t txPower) {
vcoubard	1048:efb29faf12fc	454	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	455	(void)txPower;
rgrover1	734:4872b70437ce	456
rgrover1	728:997ba5e7b3b6	457	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	458	}
rgrover1	710:b2e1a2660ec2	459
rgrover1	710:b2e1a2660ec2	460	/**
rgrover1	710:b2e1a2660ec2	461	* Query the underlying stack for permitted arguments for setTxPower().
rgrover1	710:b2e1a2660ec2	462	*
rgrover1	710:b2e1a2660ec2	463	* @param[out] valueArrayPP
rgrover1	710:b2e1a2660ec2	464	* Out parameter to receive the immutable array of Tx values.
rgrover1	710:b2e1a2660ec2	465	* @param[out] countP
rgrover1	710:b2e1a2660ec2	466	* Out parameter to receive the array's size.
rgrover1	710:b2e1a2660ec2	467	*/
rgrover1	710:b2e1a2660ec2	468	virtual void getPermittedTxPowerValues(const int8_t *valueArrayPP, size_t countP) {
vcoubard	1048:efb29faf12fc	469	/* Avoid compiler warnings about unused variables. */
rgrover1	734:4872b70437ce	470	(void)valueArrayPP;
rgrover1	734:4872b70437ce	471	(void)countP;
rgrover1	734:4872b70437ce	472
rgrover1	742:861ed7eb186d	473	countP = 0; / Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	474	}
rgrover1	710:b2e1a2660ec2	475
rgrover1	710:b2e1a2660ec2	476	protected:
rgrover1	710:b2e1a2660ec2	477	/* Override the following in the underlying adaptation layer to provide the functionality of scanning. */
rgrover1	710:b2e1a2660ec2	478	virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams) {
rgrover1	772:b6d27ab66c94	479	(void)scanningParams;
rgrover1	728:997ba5e7b3b6	480	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	710:b2e1a2660ec2	481	}
rgrover1	710:b2e1a2660ec2	482
rgrover1	710:b2e1a2660ec2	483	/*
rgrover1	710:b2e1a2660ec2	484	* APIs with non-virtual implementations.
rgrover1	710:b2e1a2660ec2	485	*/
rgrover1	710:b2e1a2660ec2	486	public:
rgrover1	710:b2e1a2660ec2	487	/**
vcoubard	1048:efb29faf12fc	488	* Returns the current GAP state of the device using a bitmask that
vcoubard	1048:efb29faf12fc	489	* describes whether the device is advertising or connected.
rgrover1	710:b2e1a2660ec2	490	*/
rgrover1	710:b2e1a2660ec2	491	GapState_t getState(void) const {
rgrover1	710:b2e1a2660ec2	492	return state;
rgrover1	710:b2e1a2660ec2	493	}
rgrover1	710:b2e1a2660ec2	494
rgrover1	710:b2e1a2660ec2	495	/**
rgrover1	710:b2e1a2660ec2	496	* Set the GAP advertising mode to use for this device.
rgrover1	710:b2e1a2660ec2	497	*/
rgrover1	710:b2e1a2660ec2	498	void setAdvertisingType(GapAdvertisingParams::AdvertisingType_t advType) {
rgrover1	710:b2e1a2660ec2	499	_advParams.setAdvertisingType(advType);
rgrover1	710:b2e1a2660ec2	500	}
rgrover1	710:b2e1a2660ec2	501
rgrover1	710:b2e1a2660ec2	502	/**
rgrover1	710:b2e1a2660ec2	503	* @param[in] interval
rgrover1	710:b2e1a2660ec2	504	* Advertising interval in units of milliseconds. Advertising
rgrover1	710:b2e1a2660ec2	505	* is disabled if interval is 0. If interval is smaller than
rgrover1	710:b2e1a2660ec2	506	* the minimum supported value, then the minimum supported
rgrover1	710:b2e1a2660ec2	507	* value is used instead. This minimum value can be discovered
rgrover1	710:b2e1a2660ec2	508	* using getMinAdvertisingInterval().
rgrover1	710:b2e1a2660ec2	509	*
rgrover1	710:b2e1a2660ec2	510	* This field must be set to 0 if connectionMode is equal
rgrover1	710:b2e1a2660ec2	511	* to ADV_CONNECTABLE_DIRECTED.
rgrover1	710:b2e1a2660ec2	512	*
rgrover1	710:b2e1a2660ec2	513	* @note: Decreasing this value will allow central devices to detect a
vcoubard	1048:efb29faf12fc	514	* peripheral faster, at the expense of more power being used by the radio
rgrover1	710:b2e1a2660ec2	515	* due to the higher data transmit rate.
rgrover1	710:b2e1a2660ec2	516	*
rgrover1	710:b2e1a2660ec2	517	* @Note: [WARNING] This API previously used 0.625ms as the unit for its
rgrover1	710:b2e1a2660ec2	518	* 'interval' argument. That required an explicit conversion from
rgrover1	710:b2e1a2660ec2	519	* milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
rgrover1	710:b2e1a2660ec2	520	* no longer required as the new units are milliseconds. Any application
vcoubard	1048:efb29faf12fc	521	* code depending on the old semantics needs to be updated accordingly.
rgrover1	710:b2e1a2660ec2	522	*/
rgrover1	710:b2e1a2660ec2	523	void setAdvertisingInterval(uint16_t interval) {
rgrover1	710:b2e1a2660ec2	524	if (interval == 0) {
rgrover1	710:b2e1a2660ec2	525	stopAdvertising();
rgrover1	710:b2e1a2660ec2	526	} else if (interval < getMinAdvertisingInterval()) {
rgrover1	710:b2e1a2660ec2	527	interval = getMinAdvertisingInterval();
rgrover1	710:b2e1a2660ec2	528	}
rgrover1	786:d6d7087d8377	529	_advParams.setInterval(interval);
rgrover1	710:b2e1a2660ec2	530	}
rgrover1	710:b2e1a2660ec2	531
rgrover1	710:b2e1a2660ec2	532	/**
rgrover1	710:b2e1a2660ec2	533	* @param[in] timeout
rgrover1	710:b2e1a2660ec2	534	* Advertising timeout (in seconds) between 0x1 and 0x3FFF (1
rgrover1	710:b2e1a2660ec2	535	* and 16383). Use 0 to disable the advertising timeout.
rgrover1	710:b2e1a2660ec2	536	*/
rgrover1	710:b2e1a2660ec2	537	void setAdvertisingTimeout(uint16_t timeout) {
rgrover1	710:b2e1a2660ec2	538	_advParams.setTimeout(timeout);
rgrover1	710:b2e1a2660ec2	539	}
rgrover1	710:b2e1a2660ec2	540
rgrover1	710:b2e1a2660ec2	541	/**
rgrover1	710:b2e1a2660ec2	542	* Start advertising.
rgrover1	710:b2e1a2660ec2	543	*/
rgrover1	710:b2e1a2660ec2	544	ble_error_t startAdvertising(void) {
vcoubard	1048:efb29faf12fc	545	setAdvertisingData(); /* Update the underlying stack. */
rgrover1	710:b2e1a2660ec2	546	return startAdvertising(_advParams);
rgrover1	710:b2e1a2660ec2	547	}
rgrover1	710:b2e1a2660ec2	548
rgrover1	710:b2e1a2660ec2	549	/**
rgrover1	710:b2e1a2660ec2	550	* Reset any advertising payload prepared from prior calls to
rgrover1	710:b2e1a2660ec2	551	* accumulateAdvertisingPayload(). This automatically propagates the re-
vcoubard	1048:efb29faf12fc	552	* initialized advertising payload to the underlying stack.
rgrover1	710:b2e1a2660ec2	553	*/
rgrover1	710:b2e1a2660ec2	554	void clearAdvertisingPayload(void) {
rgrover1	710:b2e1a2660ec2	555	_advPayload.clear();
rgrover1	710:b2e1a2660ec2	556	setAdvertisingData();
rgrover1	710:b2e1a2660ec2	557	}
rgrover1	710:b2e1a2660ec2	558
rgrover1	710:b2e1a2660ec2	559	/**
rgrover1	710:b2e1a2660ec2	560	* Accumulate an AD structure in the advertising payload. Please note that
rgrover1	710:b2e1a2660ec2	561	* the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard	1048:efb29faf12fc	562	* as an additional 31 bytes if the advertising payload is too
rgrover1	710:b2e1a2660ec2	563	* small.
rgrover1	710:b2e1a2660ec2	564	*
rgrover1	710:b2e1a2660ec2	565	* @param[in] flags
rgrover1	710:b2e1a2660ec2	566	* The flags to be added. Please refer to
rgrover1	710:b2e1a2660ec2	567	* GapAdvertisingData::Flags for valid flags. Multiple
rgrover1	710:b2e1a2660ec2	568	* flags may be specified in combination.
rgrover1	710:b2e1a2660ec2	569	*/
rgrover1	710:b2e1a2660ec2	570	ble_error_t accumulateAdvertisingPayload(uint8_t flags) {
rgrover1	710:b2e1a2660ec2	571	ble_error_t rc;
rgrover1	710:b2e1a2660ec2	572	if ((rc = _advPayload.addFlags(flags)) != BLE_ERROR_NONE) {
rgrover1	710:b2e1a2660ec2	573	return rc;
rgrover1	710:b2e1a2660ec2	574	}
rgrover1	710:b2e1a2660ec2	575
rgrover1	710:b2e1a2660ec2	576	return setAdvertisingData();
rgrover1	710:b2e1a2660ec2	577	}
rgrover1	710:b2e1a2660ec2	578
rgrover1	710:b2e1a2660ec2	579	/**
rgrover1	710:b2e1a2660ec2	580	* Accumulate an AD structure in the advertising payload. Please note that
rgrover1	710:b2e1a2660ec2	581	* the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard	1048:efb29faf12fc	582	* as an additional 31 bytes if the advertising payload is too
rgrover1	710:b2e1a2660ec2	583	* small.
rgrover1	710:b2e1a2660ec2	584	*
rgrover1	710:b2e1a2660ec2	585	* @param app
rgrover1	710:b2e1a2660ec2	586	* The appearance of the peripheral.
rgrover1	710:b2e1a2660ec2	587	*/
rgrover1	710:b2e1a2660ec2	588	ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app) {
rgrover1	710:b2e1a2660ec2	589	setAppearance(app);
rgrover1	710:b2e1a2660ec2	590
rgrover1	710:b2e1a2660ec2	591	ble_error_t rc;
rgrover1	710:b2e1a2660ec2	592	if ((rc = _advPayload.addAppearance(app)) != BLE_ERROR_NONE) {
rgrover1	710:b2e1a2660ec2	593	return rc;
rgrover1	710:b2e1a2660ec2	594	}
rgrover1	710:b2e1a2660ec2	595
rgrover1	710:b2e1a2660ec2	596	return setAdvertisingData();
rgrover1	710:b2e1a2660ec2	597	}
rgrover1	710:b2e1a2660ec2	598
rgrover1	710:b2e1a2660ec2	599	/**
rgrover1	710:b2e1a2660ec2	600	* Accumulate an AD structure in the advertising payload. Please note that
rgrover1	710:b2e1a2660ec2	601	* the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard	1048:efb29faf12fc	602	* as an additional 31 bytes if the advertising payload is too
rgrover1	710:b2e1a2660ec2	603	* small.
rgrover1	710:b2e1a2660ec2	604	*
vcoubard	1048:efb29faf12fc	605	* @param power
rgrover1	764:1e560f0d45e1	606	* The max transmit power to be used by the controller (in dBm).
rgrover1	710:b2e1a2660ec2	607	*/
rgrover1	710:b2e1a2660ec2	608	ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power) {
rgrover1	710:b2e1a2660ec2	609	ble_error_t rc;
rgrover1	710:b2e1a2660ec2	610	if ((rc = _advPayload.addTxPower(power)) != BLE_ERROR_NONE) {
rgrover1	710:b2e1a2660ec2	611	return rc;
rgrover1	710:b2e1a2660ec2	612	}
rgrover1	710:b2e1a2660ec2	613
rgrover1	710:b2e1a2660ec2	614	return setAdvertisingData();
rgrover1	710:b2e1a2660ec2	615	}
rgrover1	710:b2e1a2660ec2	616
rgrover1	710:b2e1a2660ec2	617	/**
rgrover1	710:b2e1a2660ec2	618	* Accumulate a variable length byte-stream as an AD structure in the
rgrover1	710:b2e1a2660ec2	619	* advertising payload. Please note that the payload is limited to 31 bytes.
rgrover1	710:b2e1a2660ec2	620	* The SCAN_RESPONSE message may be used as an additional 31 bytes if the
vcoubard	1048:efb29faf12fc	621	* advertising payload is too small.
rgrover1	710:b2e1a2660ec2	622	*
vcoubard	1048:efb29faf12fc	623	* @param type The type describing the variable length data.
vcoubard	1048:efb29faf12fc	624	* @param data Data bytes.
vcoubard	1048:efb29faf12fc	625	* @param len Length of data.
vcoubard	1104:0244fbb0324e	626	*
vcoubard	1104:0244fbb0324e	627	* @return BLE_ERROR_NONE if the advertisement payload was updated based on
vcoubard	1104:0244fbb0324e	628	* matching AD type; otherwise, an appropriate error.
vcoubard	1104:0244fbb0324e	629	*
vcoubard	1104:0244fbb0324e	630	* @note When the specified AD type is INCOMPLETE_LIST_16BIT_SERVICE_IDS,
vcoubard	1104:0244fbb0324e	631	* COMPLETE_LIST_16BIT_SERVICE_IDS, INCOMPLETE_LIST_32BIT_SERVICE_IDS,
vcoubard	1104:0244fbb0324e	632	* COMPLETE_LIST_32BIT_SERVICE_IDS, INCOMPLETE_LIST_128BIT_SERVICE_IDS,
vcoubard	1104:0244fbb0324e	633	* COMPLETE_LIST_128BIT_SERVICE_IDS or LIST_128BIT_SOLICITATION_IDS the
vcoubard	1104:0244fbb0324e	634	* supplied value is appended to the values previously added to the
vcoubard	1104:0244fbb0324e	635	* payload.
rgrover1	710:b2e1a2660ec2	636	*/
rgrover1	710:b2e1a2660ec2	637	ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1	710:b2e1a2660ec2	638	if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
rgrover1	710:b2e1a2660ec2	639	setDeviceName(data);
rgrover1	710:b2e1a2660ec2	640	}
rgrover1	710:b2e1a2660ec2	641
rgrover1	710:b2e1a2660ec2	642	ble_error_t rc;
rgrover1	710:b2e1a2660ec2	643	if ((rc = _advPayload.addData(type, data, len)) != BLE_ERROR_NONE) {
rgrover1	710:b2e1a2660ec2	644	return rc;
rgrover1	710:b2e1a2660ec2	645	}
rgrover1	710:b2e1a2660ec2	646
rgrover1	710:b2e1a2660ec2	647	return setAdvertisingData();
rgrover1	710:b2e1a2660ec2	648	}
rgrover1	710:b2e1a2660ec2	649
rgrover1	710:b2e1a2660ec2	650	/**
rgrover1	765:4cd91998cd48	651	* Update a particular ADV field in the advertising payload (based on
vcoubard	1104:0244fbb0324e	652	* matching type).
rgrover1	763:36c3e2b1f1ae	653	*
vcoubard	1048:efb29faf12fc	654	* @param[in] type The ADV type field describing the variable length data.
vcoubard	1048:efb29faf12fc	655	* @param[in] data Data bytes.
vcoubard	1048:efb29faf12fc	656	* @param[in] len Length of data.
rgrover1	765:4cd91998cd48	657	*
rgrover1	765:4cd91998cd48	658	* @note: If advertisements are enabled, then the update will take effect immediately.
rgrover1	765:4cd91998cd48	659	*
rgrover1	765:4cd91998cd48	660	* @return BLE_ERROR_NONE if the advertisement payload was updated based on
vcoubard	1104:0244fbb0324e	661	* matching AD type; otherwise, an appropriate error.
rgrover1	763:36c3e2b1f1ae	662	*/
rgrover1	763:36c3e2b1f1ae	663	ble_error_t updateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1	763:36c3e2b1f1ae	664	if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
rgrover1	763:36c3e2b1f1ae	665	setDeviceName(data);
rgrover1	763:36c3e2b1f1ae	666	}
rgrover1	763:36c3e2b1f1ae	667
rgrover1	763:36c3e2b1f1ae	668	ble_error_t rc;
rgrover1	763:36c3e2b1f1ae	669	if ((rc = _advPayload.updateData(type, data, len)) != BLE_ERROR_NONE) {
rgrover1	763:36c3e2b1f1ae	670	return rc;
rgrover1	763:36c3e2b1f1ae	671	}
rgrover1	763:36c3e2b1f1ae	672
rgrover1	763:36c3e2b1f1ae	673	return setAdvertisingData();
rgrover1	763:36c3e2b1f1ae	674	}
rgrover1	763:36c3e2b1f1ae	675
rgrover1	763:36c3e2b1f1ae	676	/**
vcoubard	1048:efb29faf12fc	677	* Set up a particular, user-constructed advertisement payload for the
rgrover1	710:b2e1a2660ec2	678	* underlying stack. It would be uncommon for this API to be used directly;
rgrover1	710:b2e1a2660ec2	679	* there are other APIs to build an advertisement payload (see above).
rgrover1	710:b2e1a2660ec2	680	*/
rgrover1	710:b2e1a2660ec2	681	ble_error_t setAdvertisingPayload(const GapAdvertisingData &payload) {
rgrover1	710:b2e1a2660ec2	682	_advPayload = payload;
rgrover1	710:b2e1a2660ec2	683	return setAdvertisingData();
rgrover1	710:b2e1a2660ec2	684	}
rgrover1	710:b2e1a2660ec2	685
rgrover1	710:b2e1a2660ec2	686	/**
rgrover1	710:b2e1a2660ec2	687	* @return Read back advertising data. Useful for storing and
rgrover1	710:b2e1a2660ec2	688	* restoring payload.
rgrover1	710:b2e1a2660ec2	689	*/
rgrover1	710:b2e1a2660ec2	690	const GapAdvertisingData &getAdvertisingPayload(void) const {
rgrover1	710:b2e1a2660ec2	691	return _advPayload;
rgrover1	710:b2e1a2660ec2	692	}
rgrover1	710:b2e1a2660ec2	693
rgrover1	710:b2e1a2660ec2	694	/**
rgrover1	710:b2e1a2660ec2	695	* Accumulate a variable length byte-stream as an AD structure in the
rgrover1	710:b2e1a2660ec2	696	* scanResponse payload.
rgrover1	710:b2e1a2660ec2	697	*
vcoubard	1048:efb29faf12fc	698	* @param[in] type The type describing the variable length data.
vcoubard	1048:efb29faf12fc	699	* @param[in] data Data bytes.
vcoubard	1048:efb29faf12fc	700	* @param[in] len Length of data.
rgrover1	710:b2e1a2660ec2	701	*/
rgrover1	710:b2e1a2660ec2	702	ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1	710:b2e1a2660ec2	703	ble_error_t rc;
rgrover1	710:b2e1a2660ec2	704	if ((rc = _scanResponse.addData(type, data, len)) != BLE_ERROR_NONE) {
rgrover1	710:b2e1a2660ec2	705	return rc;
rgrover1	710:b2e1a2660ec2	706	}
rgrover1	710:b2e1a2660ec2	707
rgrover1	710:b2e1a2660ec2	708	return setAdvertisingData();
rgrover1	710:b2e1a2660ec2	709	}
rgrover1	710:b2e1a2660ec2	710
rgrover1	710:b2e1a2660ec2	711	/**
rgrover1	710:b2e1a2660ec2	712	* Reset any scan response prepared from prior calls to
rgrover1	710:b2e1a2660ec2	713	* accumulateScanResponse().
rgrover1	710:b2e1a2660ec2	714	*
rgrover1	710:b2e1a2660ec2	715	* Note: This should be followed by a call to setAdvertisingPayload() or
rgrover1	710:b2e1a2660ec2	716	* startAdvertising() before the update takes effect.
rgrover1	710:b2e1a2660ec2	717	*/
rgrover1	710:b2e1a2660ec2	718	void clearScanResponse(void) {
rgrover1	710:b2e1a2660ec2	719	_scanResponse.clear();
rgrover1	710:b2e1a2660ec2	720	setAdvertisingData();
rgrover1	710:b2e1a2660ec2	721	}
rgrover1	710:b2e1a2660ec2	722
rgrover1	710:b2e1a2660ec2	723	/**
vcoubard	1048:efb29faf12fc	724	* Set up parameters for GAP scanning (observer mode).
rgrover1	710:b2e1a2660ec2	725	* @param[in] interval
rgrover1	710:b2e1a2660ec2	726	* Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1	710:b2e1a2660ec2	727	* @param[in] window
rgrover1	710:b2e1a2660ec2	728	* Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1	710:b2e1a2660ec2	729	* @param[in] timeout
vcoubard	1048:efb29faf12fc	730	* Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables the timeout.
rgrover1	710:b2e1a2660ec2	731	* @param[in] activeScanning
rgrover1	710:b2e1a2660ec2	732	* Set to True if active-scanning is required. This is used to fetch the
rgrover1	710:b2e1a2660ec2	733	* scan response from a peer if possible.
rgrover1	710:b2e1a2660ec2	734	*
rgrover1	710:b2e1a2660ec2	735	* The scanning window divided by the interval determines the duty cycle for
rgrover1	710:b2e1a2660ec2	736	* scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1	710:b2e1a2660ec2	737	* then the controller will scan for 10 percent of the time. It is possible
rgrover1	710:b2e1a2660ec2	738	* to have the interval and window set to the same value. In this case,
rgrover1	710:b2e1a2660ec2	739	* scanning is continuous, with a change of scanning frequency once every
rgrover1	710:b2e1a2660ec2	740	* interval.
rgrover1	710:b2e1a2660ec2	741	*
rgrover1	710:b2e1a2660ec2	742	* Once the scanning parameters have been configured, scanning can be
rgrover1	710:b2e1a2660ec2	743	* enabled by using startScan().
rgrover1	710:b2e1a2660ec2	744	*
rgrover1	710:b2e1a2660ec2	745	* @Note: The scan interval and window are recommendations to the BLE stack.
rgrover1	710:b2e1a2660ec2	746	*/
rgrover1	710:b2e1a2660ec2	747	ble_error_t setScanParams(uint16_t interval = GapScanningParams::SCAN_INTERVAL_MAX,
rgrover1	710:b2e1a2660ec2	748	uint16_t window = GapScanningParams::SCAN_WINDOW_MAX,
rgrover1	710:b2e1a2660ec2	749	uint16_t timeout = 0,
rgrover1	710:b2e1a2660ec2	750	bool activeScanning = false) {
rgrover1	710:b2e1a2660ec2	751	ble_error_t rc;
rgrover1	710:b2e1a2660ec2	752	if (((rc = _scanningParams.setInterval(interval)) == BLE_ERROR_NONE) &&
rgrover1	710:b2e1a2660ec2	753	((rc = _scanningParams.setWindow(window)) == BLE_ERROR_NONE) &&
rgrover1	710:b2e1a2660ec2	754	((rc = _scanningParams.setTimeout(timeout)) == BLE_ERROR_NONE)) {
rgrover1	710:b2e1a2660ec2	755	_scanningParams.setActiveScanning(activeScanning);
rgrover1	710:b2e1a2660ec2	756	return BLE_ERROR_NONE;
rgrover1	710:b2e1a2660ec2	757	}
rgrover1	710:b2e1a2660ec2	758
rgrover1	710:b2e1a2660ec2	759	return rc;
rgrover1	710:b2e1a2660ec2	760	}
rgrover1	710:b2e1a2660ec2	761
rgrover1	710:b2e1a2660ec2	762	/**
vcoubard	1048:efb29faf12fc	763	* Set up the scanInterval parameter for GAP scanning (observer mode).
rgrover1	710:b2e1a2660ec2	764	* @param[in] interval
rgrover1	710:b2e1a2660ec2	765	* Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1	710:b2e1a2660ec2	766	*
rgrover1	710:b2e1a2660ec2	767	* The scanning window divided by the interval determines the duty cycle for
rgrover1	710:b2e1a2660ec2	768	* scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1	710:b2e1a2660ec2	769	* then the controller will scan for 10 percent of the time. It is possible
rgrover1	710:b2e1a2660ec2	770	* to have the interval and window set to the same value. In this case,
rgrover1	710:b2e1a2660ec2	771	* scanning is continuous, with a change of scanning frequency once every
rgrover1	710:b2e1a2660ec2	772	* interval.
rgrover1	710:b2e1a2660ec2	773	*
rgrover1	710:b2e1a2660ec2	774	* Once the scanning parameters have been configured, scanning can be
rgrover1	710:b2e1a2660ec2	775	* enabled by using startScan().
rgrover1	710:b2e1a2660ec2	776	*/
rgrover1	710:b2e1a2660ec2	777	ble_error_t setScanInterval(uint16_t interval) {
rgrover1	710:b2e1a2660ec2	778	return _scanningParams.setInterval(interval);
rgrover1	710:b2e1a2660ec2	779	}
rgrover1	710:b2e1a2660ec2	780
rgrover1	710:b2e1a2660ec2	781	/**
vcoubard	1048:efb29faf12fc	782	* Set up the scanWindow parameter for GAP scanning (observer mode).
rgrover1	710:b2e1a2660ec2	783	* @param[in] window
rgrover1	710:b2e1a2660ec2	784	* Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1	710:b2e1a2660ec2	785	*
rgrover1	710:b2e1a2660ec2	786	* The scanning window divided by the interval determines the duty cycle for
rgrover1	710:b2e1a2660ec2	787	* scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1	710:b2e1a2660ec2	788	* then the controller will scan for 10 percent of the time. It is possible
rgrover1	710:b2e1a2660ec2	789	* to have the interval and window set to the same value. In this case,
rgrover1	710:b2e1a2660ec2	790	* scanning is continuous, with a change of scanning frequency once every
rgrover1	710:b2e1a2660ec2	791	* interval.
rgrover1	710:b2e1a2660ec2	792	*
rgrover1	710:b2e1a2660ec2	793	* Once the scanning parameters have been configured, scanning can be
rgrover1	710:b2e1a2660ec2	794	* enabled by using startScan().
rgrover1	770:079b714e9c1a	795	*
rgrover1	770:079b714e9c1a	796	* If scanning is already active, the updated value of scanWindow will be
rgrover1	770:079b714e9c1a	797	* propagated to the underlying BLE stack.
rgrover1	710:b2e1a2660ec2	798	*/
rgrover1	710:b2e1a2660ec2	799	ble_error_t setScanWindow(uint16_t window) {
rgrover1	770:079b714e9c1a	800	ble_error_t rc;
rgrover1	770:079b714e9c1a	801	if ((rc = _scanningParams.setWindow(window)) != BLE_ERROR_NONE) {
rgrover1	770:079b714e9c1a	802	return rc;
rgrover1	770:079b714e9c1a	803	}
rgrover1	770:079b714e9c1a	804
rgrover1	770:079b714e9c1a	805	/* If scanning is already active, propagate the new setting to the stack. */
rgrover1	770:079b714e9c1a	806	if (scanningActive) {
rgrover1	770:079b714e9c1a	807	return startRadioScan(_scanningParams);
rgrover1	770:079b714e9c1a	808	}
rgrover1	770:079b714e9c1a	809
rgrover1	770:079b714e9c1a	810	return BLE_ERROR_NONE;
rgrover1	710:b2e1a2660ec2	811	}
rgrover1	710:b2e1a2660ec2	812
rgrover1	710:b2e1a2660ec2	813	/**
vcoubard	1048:efb29faf12fc	814	* Set up parameters for GAP scanning (observer mode).
rgrover1	710:b2e1a2660ec2	815	* @param[in] timeout
vcoubard	1048:efb29faf12fc	816	* Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables the timeout.
rgrover1	710:b2e1a2660ec2	817	*
rgrover1	710:b2e1a2660ec2	818	* Once the scanning parameters have been configured, scanning can be
rgrover1	710:b2e1a2660ec2	819	* enabled by using startScan().
rgrover1	770:079b714e9c1a	820	*
rgrover1	770:079b714e9c1a	821	* If scanning is already active, the updated value of scanTimeout will be
rgrover1	770:079b714e9c1a	822	* propagated to the underlying BLE stack.
rgrover1	710:b2e1a2660ec2	823	*/
rgrover1	710:b2e1a2660ec2	824	ble_error_t setScanTimeout(uint16_t timeout) {
rgrover1	770:079b714e9c1a	825	ble_error_t rc;
rgrover1	770:079b714e9c1a	826	if ((rc = _scanningParams.setTimeout(timeout)) != BLE_ERROR_NONE) {
rgrover1	770:079b714e9c1a	827	return rc;
rgrover1	770:079b714e9c1a	828	}
rgrover1	770:079b714e9c1a	829
rgrover1	770:079b714e9c1a	830	/* If scanning is already active, propagate the new settings to the stack. */
rgrover1	770:079b714e9c1a	831	if (scanningActive) {
rgrover1	770:079b714e9c1a	832	return startRadioScan(_scanningParams);
rgrover1	770:079b714e9c1a	833	}
rgrover1	770:079b714e9c1a	834
rgrover1	770:079b714e9c1a	835	return BLE_ERROR_NONE;
rgrover1	710:b2e1a2660ec2	836	}
rgrover1	710:b2e1a2660ec2	837
rgrover1	710:b2e1a2660ec2	838	/**
vcoubard	1048:efb29faf12fc	839	* Set up parameters for GAP scanning (observer mode).
rgrover1	710:b2e1a2660ec2	840	* @param[in] activeScanning
rgrover1	710:b2e1a2660ec2	841	* Set to True if active-scanning is required. This is used to fetch the
rgrover1	710:b2e1a2660ec2	842	* scan response from a peer if possible.
rgrover1	710:b2e1a2660ec2	843	*
rgrover1	710:b2e1a2660ec2	844	* Once the scanning parameters have been configured, scanning can be
rgrover1	710:b2e1a2660ec2	845	* enabled by using startScan().
rgrover1	770:079b714e9c1a	846	*
rgrover1	770:079b714e9c1a	847	* If scanning is already in progress, then active-scanning will be enabled
rgrover1	770:079b714e9c1a	848	* for the underlying BLE stack.
rgrover1	710:b2e1a2660ec2	849	*/
rgrover1	770:079b714e9c1a	850	ble_error_t setActiveScanning(bool activeScanning) {
rgrover1	710:b2e1a2660ec2	851	_scanningParams.setActiveScanning(activeScanning);
rgrover1	770:079b714e9c1a	852
rgrover1	770:079b714e9c1a	853	/* If scanning is already active, propagate the new settings to the stack. */
rgrover1	770:079b714e9c1a	854	if (scanningActive) {
rgrover1	770:079b714e9c1a	855	return startRadioScan(_scanningParams);
rgrover1	770:079b714e9c1a	856	}
rgrover1	770:079b714e9c1a	857
rgrover1	770:079b714e9c1a	858	return BLE_ERROR_NONE;
rgrover1	710:b2e1a2660ec2	859	}
rgrover1	710:b2e1a2660ec2	860
rgrover1	710:b2e1a2660ec2	861	/**
rgrover1	710:b2e1a2660ec2	862	* Start scanning (Observer Procedure) based on the parameters currently in
rgrover1	710:b2e1a2660ec2	863	* effect.
rgrover1	710:b2e1a2660ec2	864	*
rgrover1	710:b2e1a2660ec2	865	* @param[in] callback
vcoubard	1048:efb29faf12fc	866	* The application-specific callback to be invoked upon
rgrover1	710:b2e1a2660ec2	867	* receiving every advertisement report. This can be passed in
rgrover1	710:b2e1a2660ec2	868	* as NULL, in which case scanning may not be enabled at all.
rgrover1	710:b2e1a2660ec2	869	*/
rgrover1	710:b2e1a2660ec2	870	ble_error_t startScan(void (callback)(const AdvertisementCallbackParams_t params)) {
rgrover1	710:b2e1a2660ec2	871	ble_error_t err = BLE_ERROR_NONE;
rgrover1	710:b2e1a2660ec2	872	if (callback) {
rgrover1	710:b2e1a2660ec2	873	if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
rgrover1	770:079b714e9c1a	874	scanningActive = true;
rgrover1	710:b2e1a2660ec2	875	onAdvertisementReport.attach(callback);
rgrover1	710:b2e1a2660ec2	876	}
rgrover1	710:b2e1a2660ec2	877	}
rgrover1	710:b2e1a2660ec2	878
rgrover1	710:b2e1a2660ec2	879	return err;
rgrover1	710:b2e1a2660ec2	880	}
rgrover1	710:b2e1a2660ec2	881
rgrover1	710:b2e1a2660ec2	882	/**
rgrover1	710:b2e1a2660ec2	883	* Same as above, but this takes an (object, method) pair for a callback.
rgrover1	710:b2e1a2660ec2	884	*/
rgrover1	710:b2e1a2660ec2	885	template<typename T>
rgrover1	710:b2e1a2660ec2	886	ble_error_t startScan(T object, void (T::callbackMember)(const AdvertisementCallbackParams_t *params)) {
rgrover1	710:b2e1a2660ec2	887	ble_error_t err = BLE_ERROR_NONE;
rgrover1	710:b2e1a2660ec2	888	if (object && callbackMember) {
rgrover1	710:b2e1a2660ec2	889	if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
rgrover1	770:079b714e9c1a	890	scanningActive = true;
rgrover1	710:b2e1a2660ec2	891	onAdvertisementReport.attach(object, callbackMember);
rgrover1	710:b2e1a2660ec2	892	}
rgrover1	710:b2e1a2660ec2	893	}
rgrover1	710:b2e1a2660ec2	894
rgrover1	710:b2e1a2660ec2	895	return err;
rgrover1	710:b2e1a2660ec2	896	}
rgrover1	710:b2e1a2660ec2	897
rgrover1	753:0f60274cd3ad	898	/**
rgrover1	753:0f60274cd3ad	899	* Initialize radio-notification events to be generated from the stack.
vcoubard	1048:efb29faf12fc	900	* This API doesn't need to be called directly.
rgrover1	753:0f60274cd3ad	901	*
rgrover1	753:0f60274cd3ad	902	* Radio Notification is a feature that enables ACTIVE and INACTIVE
rgrover1	753:0f60274cd3ad	903	* (nACTIVE) signals from the stack that notify the application when the
rgrover1	753:0f60274cd3ad	904	* radio is in use.
rgrover1	753:0f60274cd3ad	905	*
vcoubard	1048:efb29faf12fc	906	* The ACTIVE signal is sent before the radio event starts. The nACTIVE
vcoubard	1048:efb29faf12fc	907	* signal is sent at the end of the radio event. These signals can be used
rgrover1	753:0f60274cd3ad	908	* by the application programmer to synchronize application logic with radio
rgrover1	753:0f60274cd3ad	909	* activity. For example, the ACTIVE signal can be used to shut off external
vcoubard	1048:efb29faf12fc	910	* devices, to manage peak current drawn during periods when the radio is on,
rgrover1	753:0f60274cd3ad	911	* or to trigger sensor data collection for transmission in the Radio Event.
rgrover1	753:0f60274cd3ad	912	*
rgrover1	753:0f60274cd3ad	913	* @return BLE_ERROR_NONE on successful initialization, otherwise an error code.
rgrover1	753:0f60274cd3ad	914	*/
rgrover1	753:0f60274cd3ad	915	virtual ble_error_t initRadioNotification(void) {
rgrover1	753:0f60274cd3ad	916	return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1	753:0f60274cd3ad	917	}
rgrover1	753:0f60274cd3ad	918
rgrover1	710:b2e1a2660ec2	919	private:
rgrover1	710:b2e1a2660ec2	920	ble_error_t setAdvertisingData(void) {
rgrover1	710:b2e1a2660ec2	921	return setAdvertisingData(_advPayload, _scanResponse);
rgrover1	710:b2e1a2660ec2	922	}
rgrover1	710:b2e1a2660ec2	923
rgrover1	710:b2e1a2660ec2	924	private:
rgrover1	896:791741895cd8	925	virtual ble_error_t setAdvertisingData(const GapAdvertisingData &advData, const GapAdvertisingData &scanResponse) = 0;
rgrover1	896:791741895cd8	926	virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0;
rgrover1	710:b2e1a2660ec2	927
rgrover1	710:b2e1a2660ec2	928	public:
rgrover1	710:b2e1a2660ec2	929	/**
rgrover1	710:b2e1a2660ec2	930	* Accessors to read back currently active advertising params.
rgrover1	710:b2e1a2660ec2	931	*/
rgrover1	710:b2e1a2660ec2	932	GapAdvertisingParams &getAdvertisingParams(void) {
rgrover1	710:b2e1a2660ec2	933	return _advParams;
rgrover1	710:b2e1a2660ec2	934	}
rgrover1	710:b2e1a2660ec2	935	const GapAdvertisingParams &getAdvertisingParams(void) const {
rgrover1	710:b2e1a2660ec2	936	return _advParams;
rgrover1	710:b2e1a2660ec2	937	}
rgrover1	710:b2e1a2660ec2	938
rgrover1	710:b2e1a2660ec2	939	/**
vcoubard	1048:efb29faf12fc	940	* Set up a particular, user-constructed set of advertisement parameters for
rgrover1	710:b2e1a2660ec2	941	* the underlying stack. It would be uncommon for this API to be used
rgrover1	710:b2e1a2660ec2	942	* directly; there are other APIs to tweak advertisement parameters
rgrover1	710:b2e1a2660ec2	943	* individually.
rgrover1	710:b2e1a2660ec2	944	*/
rgrover1	710:b2e1a2660ec2	945	void setAdvertisingParams(const GapAdvertisingParams &newParams) {
rgrover1	710:b2e1a2660ec2	946	_advParams = newParams;
rgrover1	710:b2e1a2660ec2	947	}
rgrover1	710:b2e1a2660ec2	948
rgrover1	710:b2e1a2660ec2	949	/* Event callback handlers. */
rgrover1	710:b2e1a2660ec2	950	public:
rgrover1	710:b2e1a2660ec2	951	/**
vcoubard	1048:efb29faf12fc	952	* Set up a callback for timeout events. Refer to TimeoutSource_t for
rgrover1	710:b2e1a2660ec2	953	* possible event types.
vcoubard	1052:b55e1ad3e1b3	954	* @note It is possible to unregister callbacks using onTimeout().detach(callback)
rgrover1	710:b2e1a2660ec2	955	*/
vcoubard	1052:b55e1ad3e1b3	956	void onTimeout(TimeoutEventCallback_t callback) {
vcoubard	1052:b55e1ad3e1b3	957	timeoutCallbackChain.add(callback);
vcoubard	1052:b55e1ad3e1b3	958	}
vcoubard	1052:b55e1ad3e1b3	959
vcoubard	1052:b55e1ad3e1b3	960	/**
vcoubard	1052:b55e1ad3e1b3	961	* @brief provide access to the callchain of timeout event callbacks
vcoubard	1052:b55e1ad3e1b3	962	* It is possible to register callbacks using onTimeout().add(callback);
vcoubard	1054:f59e5d9a992a	963	* It is possible to unregister callbacks using onTimeout().detach(callback)
vcoubard	1052:b55e1ad3e1b3	964	* @return The timeout event callbacks chain
vcoubard	1052:b55e1ad3e1b3	965	*/
vcoubard	1052:b55e1ad3e1b3	966	TimeoutEventCallbackChain_t& onTimeout() {
vcoubard	1052:b55e1ad3e1b3	967	return timeoutCallbackChain;
vcoubard	1052:b55e1ad3e1b3	968	}
rgrover1	710:b2e1a2660ec2	969
rgrover1	710:b2e1a2660ec2	970	/**
rgrover1	829:9072de50087b	971	* Append to a chain of callbacks to be invoked upon GAP connection.
vcoubard	1052:b55e1ad3e1b3	972	* @note It is possible to unregister callbacks using onConnection().detach(callback)
rgrover1	710:b2e1a2660ec2	973	*/
rgrover1	829:9072de50087b	974	void onConnection(ConnectionEventCallback_t callback) {connectionCallChain.add(callback);}
rgrover1	710:b2e1a2660ec2	975
rgrover1	829:9072de50087b	976	template<typename T>
rgrover1	829:9072de50087b	977	void onConnection(T tptr, void (T::mptr)(const ConnectionCallbackParams_t*)) {connectionCallChain.add(tptr, mptr);}
rgrover1	710:b2e1a2660ec2	978
rgrover1	710:b2e1a2660ec2	979	/**
vcoubard	1052:b55e1ad3e1b3	980	* @brief provide access to the callchain of connection event callbacks
vcoubard	1052:b55e1ad3e1b3	981	* It is possible to register callbacks using onConnection().add(callback);
vcoubard	1054:f59e5d9a992a	982	* It is possible to unregister callbacks using onConnection().detach(callback)
vcoubard	1052:b55e1ad3e1b3	983	* @return The connection event callbacks chain
vcoubard	1052:b55e1ad3e1b3	984	*/
vcoubard	1054:f59e5d9a992a	985	ConnectionEventCallbackChain_t& onConnection() {
vcoubard	1052:b55e1ad3e1b3	986	return connectionCallChain;
vcoubard	1052:b55e1ad3e1b3	987	}
vcoubard	1052:b55e1ad3e1b3	988
vcoubard	1052:b55e1ad3e1b3	989	/**
rgrover1	829:9072de50087b	990	* Append to a chain of callbacks to be invoked upon GAP disconnection.
vcoubard	1052:b55e1ad3e1b3	991	* @note It is possible to unregister callbacks using onDisconnection().detach(callback)
rgrover1	816:2b4f0ef8c06e	992	*/
rgrover1	829:9072de50087b	993	void onDisconnection(DisconnectionEventCallback_t callback) {disconnectionCallChain.add(callback);}
rgrover1	816:2b4f0ef8c06e	994
rgrover1	710:b2e1a2660ec2	995	template<typename T>
rgrover1	829:9072de50087b	996	void onDisconnection(T tptr, void (T::mptr)(const DisconnectionCallbackParams_t*)) {disconnectionCallChain.add(tptr, mptr);}
rgrover1	710:b2e1a2660ec2	997
rgrover1	710:b2e1a2660ec2	998	/**
vcoubard	1052:b55e1ad3e1b3	999	* @brief provide access to the callchain of disconnection event callbacks
vcoubard	1052:b55e1ad3e1b3	1000	* It is possible to register callbacks using onDisconnection().add(callback);
vcoubard	1054:f59e5d9a992a	1001	* It is possible to unregister callbacks using onDisconnection().detach(callback)
vcoubard	1052:b55e1ad3e1b3	1002	* @return The disconnection event callbacks chain
vcoubard	1052:b55e1ad3e1b3	1003	*/
vcoubard	1052:b55e1ad3e1b3	1004	DisconnectionEventCallbackChain_t& onDisconnection() {
vcoubard	1052:b55e1ad3e1b3	1005	return disconnectionCallChain;
vcoubard	1052:b55e1ad3e1b3	1006	}
vcoubard	1052:b55e1ad3e1b3	1007
vcoubard	1052:b55e1ad3e1b3	1008	/**
rgrover1	710:b2e1a2660ec2	1009	* Set the application callback for radio-notification events.
rgrover1	710:b2e1a2660ec2	1010	*
rgrover1	710:b2e1a2660ec2	1011	* Radio Notification is a feature that enables ACTIVE and INACTIVE
rgrover1	710:b2e1a2660ec2	1012	* (nACTIVE) signals from the stack that notify the application when the
rgrover1	753:0f60274cd3ad	1013	* radio is in use.
rgrover1	710:b2e1a2660ec2	1014	*
vcoubard	1048:efb29faf12fc	1015	* The ACTIVE signal is sent before the radio event starts. The nACTIVE
vcoubard	1048:efb29faf12fc	1016	* signal is sent at the end of the radio event. These signals can be used
rgrover1	710:b2e1a2660ec2	1017	* by the application programmer to synchronize application logic with radio
rgrover1	710:b2e1a2660ec2	1018	* activity. For example, the ACTIVE signal can be used to shut off external
vcoubard	1048:efb29faf12fc	1019	* devices, to manage peak current drawn during periods when the radio is on,
rgrover1	710:b2e1a2660ec2	1020	* or to trigger sensor data collection for transmission in the Radio Event.
rgrover1	710:b2e1a2660ec2	1021	*
rgrover1	710:b2e1a2660ec2	1022	* @param callback
rgrover1	710:b2e1a2660ec2	1023	* The application handler to be invoked in response to a radio
rgrover1	710:b2e1a2660ec2	1024	* ACTIVE/INACTIVE event.
rgrover1	754:9b391fb5c5d7	1025	*
vcoubard	1048:efb29faf12fc	1026	* Or in the other version:
rgrover1	754:9b391fb5c5d7	1027	*
rgrover1	754:9b391fb5c5d7	1028	* @param tptr
rgrover1	754:9b391fb5c5d7	1029	* Pointer to the object of a class defining the member callback
rgrover1	754:9b391fb5c5d7	1030	* function (mptr).
rgrover1	754:9b391fb5c5d7	1031	* @param mptr
rgrover1	754:9b391fb5c5d7	1032	* The member callback (within the context of an object) to be
rgrover1	754:9b391fb5c5d7	1033	* invoked in response to a radio ACTIVE/INACTIVE event.
rgrover1	710:b2e1a2660ec2	1034	*/
rgrover1	753:0f60274cd3ad	1035	void onRadioNotification(void (*callback)(bool param)) {
rgrover1	753:0f60274cd3ad	1036	radioNotificationCallback.attach(callback);
rgrover1	753:0f60274cd3ad	1037	}
rgrover1	753:0f60274cd3ad	1038	template <typename T>
rgrover1	753:0f60274cd3ad	1039	void onRadioNotification(T tptr, void (T::mptr)(bool)) {
rgrover1	753:0f60274cd3ad	1040	radioNotificationCallback.attach(tptr, mptr);
rgrover1	753:0f60274cd3ad	1041	}
rgrover1	710:b2e1a2660ec2	1042
vcoubard	1090:148d8b9b56a5	1043	/**
vcoubard	1090:148d8b9b56a5	1044	* Setup a callback to be invoked to notify the user application that the
vcoubard	1090:148d8b9b56a5	1045	* Gap instance is about to shutdown (possibly as a result of a call
vcoubard	1090:148d8b9b56a5	1046	* to BLE::shutdown()).
vcoubard	1090:148d8b9b56a5	1047	*
vcoubard	1090:148d8b9b56a5	1048	* @Note: It is possible to chain together multiple onShutdown callbacks
vcoubard	1090:148d8b9b56a5	1049	* (potentially from different modules of an application) to be notified
vcoubard	1090:148d8b9b56a5	1050	* before the Gap instance is shutdown.
vcoubard	1090:148d8b9b56a5	1051	*
vcoubard	1090:148d8b9b56a5	1052	* @Note: It is also possible to set up a callback into a member function of
vcoubard	1090:148d8b9b56a5	1053	* some object.
vcoubard	1090:148d8b9b56a5	1054	*
vcoubard	1090:148d8b9b56a5	1055	* @Note It is possible to unregister a callback using onShutdown().detach(callback)
vcoubard	1090:148d8b9b56a5	1056	*/
vcoubard	1090:148d8b9b56a5	1057	void onShutdown(const GapShutdownCallback_t& callback) {
vcoubard	1090:148d8b9b56a5	1058	shutdownCallChain.add(callback);
vcoubard	1090:148d8b9b56a5	1059	}
vcoubard	1090:148d8b9b56a5	1060	template <typename T>
vcoubard	1090:148d8b9b56a5	1061	void onShutdown(T objPtr, void (T::memberPtr)(void)) {
vcoubard	1090:148d8b9b56a5	1062	shutdownCallChain.add(objPtr, memberPtr);
vcoubard	1090:148d8b9b56a5	1063	}
vcoubard	1090:148d8b9b56a5	1064
vcoubard	1090:148d8b9b56a5	1065	/**
vcoubard	1090:148d8b9b56a5	1066	* @brief provide access to the callchain of shutdown event callbacks
vcoubard	1090:148d8b9b56a5	1067	* It is possible to register callbacks using onShutdown().add(callback);
vcoubard	1090:148d8b9b56a5	1068	* It is possible to unregister callbacks using onShutdown().detach(callback)
vcoubard	1090:148d8b9b56a5	1069	* @return The shutdown event callbacks chain
vcoubard	1090:148d8b9b56a5	1070	*/
vcoubard	1090:148d8b9b56a5	1071	GapShutdownCallbackChain_t& onShutdown() {
vcoubard	1090:148d8b9b56a5	1072	return shutdownCallChain;
vcoubard	1090:148d8b9b56a5	1073	}
vcoubard	1090:148d8b9b56a5	1074
vcoubard	1082:127667021827	1075	public:
vcoubard	1082:127667021827	1076	/**
vcoubard	1090:148d8b9b56a5	1077	* Notify all registered onShutdown callbacks that the Gap instance is
vcoubard	1090:148d8b9b56a5	1078	* about to be shutdown and clear all Gap state of the
vcoubard	1090:148d8b9b56a5	1079	* associated object.
vcoubard	1082:127667021827	1080	*
vcoubard	1082:127667021827	1081	* This function is meant to be overridden in the platform-specific
vcoubard	1082:127667021827	1082	* sub-class. Nevertheless, the sub-class is only expected to reset its
vcoubard	1082:127667021827	1083	* state and not the data held in Gap members. This shall be achieved by a
vcoubard	1082:127667021827	1084	* call to Gap::reset() from the sub-class' reset() implementation.
vcoubard	1082:127667021827	1085	*
vcoubard	1082:127667021827	1086	* @return BLE_ERROR_NONE on success.
vcoubard	1082:127667021827	1087	*
vcoubard	1082:127667021827	1088	* @note: Currently a call to reset() does not reset the advertising and
vcoubard	1082:127667021827	1089	* scan parameters to default values.
vcoubard	1082:127667021827	1090	*/
vcoubard	1082:127667021827	1091	virtual ble_error_t reset(void) {
vcoubard	1090:148d8b9b56a5	1092	/* Notify that the instance is about to shutdown */
vcoubard	1090:148d8b9b56a5	1093	shutdownCallChain.call(this);
vcoubard	1090:148d8b9b56a5	1094	shutdownCallChain.clear();
vcoubard	1090:148d8b9b56a5	1095
vcoubard	1082:127667021827	1096	/* Clear Gap state */
vcoubard	1082:127667021827	1097	state.advertising = 0;
vcoubard	1084:40c1e518d6de	1098	state.connected = 0;
vcoubard	1082:127667021827	1099
vcoubard	1082:127667021827	1100	/* Clear scanning state */
vcoubard	1082:127667021827	1101	scanningActive = false;
vcoubard	1082:127667021827	1102
vcoubard	1082:127667021827	1103	/* Clear advertising and scanning data */
vcoubard	1082:127667021827	1104	_advPayload.clear();
vcoubard	1082:127667021827	1105	_scanResponse.clear();
vcoubard	1082:127667021827	1106
vcoubard	1082:127667021827	1107	/* Clear callbacks */
vcoubard	1082:127667021827	1108	timeoutCallbackChain.clear();
vcoubard	1082:127667021827	1109	connectionCallChain.clear();
vcoubard	1082:127667021827	1110	disconnectionCallChain.clear();
vcoubard	1082:127667021827	1111	radioNotificationCallback = NULL;
vcoubard	1084:40c1e518d6de	1112	onAdvertisementReport = NULL;
vcoubard	1082:127667021827	1113
vcoubard	1082:127667021827	1114	return BLE_ERROR_NONE;
vcoubard	1082:127667021827	1115	}
vcoubard	1082:127667021827	1116
rgrover1	710:b2e1a2660ec2	1117	protected:
rgrover1	710:b2e1a2660ec2	1118	Gap() :
rgrover1	710:b2e1a2660ec2	1119	_advParams(),
rgrover1	710:b2e1a2660ec2	1120	_advPayload(),
rgrover1	710:b2e1a2660ec2	1121	_scanningParams(),
rgrover1	710:b2e1a2660ec2	1122	_scanResponse(),
rgrover1	710:b2e1a2660ec2	1123	state(),
rgrover1	770:079b714e9c1a	1124	scanningActive(false),
vcoubard	1052:b55e1ad3e1b3	1125	timeoutCallbackChain(),
rgrover1	710:b2e1a2660ec2	1126	radioNotificationCallback(),
rgrover1	710:b2e1a2660ec2	1127	onAdvertisementReport(),
rgrover1	816:2b4f0ef8c06e	1128	connectionCallChain(),
rgrover1	710:b2e1a2660ec2	1129	disconnectionCallChain() {
rgrover1	710:b2e1a2660ec2	1130	_advPayload.clear();
rgrover1	710:b2e1a2660ec2	1131	_scanResponse.clear();
rgrover1	710:b2e1a2660ec2	1132	}
rgrover1	710:b2e1a2660ec2	1133
rgrover1	710:b2e1a2660ec2	1134	/* Entry points for the underlying stack to report events back to the user. */
rgrover1	710:b2e1a2660ec2	1135	public:
vcoubard	1079:6e2d9514f3df	1136	void processConnectionEvent(Handle_t handle,
vcoubard	1079:6e2d9514f3df	1137	Role_t role,
vcoubard	1079:6e2d9514f3df	1138	BLEProtocol::AddressType_t peerAddrType,
vcoubard	1115:82d4a8a56d91	1139	const BLEProtocol::AddressBytes_t peerAddr,
vcoubard	1079:6e2d9514f3df	1140	BLEProtocol::AddressType_t ownAddrType,
vcoubard	1115:82d4a8a56d91	1141	const BLEProtocol::AddressBytes_t ownAddr,
vcoubard	1079:6e2d9514f3df	1142	const ConnectionParams_t *connectionParams) {
rgrover1	710:b2e1a2660ec2	1143	state.connected = 1;
rgrover1	829:9072de50087b	1144	ConnectionCallbackParams_t callbackParams(handle, role, peerAddrType, peerAddr, ownAddrType, ownAddr, connectionParams);
rgrover1	829:9072de50087b	1145	connectionCallChain.call(&callbackParams);
rgrover1	710:b2e1a2660ec2	1146	}
rgrover1	710:b2e1a2660ec2	1147
rgrover1	710:b2e1a2660ec2	1148	void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) {
rgrover1	710:b2e1a2660ec2	1149	state.connected = 0;
rgrover1	829:9072de50087b	1150	DisconnectionCallbackParams_t callbackParams(handle, reason);
rgrover1	829:9072de50087b	1151	disconnectionCallChain.call(&callbackParams);
rgrover1	710:b2e1a2660ec2	1152	}
rgrover1	710:b2e1a2660ec2	1153
vcoubard	1115:82d4a8a56d91	1154	void processAdvertisementReport(const BLEProtocol::AddressBytes_t peerAddr,
vcoubard	1079:6e2d9514f3df	1155	int8_t rssi,
vcoubard	1079:6e2d9514f3df	1156	bool isScanResponse,
rgrover1	710:b2e1a2660ec2	1157	GapAdvertisingParams::AdvertisingType_t type,
vcoubard	1079:6e2d9514f3df	1158	uint8_t advertisingDataLen,
vcoubard	1079:6e2d9514f3df	1159	const uint8_t *advertisingData) {
rgrover1	710:b2e1a2660ec2	1160	AdvertisementCallbackParams_t params;
rgrover1	710:b2e1a2660ec2	1161	memcpy(params.peerAddr, peerAddr, ADDR_LEN);
rgrover1	710:b2e1a2660ec2	1162	params.rssi = rssi;
rgrover1	710:b2e1a2660ec2	1163	params.isScanResponse = isScanResponse;
rgrover1	710:b2e1a2660ec2	1164	params.type = type;
rgrover1	710:b2e1a2660ec2	1165	params.advertisingDataLen = advertisingDataLen;
rgrover1	710:b2e1a2660ec2	1166	params.advertisingData = advertisingData;
rgrover1	710:b2e1a2660ec2	1167	onAdvertisementReport.call(&params);
rgrover1	710:b2e1a2660ec2	1168	}
rgrover1	710:b2e1a2660ec2	1169
rgrover1	710:b2e1a2660ec2	1170	void processTimeoutEvent(TimeoutSource_t source) {
vcoubard	1052:b55e1ad3e1b3	1171	if (timeoutCallbackChain) {
vcoubard	1052:b55e1ad3e1b3	1172	timeoutCallbackChain(source);
rgrover1	710:b2e1a2660ec2	1173	}
rgrover1	710:b2e1a2660ec2	1174	}
rgrover1	710:b2e1a2660ec2	1175
vcoubard	1115:82d4a8a56d91	1176	///////////////////////////////////////////////////
vcoubard	1115:82d4a8a56d91	1177	public:
vcoubard	1115:82d4a8a56d91	1178	enum AdvertisingPolicyMode_t {
vcoubard	1115:82d4a8a56d91	1179	ADV_POLICY_IGNORE_WHITELIST = 0,
vcoubard	1115:82d4a8a56d91	1180	ADV_POLICY_FILTER_SCAN_REQS = 1,
vcoubard	1115:82d4a8a56d91	1181	ADV_POLICY_FILTER_CONN_REQS = 2,
vcoubard	1115:82d4a8a56d91	1182	ADV_POLICY_FILTER_ALL_REQS = 3,
vcoubard	1115:82d4a8a56d91	1183	};
vcoubard	1115:82d4a8a56d91	1184
vcoubard	1115:82d4a8a56d91	1185	enum ScanningPolicyMode_t {
vcoubard	1115:82d4a8a56d91	1186	SCAN_POLICY_IGNORE_WHITELIST = 0,
vcoubard	1115:82d4a8a56d91	1187	SCAN_POLICY_FILTER_ALL_ADV = 1,
vcoubard	1115:82d4a8a56d91	1188	};
vcoubard	1115:82d4a8a56d91	1189
vcoubard	1115:82d4a8a56d91	1190	enum InitiatorPolicyMode_t {
vcoubard	1115:82d4a8a56d91	1191	INIT_POLICY_IGNORE_WHITELIST = 0,
vcoubard	1115:82d4a8a56d91	1192	INIT_POLICY_FILTER_ALL_ADV = 1,
vcoubard	1115:82d4a8a56d91	1193	};
vcoubard	1115:82d4a8a56d91	1194
vcoubard	1115:82d4a8a56d91	1195	// Things to be implemented by the porter
vcoubard	1115:82d4a8a56d91	1196	virtual int8_t getMaxWhitelistSize(void) const
vcoubard	1115:82d4a8a56d91	1197	{
vcoubard	1115:82d4a8a56d91	1198	return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard	1115:82d4a8a56d91	1199	}
vcoubard	1115:82d4a8a56d91	1200
vcoubard	1115:82d4a8a56d91	1201	virtual ble_error_t getWhitelist(std::set<BLEProtocol::Address_t> &whitelist) const
vcoubard	1115:82d4a8a56d91	1202	{
vcoubard	1115:82d4a8a56d91	1203	(void) whitelist;
vcoubard	1115:82d4a8a56d91	1204	return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard	1115:82d4a8a56d91	1205	}
vcoubard	1115:82d4a8a56d91	1206
vcoubard	1115:82d4a8a56d91	1207	virtual ble_error_t setWhitelist(std::set<BLEProtocol::Address_t> whitelist)
vcoubard	1115:82d4a8a56d91	1208	{
vcoubard	1115:82d4a8a56d91	1209	(void) whitelist;
vcoubard	1115:82d4a8a56d91	1210	return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard	1115:82d4a8a56d91	1211	}
vcoubard	1115:82d4a8a56d91	1212
vcoubard	1115:82d4a8a56d91	1213	// Accessors
vcoubard	1115:82d4a8a56d91	1214	virtual void setAdvertisingPolicyMode(AdvertisingPolicyMode_t mode)
vcoubard	1115:82d4a8a56d91	1215	{
vcoubard	1115:82d4a8a56d91	1216	(void) mode;
vcoubard	1115:82d4a8a56d91	1217	}
vcoubard	1115:82d4a8a56d91	1218
vcoubard	1115:82d4a8a56d91	1219	virtual void setScanningPolicyMode(ScanningPolicyMode_t mode)
vcoubard	1115:82d4a8a56d91	1220	{
vcoubard	1115:82d4a8a56d91	1221	(void) mode;
vcoubard	1115:82d4a8a56d91	1222	}
vcoubard	1115:82d4a8a56d91	1223
vcoubard	1115:82d4a8a56d91	1224	virtual void setInitiatorPolicyMode(InitiatorPolicyMode_t mode)
vcoubard	1115:82d4a8a56d91	1225	{
vcoubard	1115:82d4a8a56d91	1226	(void) mode;
vcoubard	1115:82d4a8a56d91	1227	}
vcoubard	1115:82d4a8a56d91	1228
vcoubard	1115:82d4a8a56d91	1229	virtual AdvertisingPolicyMode_t getAdvertisingPolicyMode(void) const
vcoubard	1115:82d4a8a56d91	1230	{
vcoubard	1115:82d4a8a56d91	1231	return ADV_POLICY_IGNORE_WHITELIST;
vcoubard	1115:82d4a8a56d91	1232	}
vcoubard	1115:82d4a8a56d91	1233
vcoubard	1115:82d4a8a56d91	1234	virtual ScanningPolicyMode_t getScanningPolicyMode(void) const
vcoubard	1115:82d4a8a56d91	1235	{
vcoubard	1115:82d4a8a56d91	1236	return SCAN_POLICY_IGNORE_WHITELIST;
vcoubard	1115:82d4a8a56d91	1237	}
vcoubard	1115:82d4a8a56d91	1238
vcoubard	1115:82d4a8a56d91	1239	virtual InitiatorPolicyMode_t getInitiatorPolicyMode(void) const
vcoubard	1115:82d4a8a56d91	1240	{
vcoubard	1115:82d4a8a56d91	1241	return INIT_POLICY_IGNORE_WHITELIST;
vcoubard	1115:82d4a8a56d91	1242	}
vcoubard	1115:82d4a8a56d91	1243
vcoubard	1115:82d4a8a56d91	1244	///////////////////////////////////////////////////
vcoubard	1115:82d4a8a56d91	1245
rgrover1	710:b2e1a2660ec2	1246	protected:
rgrover1	710:b2e1a2660ec2	1247	GapAdvertisingParams _advParams;
rgrover1	710:b2e1a2660ec2	1248	GapAdvertisingData _advPayload;
rgrover1	710:b2e1a2660ec2	1249	GapScanningParams _scanningParams;
rgrover1	710:b2e1a2660ec2	1250	GapAdvertisingData _scanResponse;
rgrover1	710:b2e1a2660ec2	1251
rgrover1	710:b2e1a2660ec2	1252	GapState_t state;
rgrover1	770:079b714e9c1a	1253	bool scanningActive;
rgrover1	710:b2e1a2660ec2	1254
rgrover1	710:b2e1a2660ec2	1255	protected:
vcoubard	1052:b55e1ad3e1b3	1256	TimeoutEventCallbackChain_t timeoutCallbackChain;
vcoubard	1052:b55e1ad3e1b3	1257	RadioNotificationEventCallback_t radioNotificationCallback;
vcoubard	1052:b55e1ad3e1b3	1258	AdvertisementReportCallback_t onAdvertisementReport;
vcoubard	1052:b55e1ad3e1b3	1259	ConnectionEventCallbackChain_t connectionCallChain;
vcoubard	1052:b55e1ad3e1b3	1260	DisconnectionEventCallbackChain_t disconnectionCallChain;
rgrover1	710:b2e1a2660ec2	1261
rgrover1	710:b2e1a2660ec2	1262	private:
vcoubard	1090:148d8b9b56a5	1263	GapShutdownCallbackChain_t shutdownCallChain;
vcoubard	1090:148d8b9b56a5	1264
vcoubard	1090:148d8b9b56a5	1265	private:
vcoubard	1048:efb29faf12fc	1266	/* Disallow copy and assignment. */
rgrover1	710:b2e1a2660ec2	1267	Gap(const Gap &);
rgrover1	710:b2e1a2660ec2	1268	Gap& operator=(const Gap &);
rgrover1	710:b2e1a2660ec2	1269	};
rgrover1	710:b2e1a2660ec2	1270
rgrover1	710:b2e1a2660ec2	1271	#endif // ifndef __GAP_H__

Repository toolbox

Export to desktop IDE

Repository details

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

ble/Gap.h@1116:9cb51490b3f7, 2016-01-11 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning