aapje monkey / BLE_API

Bike service

Fork of BLE_API by Bluetooth Low Energy

ble/Gap.h@1157:e1ea38b576c6, 2016-04-06 (annotated)

Committer:
vcoubard
Date:
Wed Apr 06 19:14:38 2016 +0100
Revision:
1157:e1ea38b576c6
Parent:
1136:22aada733dbd
Child:
1161:c6c088802d38
Synchronized with git rev 5749d87d

Author: Andres Amaya Garcia

Add missing documentation to Gap.h and fix doxygen warnings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vcoubard 1132:692ddf04fc42 1 /* mbed Microcontroller Library
vcoubard 1132:692ddf04fc42 2 * Copyright (c) 2006-2013 ARM Limited
vcoubard 1132:692ddf04fc42 3 *
vcoubard 1132:692ddf04fc42 4 * Licensed under the Apache License, Version 2.0 (the "License");
vcoubard 1132:692ddf04fc42 5 * you may not use this file except in compliance with the License.
vcoubard 1132:692ddf04fc42 6 * You may obtain a copy of the License at
vcoubard 1132:692ddf04fc42 7 *
vcoubard 1132:692ddf04fc42 8 * http://www.apache.org/licenses/LICENSE-2.0
vcoubard 1132:692ddf04fc42 9 *
vcoubard 1132:692ddf04fc42 10 * Unless required by applicable law or agreed to in writing, software
vcoubard 1132:692ddf04fc42 11 * distributed under the License is distributed on an "AS IS" BASIS,
vcoubard 1132:692ddf04fc42 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vcoubard 1132:692ddf04fc42 13 * See the License for the specific language governing permissions and
vcoubard 1132:692ddf04fc42 14 * limitations under the License.
vcoubard 1132:692ddf04fc42 15 */
vcoubard 1132:692ddf04fc42 16
vcoubard 1132:692ddf04fc42 17 #ifndef __GAP_H__
vcoubard 1132:692ddf04fc42 18 #define __GAP_H__
vcoubard 1132:692ddf04fc42 19
vcoubard 1136:22aada733dbd 20 #include "ble/BLEProtocol.h"
vcoubard 1132:692ddf04fc42 21 #include "GapAdvertisingData.h"
vcoubard 1132:692ddf04fc42 22 #include "GapAdvertisingParams.h"
vcoubard 1132:692ddf04fc42 23 #include "GapScanningParams.h"
vcoubard 1132:692ddf04fc42 24 #include "GapEvents.h"
vcoubard 1132:692ddf04fc42 25 #include "CallChainOfFunctionPointersWithContext.h"
vcoubard 1132:692ddf04fc42 26 #include "FunctionPointerWithContext.h"
vcoubard 1136:22aada733dbd 27 #include "deprecate.h"
vcoubard 1132:692ddf04fc42 28
vcoubard 1132:692ddf04fc42 29 /* Forward declarations for classes that will only be used for pointers or references in the following. */
vcoubard 1132:692ddf04fc42 30 class GapAdvertisingParams;
vcoubard 1132:692ddf04fc42 31 class GapScanningParams;
vcoubard 1132:692ddf04fc42 32 class GapAdvertisingData;
vcoubard 1132:692ddf04fc42 33
vcoubard 1132:692ddf04fc42 34 class Gap {
vcoubard 1136:22aada733dbd 35 /*
vcoubard 1136:22aada733dbd 36 * DEPRECATION ALERT: all of the APIs in this `public` block are deprecated.
vcoubard 1136:22aada733dbd 37 * They have been relocated to the class BLEProtocol.
vcoubard 1136:22aada733dbd 38 */
vcoubard 1132:692ddf04fc42 39 public:
vcoubard 1136:22aada733dbd 40 /**
vcoubard 1136:22aada733dbd 41 * Address-type for BLEProtocol addresses.
vcoubard 1136:22aada733dbd 42 *
vcoubard 1157:e1ea38b576c6 43 * @deprecated Use BLEProtocol::AddressType_t instead.
vcoubard 1136:22aada733dbd 44 */
vcoubard 1136:22aada733dbd 45 typedef BLEProtocol::AddressType_t AddressType_t;
vcoubard 1136:22aada733dbd 46
vcoubard 1136:22aada733dbd 47 /**
vcoubard 1136:22aada733dbd 48 * Address-type for BLEProtocol addresses.
vcoubard 1157:e1ea38b576c6 49 *
vcoubard 1157:e1ea38b576c6 50 * @deprecated Use BLEProtocol::AddressType_t instead.
vcoubard 1136:22aada733dbd 51 */
vcoubard 1136:22aada733dbd 52 typedef BLEProtocol::AddressType_t addr_type_t;
vcoubard 1136:22aada733dbd 53
vcoubard 1136:22aada733dbd 54 /**
vcoubard 1136:22aada733dbd 55 * Address-type for BLEProtocol addresses.
vcoubard 1136:22aada733dbd 56 *
vcoubard 1157:e1ea38b576c6 57 * @deprecated Use BLEProtocol::AddressType_t instead. The following
vcoubard 1157:e1ea38b576c6 58 * constants have been left in their deprecated state to
vcoubard 1157:e1ea38b576c6 59 * transparenly support existing applications which may have
vcoubard 1157:e1ea38b576c6 60 * used Gap::ADDR_TYPE_*.
vcoubard 1136:22aada733dbd 61 */
vcoubard 1136:22aada733dbd 62 enum DeprecatedAddressType_t {
vcoubard 1136:22aada733dbd 63 ADDR_TYPE_PUBLIC = BLEProtocol::AddressType::PUBLIC,
vcoubard 1136:22aada733dbd 64 ADDR_TYPE_RANDOM_STATIC = BLEProtocol::AddressType::RANDOM_STATIC,
vcoubard 1136:22aada733dbd 65 ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE = BLEProtocol::AddressType::RANDOM_PRIVATE_RESOLVABLE,
vcoubard 1136:22aada733dbd 66 ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE = BLEProtocol::AddressType::RANDOM_PRIVATE_NON_RESOLVABLE
vcoubard 1132:692ddf04fc42 67 };
vcoubard 1132:692ddf04fc42 68
vcoubard 1157:e1ea38b576c6 69 /**
vcoubard 1157:e1ea38b576c6 70 * Length (in octets) of the BLE MAC address.
vcoubard 1157:e1ea38b576c6 71 */
vcoubard 1157:e1ea38b576c6 72 static const unsigned ADDR_LEN = BLEProtocol::ADDR_LEN;
vcoubard 1157:e1ea38b576c6 73 /**
vcoubard 1157:e1ea38b576c6 74 * 48-bit address, LSB format.
vcoubard 1157:e1ea38b576c6 75 *
vcoubard 1157:e1ea38b576c6 76 * @deprecated Use BLEProtocol::AddressBytes_t instead.
vcoubard 1157:e1ea38b576c6 77 */
vcoubard 1157:e1ea38b576c6 78 typedef BLEProtocol::AddressBytes_t Address_t;
vcoubard 1157:e1ea38b576c6 79 /**
vcoubard 1157:e1ea38b576c6 80 * 48-bit address, LSB format.
vcoubard 1157:e1ea38b576c6 81 *
vcoubard 1157:e1ea38b576c6 82 * @deprecated Use BLEProtocol::AddressBytes_t instead.
vcoubard 1157:e1ea38b576c6 83 */
vcoubard 1157:e1ea38b576c6 84 typedef BLEProtocol::AddressBytes_t address_t;
vcoubard 1132:692ddf04fc42 85
vcoubard 1136:22aada733dbd 86 public:
vcoubard 1157:e1ea38b576c6 87 /**
vcoubard 1157:e1ea38b576c6 88 * Enumeration for timeout sources.
vcoubard 1157:e1ea38b576c6 89 */
vcoubard 1132:692ddf04fc42 90 enum TimeoutSource_t {
vcoubard 1132:692ddf04fc42 91 TIMEOUT_SRC_ADVERTISING = 0x00, /**< Advertising timeout. */
vcoubard 1132:692ddf04fc42 92 TIMEOUT_SRC_SECURITY_REQUEST = 0x01, /**< Security request timeout. */
vcoubard 1132:692ddf04fc42 93 TIMEOUT_SRC_SCAN = 0x02, /**< Scanning timeout. */
vcoubard 1132:692ddf04fc42 94 TIMEOUT_SRC_CONN = 0x03, /**< Connection timeout. */
vcoubard 1132:692ddf04fc42 95 };
vcoubard 1132:692ddf04fc42 96
vcoubard 1132:692ddf04fc42 97 /**
vcoubard 1132:692ddf04fc42 98 * Enumeration for disconnection reasons. The values for these reasons are
vcoubard 1132:692ddf04fc42 99 * derived from Nordic's implementation, but the reasons are meant to be
vcoubard 1132:692ddf04fc42 100 * independent of the transport. If you are returned a reason that is not
vcoubard 1132:692ddf04fc42 101 * covered by this enumeration, please refer to the underlying
vcoubard 1132:692ddf04fc42 102 * transport library.
vcoubard 1132:692ddf04fc42 103 */
vcoubard 1132:692ddf04fc42 104 enum DisconnectionReason_t {
vcoubard 1132:692ddf04fc42 105 CONNECTION_TIMEOUT = 0x08,
vcoubard 1132:692ddf04fc42 106 REMOTE_USER_TERMINATED_CONNECTION = 0x13,
vcoubard 1132:692ddf04fc42 107 REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES = 0x14, /**< Remote device terminated connection due to low resources.*/
vcoubard 1132:692ddf04fc42 108 REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF = 0x15, /**< Remote device terminated connection due to power off. */
vcoubard 1132:692ddf04fc42 109 LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
vcoubard 1132:692ddf04fc42 110 CONN_INTERVAL_UNACCEPTABLE = 0x3B,
vcoubard 1132:692ddf04fc42 111 };
vcoubard 1132:692ddf04fc42 112
vcoubard 1136:22aada733dbd 113 /**
vcoubard 1136:22aada733dbd 114 * Enumeration for whitelist advertising policy filter modes. The possible
vcoubard 1136:22aada733dbd 115 * filter modes were obtained from the Bluetooth Core Specification
vcoubard 1136:22aada733dbd 116 * 4.2 (Vol. 6), Part B, Section 4.3.2.
vcoubard 1136:22aada733dbd 117 *
vcoubard 1136:22aada733dbd 118 * @experimental
vcoubard 1136:22aada733dbd 119 */
vcoubard 1136:22aada733dbd 120 enum AdvertisingPolicyMode_t {
vcoubard 1136:22aada733dbd 121 ADV_POLICY_IGNORE_WHITELIST = 0,
vcoubard 1136:22aada733dbd 122 ADV_POLICY_FILTER_SCAN_REQS = 1,
vcoubard 1136:22aada733dbd 123 ADV_POLICY_FILTER_CONN_REQS = 2,
vcoubard 1136:22aada733dbd 124 ADV_POLICY_FILTER_ALL_REQS = 3,
vcoubard 1136:22aada733dbd 125 };
vcoubard 1136:22aada733dbd 126
vcoubard 1136:22aada733dbd 127 /**
vcoubard 1136:22aada733dbd 128 * Enumeration for whitelist scanning policy filter modes. The possible
vcoubard 1136:22aada733dbd 129 * filter modes were obtained from the Bluetooth Core Specification
vcoubard 1136:22aada733dbd 130 * 4.2 (Vol. 6), Part B, Section 4.3.3.
vcoubard 1136:22aada733dbd 131 *
vcoubard 1136:22aada733dbd 132 * @experimental
vcoubard 1136:22aada733dbd 133 */
vcoubard 1136:22aada733dbd 134 enum ScanningPolicyMode_t {
vcoubard 1136:22aada733dbd 135 SCAN_POLICY_IGNORE_WHITELIST = 0,
vcoubard 1136:22aada733dbd 136 SCAN_POLICY_FILTER_ALL_ADV = 1,
vcoubard 1136:22aada733dbd 137 };
vcoubard 1136:22aada733dbd 138
vcoubard 1136:22aada733dbd 139 /**
vcoubard 1136:22aada733dbd 140 * Enumeration for the whitelist initiator policy fiter modes. The possible
vcoubard 1136:22aada733dbd 141 * filter modes were obtained from the Bluetooth Core Specification
vcoubard 1136:22aada733dbd 142 * 4.2 (vol. 6), Part B, Section 4.4.4.
vcoubard 1136:22aada733dbd 143 *
vcoubard 1136:22aada733dbd 144 * @experimental
vcoubard 1136:22aada733dbd 145 */
vcoubard 1136:22aada733dbd 146 enum InitiatorPolicyMode_t {
vcoubard 1136:22aada733dbd 147 INIT_POLICY_IGNORE_WHITELIST = 0,
vcoubard 1136:22aada733dbd 148 INIT_POLICY_FILTER_ALL_ADV = 1,
vcoubard 1136:22aada733dbd 149 };
vcoubard 1136:22aada733dbd 150
vcoubard 1136:22aada733dbd 151 /**
vcoubard 1136:22aada733dbd 152 * Representation of a Bluetooth Low Enery Whitelist containing addresses.
vcoubard 1136:22aada733dbd 153 *
vcoubard 1136:22aada733dbd 154 * @experimental
vcoubard 1136:22aada733dbd 155 */
vcoubard 1136:22aada733dbd 156 struct Whitelist_t {
vcoubard 1157:e1ea38b576c6 157 BLEProtocol::Address_t *addresses; /**< List of BLE addresses in the whitelist. */
vcoubard 1157:e1ea38b576c6 158 uint8_t size; /**< Total number of BLE addresses in this whitelist */
vcoubard 1157:e1ea38b576c6 159 uint8_t capacity; /**< Maximum number of BLE addresses that can be added to this whitelist. */
vcoubard 1136:22aada733dbd 160 };
vcoubard 1136:22aada733dbd 161
vcoubard 1136:22aada733dbd 162
vcoubard 1157:e1ea38b576c6 163 /**
vcoubard 1157:e1ea38b576c6 164 * Describes the current state of the device (more than one bit can be set).
vcoubard 1157:e1ea38b576c6 165 */
vcoubard 1132:692ddf04fc42 166 struct GapState_t {
vcoubard 1132:692ddf04fc42 167 unsigned advertising : 1; /**< Peripheral is currently advertising. */
vcoubard 1132:692ddf04fc42 168 unsigned connected : 1; /**< Peripheral is connected to a central. */
vcoubard 1132:692ddf04fc42 169 };
vcoubard 1132:692ddf04fc42 170
vcoubard 1157:e1ea38b576c6 171 /**
vcoubard 1157:e1ea38b576c6 172 * Type for connection handle.
vcoubard 1157:e1ea38b576c6 173 */
vcoubard 1157:e1ea38b576c6 174 typedef uint16_t Handle_t;
vcoubard 1132:692ddf04fc42 175
vcoubard 1157:e1ea38b576c6 176 /**
vcoubard 1157:e1ea38b576c6 177 * Structure containing GAP connection parameters. When in peripheral role
vcoubard 1157:e1ea38b576c6 178 * the connection parameters are suggestions. The choice of the connection
vcoubard 1157:e1ea38b576c6 179 * parameters is eventually up to the central.
vcoubard 1157:e1ea38b576c6 180 */
vcoubard 1132:692ddf04fc42 181 typedef struct {
vcoubard 1157:e1ea38b576c6 182 uint16_t minConnectionInterval; /**< Minimum Connection Interval in 1.25 ms units, see BLE_GAP_CP_LIMITS.*/
vcoubard 1157:e1ea38b576c6 183 uint16_t maxConnectionInterval; /**< Maximum Connection Interval in 1.25 ms units, see BLE_GAP_CP_LIMITS.*/
vcoubard 1157:e1ea38b576c6 184 uint16_t slaveLatency; /**< Slave Latency in number of connection events, see BLE_GAP_CP_LIMITS.*/
vcoubard 1157:e1ea38b576c6 185 uint16_t connectionSupervisionTimeout; /**< Connection Supervision Timeout in 10 ms units, see BLE_GAP_CP_LIMITS.*/
vcoubard 1132:692ddf04fc42 186 } ConnectionParams_t;
vcoubard 1132:692ddf04fc42 187
vcoubard 1157:e1ea38b576c6 188 /**
vcoubard 1157:e1ea38b576c6 189 * Enumeration for the possible GAP roles of a BLE device.
vcoubard 1157:e1ea38b576c6 190 */
vcoubard 1132:692ddf04fc42 191 enum Role_t {
vcoubard 1132:692ddf04fc42 192 PERIPHERAL = 0x1, /**< Peripheral Role. */
vcoubard 1132:692ddf04fc42 193 CENTRAL = 0x2, /**< Central Role. */
vcoubard 1132:692ddf04fc42 194 };
vcoubard 1132:692ddf04fc42 195
vcoubard 1157:e1ea38b576c6 196 /**
vcoubard 1157:e1ea38b576c6 197 * Structure containing data and metadata of a scanned advertising packet.
vcoubard 1157:e1ea38b576c6 198 */
vcoubard 1132:692ddf04fc42 199 struct AdvertisementCallbackParams_t {
vcoubard 1157:e1ea38b576c6 200 BLEProtocol::AddressBytes_t peerAddr; /**< The peer's BLE address. */
vcoubard 1157:e1ea38b576c6 201 int8_t rssi; /**< The advertisement packet RSSI value. */
vcoubard 1157:e1ea38b576c6 202 bool isScanResponse; /**< Whether this packet is the response to a scan request. */
vcoubard 1157:e1ea38b576c6 203 GapAdvertisingParams::AdvertisingType_t type; /**< The type of advertisement. */
vcoubard 1157:e1ea38b576c6 204 uint8_t advertisingDataLen; /**< Length of the advertisement data. */
vcoubard 1157:e1ea38b576c6 205 const uint8_t *advertisingData; /**< Pointer to the advertisement packet's data. */
vcoubard 1132:692ddf04fc42 206 };
vcoubard 1157:e1ea38b576c6 207
vcoubard 1157:e1ea38b576c6 208 /**
vcoubard 1157:e1ea38b576c6 209 * Type for the handlers of advertisement callback events. Refer to
vcoubard 1157:e1ea38b576c6 210 * Gap::startScan().
vcoubard 1157:e1ea38b576c6 211 */
vcoubard 1132:692ddf04fc42 212 typedef FunctionPointerWithContext<const AdvertisementCallbackParams_t *> AdvertisementReportCallback_t;
vcoubard 1132:692ddf04fc42 213
vcoubard 1157:e1ea38b576c6 214 /**
vcoubard 1157:e1ea38b576c6 215 * Encapsulates the parameters of a connection. This information is passed
vcoubard 1157:e1ea38b576c6 216 * to the registered handler of connection events. Refer to Gap::onConnection().
vcoubard 1157:e1ea38b576c6 217 */
vcoubard 1132:692ddf04fc42 218 struct ConnectionCallbackParams_t {
vcoubard 1157:e1ea38b576c6 219 Handle_t handle; /**< The ID for this connection */
vcoubard 1157:e1ea38b576c6 220 Role_t role; /**< This device's role in the connection */
vcoubard 1157:e1ea38b576c6 221 BLEProtocol::AddressType_t peerAddrType; /**< The peer's BLE address type */
vcoubard 1157:e1ea38b576c6 222 BLEProtocol::AddressBytes_t peerAddr; /**< The peer's BLE address */
vcoubard 1157:e1ea38b576c6 223 BLEProtocol::AddressType_t ownAddrType; /**< This device's BLE address type */
vcoubard 1157:e1ea38b576c6 224 BLEProtocol::AddressBytes_t ownAddr; /**< This devices's BLE address */
vcoubard 1157:e1ea38b576c6 225 const ConnectionParams_t *connectionParams; /**< The currently configured connection parameters */
vcoubard 1132:692ddf04fc42 226
vcoubard 1157:e1ea38b576c6 227 /**
vcoubard 1157:e1ea38b576c6 228 * Constructor for ConnectionCallbackParams_t.
vcoubard 1157:e1ea38b576c6 229 *
vcoubard 1157:e1ea38b576c6 230 * @param[in] handleIn
vcoubard 1157:e1ea38b576c6 231 * Value for ConnectionCallbackParams_t::handle
vcoubard 1157:e1ea38b576c6 232 * @param[in] roleIn
vcoubard 1157:e1ea38b576c6 233 * Value for ConnectionCallbackParams_t::role
vcoubard 1157:e1ea38b576c6 234 * @param[in] peerAddrTypeIn
vcoubard 1157:e1ea38b576c6 235 * Value for ConnectionCallbackParams_t::peerAddrType
vcoubard 1157:e1ea38b576c6 236 * @param[in] peerAddrIn
vcoubard 1157:e1ea38b576c6 237 * Value for ConnectionCallbackParams_t::peerAddr
vcoubard 1157:e1ea38b576c6 238 * @param[in] ownAddrTypeIn
vcoubard 1157:e1ea38b576c6 239 * Value for ConnectionCallbackParams_t::ownAddrType
vcoubard 1157:e1ea38b576c6 240 * @param[in] ownAddrIn
vcoubard 1157:e1ea38b576c6 241 * Value for ConnectionCallbackParams_t::ownAddr
vcoubard 1157:e1ea38b576c6 242 * @param[in] connectionParamsIn
vcoubard 1157:e1ea38b576c6 243 * Value for ConnectionCallbackParams_t::connectionParams
vcoubard 1157:e1ea38b576c6 244 */
vcoubard 1136:22aada733dbd 245 ConnectionCallbackParams_t(Handle_t handleIn,
vcoubard 1136:22aada733dbd 246 Role_t roleIn,
vcoubard 1136:22aada733dbd 247 BLEProtocol::AddressType_t peerAddrTypeIn,
vcoubard 1136:22aada733dbd 248 const uint8_t *peerAddrIn,
vcoubard 1136:22aada733dbd 249 BLEProtocol::AddressType_t ownAddrTypeIn,
vcoubard 1136:22aada733dbd 250 const uint8_t *ownAddrIn,
vcoubard 1136:22aada733dbd 251 const ConnectionParams_t *connectionParamsIn) :
vcoubard 1132:692ddf04fc42 252 handle(handleIn),
vcoubard 1132:692ddf04fc42 253 role(roleIn),
vcoubard 1132:692ddf04fc42 254 peerAddrType(peerAddrTypeIn),
vcoubard 1132:692ddf04fc42 255 peerAddr(),
vcoubard 1132:692ddf04fc42 256 ownAddrType(ownAddrTypeIn),
vcoubard 1132:692ddf04fc42 257 ownAddr(),
vcoubard 1132:692ddf04fc42 258 connectionParams(connectionParamsIn) {
vcoubard 1132:692ddf04fc42 259 memcpy(peerAddr, peerAddrIn, ADDR_LEN);
vcoubard 1132:692ddf04fc42 260 memcpy(ownAddr, ownAddrIn, ADDR_LEN);
vcoubard 1132:692ddf04fc42 261 }
vcoubard 1132:692ddf04fc42 262 };
vcoubard 1132:692ddf04fc42 263
vcoubard 1157:e1ea38b576c6 264 /**
vcoubard 1157:e1ea38b576c6 265 * Structure that encapsulates information about a disconnection event.
vcoubard 1157:e1ea38b576c6 266 * Refer to Gap::onDisconnection().
vcoubard 1157:e1ea38b576c6 267 */
vcoubard 1132:692ddf04fc42 268 struct DisconnectionCallbackParams_t {
vcoubard 1157:e1ea38b576c6 269 Handle_t handle; /**< The ID of the connection that caused the disconnection event */
vcoubard 1157:e1ea38b576c6 270 DisconnectionReason_t reason; /**< The reason of the disconnection event */
vcoubard 1132:692ddf04fc42 271
vcoubard 1157:e1ea38b576c6 272 /**
vcoubard 1157:e1ea38b576c6 273 * Constructor for DisconnectionCallbackParams_t.
vcoubard 1157:e1ea38b576c6 274 *
vcoubard 1157:e1ea38b576c6 275 * @param[in] handleIn
vcoubard 1157:e1ea38b576c6 276 * Value for DisconnectionCallbackParams_t::handle.
vcoubard 1157:e1ea38b576c6 277 * @param[in] reasonIn
vcoubard 1157:e1ea38b576c6 278 * Value for DisconnectionCallbackParams_t::reason.
vcoubard 1157:e1ea38b576c6 279 */
vcoubard 1132:692ddf04fc42 280 DisconnectionCallbackParams_t(Handle_t handleIn,
vcoubard 1132:692ddf04fc42 281 DisconnectionReason_t reasonIn) :
vcoubard 1132:692ddf04fc42 282 handle(handleIn),
vcoubard 1132:692ddf04fc42 283 reason(reasonIn)
vcoubard 1132:692ddf04fc42 284 {}
vcoubard 1132:692ddf04fc42 285 };
vcoubard 1132:692ddf04fc42 286
vcoubard 1132:692ddf04fc42 287 static const uint16_t UNIT_1_25_MS = 1250; /**< Number of microseconds in 1.25 milliseconds. */
vcoubard 1157:e1ea38b576c6 288 /**
vcoubard 1157:e1ea38b576c6 289 * Helper function to convert from units of milliseconds to GAP duration
vcoubard 1157:e1ea38b576c6 290 * units.
vcoubard 1157:e1ea38b576c6 291 *
vcoubard 1157:e1ea38b576c6 292 * @param[in] durationInMillis
vcoubard 1157:e1ea38b576c6 293 * The duration in milliseconds.
vcoubard 1157:e1ea38b576c6 294 *
vcoubard 1157:e1ea38b576c6 295 * @return The duration in GAP duration units.
vcoubard 1157:e1ea38b576c6 296 */
vcoubard 1132:692ddf04fc42 297 static uint16_t MSEC_TO_GAP_DURATION_UNITS(uint32_t durationInMillis) {
vcoubard 1132:692ddf04fc42 298 return (durationInMillis * 1000) / UNIT_1_25_MS;
vcoubard 1132:692ddf04fc42 299 }
vcoubard 1132:692ddf04fc42 300
vcoubard 1157:e1ea38b576c6 301 /**
vcoubard 1157:e1ea38b576c6 302 * Type for the registered callbacks added to the timeout event callchain.
vcoubard 1157:e1ea38b576c6 303 * Refer to Gap::onTimeout().
vcoubard 1157:e1ea38b576c6 304 */
vcoubard 1132:692ddf04fc42 305 typedef FunctionPointerWithContext<TimeoutSource_t> TimeoutEventCallback_t;
vcoubard 1157:e1ea38b576c6 306 /**
vcoubard 1157:e1ea38b576c6 307 * Type for the timeout event callchain. Refer to Gap::onTimeout().
vcoubard 1157:e1ea38b576c6 308 */
vcoubard 1132:692ddf04fc42 309 typedef CallChainOfFunctionPointersWithContext<TimeoutSource_t> TimeoutEventCallbackChain_t;
vcoubard 1132:692ddf04fc42 310
vcoubard 1157:e1ea38b576c6 311 /**
vcoubard 1157:e1ea38b576c6 312 * Type for the registered callbacks added to the connection event
vcoubard 1157:e1ea38b576c6 313 * callchain. Refer to Gap::onConnection().
vcoubard 1157:e1ea38b576c6 314 */
vcoubard 1132:692ddf04fc42 315 typedef FunctionPointerWithContext<const ConnectionCallbackParams_t *> ConnectionEventCallback_t;
vcoubard 1157:e1ea38b576c6 316 /**
vcoubard 1157:e1ea38b576c6 317 * Type for the connection event callchain. Refer to Gap::onConnection().
vcoubard 1157:e1ea38b576c6 318 */
vcoubard 1132:692ddf04fc42 319 typedef CallChainOfFunctionPointersWithContext<const ConnectionCallbackParams_t *> ConnectionEventCallbackChain_t;
vcoubard 1132:692ddf04fc42 320
vcoubard 1157:e1ea38b576c6 321 /**
vcoubard 1157:e1ea38b576c6 322 * Type for the registered callbacks added to the disconnection event
vcoubard 1157:e1ea38b576c6 323 * callchain. Refer to Gap::onDisconnetion().
vcoubard 1157:e1ea38b576c6 324 */
vcoubard 1132:692ddf04fc42 325 typedef FunctionPointerWithContext<const DisconnectionCallbackParams_t*> DisconnectionEventCallback_t;
vcoubard 1157:e1ea38b576c6 326 /**
vcoubard 1157:e1ea38b576c6 327 * Type for the disconnection event callchain. Refer to Gap::onDisconnection().
vcoubard 1157:e1ea38b576c6 328 */
vcoubard 1133:6362b7c2fdff 329 typedef CallChainOfFunctionPointersWithContext<const DisconnectionCallbackParams_t*> DisconnectionEventCallbackChain_t;
vcoubard 1132:692ddf04fc42 330
vcoubard 1157:e1ea38b576c6 331 /**
vcoubard 1157:e1ea38b576c6 332 * Type for the handlers of radio notification callback events. Refer to
vcoubard 1157:e1ea38b576c6 333 * Gap::onRadioNotification().
vcoubard 1157:e1ea38b576c6 334 */
vcoubard 1132:692ddf04fc42 335 typedef FunctionPointerWithContext<bool> RadioNotificationEventCallback_t;
vcoubard 1132:692ddf04fc42 336
vcoubard 1157:e1ea38b576c6 337 /**
vcoubard 1157:e1ea38b576c6 338 * Type for the handlers of shutdown callback events. Refer to
vcoubard 1157:e1ea38b576c6 339 * Gap::onShutdown().
vcoubard 1157:e1ea38b576c6 340 */
vcoubard 1136:22aada733dbd 341 typedef FunctionPointerWithContext<const Gap *> GapShutdownCallback_t;
vcoubard 1157:e1ea38b576c6 342 /**
vcoubard 1157:e1ea38b576c6 343 * Type for the shutdown event callchain. Refer to Gap::onShutdown().
vcoubard 1157:e1ea38b576c6 344 */
vcoubard 1136:22aada733dbd 345 typedef CallChainOfFunctionPointersWithContext<const Gap *> GapShutdownCallbackChain_t;
vcoubard 1136:22aada733dbd 346
vcoubard 1132:692ddf04fc42 347 /*
vcoubard 1132:692ddf04fc42 348 * The following functions are meant to be overridden in the platform-specific sub-class.
vcoubard 1132:692ddf04fc42 349 */
vcoubard 1132:692ddf04fc42 350 public:
vcoubard 1132:692ddf04fc42 351 /**
vcoubard 1132:692ddf04fc42 352 * Set the BTLE MAC address and type. Please note that the address format is
vcoubard 1136:22aada733dbd 353 * least significant byte first (LSB). Please refer to BLEProtocol::AddressBytes_t.
vcoubard 1132:692ddf04fc42 354 *
vcoubard 1157:e1ea38b576c6 355 * @param[in] type
vcoubard 1157:e1ea38b576c6 356 * The type of the BLE address to set.
vcoubard 1157:e1ea38b576c6 357 * @param[in] address
vcoubard 1157:e1ea38b576c6 358 * The BLE address to set.
vcoubard 1157:e1ea38b576c6 359 *
vcoubard 1132:692ddf04fc42 360 * @return BLE_ERROR_NONE on success.
vcoubard 1132:692ddf04fc42 361 */
vcoubard 1136:22aada733dbd 362 virtual ble_error_t setAddress(BLEProtocol::AddressType_t type, const BLEProtocol::AddressBytes_t address) {
vcoubard 1132:692ddf04fc42 363 /* avoid compiler warnings about unused variables */
vcoubard 1132:692ddf04fc42 364 (void)type;
vcoubard 1132:692ddf04fc42 365 (void)address;
vcoubard 1132:692ddf04fc42 366
vcoubard 1132:692ddf04fc42 367 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 368 }
vcoubard 1132:692ddf04fc42 369
vcoubard 1132:692ddf04fc42 370 /**
vcoubard 1132:692ddf04fc42 371 * Fetch the BTLE MAC address and type.
vcoubard 1132:692ddf04fc42 372 *
vcoubard 1157:e1ea38b576c6 373 * @param[out] typeP
vcoubard 1157:e1ea38b576c6 374 * The current BLE address type.
vcoubard 1157:e1ea38b576c6 375 * @param[out] address
vcoubard 1157:e1ea38b576c6 376 * The current BLE address.
vcoubard 1157:e1ea38b576c6 377 *
vcoubard 1132:692ddf04fc42 378 * @return BLE_ERROR_NONE on success.
vcoubard 1132:692ddf04fc42 379 */
vcoubard 1136:22aada733dbd 380 virtual ble_error_t getAddress(BLEProtocol::AddressType_t *typeP, BLEProtocol::AddressBytes_t address) {
vcoubard 1132:692ddf04fc42 381 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 382 (void)typeP;
vcoubard 1132:692ddf04fc42 383 (void)address;
vcoubard 1132:692ddf04fc42 384
vcoubard 1132:692ddf04fc42 385 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 386 }
vcoubard 1132:692ddf04fc42 387
vcoubard 1132:692ddf04fc42 388 /**
vcoubard 1157:e1ea38b576c6 389 * Get the minimum advertising interval in milliseconds for connectable
vcoubard 1157:e1ea38b576c6 390 * undirected and connectable directed event types supported by the
vcoubard 1157:e1ea38b576c6 391 * underlying BLE stack.
vcoubard 1157:e1ea38b576c6 392 *
vcoubard 1135:d540a48f650d 393 * @return Minimum Advertising interval in milliseconds for connectable
vcoubard 1157:e1ea38b576c6 394 * undirected and connectable directed event types.
vcoubard 1132:692ddf04fc42 395 */
vcoubard 1132:692ddf04fc42 396 virtual uint16_t getMinAdvertisingInterval(void) const {
vcoubard 1132:692ddf04fc42 397 return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 398 }
vcoubard 1132:692ddf04fc42 399
vcoubard 1132:692ddf04fc42 400 /**
vcoubard 1157:e1ea38b576c6 401 * Get the minimum advertising interval in milliseconds for scannable
vcoubard 1157:e1ea38b576c6 402 * undirected and non-connectable undirected even types supported by the
vcoubard 1157:e1ea38b576c6 403 * underlying BLE stack.
vcoubard 1157:e1ea38b576c6 404 *
vcoubard 1135:d540a48f650d 405 * @return Minimum Advertising interval in milliseconds for scannable
vcoubard 1157:e1ea38b576c6 406 * undirected and non-connectable undirected event types.
vcoubard 1132:692ddf04fc42 407 */
vcoubard 1132:692ddf04fc42 408 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {
vcoubard 1132:692ddf04fc42 409 return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 410 }
vcoubard 1132:692ddf04fc42 411
vcoubard 1132:692ddf04fc42 412 /**
vcoubard 1157:e1ea38b576c6 413 * Get the maximum advertising interval in milliseconds for all event types
vcoubard 1157:e1ea38b576c6 414 * supported by the underlying BLE stack.
vcoubard 1157:e1ea38b576c6 415 *
vcoubard 1132:692ddf04fc42 416 * @return Maximum Advertising interval in milliseconds.
vcoubard 1132:692ddf04fc42 417 */
vcoubard 1132:692ddf04fc42 418 virtual uint16_t getMaxAdvertisingInterval(void) const {
vcoubard 1132:692ddf04fc42 419 return 0xFFFF; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 420 }
vcoubard 1132:692ddf04fc42 421
vcoubard 1157:e1ea38b576c6 422 /**
vcoubard 1157:e1ea38b576c6 423 * Stop advertising. The current advertising parameters remain in effect.
vcoubard 1157:e1ea38b576c6 424 *
vcoubard 1157:e1ea38b576c6 425 * @retval BLE_ERROR_NONE if successfully stopped advertising procedure.
vcoubard 1157:e1ea38b576c6 426 */
vcoubard 1132:692ddf04fc42 427 virtual ble_error_t stopAdvertising(void) {
vcoubard 1132:692ddf04fc42 428 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 429 }
vcoubard 1132:692ddf04fc42 430
vcoubard 1132:692ddf04fc42 431 /**
vcoubard 1132:692ddf04fc42 432 * Stop scanning. The current scanning parameters remain in effect.
vcoubard 1132:692ddf04fc42 433 *
vcoubard 1132:692ddf04fc42 434 * @retval BLE_ERROR_NONE if successfully stopped scanning procedure.
vcoubard 1132:692ddf04fc42 435 */
vcoubard 1132:692ddf04fc42 436 virtual ble_error_t stopScan() {
vcoubard 1132:692ddf04fc42 437 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 438 }
vcoubard 1132:692ddf04fc42 439
vcoubard 1132:692ddf04fc42 440 /**
vcoubard 1132:692ddf04fc42 441 * Create a connection (GAP Link Establishment).
vcoubard 1132:692ddf04fc42 442 *
vcoubard 1157:e1ea38b576c6 443 * @param[in] peerAddr
vcoubard 1157:e1ea38b576c6 444 * 48-bit address, LSB format.
vcoubard 1157:e1ea38b576c6 445 * @param[in] peerAddrType
vcoubard 1157:e1ea38b576c6 446 * Address type of the peer.
vcoubard 1157:e1ea38b576c6 447 * @param[in] connectionParams
vcoubard 1157:e1ea38b576c6 448 * Connection parameters.
vcoubard 1157:e1ea38b576c6 449 * @param[in] scanParams
vcoubard 1157:e1ea38b576c6 450 * Paramters to be used while scanning for the peer.
vcoubard 1157:e1ea38b576c6 451 *
vcoubard 1132:692ddf04fc42 452 * @return BLE_ERROR_NONE if connection establishment procedure is started
vcoubard 1157:e1ea38b576c6 453 * successfully. The connectionCallChain (if set) will be invoked upon
vcoubard 1157:e1ea38b576c6 454 * a connection event.
vcoubard 1132:692ddf04fc42 455 */
vcoubard 1136:22aada733dbd 456 virtual ble_error_t connect(const BLEProtocol::AddressBytes_t peerAddr,
vcoubard 1136:22aada733dbd 457 BLEProtocol::AddressType_t peerAddrType,
vcoubard 1136:22aada733dbd 458 const ConnectionParams_t *connectionParams,
vcoubard 1136:22aada733dbd 459 const GapScanningParams *scanParams) {
vcoubard 1132:692ddf04fc42 460 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 461 (void)peerAddr;
vcoubard 1132:692ddf04fc42 462 (void)peerAddrType;
vcoubard 1132:692ddf04fc42 463 (void)connectionParams;
vcoubard 1132:692ddf04fc42 464 (void)scanParams;
vcoubard 1132:692ddf04fc42 465
vcoubard 1132:692ddf04fc42 466 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 467 }
vcoubard 1132:692ddf04fc42 468
vcoubard 1132:692ddf04fc42 469 /**
vcoubard 1136:22aada733dbd 470 * Create a connection (GAP Link Establishment).
vcoubard 1136:22aada733dbd 471 *
vcoubard 1157:e1ea38b576c6 472 * @deprecated This funtion overloads Gap::connect(const BLEProtocol::Address_t peerAddr,
vcoubard 1157:e1ea38b576c6 473 * BLEProtocol::AddressType_t peerAddrType,
vcoubard 1157:e1ea38b576c6 474 * const ConnectionParams_t *connectionParams,
vcoubard 1157:e1ea38b576c6 475 * const GapScanningParams *scanParams)
vcoubard 1157:e1ea38b576c6 476 * to maintain backward compatibility for change from Gap::AddressType_t to
vcoubard 1157:e1ea38b576c6 477 * BLEProtocol::AddressType_t.
vcoubard 1136:22aada733dbd 478 */
vcoubard 1136:22aada733dbd 479 ble_error_t connect(const BLEProtocol::AddressBytes_t peerAddr,
vcoubard 1136:22aada733dbd 480 DeprecatedAddressType_t peerAddrType,
vcoubard 1136:22aada733dbd 481 const ConnectionParams_t *connectionParams,
vcoubard 1136:22aada733dbd 482 const GapScanningParams *scanParams)
vcoubard 1136:22aada733dbd 483 __deprecated_message("Gap::DeprecatedAddressType_t is deprecated, use BLEProtocol::AddressType_t instead") {
vcoubard 1136:22aada733dbd 484 return connect(peerAddr, (BLEProtocol::AddressType_t) peerAddrType, connectionParams, scanParams);
vcoubard 1136:22aada733dbd 485 }
vcoubard 1136:22aada733dbd 486
vcoubard 1136:22aada733dbd 487 /**
vcoubard 1132:692ddf04fc42 488 * This call initiates the disconnection procedure, and its completion will
vcoubard 1132:692ddf04fc42 489 * be communicated to the application with an invocation of the
vcoubard 1132:692ddf04fc42 490 * disconnectionCallback.
vcoubard 1132:692ddf04fc42 491 *
vcoubard 1157:e1ea38b576c6 492 * @param[in] reason
vcoubard 1157:e1ea38b576c6 493 * The reason for disconnection; to be sent back to the peer.
vcoubard 1157:e1ea38b576c6 494 * @param[in] connectionHandle
vcoubard 1157:e1ea38b576c6 495 * The handle of the connection to disconnect from.
vcoubard 1157:e1ea38b576c6 496 *
vcoubard 1157:e1ea38b576c6 497 * @return BLE_ERROR_NONE if disconnection was successful.
vcoubard 1132:692ddf04fc42 498 */
vcoubard 1132:692ddf04fc42 499 virtual ble_error_t disconnect(Handle_t connectionHandle, DisconnectionReason_t reason) {
vcoubard 1132:692ddf04fc42 500 /* avoid compiler warnings about unused variables */
vcoubard 1132:692ddf04fc42 501 (void)connectionHandle;
vcoubard 1132:692ddf04fc42 502 (void)reason;
vcoubard 1132:692ddf04fc42 503
vcoubard 1132:692ddf04fc42 504 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 505 }
vcoubard 1132:692ddf04fc42 506
vcoubard 1132:692ddf04fc42 507 /**
vcoubard 1132:692ddf04fc42 508 * This call initiates the disconnection procedure, and its completion will
vcoubard 1132:692ddf04fc42 509 * be communicated to the application with an invocation of the
vcoubard 1132:692ddf04fc42 510 * disconnectionCallback.
vcoubard 1132:692ddf04fc42 511 *
vcoubard 1157:e1ea38b576c6 512 * @param[in] reason
vcoubard 1157:e1ea38b576c6 513 * The reason for disconnection; to be sent back to the peer.
vcoubard 1157:e1ea38b576c6 514 *
vcoubard 1157:e1ea38b576c6 515 * @return BLE_ERROR_NONE if disconnection was successful.
vcoubard 1132:692ddf04fc42 516 *
vcoubard 1157:e1ea38b576c6 517 * @deprecated This version of disconnect() doesn't take a connection handle. It
vcoubard 1157:e1ea38b576c6 518 * works reliably only for stacks that are limited to a single
vcoubard 1157:e1ea38b576c6 519 * connection. Use instead Gap::disconnect(Handle_t connectionHandle,
vcoubard 1157:e1ea38b576c6 520 * DisconnectionReason_t reason) instead.
vcoubard 1132:692ddf04fc42 521 */
vcoubard 1132:692ddf04fc42 522 virtual ble_error_t disconnect(DisconnectionReason_t reason) {
vcoubard 1132:692ddf04fc42 523 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 524 (void)reason;
vcoubard 1132:692ddf04fc42 525
vcoubard 1132:692ddf04fc42 526 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 527 }
vcoubard 1132:692ddf04fc42 528
vcoubard 1132:692ddf04fc42 529 /**
vcoubard 1132:692ddf04fc42 530 * Get the GAP peripheral preferred connection parameters. These are the
vcoubard 1132:692ddf04fc42 531 * defaults that the peripheral would like to have in a connection. The
vcoubard 1132:692ddf04fc42 532 * choice of the connection parameters is eventually up to the central.
vcoubard 1132:692ddf04fc42 533 *
vcoubard 1132:692ddf04fc42 534 * @param[out] params
vcoubard 1132:692ddf04fc42 535 * The structure where the parameters will be stored. Memory
vcoubard 1132:692ddf04fc42 536 * for this is owned by the caller.
vcoubard 1132:692ddf04fc42 537 *
vcoubard 1132:692ddf04fc42 538 * @return BLE_ERROR_NONE if the parameters were successfully filled into
vcoubard 1157:e1ea38b576c6 539 * the given structure pointed to by params.
vcoubard 1132:692ddf04fc42 540 */
vcoubard 1132:692ddf04fc42 541 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) {
vcoubard 1132:692ddf04fc42 542 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 543 (void)params;
vcoubard 1132:692ddf04fc42 544
vcoubard 1132:692ddf04fc42 545 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 546 }
vcoubard 1132:692ddf04fc42 547
vcoubard 1132:692ddf04fc42 548 /**
vcoubard 1132:692ddf04fc42 549 * Set the GAP peripheral preferred connection parameters. These are the
vcoubard 1132:692ddf04fc42 550 * defaults that the peripheral would like to have in a connection. The
vcoubard 1132:692ddf04fc42 551 * choice of the connection parameters is eventually up to the central.
vcoubard 1132:692ddf04fc42 552 *
vcoubard 1132:692ddf04fc42 553 * @param[in] params
vcoubard 1132:692ddf04fc42 554 * The structure containing the desired parameters.
vcoubard 1157:e1ea38b576c6 555 *
vcoubard 1157:e1ea38b576c6 556 * @return BLE_ERROR_NONE if the preferred connection params were set
vcoubard 1157:e1ea38b576c6 557 * correctly.
vcoubard 1132:692ddf04fc42 558 */
vcoubard 1132:692ddf04fc42 559 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) {
vcoubard 1132:692ddf04fc42 560 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 561 (void)params;
vcoubard 1132:692ddf04fc42 562
vcoubard 1132:692ddf04fc42 563 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 564 }
vcoubard 1132:692ddf04fc42 565
vcoubard 1132:692ddf04fc42 566 /**
vcoubard 1157:e1ea38b576c6 567 * Update connection parameters. In the central role this will initiate a
vcoubard 1157:e1ea38b576c6 568 * Link Layer connection parameter update procedure. In the peripheral role,
vcoubard 1157:e1ea38b576c6 569 * this will send the corresponding L2CAP request and wait for the central
vcoubard 1157:e1ea38b576c6 570 * to perform the procedure.
vcoubard 1132:692ddf04fc42 571 *
vcoubard 1132:692ddf04fc42 572 * @param[in] handle
vcoubard 1132:692ddf04fc42 573 * Connection Handle.
vcoubard 1132:692ddf04fc42 574 * @param[in] params
vcoubard 1132:692ddf04fc42 575 * Pointer to desired connection parameters. If NULL is provided on a peripheral role,
vcoubard 1132:692ddf04fc42 576 * the parameters in the PPCP characteristic of the GAP service will be used instead.
vcoubard 1157:e1ea38b576c6 577 *
vcoubard 1157:e1ea38b576c6 578 * @return BLE_ERROR_NONE if the connection parameters were updated correctly.
vcoubard 1132:692ddf04fc42 579 */
vcoubard 1132:692ddf04fc42 580 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) {
vcoubard 1132:692ddf04fc42 581 /* avoid compiler warnings about unused variables */
vcoubard 1132:692ddf04fc42 582 (void)handle;
vcoubard 1132:692ddf04fc42 583 (void)params;
vcoubard 1132:692ddf04fc42 584
vcoubard 1132:692ddf04fc42 585 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 586 }
vcoubard 1132:692ddf04fc42 587
vcoubard 1132:692ddf04fc42 588 /**
vcoubard 1132:692ddf04fc42 589 * Set the device name characteristic in the GAP service.
vcoubard 1157:e1ea38b576c6 590 *
vcoubard 1132:692ddf04fc42 591 * @param[in] deviceName
vcoubard 1132:692ddf04fc42 592 * The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
vcoubard 1157:e1ea38b576c6 593 *
vcoubard 1157:e1ea38b576c6 594 * @return BLE_ERROR_NONE if the device name was set correctly.
vcoubard 1132:692ddf04fc42 595 */
vcoubard 1132:692ddf04fc42 596 virtual ble_error_t setDeviceName(const uint8_t *deviceName) {
vcoubard 1132:692ddf04fc42 597 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 598 (void)deviceName;
vcoubard 1132:692ddf04fc42 599
vcoubard 1132:692ddf04fc42 600 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 601 }
vcoubard 1132:692ddf04fc42 602
vcoubard 1132:692ddf04fc42 603 /**
vcoubard 1132:692ddf04fc42 604 * Get the value of the device name characteristic in the GAP service.
vcoubard 1157:e1ea38b576c6 605 *
vcoubard 1132:692ddf04fc42 606 * @param[out] deviceName
vcoubard 1132:692ddf04fc42 607 * Pointer to an empty buffer where the UTF-8 *non NULL-
vcoubard 1132:692ddf04fc42 608 * terminated* string will be placed. Set this
vcoubard 1132:692ddf04fc42 609 * value to NULL in order to obtain the deviceName-length
vcoubard 1132:692ddf04fc42 610 * from the 'length' parameter.
vcoubard 1132:692ddf04fc42 611 *
vcoubard 1157:e1ea38b576c6 612 * @param[in,out] lengthP
vcoubard 1132:692ddf04fc42 613 * (on input) Length of the buffer pointed to by deviceName;
vcoubard 1132:692ddf04fc42 614 * (on output) the complete device name length (without the
vcoubard 1132:692ddf04fc42 615 * null terminator).
vcoubard 1132:692ddf04fc42 616 *
vcoubard 1157:e1ea38b576c6 617 * @return BLE_ERROR_NONE if the device name was fetched correctly from the
vcoubard 1157:e1ea38b576c6 618 * underlying BLE stack.
vcoubard 1157:e1ea38b576c6 619 *
vcoubard 1132:692ddf04fc42 620 * @note If the device name is longer than the size of the supplied buffer,
vcoubard 1157:e1ea38b576c6 621 * length will return the complete device name length, and not the
vcoubard 1157:e1ea38b576c6 622 * number of bytes actually returned in deviceName. The application may
vcoubard 1157:e1ea38b576c6 623 * use this information to retry with a suitable buffer size.
vcoubard 1132:692ddf04fc42 624 */
vcoubard 1132:692ddf04fc42 625 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) {
vcoubard 1132:692ddf04fc42 626 /* avoid compiler warnings about unused variables */
vcoubard 1132:692ddf04fc42 627 (void)deviceName;
vcoubard 1132:692ddf04fc42 628 (void)lengthP;
vcoubard 1132:692ddf04fc42 629
vcoubard 1132:692ddf04fc42 630 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 631 }
vcoubard 1132:692ddf04fc42 632
vcoubard 1132:692ddf04fc42 633 /**
vcoubard 1132:692ddf04fc42 634 * Set the appearance characteristic in the GAP service.
vcoubard 1157:e1ea38b576c6 635 *
vcoubard 1132:692ddf04fc42 636 * @param[in] appearance
vcoubard 1132:692ddf04fc42 637 * The new value for the device-appearance.
vcoubard 1157:e1ea38b576c6 638 *
vcoubard 1157:e1ea38b576c6 639 * @return BLE_ERROR_NONE if the new appearance was set correctly.
vcoubard 1132:692ddf04fc42 640 */
vcoubard 1132:692ddf04fc42 641 virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance) {
vcoubard 1132:692ddf04fc42 642 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 643 (void)appearance;
vcoubard 1132:692ddf04fc42 644
vcoubard 1132:692ddf04fc42 645 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 646 }
vcoubard 1132:692ddf04fc42 647
vcoubard 1132:692ddf04fc42 648 /**
vcoubard 1132:692ddf04fc42 649 * Get the appearance characteristic in the GAP service.
vcoubard 1157:e1ea38b576c6 650 *
vcoubard 1132:692ddf04fc42 651 * @param[out] appearance
vcoubard 1157:e1ea38b576c6 652 * The current device-appearance value.
vcoubard 1157:e1ea38b576c6 653 *
vcoubard 1157:e1ea38b576c6 654 * @return BLE_ERROR_NONE if the device-appearance was fetched correctly
vcoubard 1157:e1ea38b576c6 655 * from the underlying BLE stack.
vcoubard 1132:692ddf04fc42 656 */
vcoubard 1132:692ddf04fc42 657 virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP) {
vcoubard 1132:692ddf04fc42 658 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 659 (void)appearanceP;
vcoubard 1132:692ddf04fc42 660
vcoubard 1132:692ddf04fc42 661 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 662 }
vcoubard 1132:692ddf04fc42 663
vcoubard 1132:692ddf04fc42 664 /**
vcoubard 1132:692ddf04fc42 665 * Set the radio's transmit power.
vcoubard 1157:e1ea38b576c6 666 *
vcoubard 1157:e1ea38b576c6 667 * @param[in] txPower
vcoubard 1157:e1ea38b576c6 668 * Radio's transmit power in dBm.
vcoubard 1157:e1ea38b576c6 669 *
vcoubard 1157:e1ea38b576c6 670 * @return BLE_ERROR_NONE if the new radio's transmit power was set
vcoubard 1157:e1ea38b576c6 671 * correctly.
vcoubard 1132:692ddf04fc42 672 */
vcoubard 1132:692ddf04fc42 673 virtual ble_error_t setTxPower(int8_t txPower) {
vcoubard 1132:692ddf04fc42 674 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 675 (void)txPower;
vcoubard 1132:692ddf04fc42 676
vcoubard 1132:692ddf04fc42 677 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 678 }
vcoubard 1132:692ddf04fc42 679
vcoubard 1132:692ddf04fc42 680 /**
vcoubard 1132:692ddf04fc42 681 * Query the underlying stack for permitted arguments for setTxPower().
vcoubard 1132:692ddf04fc42 682 *
vcoubard 1132:692ddf04fc42 683 * @param[out] valueArrayPP
vcoubard 1132:692ddf04fc42 684 * Out parameter to receive the immutable array of Tx values.
vcoubard 1132:692ddf04fc42 685 * @param[out] countP
vcoubard 1132:692ddf04fc42 686 * Out parameter to receive the array's size.
vcoubard 1132:692ddf04fc42 687 */
vcoubard 1132:692ddf04fc42 688 virtual void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP) {
vcoubard 1132:692ddf04fc42 689 /* Avoid compiler warnings about unused variables. */
vcoubard 1132:692ddf04fc42 690 (void)valueArrayPP;
vcoubard 1132:692ddf04fc42 691 (void)countP;
vcoubard 1132:692ddf04fc42 692
vcoubard 1132:692ddf04fc42 693 *countP = 0; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 694 }
vcoubard 1132:692ddf04fc42 695
vcoubard 1136:22aada733dbd 696 /**
vcoubard 1157:e1ea38b576c6 697 * Get the maximum size of the whitelist.
vcoubard 1157:e1ea38b576c6 698 *
vcoubard 1136:22aada733dbd 699 * @return Maximum size of the whitelist.
vcoubard 1136:22aada733dbd 700 *
vcoubard 1157:e1ea38b576c6 701 * @note If using mbed OS the size of the whitelist can be configured by
vcoubard 1157:e1ea38b576c6 702 * setting the YOTTA_CFG_WHITELIST_MAX_SIZE macro in your yotta
vcoubard 1157:e1ea38b576c6 703 * config file.
vcoubard 1157:e1ea38b576c6 704 *
vcoubard 1136:22aada733dbd 705 * @experimental
vcoubard 1136:22aada733dbd 706 */
vcoubard 1136:22aada733dbd 707 virtual uint8_t getMaxWhitelistSize(void) const
vcoubard 1136:22aada733dbd 708 {
vcoubard 1136:22aada733dbd 709 return 0;
vcoubard 1136:22aada733dbd 710 }
vcoubard 1136:22aada733dbd 711
vcoubard 1136:22aada733dbd 712 /**
vcoubard 1136:22aada733dbd 713 * Get the internal whitelist to be used by the Link Layer when scanning,
vcoubard 1136:22aada733dbd 714 * advertising or initiating a connection depending on the filter policies.
vcoubard 1136:22aada733dbd 715 *
vcoubard 1157:e1ea38b576c6 716 * @param[in,out] whitelist
vcoubard 1136:22aada733dbd 717 * (on input) whitelist.capacity contains the maximum number
vcoubard 1136:22aada733dbd 718 * of addresses to be returned.
vcoubard 1136:22aada733dbd 719 * (on output) The populated whitelist with copies of the
vcoubard 1136:22aada733dbd 720 * addresses in the implementation's whitelist.
vcoubard 1136:22aada733dbd 721 *
vcoubard 1136:22aada733dbd 722 * @return BLE_ERROR_NONE if the implementation's whitelist was successfully
vcoubard 1136:22aada733dbd 723 * copied into the supplied reference.
vcoubard 1136:22aada733dbd 724 *
vcoubard 1136:22aada733dbd 725 * @experimental
vcoubard 1136:22aada733dbd 726 */
vcoubard 1136:22aada733dbd 727 virtual ble_error_t getWhitelist(Whitelist_t &whitelist) const
vcoubard 1136:22aada733dbd 728 {
vcoubard 1136:22aada733dbd 729 (void) whitelist;
vcoubard 1136:22aada733dbd 730 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 1136:22aada733dbd 731 }
vcoubard 1136:22aada733dbd 732
vcoubard 1136:22aada733dbd 733 /**
vcoubard 1136:22aada733dbd 734 * Set the internal whitelist to be used by the Link Layer when scanning,
vcoubard 1136:22aada733dbd 735 * advertising or initiating a connection depending on the filter policies.
vcoubard 1136:22aada733dbd 736 *
vcoubard 1136:22aada733dbd 737 * @param[in] whitelist
vcoubard 1136:22aada733dbd 738 * A reference to a whitelist containing the addresses to
vcoubard 1136:22aada733dbd 739 * be added to the internal whitelist.
vcoubard 1136:22aada733dbd 740 *
vcoubard 1136:22aada733dbd 741 * @return BLE_ERROR_NONE if the implementation's whitelist was successfully
vcoubard 1136:22aada733dbd 742 * populated with the addresses in the given whitelist.
vcoubard 1136:22aada733dbd 743 *
vcoubard 1136:22aada733dbd 744 * @note The whitelist must not contain addresses of type @ref
vcoubard 1136:22aada733dbd 745 * BLEProtocol::AddressType_t::RANDOM_PRIVATE_NON_RESOLVABLE, this
vcoubard 1136:22aada733dbd 746 * this will result in a @ref BLE_ERROR_INVALID_PARAM since the
vcoubard 1136:22aada733dbd 747 * remote peer might change its private address at any time and it
vcoubard 1136:22aada733dbd 748 * is not possible to resolve it.
vcoubard 1136:22aada733dbd 749 * @note If the input whitelist is larger than @ref getMaxWhitelistSize()
vcoubard 1136:22aada733dbd 750 * the @ref BLE_ERROR_PARAM_OUT_OF_RANGE is returned.
vcoubard 1136:22aada733dbd 751 *
vcoubard 1136:22aada733dbd 752 * @experimental
vcoubard 1136:22aada733dbd 753 */
vcoubard 1136:22aada733dbd 754 virtual ble_error_t setWhitelist(const Whitelist_t &whitelist)
vcoubard 1136:22aada733dbd 755 {
vcoubard 1136:22aada733dbd 756 (void) whitelist;
vcoubard 1136:22aada733dbd 757 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 1136:22aada733dbd 758 }
vcoubard 1136:22aada733dbd 759
vcoubard 1136:22aada733dbd 760 /**
vcoubard 1136:22aada733dbd 761 * Set the advertising policy filter mode to be used in the next call
vcoubard 1136:22aada733dbd 762 * to startAdvertising().
vcoubard 1136:22aada733dbd 763 *
vcoubard 1136:22aada733dbd 764 * @param[in] mode
vcoubard 1136:22aada733dbd 765 * The new advertising policy filter mode.
vcoubard 1136:22aada733dbd 766 *
vcoubard 1136:22aada733dbd 767 * @return BLE_ERROR_NONE if the specified policy filter mode was set
vcoubard 1136:22aada733dbd 768 * successfully.
vcoubard 1136:22aada733dbd 769 *
vcoubard 1136:22aada733dbd 770 * @experimental
vcoubard 1136:22aada733dbd 771 */
vcoubard 1136:22aada733dbd 772 virtual ble_error_t setAdvertisingPolicyMode(AdvertisingPolicyMode_t mode)
vcoubard 1136:22aada733dbd 773 {
vcoubard 1136:22aada733dbd 774 (void) mode;
vcoubard 1136:22aada733dbd 775 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 1136:22aada733dbd 776 }
vcoubard 1136:22aada733dbd 777
vcoubard 1136:22aada733dbd 778 /**
vcoubard 1136:22aada733dbd 779 * Set the scan policy filter mode to be used in the next call
vcoubard 1136:22aada733dbd 780 * to startScan().
vcoubard 1136:22aada733dbd 781 *
vcoubard 1136:22aada733dbd 782 * @param[in] mode
vcoubard 1136:22aada733dbd 783 * The new scan policy filter mode.
vcoubard 1136:22aada733dbd 784 *
vcoubard 1136:22aada733dbd 785 * @return BLE_ERROR_NONE if the specified policy filter mode was set
vcoubard 1136:22aada733dbd 786 * successfully.
vcoubard 1136:22aada733dbd 787 *
vcoubard 1136:22aada733dbd 788 * @experimental
vcoubard 1136:22aada733dbd 789 */
vcoubard 1136:22aada733dbd 790 virtual ble_error_t setScanningPolicyMode(ScanningPolicyMode_t mode)
vcoubard 1136:22aada733dbd 791 {
vcoubard 1136:22aada733dbd 792 (void) mode;
vcoubard 1136:22aada733dbd 793 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 1136:22aada733dbd 794 }
vcoubard 1136:22aada733dbd 795
vcoubard 1136:22aada733dbd 796 /**
vcoubard 1136:22aada733dbd 797 * Set the initiator policy filter mode to be used.
vcoubard 1136:22aada733dbd 798 *
vcoubard 1136:22aada733dbd 799 * @param[in] mode
vcoubard 1136:22aada733dbd 800 * The new initiator policy filter mode.
vcoubard 1136:22aada733dbd 801 *
vcoubard 1136:22aada733dbd 802 * @return BLE_ERROR_NONE if the specified policy filter mode was set
vcoubard 1136:22aada733dbd 803 * successfully.
vcoubard 1136:22aada733dbd 804 *
vcoubard 1136:22aada733dbd 805 * @experimental
vcoubard 1136:22aada733dbd 806 */
vcoubard 1136:22aada733dbd 807 virtual ble_error_t setInitiatorPolicyMode(InitiatorPolicyMode_t mode)
vcoubard 1136:22aada733dbd 808 {
vcoubard 1136:22aada733dbd 809 (void) mode;
vcoubard 1136:22aada733dbd 810 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 1136:22aada733dbd 811 }
vcoubard 1136:22aada733dbd 812
vcoubard 1136:22aada733dbd 813 /**
vcoubard 1136:22aada733dbd 814 * Get the advertising policy filter mode that will be used in the next
vcoubard 1136:22aada733dbd 815 * call to startAdvertising().
vcoubard 1136:22aada733dbd 816 *
vcoubard 1136:22aada733dbd 817 * @return The set advertising policy filter mode.
vcoubard 1136:22aada733dbd 818 *
vcoubard 1136:22aada733dbd 819 * @experimental
vcoubard 1136:22aada733dbd 820 */
vcoubard 1136:22aada733dbd 821 virtual AdvertisingPolicyMode_t getAdvertisingPolicyMode(void) const
vcoubard 1136:22aada733dbd 822 {
vcoubard 1136:22aada733dbd 823 return ADV_POLICY_IGNORE_WHITELIST;
vcoubard 1136:22aada733dbd 824 }
vcoubard 1136:22aada733dbd 825
vcoubard 1136:22aada733dbd 826 /**
vcoubard 1136:22aada733dbd 827 * Get the scan policy filter mode that will be used in the next
vcoubard 1136:22aada733dbd 828 * call to startScan().
vcoubard 1136:22aada733dbd 829 *
vcoubard 1136:22aada733dbd 830 * @return The set scan policy filter mode.
vcoubard 1136:22aada733dbd 831 *
vcoubard 1136:22aada733dbd 832 * @experimental
vcoubard 1136:22aada733dbd 833 */
vcoubard 1136:22aada733dbd 834 virtual ScanningPolicyMode_t getScanningPolicyMode(void) const
vcoubard 1136:22aada733dbd 835 {
vcoubard 1136:22aada733dbd 836 return SCAN_POLICY_IGNORE_WHITELIST;
vcoubard 1136:22aada733dbd 837 }
vcoubard 1136:22aada733dbd 838
vcoubard 1136:22aada733dbd 839 /**
vcoubard 1136:22aada733dbd 840 * Get the initiator policy filter mode that will be used.
vcoubard 1136:22aada733dbd 841 *
vcoubard 1136:22aada733dbd 842 * @return The set scan policy filter mode.
vcoubard 1136:22aada733dbd 843 *
vcoubard 1136:22aada733dbd 844 * @experimental
vcoubard 1136:22aada733dbd 845 */
vcoubard 1136:22aada733dbd 846 virtual InitiatorPolicyMode_t getInitiatorPolicyMode(void) const
vcoubard 1136:22aada733dbd 847 {
vcoubard 1136:22aada733dbd 848 return INIT_POLICY_IGNORE_WHITELIST;
vcoubard 1136:22aada733dbd 849 }
vcoubard 1136:22aada733dbd 850
vcoubard 1136:22aada733dbd 851
vcoubard 1132:692ddf04fc42 852 protected:
vcoubard 1132:692ddf04fc42 853 /* Override the following in the underlying adaptation layer to provide the functionality of scanning. */
vcoubard 1157:e1ea38b576c6 854
vcoubard 1157:e1ea38b576c6 855 /**
vcoubard 1157:e1ea38b576c6 856 * Start scanning procedure in the underlying BLE stack.
vcoubard 1157:e1ea38b576c6 857 *
vcoubard 1157:e1ea38b576c6 858 * @param[in] scanningParams
vcoubard 1157:e1ea38b576c6 859 * The GAP scanning parameters.
vcoubard 1157:e1ea38b576c6 860 *
vcoubard 1157:e1ea38b576c6 861 * @return BLE_ERROR_NONE if the scan procedure started successfully.
vcoubard 1157:e1ea38b576c6 862 */
vcoubard 1132:692ddf04fc42 863 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams) {
vcoubard 1132:692ddf04fc42 864 (void)scanningParams;
vcoubard 1132:692ddf04fc42 865 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 866 }
vcoubard 1132:692ddf04fc42 867
vcoubard 1132:692ddf04fc42 868 /*
vcoubard 1132:692ddf04fc42 869 * APIs with non-virtual implementations.
vcoubard 1132:692ddf04fc42 870 */
vcoubard 1132:692ddf04fc42 871 public:
vcoubard 1132:692ddf04fc42 872 /**
vcoubard 1157:e1ea38b576c6 873 * Get the current GAP state of the device using a bitmask that
vcoubard 1132:692ddf04fc42 874 * describes whether the device is advertising or connected.
vcoubard 1157:e1ea38b576c6 875 *
vcoubard 1157:e1ea38b576c6 876 * @return The current GAP state of the device.
vcoubard 1132:692ddf04fc42 877 */
vcoubard 1132:692ddf04fc42 878 GapState_t getState(void) const {
vcoubard 1132:692ddf04fc42 879 return state;
vcoubard 1132:692ddf04fc42 880 }
vcoubard 1132:692ddf04fc42 881
vcoubard 1132:692ddf04fc42 882 /**
vcoubard 1132:692ddf04fc42 883 * Set the GAP advertising mode to use for this device.
vcoubard 1157:e1ea38b576c6 884 *
vcoubard 1157:e1ea38b576c6 885 * @param[in] advType
vcoubard 1157:e1ea38b576c6 886 * The new type of the advertising packets.
vcoubard 1132:692ddf04fc42 887 */
vcoubard 1132:692ddf04fc42 888 void setAdvertisingType(GapAdvertisingParams::AdvertisingType_t advType) {
vcoubard 1132:692ddf04fc42 889 _advParams.setAdvertisingType(advType);
vcoubard 1132:692ddf04fc42 890 }
vcoubard 1132:692ddf04fc42 891
vcoubard 1132:692ddf04fc42 892 /**
vcoubard 1157:e1ea38b576c6 893 * Set the advertising interval.
vcoubard 1157:e1ea38b576c6 894 *
vcoubard 1132:692ddf04fc42 895 * @param[in] interval
vcoubard 1132:692ddf04fc42 896 * Advertising interval in units of milliseconds. Advertising
vcoubard 1132:692ddf04fc42 897 * is disabled if interval is 0. If interval is smaller than
vcoubard 1132:692ddf04fc42 898 * the minimum supported value, then the minimum supported
vcoubard 1132:692ddf04fc42 899 * value is used instead. This minimum value can be discovered
vcoubard 1132:692ddf04fc42 900 * using getMinAdvertisingInterval().
vcoubard 1132:692ddf04fc42 901 *
vcoubard 1132:692ddf04fc42 902 * This field must be set to 0 if connectionMode is equal
vcoubard 1132:692ddf04fc42 903 * to ADV_CONNECTABLE_DIRECTED.
vcoubard 1132:692ddf04fc42 904 *
vcoubard 1157:e1ea38b576c6 905 * @note Decreasing this value will allow central devices to detect a
vcoubard 1157:e1ea38b576c6 906 * peripheral faster, at the expense of more power being used by the radio
vcoubard 1157:e1ea38b576c6 907 * due to the higher data transmit rate.
vcoubard 1132:692ddf04fc42 908 *
vcoubard 1157:e1ea38b576c6 909 * @note [WARNING] This API previously used 0.625ms as the unit for its
vcoubard 1157:e1ea38b576c6 910 * @p interval argument. That required an explicit conversion from
vcoubard 1157:e1ea38b576c6 911 * milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
vcoubard 1157:e1ea38b576c6 912 * no longer required as the new units are milliseconds. Any application
vcoubard 1157:e1ea38b576c6 913 * code depending on the old semantics needs to be updated accordingly.
vcoubard 1132:692ddf04fc42 914 */
vcoubard 1132:692ddf04fc42 915 void setAdvertisingInterval(uint16_t interval) {
vcoubard 1132:692ddf04fc42 916 if (interval == 0) {
vcoubard 1132:692ddf04fc42 917 stopAdvertising();
vcoubard 1132:692ddf04fc42 918 } else if (interval < getMinAdvertisingInterval()) {
vcoubard 1132:692ddf04fc42 919 interval = getMinAdvertisingInterval();
vcoubard 1132:692ddf04fc42 920 }
vcoubard 1132:692ddf04fc42 921 _advParams.setInterval(interval);
vcoubard 1132:692ddf04fc42 922 }
vcoubard 1132:692ddf04fc42 923
vcoubard 1132:692ddf04fc42 924 /**
vcoubard 1157:e1ea38b576c6 925 * Set the advertising timeout. The length of time to advertise for before
vcoubard 1157:e1ea38b576c6 926 * a timeout event is generated.
vcoubard 1157:e1ea38b576c6 927 *
vcoubard 1132:692ddf04fc42 928 * @param[in] timeout
vcoubard 1132:692ddf04fc42 929 * Advertising timeout (in seconds) between 0x1 and 0x3FFF (1
vcoubard 1132:692ddf04fc42 930 * and 16383). Use 0 to disable the advertising timeout.
vcoubard 1132:692ddf04fc42 931 */
vcoubard 1132:692ddf04fc42 932 void setAdvertisingTimeout(uint16_t timeout) {
vcoubard 1132:692ddf04fc42 933 _advParams.setTimeout(timeout);
vcoubard 1132:692ddf04fc42 934 }
vcoubard 1132:692ddf04fc42 935
vcoubard 1132:692ddf04fc42 936 /**
vcoubard 1132:692ddf04fc42 937 * Start advertising.
vcoubard 1157:e1ea38b576c6 938 *
vcoubard 1157:e1ea38b576c6 939 * @return BLE_ERROR_NONE if the device started advertising successfully.
vcoubard 1132:692ddf04fc42 940 */
vcoubard 1132:692ddf04fc42 941 ble_error_t startAdvertising(void) {
vcoubard 1132:692ddf04fc42 942 setAdvertisingData(); /* Update the underlying stack. */
vcoubard 1132:692ddf04fc42 943 return startAdvertising(_advParams);
vcoubard 1132:692ddf04fc42 944 }
vcoubard 1132:692ddf04fc42 945
vcoubard 1132:692ddf04fc42 946 /**
vcoubard 1132:692ddf04fc42 947 * Reset any advertising payload prepared from prior calls to
vcoubard 1132:692ddf04fc42 948 * accumulateAdvertisingPayload(). This automatically propagates the re-
vcoubard 1132:692ddf04fc42 949 * initialized advertising payload to the underlying stack.
vcoubard 1132:692ddf04fc42 950 */
vcoubard 1132:692ddf04fc42 951 void clearAdvertisingPayload(void) {
vcoubard 1132:692ddf04fc42 952 _advPayload.clear();
vcoubard 1132:692ddf04fc42 953 setAdvertisingData();
vcoubard 1132:692ddf04fc42 954 }
vcoubard 1132:692ddf04fc42 955
vcoubard 1132:692ddf04fc42 956 /**
vcoubard 1132:692ddf04fc42 957 * Accumulate an AD structure in the advertising payload. Please note that
vcoubard 1132:692ddf04fc42 958 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard 1132:692ddf04fc42 959 * as an additional 31 bytes if the advertising payload is too
vcoubard 1132:692ddf04fc42 960 * small.
vcoubard 1132:692ddf04fc42 961 *
vcoubard 1132:692ddf04fc42 962 * @param[in] flags
vcoubard 1132:692ddf04fc42 963 * The flags to be added. Please refer to
vcoubard 1132:692ddf04fc42 964 * GapAdvertisingData::Flags for valid flags. Multiple
vcoubard 1132:692ddf04fc42 965 * flags may be specified in combination.
vcoubard 1157:e1ea38b576c6 966 *
vcoubard 1157:e1ea38b576c6 967 * @return BLE_ERROR_NONE if the data was successfully added to the
vcoubard 1157:e1ea38b576c6 968 * advertising payload.
vcoubard 1132:692ddf04fc42 969 */
vcoubard 1132:692ddf04fc42 970 ble_error_t accumulateAdvertisingPayload(uint8_t flags) {
vcoubard 1132:692ddf04fc42 971 ble_error_t rc;
vcoubard 1132:692ddf04fc42 972 if ((rc = _advPayload.addFlags(flags)) != BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 973 return rc;
vcoubard 1132:692ddf04fc42 974 }
vcoubard 1132:692ddf04fc42 975
vcoubard 1132:692ddf04fc42 976 return setAdvertisingData();
vcoubard 1132:692ddf04fc42 977 }
vcoubard 1132:692ddf04fc42 978
vcoubard 1132:692ddf04fc42 979 /**
vcoubard 1132:692ddf04fc42 980 * Accumulate an AD structure in the advertising payload. Please note that
vcoubard 1132:692ddf04fc42 981 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard 1132:692ddf04fc42 982 * as an additional 31 bytes if the advertising payload is too
vcoubard 1132:692ddf04fc42 983 * small.
vcoubard 1132:692ddf04fc42 984 *
vcoubard 1157:e1ea38b576c6 985 * @param[in] app
vcoubard 1157:e1ea38b576c6 986 * The appearance of the peripheral.
vcoubard 1157:e1ea38b576c6 987 *
vcoubard 1157:e1ea38b576c6 988 * @return BLE_ERROR_NONE if the data was successfully added to the
vcoubard 1157:e1ea38b576c6 989 * advertising payload.
vcoubard 1132:692ddf04fc42 990 */
vcoubard 1132:692ddf04fc42 991 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app) {
vcoubard 1132:692ddf04fc42 992 setAppearance(app);
vcoubard 1132:692ddf04fc42 993
vcoubard 1132:692ddf04fc42 994 ble_error_t rc;
vcoubard 1132:692ddf04fc42 995 if ((rc = _advPayload.addAppearance(app)) != BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 996 return rc;
vcoubard 1132:692ddf04fc42 997 }
vcoubard 1132:692ddf04fc42 998
vcoubard 1132:692ddf04fc42 999 return setAdvertisingData();
vcoubard 1132:692ddf04fc42 1000 }
vcoubard 1132:692ddf04fc42 1001
vcoubard 1132:692ddf04fc42 1002 /**
vcoubard 1132:692ddf04fc42 1003 * Accumulate an AD structure in the advertising payload. Please note that
vcoubard 1132:692ddf04fc42 1004 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard 1132:692ddf04fc42 1005 * as an additional 31 bytes if the advertising payload is too
vcoubard 1132:692ddf04fc42 1006 * small.
vcoubard 1132:692ddf04fc42 1007 *
vcoubard 1157:e1ea38b576c6 1008 * @param[in] power
vcoubard 1157:e1ea38b576c6 1009 * The max transmit power to be used by the controller (in dBm).
vcoubard 1157:e1ea38b576c6 1010 *
vcoubard 1157:e1ea38b576c6 1011 * @return BLE_ERROR_NONE if the data was successfully added to the
vcoubard 1157:e1ea38b576c6 1012 * advertising payload.
vcoubard 1132:692ddf04fc42 1013 */
vcoubard 1132:692ddf04fc42 1014 ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power) {
vcoubard 1132:692ddf04fc42 1015 ble_error_t rc;
vcoubard 1132:692ddf04fc42 1016 if ((rc = _advPayload.addTxPower(power)) != BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 1017 return rc;
vcoubard 1132:692ddf04fc42 1018 }
vcoubard 1132:692ddf04fc42 1019
vcoubard 1132:692ddf04fc42 1020 return setAdvertisingData();
vcoubard 1132:692ddf04fc42 1021 }
vcoubard 1132:692ddf04fc42 1022
vcoubard 1132:692ddf04fc42 1023 /**
vcoubard 1132:692ddf04fc42 1024 * Accumulate a variable length byte-stream as an AD structure in the
vcoubard 1132:692ddf04fc42 1025 * advertising payload. Please note that the payload is limited to 31 bytes.
vcoubard 1132:692ddf04fc42 1026 * The SCAN_RESPONSE message may be used as an additional 31 bytes if the
vcoubard 1132:692ddf04fc42 1027 * advertising payload is too small.
vcoubard 1132:692ddf04fc42 1028 *
vcoubard 1157:e1ea38b576c6 1029 * @param[in] type
vcoubard 1157:e1ea38b576c6 1030 * The type describing the variable length data.
vcoubard 1157:e1ea38b576c6 1031 * @param[in] data
vcoubard 1157:e1ea38b576c6 1032 * Data bytes.
vcoubard 1157:e1ea38b576c6 1033 * @param[in] len
vcoubard 1157:e1ea38b576c6 1034 * Length of data.
vcoubard 1136:22aada733dbd 1035 *
vcoubard 1136:22aada733dbd 1036 * @return BLE_ERROR_NONE if the advertisement payload was updated based on
vcoubard 1136:22aada733dbd 1037 * matching AD type; otherwise, an appropriate error.
vcoubard 1136:22aada733dbd 1038 *
vcoubard 1136:22aada733dbd 1039 * @note When the specified AD type is INCOMPLETE_LIST_16BIT_SERVICE_IDS,
vcoubard 1136:22aada733dbd 1040 * COMPLETE_LIST_16BIT_SERVICE_IDS, INCOMPLETE_LIST_32BIT_SERVICE_IDS,
vcoubard 1136:22aada733dbd 1041 * COMPLETE_LIST_32BIT_SERVICE_IDS, INCOMPLETE_LIST_128BIT_SERVICE_IDS,
vcoubard 1136:22aada733dbd 1042 * COMPLETE_LIST_128BIT_SERVICE_IDS or LIST_128BIT_SOLICITATION_IDS the
vcoubard 1136:22aada733dbd 1043 * supplied value is appended to the values previously added to the
vcoubard 1136:22aada733dbd 1044 * payload.
vcoubard 1132:692ddf04fc42 1045 */
vcoubard 1132:692ddf04fc42 1046 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
vcoubard 1132:692ddf04fc42 1047 if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
vcoubard 1132:692ddf04fc42 1048 setDeviceName(data);
vcoubard 1132:692ddf04fc42 1049 }
vcoubard 1132:692ddf04fc42 1050
vcoubard 1132:692ddf04fc42 1051 ble_error_t rc;
vcoubard 1132:692ddf04fc42 1052 if ((rc = _advPayload.addData(type, data, len)) != BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 1053 return rc;
vcoubard 1132:692ddf04fc42 1054 }
vcoubard 1132:692ddf04fc42 1055
vcoubard 1132:692ddf04fc42 1056 return setAdvertisingData();
vcoubard 1132:692ddf04fc42 1057 }
vcoubard 1132:692ddf04fc42 1058
vcoubard 1132:692ddf04fc42 1059 /**
vcoubard 1132:692ddf04fc42 1060 * Update a particular ADV field in the advertising payload (based on
vcoubard 1136:22aada733dbd 1061 * matching type).
vcoubard 1132:692ddf04fc42 1062 *
vcoubard 1157:e1ea38b576c6 1063 * @param[in] type
vcoubard 1157:e1ea38b576c6 1064 * The ADV type field describing the variable length data.
vcoubard 1157:e1ea38b576c6 1065 * @param[in] data
vcoubard 1157:e1ea38b576c6 1066 * Data bytes.
vcoubard 1157:e1ea38b576c6 1067 * @param[in] len
vcoubard 1157:e1ea38b576c6 1068 * Length of data.
vcoubard 1132:692ddf04fc42 1069 *
vcoubard 1157:e1ea38b576c6 1070 * @note If advertisements are enabled, then the update will take effect immediately.
vcoubard 1132:692ddf04fc42 1071 *
vcoubard 1132:692ddf04fc42 1072 * @return BLE_ERROR_NONE if the advertisement payload was updated based on
vcoubard 1136:22aada733dbd 1073 * matching AD type; otherwise, an appropriate error.
vcoubard 1132:692ddf04fc42 1074 */
vcoubard 1132:692ddf04fc42 1075 ble_error_t updateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
vcoubard 1132:692ddf04fc42 1076 if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
vcoubard 1132:692ddf04fc42 1077 setDeviceName(data);
vcoubard 1132:692ddf04fc42 1078 }
vcoubard 1132:692ddf04fc42 1079
vcoubard 1132:692ddf04fc42 1080 ble_error_t rc;
vcoubard 1132:692ddf04fc42 1081 if ((rc = _advPayload.updateData(type, data, len)) != BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 1082 return rc;
vcoubard 1132:692ddf04fc42 1083 }
vcoubard 1132:692ddf04fc42 1084
vcoubard 1132:692ddf04fc42 1085 return setAdvertisingData();
vcoubard 1132:692ddf04fc42 1086 }
vcoubard 1132:692ddf04fc42 1087
vcoubard 1132:692ddf04fc42 1088 /**
vcoubard 1132:692ddf04fc42 1089 * Set up a particular, user-constructed advertisement payload for the
vcoubard 1132:692ddf04fc42 1090 * underlying stack. It would be uncommon for this API to be used directly;
vcoubard 1157:e1ea38b576c6 1091 * there are other APIs to build an advertisement payload (refer to
vcoubard 1157:e1ea38b576c6 1092 * Gap::accumulateAdvertisingPayload()).
vcoubard 1157:e1ea38b576c6 1093 *
vcoubard 1157:e1ea38b576c6 1094 * @param[in] payload
vcoubard 1157:e1ea38b576c6 1095 * A reference to a user constructed advertisement
vcoubard 1157:e1ea38b576c6 1096 * payload.
vcoubard 1157:e1ea38b576c6 1097 *
vcoubard 1157:e1ea38b576c6 1098 * @return BLE_ERROR_NONE if the advertisement payload was successfully
vcoubard 1157:e1ea38b576c6 1099 * set.
vcoubard 1132:692ddf04fc42 1100 */
vcoubard 1132:692ddf04fc42 1101 ble_error_t setAdvertisingPayload(const GapAdvertisingData &payload) {
vcoubard 1132:692ddf04fc42 1102 _advPayload = payload;
vcoubard 1132:692ddf04fc42 1103 return setAdvertisingData();
vcoubard 1132:692ddf04fc42 1104 }
vcoubard 1132:692ddf04fc42 1105
vcoubard 1132:692ddf04fc42 1106 /**
vcoubard 1157:e1ea38b576c6 1107 * Get a reference to the advertising payload.
vcoubard 1157:e1ea38b576c6 1108 *
vcoubard 1157:e1ea38b576c6 1109 * @return Read back advertising data.
vcoubard 1157:e1ea38b576c6 1110 *
vcoubard 1157:e1ea38b576c6 1111 * @note Useful for storing and restoring payload.
vcoubard 1132:692ddf04fc42 1112 */
vcoubard 1132:692ddf04fc42 1113 const GapAdvertisingData &getAdvertisingPayload(void) const {
vcoubard 1132:692ddf04fc42 1114 return _advPayload;
vcoubard 1132:692ddf04fc42 1115 }
vcoubard 1132:692ddf04fc42 1116
vcoubard 1132:692ddf04fc42 1117 /**
vcoubard 1132:692ddf04fc42 1118 * Accumulate a variable length byte-stream as an AD structure in the
vcoubard 1132:692ddf04fc42 1119 * scanResponse payload.
vcoubard 1132:692ddf04fc42 1120 *
vcoubard 1157:e1ea38b576c6 1121 * @param[in] type
vcoubard 1157:e1ea38b576c6 1122 * The type describing the variable length data.
vcoubard 1157:e1ea38b576c6 1123 * @param[in] data
vcoubard 1157:e1ea38b576c6 1124 * Data bytes.
vcoubard 1157:e1ea38b576c6 1125 * @param[in] len
vcoubard 1157:e1ea38b576c6 1126 * Length of data.
vcoubard 1157:e1ea38b576c6 1127 *
vcoubard 1157:e1ea38b576c6 1128 * @return BLE_ERROR_NONE if the data was successfully added to the scan
vcoubard 1157:e1ea38b576c6 1129 * response payload.
vcoubard 1132:692ddf04fc42 1130 */
vcoubard 1132:692ddf04fc42 1131 ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
vcoubard 1132:692ddf04fc42 1132 ble_error_t rc;
vcoubard 1132:692ddf04fc42 1133 if ((rc = _scanResponse.addData(type, data, len)) != BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 1134 return rc;
vcoubard 1132:692ddf04fc42 1135 }
vcoubard 1132:692ddf04fc42 1136
vcoubard 1132:692ddf04fc42 1137 return setAdvertisingData();
vcoubard 1132:692ddf04fc42 1138 }
vcoubard 1132:692ddf04fc42 1139
vcoubard 1132:692ddf04fc42 1140 /**
vcoubard 1132:692ddf04fc42 1141 * Reset any scan response prepared from prior calls to
vcoubard 1157:e1ea38b576c6 1142 * Gap::accumulateScanResponse().
vcoubard 1132:692ddf04fc42 1143 *
vcoubard 1157:e1ea38b576c6 1144 * @note This should be followed by a call to Gap::setAdvertisingPayload() or
vcoubard 1157:e1ea38b576c6 1145 * Gap::startAdvertising() before the update takes effect.
vcoubard 1132:692ddf04fc42 1146 */
vcoubard 1132:692ddf04fc42 1147 void clearScanResponse(void) {
vcoubard 1132:692ddf04fc42 1148 _scanResponse.clear();
vcoubard 1132:692ddf04fc42 1149 setAdvertisingData();
vcoubard 1132:692ddf04fc42 1150 }
vcoubard 1132:692ddf04fc42 1151
vcoubard 1132:692ddf04fc42 1152 /**
vcoubard 1132:692ddf04fc42 1153 * Set up parameters for GAP scanning (observer mode).
vcoubard 1157:e1ea38b576c6 1154 *
vcoubard 1132:692ddf04fc42 1155 * @param[in] interval
vcoubard 1132:692ddf04fc42 1156 * Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
vcoubard 1132:692ddf04fc42 1157 * @param[in] window
vcoubard 1132:692ddf04fc42 1158 * Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
vcoubard 1132:692ddf04fc42 1159 * @param[in] timeout
vcoubard 1132:692ddf04fc42 1160 * Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables the timeout.
vcoubard 1132:692ddf04fc42 1161 * @param[in] activeScanning
vcoubard 1132:692ddf04fc42 1162 * Set to True if active-scanning is required. This is used to fetch the
vcoubard 1132:692ddf04fc42 1163 * scan response from a peer if possible.
vcoubard 1132:692ddf04fc42 1164 *
vcoubard 1157:e1ea38b576c6 1165 * @return BLE_ERROR_NONE if the scan parameters were correctly set.
vcoubard 1132:692ddf04fc42 1166 *
vcoubard 1157:e1ea38b576c6 1167 * @note The scanning window divided by the interval determines the duty cycle for
vcoubard 1157:e1ea38b576c6 1168 * scanning. For example, if the interval is 100ms and the window is 10ms,
vcoubard 1157:e1ea38b576c6 1169 * then the controller will scan for 10 percent of the time. It is possible
vcoubard 1157:e1ea38b576c6 1170 * to have the interval and window set to the same value. In this case,
vcoubard 1157:e1ea38b576c6 1171 * scanning is continuous, with a change of scanning frequency once every
vcoubard 1157:e1ea38b576c6 1172 * interval.
vcoubard 1132:692ddf04fc42 1173 *
vcoubard 1157:e1ea38b576c6 1174 * @note Once the scanning parameters have been configured, scanning can be
vcoubard 1157:e1ea38b576c6 1175 * enabled by using startScan().
vcoubard 1157:e1ea38b576c6 1176 *
vcoubard 1157:e1ea38b576c6 1177 * @note The scan interval and window are recommendations to the BLE stack.
vcoubard 1132:692ddf04fc42 1178 */
vcoubard 1132:692ddf04fc42 1179 ble_error_t setScanParams(uint16_t interval = GapScanningParams::SCAN_INTERVAL_MAX,
vcoubard 1132:692ddf04fc42 1180 uint16_t window = GapScanningParams::SCAN_WINDOW_MAX,
vcoubard 1132:692ddf04fc42 1181 uint16_t timeout = 0,
vcoubard 1132:692ddf04fc42 1182 bool activeScanning = false) {
vcoubard 1132:692ddf04fc42 1183 ble_error_t rc;
vcoubard 1132:692ddf04fc42 1184 if (((rc = _scanningParams.setInterval(interval)) == BLE_ERROR_NONE) &&
vcoubard 1132:692ddf04fc42 1185 ((rc = _scanningParams.setWindow(window)) == BLE_ERROR_NONE) &&
vcoubard 1132:692ddf04fc42 1186 ((rc = _scanningParams.setTimeout(timeout)) == BLE_ERROR_NONE)) {
vcoubard 1132:692ddf04fc42 1187 _scanningParams.setActiveScanning(activeScanning);
vcoubard 1132:692ddf04fc42 1188 return BLE_ERROR_NONE;
vcoubard 1132:692ddf04fc42 1189 }
vcoubard 1132:692ddf04fc42 1190
vcoubard 1132:692ddf04fc42 1191 return rc;
vcoubard 1132:692ddf04fc42 1192 }
vcoubard 1132:692ddf04fc42 1193
vcoubard 1132:692ddf04fc42 1194 /**
vcoubard 1132:692ddf04fc42 1195 * Set up the scanInterval parameter for GAP scanning (observer mode).
vcoubard 1157:e1ea38b576c6 1196 *
vcoubard 1132:692ddf04fc42 1197 * @param[in] interval
vcoubard 1132:692ddf04fc42 1198 * Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
vcoubard 1132:692ddf04fc42 1199 *
vcoubard 1157:e1ea38b576c6 1200 * @return BLE_ERROR_NONE if the scan interval was correctly set.
vcoubard 1132:692ddf04fc42 1201 *
vcoubard 1157:e1ea38b576c6 1202 * @note The scanning window divided by the interval determines the duty cycle for
vcoubard 1157:e1ea38b576c6 1203 * scanning. For example, if the interval is 100ms and the window is 10ms,
vcoubard 1157:e1ea38b576c6 1204 * then the controller will scan for 10 percent of the time. It is possible
vcoubard 1157:e1ea38b576c6 1205 * to have the interval and window set to the same value. In this case,
vcoubard 1157:e1ea38b576c6 1206 * scanning is continuous, with a change of scanning frequency once every
vcoubard 1157:e1ea38b576c6 1207 * interval.
vcoubard 1157:e1ea38b576c6 1208 *
vcoubard 1157:e1ea38b576c6 1209 * @note Once the scanning parameters have been configured, scanning can be
vcoubard 1157:e1ea38b576c6 1210 * enabled by using startScan().
vcoubard 1132:692ddf04fc42 1211 */
vcoubard 1132:692ddf04fc42 1212 ble_error_t setScanInterval(uint16_t interval) {
vcoubard 1132:692ddf04fc42 1213 return _scanningParams.setInterval(interval);
vcoubard 1132:692ddf04fc42 1214 }
vcoubard 1132:692ddf04fc42 1215
vcoubard 1132:692ddf04fc42 1216 /**
vcoubard 1132:692ddf04fc42 1217 * Set up the scanWindow parameter for GAP scanning (observer mode).
vcoubard 1157:e1ea38b576c6 1218 *
vcoubard 1132:692ddf04fc42 1219 * @param[in] window
vcoubard 1132:692ddf04fc42 1220 * Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
vcoubard 1132:692ddf04fc42 1221 *
vcoubard 1157:e1ea38b576c6 1222 * @return BLE_ERROR_NONE if the scan window was correctly set.
vcoubard 1132:692ddf04fc42 1223 *
vcoubard 1157:e1ea38b576c6 1224 * @note The scanning window divided by the interval determines the duty cycle for
vcoubard 1157:e1ea38b576c6 1225 * scanning. For example, if the interval is 100ms and the window is 10ms,
vcoubard 1157:e1ea38b576c6 1226 * then the controller will scan for 10 percent of the time. It is possible
vcoubard 1157:e1ea38b576c6 1227 * to have the interval and window set to the same value. In this case,
vcoubard 1157:e1ea38b576c6 1228 * scanning is continuous, with a change of scanning frequency once every
vcoubard 1157:e1ea38b576c6 1229 * interval.
vcoubard 1132:692ddf04fc42 1230 *
vcoubard 1157:e1ea38b576c6 1231 * @note Once the scanning parameters have been configured, scanning can be
vcoubard 1157:e1ea38b576c6 1232 * enabled by using startScan().
vcoubard 1157:e1ea38b576c6 1233 *
vcoubard 1157:e1ea38b576c6 1234 * @note If scanning is already active, the updated value of scanWindow will be
vcoubard 1157:e1ea38b576c6 1235 * propagated to the underlying BLE stack.
vcoubard 1132:692ddf04fc42 1236 */
vcoubard 1132:692ddf04fc42 1237 ble_error_t setScanWindow(uint16_t window) {
vcoubard 1132:692ddf04fc42 1238 ble_error_t rc;
vcoubard 1132:692ddf04fc42 1239 if ((rc = _scanningParams.setWindow(window)) != BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 1240 return rc;
vcoubard 1132:692ddf04fc42 1241 }
vcoubard 1132:692ddf04fc42 1242
vcoubard 1132:692ddf04fc42 1243 /* If scanning is already active, propagate the new setting to the stack. */
vcoubard 1132:692ddf04fc42 1244 if (scanningActive) {
vcoubard 1132:692ddf04fc42 1245 return startRadioScan(_scanningParams);
vcoubard 1132:692ddf04fc42 1246 }
vcoubard 1132:692ddf04fc42 1247
vcoubard 1132:692ddf04fc42 1248 return BLE_ERROR_NONE;
vcoubard 1132:692ddf04fc42 1249 }
vcoubard 1132:692ddf04fc42 1250
vcoubard 1132:692ddf04fc42 1251 /**
vcoubard 1132:692ddf04fc42 1252 * Set up parameters for GAP scanning (observer mode).
vcoubard 1157:e1ea38b576c6 1253 *
vcoubard 1132:692ddf04fc42 1254 * @param[in] timeout
vcoubard 1132:692ddf04fc42 1255 * Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables the timeout.
vcoubard 1132:692ddf04fc42 1256 *
vcoubard 1157:e1ea38b576c6 1257 * @return BLE_ERROR_NONE if the scan timeout was correctly set.
vcoubard 1132:692ddf04fc42 1258 *
vcoubard 1157:e1ea38b576c6 1259 * @note Once the scanning parameters have been configured, scanning can be
vcoubard 1157:e1ea38b576c6 1260 * enabled by using startScan().
vcoubard 1157:e1ea38b576c6 1261 *
vcoubard 1157:e1ea38b576c6 1262 * @note If scanning is already active, the updated value of scanTimeout will be
vcoubard 1157:e1ea38b576c6 1263 * propagated to the underlying BLE stack.
vcoubard 1132:692ddf04fc42 1264 */
vcoubard 1132:692ddf04fc42 1265 ble_error_t setScanTimeout(uint16_t timeout) {
vcoubard 1132:692ddf04fc42 1266 ble_error_t rc;
vcoubard 1132:692ddf04fc42 1267 if ((rc = _scanningParams.setTimeout(timeout)) != BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 1268 return rc;
vcoubard 1132:692ddf04fc42 1269 }
vcoubard 1132:692ddf04fc42 1270
vcoubard 1132:692ddf04fc42 1271 /* If scanning is already active, propagate the new settings to the stack. */
vcoubard 1132:692ddf04fc42 1272 if (scanningActive) {
vcoubard 1132:692ddf04fc42 1273 return startRadioScan(_scanningParams);
vcoubard 1132:692ddf04fc42 1274 }
vcoubard 1132:692ddf04fc42 1275
vcoubard 1132:692ddf04fc42 1276 return BLE_ERROR_NONE;
vcoubard 1132:692ddf04fc42 1277 }
vcoubard 1132:692ddf04fc42 1278
vcoubard 1132:692ddf04fc42 1279 /**
vcoubard 1157:e1ea38b576c6 1280 * Modify the active scanning parameter for GAP scanning (observer mode).
vcoubard 1157:e1ea38b576c6 1281 * This is used to fetch the scan response from a peer if possible.
vcoubard 1157:e1ea38b576c6 1282 *
vcoubard 1132:692ddf04fc42 1283 * @param[in] activeScanning
vcoubard 1157:e1ea38b576c6 1284 * Set to True if active-scanning is required.
vcoubard 1132:692ddf04fc42 1285 *
vcoubard 1157:e1ea38b576c6 1286 * @return BLE_ERROR_NONE if active scanning was successfully set.
vcoubard 1132:692ddf04fc42 1287 *
vcoubard 1157:e1ea38b576c6 1288 * @note Once the scanning parameters have been configured, scanning can be
vcoubard 1157:e1ea38b576c6 1289 * enabled by using startScan().
vcoubard 1157:e1ea38b576c6 1290 *
vcoubard 1157:e1ea38b576c6 1291 * @note If scanning is already in progress, then active-scanning will be enabled
vcoubard 1157:e1ea38b576c6 1292 * for the underlying BLE stack.
vcoubard 1132:692ddf04fc42 1293 */
vcoubard 1132:692ddf04fc42 1294 ble_error_t setActiveScanning(bool activeScanning) {
vcoubard 1132:692ddf04fc42 1295 _scanningParams.setActiveScanning(activeScanning);
vcoubard 1132:692ddf04fc42 1296
vcoubard 1132:692ddf04fc42 1297 /* If scanning is already active, propagate the new settings to the stack. */
vcoubard 1132:692ddf04fc42 1298 if (scanningActive) {
vcoubard 1132:692ddf04fc42 1299 return startRadioScan(_scanningParams);
vcoubard 1132:692ddf04fc42 1300 }
vcoubard 1132:692ddf04fc42 1301
vcoubard 1132:692ddf04fc42 1302 return BLE_ERROR_NONE;
vcoubard 1132:692ddf04fc42 1303 }
vcoubard 1132:692ddf04fc42 1304
vcoubard 1132:692ddf04fc42 1305 /**
vcoubard 1132:692ddf04fc42 1306 * Start scanning (Observer Procedure) based on the parameters currently in
vcoubard 1132:692ddf04fc42 1307 * effect.
vcoubard 1132:692ddf04fc42 1308 *
vcoubard 1132:692ddf04fc42 1309 * @param[in] callback
vcoubard 1132:692ddf04fc42 1310 * The application-specific callback to be invoked upon
vcoubard 1132:692ddf04fc42 1311 * receiving every advertisement report. This can be passed in
vcoubard 1132:692ddf04fc42 1312 * as NULL, in which case scanning may not be enabled at all.
vcoubard 1157:e1ea38b576c6 1313 *
vcoubard 1157:e1ea38b576c6 1314 * @return BLE_ERROR_NONE if the device successfully started the scan
vcoubard 1157:e1ea38b576c6 1315 * procedure.
vcoubard 1132:692ddf04fc42 1316 */
vcoubard 1132:692ddf04fc42 1317 ble_error_t startScan(void (*callback)(const AdvertisementCallbackParams_t *params)) {
vcoubard 1132:692ddf04fc42 1318 ble_error_t err = BLE_ERROR_NONE;
vcoubard 1132:692ddf04fc42 1319 if (callback) {
vcoubard 1132:692ddf04fc42 1320 if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 1321 scanningActive = true;
vcoubard 1132:692ddf04fc42 1322 onAdvertisementReport.attach(callback);
vcoubard 1132:692ddf04fc42 1323 }
vcoubard 1132:692ddf04fc42 1324 }
vcoubard 1132:692ddf04fc42 1325
vcoubard 1132:692ddf04fc42 1326 return err;
vcoubard 1132:692ddf04fc42 1327 }
vcoubard 1132:692ddf04fc42 1328
vcoubard 1132:692ddf04fc42 1329 /**
vcoubard 1157:e1ea38b576c6 1330 * Same Gap::startScan(), but allows the possibility to add an object
vcoubard 1157:e1ea38b576c6 1331 * reference and member function as handler for advertisement event
vcoubard 1157:e1ea38b576c6 1332 * callbacks.
vcoubard 1157:e1ea38b576c6 1333 *
vcoubard 1157:e1ea38b576c6 1334 * @param[in] object
vcoubard 1157:e1ea38b576c6 1335 * Pointer to the object of a class defining the member callback
vcoubard 1157:e1ea38b576c6 1336 * function (@p callbackMember).
vcoubard 1157:e1ea38b576c6 1337 * @param[in] callbackMember
vcoubard 1157:e1ea38b576c6 1338 * The member callback (within the context of an object) to be
vcoubard 1157:e1ea38b576c6 1339 * invoked.
vcoubard 1157:e1ea38b576c6 1340 *
vcoubard 1157:e1ea38b576c6 1341 * @return BLE_ERROR_NONE if the device successfully started the scan
vcoubard 1157:e1ea38b576c6 1342 * procedure.
vcoubard 1132:692ddf04fc42 1343 */
vcoubard 1132:692ddf04fc42 1344 template<typename T>
vcoubard 1132:692ddf04fc42 1345 ble_error_t startScan(T *object, void (T::*callbackMember)(const AdvertisementCallbackParams_t *params)) {
vcoubard 1132:692ddf04fc42 1346 ble_error_t err = BLE_ERROR_NONE;
vcoubard 1132:692ddf04fc42 1347 if (object && callbackMember) {
vcoubard 1132:692ddf04fc42 1348 if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
vcoubard 1132:692ddf04fc42 1349 scanningActive = true;
vcoubard 1132:692ddf04fc42 1350 onAdvertisementReport.attach(object, callbackMember);
vcoubard 1132:692ddf04fc42 1351 }
vcoubard 1132:692ddf04fc42 1352 }
vcoubard 1132:692ddf04fc42 1353
vcoubard 1132:692ddf04fc42 1354 return err;
vcoubard 1132:692ddf04fc42 1355 }
vcoubard 1132:692ddf04fc42 1356
vcoubard 1132:692ddf04fc42 1357 /**
vcoubard 1132:692ddf04fc42 1358 * Initialize radio-notification events to be generated from the stack.
vcoubard 1132:692ddf04fc42 1359 * This API doesn't need to be called directly.
vcoubard 1132:692ddf04fc42 1360 *
vcoubard 1132:692ddf04fc42 1361 * Radio Notification is a feature that enables ACTIVE and INACTIVE
vcoubard 1132:692ddf04fc42 1362 * (nACTIVE) signals from the stack that notify the application when the
vcoubard 1132:692ddf04fc42 1363 * radio is in use.
vcoubard 1132:692ddf04fc42 1364 *
vcoubard 1132:692ddf04fc42 1365 * The ACTIVE signal is sent before the radio event starts. The nACTIVE
vcoubard 1132:692ddf04fc42 1366 * signal is sent at the end of the radio event. These signals can be used
vcoubard 1132:692ddf04fc42 1367 * by the application programmer to synchronize application logic with radio
vcoubard 1132:692ddf04fc42 1368 * activity. For example, the ACTIVE signal can be used to shut off external
vcoubard 1132:692ddf04fc42 1369 * devices, to manage peak current drawn during periods when the radio is on,
vcoubard 1132:692ddf04fc42 1370 * or to trigger sensor data collection for transmission in the Radio Event.
vcoubard 1132:692ddf04fc42 1371 *
vcoubard 1132:692ddf04fc42 1372 * @return BLE_ERROR_NONE on successful initialization, otherwise an error code.
vcoubard 1132:692ddf04fc42 1373 */
vcoubard 1132:692ddf04fc42 1374 virtual ble_error_t initRadioNotification(void) {
vcoubard 1132:692ddf04fc42 1375 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
vcoubard 1132:692ddf04fc42 1376 }
vcoubard 1132:692ddf04fc42 1377
vcoubard 1132:692ddf04fc42 1378 private:
vcoubard 1157:e1ea38b576c6 1379 /**
vcoubard 1157:e1ea38b576c6 1380 * Helper function used to set the advertising data in the underlying BLE stack.
vcoubard 1157:e1ea38b576c6 1381 *
vcoubard 1157:e1ea38b576c6 1382 * @return BLE_ERROR_NONE if the advertising data was successfully set.
vcoubard 1157:e1ea38b576c6 1383 */
vcoubard 1132:692ddf04fc42 1384 ble_error_t setAdvertisingData(void) {
vcoubard 1132:692ddf04fc42 1385 return setAdvertisingData(_advPayload, _scanResponse);
vcoubard 1132:692ddf04fc42 1386 }
vcoubard 1132:692ddf04fc42 1387
vcoubard 1132:692ddf04fc42 1388 private:
vcoubard 1157:e1ea38b576c6 1389 /**
vcoubard 1157:e1ea38b576c6 1390 * Functionality that is BLE stack-dependent and must be implemented by the
vcoubard 1157:e1ea38b576c6 1391 * ported. This is a helper function to set the advertising data in the
vcoubard 1157:e1ea38b576c6 1392 * BLE stack.
vcoubard 1157:e1ea38b576c6 1393 *
vcoubard 1157:e1ea38b576c6 1394 * @param[in] advData
vcoubard 1157:e1ea38b576c6 1395 * The new advertising data.
vcoubard 1157:e1ea38b576c6 1396 * @param[in] scanResponse
vcoubard 1157:e1ea38b576c6 1397 * The new scan response data.
vcoubard 1157:e1ea38b576c6 1398 *
vcoubard 1157:e1ea38b576c6 1399 * @return BLE_ERROR_NONE if the advertising data was set successfully.
vcoubard 1157:e1ea38b576c6 1400 */
vcoubard 1132:692ddf04fc42 1401 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &advData, const GapAdvertisingData &scanResponse) = 0;
vcoubard 1157:e1ea38b576c6 1402
vcoubard 1157:e1ea38b576c6 1403 /**
vcoubard 1157:e1ea38b576c6 1404 * Functionality that is BLE stack-dependent and must be implemented by the
vcoubard 1157:e1ea38b576c6 1405 * ported. This is a helper function to start the advertising procedure in
vcoubard 1157:e1ea38b576c6 1406 * the underlying BLE stack.
vcoubard 1157:e1ea38b576c6 1407 *
vcoubard 1157:e1ea38b576c6 1408 * @param[in]
vcoubard 1157:e1ea38b576c6 1409 * The advertising parameters.
vcoubard 1157:e1ea38b576c6 1410 *
vcoubard 1157:e1ea38b576c6 1411 * @return BLE_ERROR_NONE if the advertising procedure was successfully
vcoubard 1157:e1ea38b576c6 1412 * started.
vcoubard 1157:e1ea38b576c6 1413 */
vcoubard 1132:692ddf04fc42 1414 virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0;
vcoubard 1132:692ddf04fc42 1415
vcoubard 1132:692ddf04fc42 1416 public:
vcoubard 1132:692ddf04fc42 1417 /**
vcoubard 1157:e1ea38b576c6 1418 * Accessor to read back currently active advertising parameters.
vcoubard 1157:e1ea38b576c6 1419 *
vcoubard 1157:e1ea38b576c6 1420 * @return A reference to the current advertising parameters.
vcoubard 1132:692ddf04fc42 1421 */
vcoubard 1132:692ddf04fc42 1422 GapAdvertisingParams &getAdvertisingParams(void) {
vcoubard 1132:692ddf04fc42 1423 return _advParams;
vcoubard 1132:692ddf04fc42 1424 }
vcoubard 1157:e1ea38b576c6 1425
vcoubard 1157:e1ea38b576c6 1426 /**
vcoubard 1157:e1ea38b576c6 1427 * A const alternative to Gap::getAdvertisingParams().
vcoubard 1157:e1ea38b576c6 1428 *
vcoubard 1157:e1ea38b576c6 1429 * @return A const reference to the current advertising parameters.
vcoubard 1157:e1ea38b576c6 1430 */
vcoubard 1132:692ddf04fc42 1431 const GapAdvertisingParams &getAdvertisingParams(void) const {
vcoubard 1132:692ddf04fc42 1432 return _advParams;
vcoubard 1132:692ddf04fc42 1433 }
vcoubard 1132:692ddf04fc42 1434
vcoubard 1132:692ddf04fc42 1435 /**
vcoubard 1132:692ddf04fc42 1436 * Set up a particular, user-constructed set of advertisement parameters for
vcoubard 1132:692ddf04fc42 1437 * the underlying stack. It would be uncommon for this API to be used
vcoubard 1132:692ddf04fc42 1438 * directly; there are other APIs to tweak advertisement parameters
vcoubard 1132:692ddf04fc42 1439 * individually.
vcoubard 1157:e1ea38b576c6 1440 *
vcoubard 1157:e1ea38b576c6 1441 * @param[in] newParams
vcoubard 1157:e1ea38b576c6 1442 * The new advertising parameters.
vcoubard 1132:692ddf04fc42 1443 */
vcoubard 1132:692ddf04fc42 1444 void setAdvertisingParams(const GapAdvertisingParams &newParams) {
vcoubard 1132:692ddf04fc42 1445 _advParams = newParams;
vcoubard 1132:692ddf04fc42 1446 }
vcoubard 1132:692ddf04fc42 1447
vcoubard 1132:692ddf04fc42 1448 /* Event callback handlers. */
vcoubard 1132:692ddf04fc42 1449 public:
vcoubard 1132:692ddf04fc42 1450 /**
vcoubard 1132:692ddf04fc42 1451 * Set up a callback for timeout events. Refer to TimeoutSource_t for
vcoubard 1132:692ddf04fc42 1452 * possible event types.
vcoubard 1157:e1ea38b576c6 1453 *
vcoubard 1157:e1ea38b576c6 1454 * @param[in] callback
vcoubard 1157:e1ea38b576c6 1455 * Event handler being registered.
vcoubard 1157:e1ea38b576c6 1456 *
vcoubard 1157:e1ea38b576c6 1457 * @note It is possible to unregister callbacks using onTimeout().detach(callback).
vcoubard 1132:692ddf04fc42 1458 */
vcoubard 1132:692ddf04fc42 1459 void onTimeout(TimeoutEventCallback_t callback) {
vcoubard 1132:692ddf04fc42 1460 timeoutCallbackChain.add(callback);
vcoubard 1132:692ddf04fc42 1461 }
vcoubard 1132:692ddf04fc42 1462
vcoubard 1132:692ddf04fc42 1463 /**
vcoubard 1157:e1ea38b576c6 1464 * @brief Provide access to the callchain of timeout event callbacks.
vcoubard 1157:e1ea38b576c6 1465 *
vcoubard 1157:e1ea38b576c6 1466 * @note It is possible to register callbacks using onTimeout().add(callback).
vcoubard 1157:e1ea38b576c6 1467 *
vcoubard 1157:e1ea38b576c6 1468 * @note It is possible to unregister callbacks using onTimeout().detach(callback).
vcoubard 1157:e1ea38b576c6 1469 *
vcoubard 1157:e1ea38b576c6 1470 * @return A reference to the timeout event callbacks chain.
vcoubard 1132:692ddf04fc42 1471 */
vcoubard 1132:692ddf04fc42 1472 TimeoutEventCallbackChain_t& onTimeout() {
vcoubard 1132:692ddf04fc42 1473 return timeoutCallbackChain;
vcoubard 1132:692ddf04fc42 1474 }
vcoubard 1132:692ddf04fc42 1475
vcoubard 1132:692ddf04fc42 1476 /**
vcoubard 1132:692ddf04fc42 1477 * Append to a chain of callbacks to be invoked upon GAP connection.
vcoubard 1157:e1ea38b576c6 1478 *
vcoubard 1157:e1ea38b576c6 1479 * @param[in] callback
vcoubard 1157:e1ea38b576c6 1480 * Event handler being registered.
vcoubard 1157:e1ea38b576c6 1481 *
vcoubard 1132:692ddf04fc42 1482 * @note It is possible to unregister callbacks using onConnection().detach(callback)
vcoubard 1132:692ddf04fc42 1483 */
vcoubard 1157:e1ea38b576c6 1484 void onConnection(ConnectionEventCallback_t callback) {
vcoubard 1157:e1ea38b576c6 1485 connectionCallChain.add(callback);
vcoubard 1157:e1ea38b576c6 1486 }
vcoubard 1132:692ddf04fc42 1487
vcoubard 1132:692ddf04fc42 1488 /**
vcoubard 1157:e1ea38b576c6 1489 * Same Gap::onConnection(), but allows the possibility to add an object
vcoubard 1157:e1ea38b576c6 1490 * reference and member function as handler for connection event
vcoubard 1157:e1ea38b576c6 1491 * callbacks.
vcoubard 1157:e1ea38b576c6 1492 *
vcoubard 1157:e1ea38b576c6 1493 * @param[in] tptr
vcoubard 1157:e1ea38b576c6 1494 * Pointer to the object of a class defining the member callback
vcoubard 1157:e1ea38b576c6 1495 * function (@p mptr).
vcoubard 1157:e1ea38b576c6 1496 * @param[in] mptr
vcoubard 1157:e1ea38b576c6 1497 * The member callback (within the context of an object) to be
vcoubard 1157:e1ea38b576c6 1498 * invoked.
vcoubard 1157:e1ea38b576c6 1499 */
vcoubard 1157:e1ea38b576c6 1500 template<typename T>
vcoubard 1157:e1ea38b576c6 1501 void onConnection(T *tptr, void (T::*mptr)(const ConnectionCallbackParams_t*)) {
vcoubard 1157:e1ea38b576c6 1502 connectionCallChain.add(tptr, mptr);
vcoubard 1157:e1ea38b576c6 1503 }
vcoubard 1157:e1ea38b576c6 1504
vcoubard 1157:e1ea38b576c6 1505 /**
vcoubard 1157:e1ea38b576c6 1506 * @brief Provide access to the callchain of connection event callbacks.
vcoubard 1157:e1ea38b576c6 1507 *
vcoubard 1157:e1ea38b576c6 1508 * @return A reference to the connection event callbacks chain.
vcoubard 1157:e1ea38b576c6 1509 *
vcoubard 1157:e1ea38b576c6 1510 * @note It is possible to register callbacks using onConnection().add(callback).
vcoubard 1157:e1ea38b576c6 1511 *
vcoubard 1157:e1ea38b576c6 1512 * @note It is possible to unregister callbacks using onConnection().detach(callback).
vcoubard 1132:692ddf04fc42 1513 */
vcoubard 1133:6362b7c2fdff 1514 ConnectionEventCallbackChain_t& onConnection() {
vcoubard 1132:692ddf04fc42 1515 return connectionCallChain;
vcoubard 1132:692ddf04fc42 1516 }
vcoubard 1132:692ddf04fc42 1517
vcoubard 1132:692ddf04fc42 1518 /**
vcoubard 1132:692ddf04fc42 1519 * Append to a chain of callbacks to be invoked upon GAP disconnection.
vcoubard 1157:e1ea38b576c6 1520 *
vcoubard 1157:e1ea38b576c6 1521 * @param[in] callback
vcoubard 1157:e1ea38b576c6 1522 Event handler being registered.
vcoubard 1157:e1ea38b576c6 1523 *
vcoubard 1157:e1ea38b576c6 1524 * @note It is possible to unregister callbacks using onDisconnection().detach(callback).
vcoubard 1132:692ddf04fc42 1525 */
vcoubard 1157:e1ea38b576c6 1526 void onDisconnection(DisconnectionEventCallback_t callback) {
vcoubard 1157:e1ea38b576c6 1527 disconnectionCallChain.add(callback);
vcoubard 1157:e1ea38b576c6 1528 }
vcoubard 1132:692ddf04fc42 1529
vcoubard 1132:692ddf04fc42 1530 /**
vcoubard 1157:e1ea38b576c6 1531 * Same Gap::onDisconnection(), but allows the possibility to add an object
vcoubard 1157:e1ea38b576c6 1532 * reference and member function as handler for disconnection event
vcoubard 1157:e1ea38b576c6 1533 * callbacks.
vcoubard 1157:e1ea38b576c6 1534 *
vcoubard 1157:e1ea38b576c6 1535 * @param[in] tptr
vcoubard 1157:e1ea38b576c6 1536 * Pointer to the object of a class defining the member callback
vcoubard 1157:e1ea38b576c6 1537 * function (@p mptr).
vcoubard 1157:e1ea38b576c6 1538 * @param[in] mptr
vcoubard 1157:e1ea38b576c6 1539 * The member callback (within the context of an object) to be
vcoubard 1157:e1ea38b576c6 1540 * invoked.
vcoubard 1157:e1ea38b576c6 1541 */
vcoubard 1157:e1ea38b576c6 1542 template<typename T>
vcoubard 1157:e1ea38b576c6 1543 void onDisconnection(T *tptr, void (T::*mptr)(const DisconnectionCallbackParams_t*)) {
vcoubard 1157:e1ea38b576c6 1544 disconnectionCallChain.add(tptr, mptr);
vcoubard 1157:e1ea38b576c6 1545 }
vcoubard 1157:e1ea38b576c6 1546
vcoubard 1157:e1ea38b576c6 1547 /**
vcoubard 1157:e1ea38b576c6 1548 * @brief Provide access to the callchain of disconnection event callbacks.
vcoubard 1157:e1ea38b576c6 1549 *
vcoubard 1157:e1ea38b576c6 1550 * @return A reference to the disconnection event callback chain.
vcoubard 1157:e1ea38b576c6 1551 *
vcoubard 1157:e1ea38b576c6 1552 * @note It is possible to register callbacks using onDisconnection().add(callback).
vcoubard 1157:e1ea38b576c6 1553 *
vcoubard 1157:e1ea38b576c6 1554 * @note It is possible to unregister callbacks using onDisconnection().detach(callback).
vcoubard 1132:692ddf04fc42 1555 */
vcoubard 1132:692ddf04fc42 1556 DisconnectionEventCallbackChain_t& onDisconnection() {
vcoubard 1132:692ddf04fc42 1557 return disconnectionCallChain;
vcoubard 1132:692ddf04fc42 1558 }
vcoubard 1132:692ddf04fc42 1559
vcoubard 1132:692ddf04fc42 1560 /**
vcoubard 1132:692ddf04fc42 1561 * Set the application callback for radio-notification events.
vcoubard 1132:692ddf04fc42 1562 *
vcoubard 1132:692ddf04fc42 1563 * Radio Notification is a feature that enables ACTIVE and INACTIVE
vcoubard 1132:692ddf04fc42 1564 * (nACTIVE) signals from the stack that notify the application when the
vcoubard 1132:692ddf04fc42 1565 * radio is in use.
vcoubard 1132:692ddf04fc42 1566 *
vcoubard 1132:692ddf04fc42 1567 * The ACTIVE signal is sent before the radio event starts. The nACTIVE
vcoubard 1132:692ddf04fc42 1568 * signal is sent at the end of the radio event. These signals can be used
vcoubard 1132:692ddf04fc42 1569 * by the application programmer to synchronize application logic with radio
vcoubard 1132:692ddf04fc42 1570 * activity. For example, the ACTIVE signal can be used to shut off external
vcoubard 1132:692ddf04fc42 1571 * devices, to manage peak current drawn during periods when the radio is on,
vcoubard 1132:692ddf04fc42 1572 * or to trigger sensor data collection for transmission in the Radio Event.
vcoubard 1132:692ddf04fc42 1573 *
vcoubard 1157:e1ea38b576c6 1574 * @param[in] callback
vcoubard 1157:e1ea38b576c6 1575 * The application handler to be invoked in response to a radio
vcoubard 1157:e1ea38b576c6 1576 * ACTIVE/INACTIVE event.
vcoubard 1132:692ddf04fc42 1577 */
vcoubard 1132:692ddf04fc42 1578 void onRadioNotification(void (*callback)(bool param)) {
vcoubard 1132:692ddf04fc42 1579 radioNotificationCallback.attach(callback);
vcoubard 1132:692ddf04fc42 1580 }
vcoubard 1157:e1ea38b576c6 1581
vcoubard 1157:e1ea38b576c6 1582 /**
vcoubard 1157:e1ea38b576c6 1583 * Same as Gap::onRadioNotification(), but allows the posibility to
vcoubard 1157:e1ea38b576c6 1584 * register an object reference and member function as handler for radio
vcoubard 1157:e1ea38b576c6 1585 * notification events.
vcoubard 1157:e1ea38b576c6 1586 *
vcoubard 1157:e1ea38b576c6 1587 * @param[in] tptr
vcoubard 1157:e1ea38b576c6 1588 * Pointer to the object of a class defining the member callback
vcoubard 1157:e1ea38b576c6 1589 * function (@p mptr).
vcoubard 1157:e1ea38b576c6 1590 * @param[in] mptr
vcoubard 1157:e1ea38b576c6 1591 * The member callback (within the context of an object) to be
vcoubard 1157:e1ea38b576c6 1592 * invoked in response to a radio ACTIVE/INACTIVE event.
vcoubard 1157:e1ea38b576c6 1593 */
vcoubard 1132:692ddf04fc42 1594 template <typename T>
vcoubard 1132:692ddf04fc42 1595 void onRadioNotification(T *tptr, void (T::*mptr)(bool)) {
vcoubard 1132:692ddf04fc42 1596 radioNotificationCallback.attach(tptr, mptr);
vcoubard 1132:692ddf04fc42 1597 }
vcoubard 1132:692ddf04fc42 1598
vcoubard 1136:22aada733dbd 1599 /**
vcoubard 1136:22aada733dbd 1600 * Setup a callback to be invoked to notify the user application that the
vcoubard 1136:22aada733dbd 1601 * Gap instance is about to shutdown (possibly as a result of a call
vcoubard 1136:22aada733dbd 1602 * to BLE::shutdown()).
vcoubard 1136:22aada733dbd 1603 *
vcoubard 1157:e1ea38b576c6 1604 * @param[in] callback
vcoubard 1157:e1ea38b576c6 1605 * The handler that is being registered to be notified of
vcoubard 1157:e1ea38b576c6 1606 * shutdown events.
vcoubard 1157:e1ea38b576c6 1607 *
vcoubard 1157:e1ea38b576c6 1608 * @note It is possible to chain together multiple onShutdown callbacks
vcoubard 1136:22aada733dbd 1609 * (potentially from different modules of an application) to be notified
vcoubard 1136:22aada733dbd 1610 * before the Gap instance is shutdown.
vcoubard 1136:22aada733dbd 1611 *
vcoubard 1157:e1ea38b576c6 1612 * @note It is also possible to set up a callback into a member function of
vcoubard 1136:22aada733dbd 1613 * some object.
vcoubard 1136:22aada733dbd 1614 *
vcoubard 1157:e1ea38b576c6 1615 * @note It is possible to unregister a callback using onShutdown().detach(callback)
vcoubard 1136:22aada733dbd 1616 */
vcoubard 1136:22aada733dbd 1617 void onShutdown(const GapShutdownCallback_t& callback) {
vcoubard 1136:22aada733dbd 1618 shutdownCallChain.add(callback);
vcoubard 1136:22aada733dbd 1619 }
vcoubard 1157:e1ea38b576c6 1620
vcoubard 1157:e1ea38b576c6 1621 /**
vcoubard 1157:e1ea38b576c6 1622 * Same as Gap::onShutdown(), but allows the posibility to
vcoubard 1157:e1ea38b576c6 1623 * register an object reference and member function as handler for shutdown
vcoubard 1157:e1ea38b576c6 1624 * events.
vcoubard 1157:e1ea38b576c6 1625 *
vcoubard 1157:e1ea38b576c6 1626 * @param[in] objPtr
vcoubard 1157:e1ea38b576c6 1627 * Pointer to the object of a class defining the member callback
vcoubard 1157:e1ea38b576c6 1628 * function (@p memberPtr).
vcoubard 1157:e1ea38b576c6 1629 * @param[in] memberPtr
vcoubard 1157:e1ea38b576c6 1630 * The member callback (within the context of an object) to be
vcoubard 1157:e1ea38b576c6 1631 * invoked in response to a shutdown event.
vcoubard 1157:e1ea38b576c6 1632 */
vcoubard 1136:22aada733dbd 1633 template <typename T>
vcoubard 1136:22aada733dbd 1634 void onShutdown(T *objPtr, void (T::*memberPtr)(void)) {
vcoubard 1136:22aada733dbd 1635 shutdownCallChain.add(objPtr, memberPtr);
vcoubard 1136:22aada733dbd 1636 }
vcoubard 1136:22aada733dbd 1637
vcoubard 1136:22aada733dbd 1638 /**
vcoubard 1157:e1ea38b576c6 1639 * @brief Provide access to the callchain of shutdown event callbacks.
vcoubard 1157:e1ea38b576c6 1640 *
vcoubard 1157:e1ea38b576c6 1641 * @return A reference to the shutdown event callback chain.
vcoubard 1157:e1ea38b576c6 1642 *
vcoubard 1157:e1ea38b576c6 1643 * @note It is possible to register callbacks using onShutdown().add(callback).
vcoubard 1157:e1ea38b576c6 1644 *
vcoubard 1157:e1ea38b576c6 1645 * @note It is possible to unregister callbacks using onShutdown().detach(callback).
vcoubard 1136:22aada733dbd 1646 */
vcoubard 1136:22aada733dbd 1647 GapShutdownCallbackChain_t& onShutdown() {
vcoubard 1136:22aada733dbd 1648 return shutdownCallChain;
vcoubard 1136:22aada733dbd 1649 }
vcoubard 1136:22aada733dbd 1650
vcoubard 1136:22aada733dbd 1651 public:
vcoubard 1136:22aada733dbd 1652 /**
vcoubard 1136:22aada733dbd 1653 * Notify all registered onShutdown callbacks that the Gap instance is
vcoubard 1136:22aada733dbd 1654 * about to be shutdown and clear all Gap state of the
vcoubard 1136:22aada733dbd 1655 * associated object.
vcoubard 1136:22aada733dbd 1656 *
vcoubard 1136:22aada733dbd 1657 * This function is meant to be overridden in the platform-specific
vcoubard 1136:22aada733dbd 1658 * sub-class. Nevertheless, the sub-class is only expected to reset its
vcoubard 1136:22aada733dbd 1659 * state and not the data held in Gap members. This shall be achieved by a
vcoubard 1136:22aada733dbd 1660 * call to Gap::reset() from the sub-class' reset() implementation.
vcoubard 1136:22aada733dbd 1661 *
vcoubard 1136:22aada733dbd 1662 * @return BLE_ERROR_NONE on success.
vcoubard 1136:22aada733dbd 1663 *
vcoubard 1157:e1ea38b576c6 1664 * @note Currently a call to reset() does not reset the advertising and
vcoubard 1136:22aada733dbd 1665 * scan parameters to default values.
vcoubard 1136:22aada733dbd 1666 */
vcoubard 1136:22aada733dbd 1667 virtual ble_error_t reset(void) {
vcoubard 1136:22aada733dbd 1668 /* Notify that the instance is about to shutdown */
vcoubard 1136:22aada733dbd 1669 shutdownCallChain.call(this);
vcoubard 1136:22aada733dbd 1670 shutdownCallChain.clear();
vcoubard 1136:22aada733dbd 1671
vcoubard 1136:22aada733dbd 1672 /* Clear Gap state */
vcoubard 1136:22aada733dbd 1673 state.advertising = 0;
vcoubard 1136:22aada733dbd 1674 state.connected = 0;
vcoubard 1136:22aada733dbd 1675
vcoubard 1136:22aada733dbd 1676 /* Clear scanning state */
vcoubard 1136:22aada733dbd 1677 scanningActive = false;
vcoubard 1136:22aada733dbd 1678
vcoubard 1136:22aada733dbd 1679 /* Clear advertising and scanning data */
vcoubard 1136:22aada733dbd 1680 _advPayload.clear();
vcoubard 1136:22aada733dbd 1681 _scanResponse.clear();
vcoubard 1136:22aada733dbd 1682
vcoubard 1136:22aada733dbd 1683 /* Clear callbacks */
vcoubard 1136:22aada733dbd 1684 timeoutCallbackChain.clear();
vcoubard 1136:22aada733dbd 1685 connectionCallChain.clear();
vcoubard 1136:22aada733dbd 1686 disconnectionCallChain.clear();
vcoubard 1136:22aada733dbd 1687 radioNotificationCallback = NULL;
vcoubard 1136:22aada733dbd 1688 onAdvertisementReport = NULL;
vcoubard 1136:22aada733dbd 1689
vcoubard 1136:22aada733dbd 1690 return BLE_ERROR_NONE;
vcoubard 1136:22aada733dbd 1691 }
vcoubard 1136:22aada733dbd 1692
vcoubard 1132:692ddf04fc42 1693 protected:
vcoubard 1157:e1ea38b576c6 1694 /**
vcoubard 1157:e1ea38b576c6 1695 * Construct a Gap instance.
vcoubard 1157:e1ea38b576c6 1696 */
vcoubard 1132:692ddf04fc42 1697 Gap() :
vcoubard 1132:692ddf04fc42 1698 _advParams(),
vcoubard 1132:692ddf04fc42 1699 _advPayload(),
vcoubard 1132:692ddf04fc42 1700 _scanningParams(),
vcoubard 1132:692ddf04fc42 1701 _scanResponse(),
vcoubard 1132:692ddf04fc42 1702 state(),
vcoubard 1132:692ddf04fc42 1703 scanningActive(false),
vcoubard 1132:692ddf04fc42 1704 timeoutCallbackChain(),
vcoubard 1132:692ddf04fc42 1705 radioNotificationCallback(),
vcoubard 1132:692ddf04fc42 1706 onAdvertisementReport(),
vcoubard 1132:692ddf04fc42 1707 connectionCallChain(),
vcoubard 1132:692ddf04fc42 1708 disconnectionCallChain() {
vcoubard 1132:692ddf04fc42 1709 _advPayload.clear();
vcoubard 1132:692ddf04fc42 1710 _scanResponse.clear();
vcoubard 1132:692ddf04fc42 1711 }
vcoubard 1132:692ddf04fc42 1712
vcoubard 1132:692ddf04fc42 1713 /* Entry points for the underlying stack to report events back to the user. */
vcoubard 1132:692ddf04fc42 1714 public:
vcoubard 1157:e1ea38b576c6 1715 /**
vcoubard 1157:e1ea38b576c6 1716 * Helper function that notifies all registered handlers of an occurrence
vcoubard 1157:e1ea38b576c6 1717 * of a connection event. This function is meant to be called from the
vcoubard 1157:e1ea38b576c6 1718 * BLE stack specific implementation when a connection event occurs.
vcoubard 1157:e1ea38b576c6 1719 *
vcoubard 1157:e1ea38b576c6 1720 * @param[in] handle
vcoubard 1157:e1ea38b576c6 1721 * The ID of the connection that generated the event.
vcoubard 1157:e1ea38b576c6 1722 * @param[in] role
vcoubard 1157:e1ea38b576c6 1723 * The role of this BLE device in the connection.
vcoubard 1157:e1ea38b576c6 1724 * @param[in] peerAddrType
vcoubard 1157:e1ea38b576c6 1725 * The peer's BLE address type.
vcoubard 1157:e1ea38b576c6 1726 * @param[in] peerAddr
vcoubard 1157:e1ea38b576c6 1727 * The peer's BLE address.
vcoubard 1157:e1ea38b576c6 1728 * @param[in] ownAddrType
vcoubard 1157:e1ea38b576c6 1729 * This device's BLE address type.
vcoubard 1157:e1ea38b576c6 1730 * @param[in] ownAddr
vcoubard 1157:e1ea38b576c6 1731 * This device's BLE address.
vcoubard 1157:e1ea38b576c6 1732 * @param[in] connectionParams
vcoubard 1157:e1ea38b576c6 1733 * The parameters configured for this connection.
vcoubard 1157:e1ea38b576c6 1734 */
vcoubard 1136:22aada733dbd 1735 void processConnectionEvent(Handle_t handle,
vcoubard 1136:22aada733dbd 1736 Role_t role,
vcoubard 1136:22aada733dbd 1737 BLEProtocol::AddressType_t peerAddrType,
vcoubard 1136:22aada733dbd 1738 const BLEProtocol::AddressBytes_t peerAddr,
vcoubard 1136:22aada733dbd 1739 BLEProtocol::AddressType_t ownAddrType,
vcoubard 1136:22aada733dbd 1740 const BLEProtocol::AddressBytes_t ownAddr,
vcoubard 1136:22aada733dbd 1741 const ConnectionParams_t *connectionParams) {
vcoubard 1132:692ddf04fc42 1742 state.connected = 1;
vcoubard 1132:692ddf04fc42 1743 ConnectionCallbackParams_t callbackParams(handle, role, peerAddrType, peerAddr, ownAddrType, ownAddr, connectionParams);
vcoubard 1132:692ddf04fc42 1744 connectionCallChain.call(&callbackParams);
vcoubard 1132:692ddf04fc42 1745 }
vcoubard 1132:692ddf04fc42 1746
vcoubard 1157:e1ea38b576c6 1747 /**
vcoubard 1157:e1ea38b576c6 1748 * Helper function that notifies all registered handlers of an occurrence
vcoubard 1157:e1ea38b576c6 1749 * of a disconnection event. This function is meant to be called from the
vcoubard 1157:e1ea38b576c6 1750 * BLE stack specific implementation when a disconnection event occurs.
vcoubard 1157:e1ea38b576c6 1751 *
vcoubard 1157:e1ea38b576c6 1752 * @param[in] handle
vcoubard 1157:e1ea38b576c6 1753 * The ID of the connection that generated the event.
vcoubard 1157:e1ea38b576c6 1754 * @param[in] reason
vcoubard 1157:e1ea38b576c6 1755 * The reason for disconnection.
vcoubard 1157:e1ea38b576c6 1756 */
vcoubard 1132:692ddf04fc42 1757 void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) {
vcoubard 1132:692ddf04fc42 1758 state.connected = 0;
vcoubard 1132:692ddf04fc42 1759 DisconnectionCallbackParams_t callbackParams(handle, reason);
vcoubard 1132:692ddf04fc42 1760 disconnectionCallChain.call(&callbackParams);
vcoubard 1132:692ddf04fc42 1761 }
vcoubard 1132:692ddf04fc42 1762
vcoubard 1157:e1ea38b576c6 1763 /**
vcoubard 1157:e1ea38b576c6 1764 * Helper function that notifies the registered handler of a scanned
vcoubard 1157:e1ea38b576c6 1765 * advertisement packet. This function is meant to be called from the
vcoubard 1157:e1ea38b576c6 1766 * BLE stack specific implementation when a such event occurs.
vcoubard 1157:e1ea38b576c6 1767 *
vcoubard 1157:e1ea38b576c6 1768 * @param[in] peerAddr
vcoubard 1157:e1ea38b576c6 1769 * The peer's BLE address.
vcoubard 1157:e1ea38b576c6 1770 * @param[in] rssi
vcoubard 1157:e1ea38b576c6 1771 * The advertisement packet RSSI value.
vcoubard 1157:e1ea38b576c6 1772 * @param[in] isScanReponse
vcoubard 1157:e1ea38b576c6 1773 * Whether this packet is the response to a scan request.
vcoubard 1157:e1ea38b576c6 1774 * @param[in] type
vcoubard 1157:e1ea38b576c6 1775 * The type of advertisement.
vcoubard 1157:e1ea38b576c6 1776 * @param[in] advertisingDataLen
vcoubard 1157:e1ea38b576c6 1777 * Length of the advertisement data.
vcoubard 1157:e1ea38b576c6 1778 * @param[in] advertisingData
vcoubard 1157:e1ea38b576c6 1779 * Pointer to the advertisement packet's data.
vcoubard 1157:e1ea38b576c6 1780 */
vcoubard 1136:22aada733dbd 1781 void processAdvertisementReport(const BLEProtocol::AddressBytes_t peerAddr,
vcoubard 1136:22aada733dbd 1782 int8_t rssi,
vcoubard 1136:22aada733dbd 1783 bool isScanResponse,
vcoubard 1132:692ddf04fc42 1784 GapAdvertisingParams::AdvertisingType_t type,
vcoubard 1136:22aada733dbd 1785 uint8_t advertisingDataLen,
vcoubard 1136:22aada733dbd 1786 const uint8_t *advertisingData) {
vcoubard 1132:692ddf04fc42 1787 AdvertisementCallbackParams_t params;
vcoubard 1132:692ddf04fc42 1788 memcpy(params.peerAddr, peerAddr, ADDR_LEN);
vcoubard 1132:692ddf04fc42 1789 params.rssi = rssi;
vcoubard 1132:692ddf04fc42 1790 params.isScanResponse = isScanResponse;
vcoubard 1132:692ddf04fc42 1791 params.type = type;
vcoubard 1132:692ddf04fc42 1792 params.advertisingDataLen = advertisingDataLen;
vcoubard 1132:692ddf04fc42 1793 params.advertisingData = advertisingData;
vcoubard 1132:692ddf04fc42 1794 onAdvertisementReport.call(&params);
vcoubard 1132:692ddf04fc42 1795 }
vcoubard 1132:692ddf04fc42 1796
vcoubard 1157:e1ea38b576c6 1797 /**
vcoubard 1157:e1ea38b576c6 1798 * Helper function that notifies all registered handlers of an occurrence
vcoubard 1157:e1ea38b576c6 1799 * of a timeout event. This function is meant to be called from the
vcoubard 1157:e1ea38b576c6 1800 * BLE stack specific implementation when a timeout event occurs.
vcoubard 1157:e1ea38b576c6 1801 *
vcoubard 1157:e1ea38b576c6 1802 * @param[in] source
vcoubard 1157:e1ea38b576c6 1803 * The source of the timout event.
vcoubard 1157:e1ea38b576c6 1804 */
vcoubard 1132:692ddf04fc42 1805 void processTimeoutEvent(TimeoutSource_t source) {
vcoubard 1132:692ddf04fc42 1806 if (timeoutCallbackChain) {
vcoubard 1132:692ddf04fc42 1807 timeoutCallbackChain(source);
vcoubard 1132:692ddf04fc42 1808 }
vcoubard 1132:692ddf04fc42 1809 }
vcoubard 1132:692ddf04fc42 1810
vcoubard 1132:692ddf04fc42 1811 protected:
vcoubard 1157:e1ea38b576c6 1812 /**
vcoubard 1157:e1ea38b576c6 1813 * Currently set advertising parameters.
vcoubard 1157:e1ea38b576c6 1814 */
vcoubard 1132:692ddf04fc42 1815 GapAdvertisingParams _advParams;
vcoubard 1157:e1ea38b576c6 1816 /**
vcoubard 1157:e1ea38b576c6 1817 * Currently set advertising data.
vcoubard 1157:e1ea38b576c6 1818 */
vcoubard 1132:692ddf04fc42 1819 GapAdvertisingData _advPayload;
vcoubard 1157:e1ea38b576c6 1820 /**
vcoubard 1157:e1ea38b576c6 1821 * Currently set scanning parameters.
vcoubard 1157:e1ea38b576c6 1822 */
vcoubard 1132:692ddf04fc42 1823 GapScanningParams _scanningParams;
vcoubard 1157:e1ea38b576c6 1824 /**
vcoubard 1157:e1ea38b576c6 1825 * Currently set scan response data.
vcoubard 1157:e1ea38b576c6 1826 */
vcoubard 1132:692ddf04fc42 1827 GapAdvertisingData _scanResponse;
vcoubard 1132:692ddf04fc42 1828
vcoubard 1157:e1ea38b576c6 1829 /**
vcoubard 1157:e1ea38b576c6 1830 * The current GAP state.
vcoubard 1157:e1ea38b576c6 1831 */
vcoubard 1132:692ddf04fc42 1832 GapState_t state;
vcoubard 1157:e1ea38b576c6 1833 /**
vcoubard 1157:e1ea38b576c6 1834 * Whether active scanning is set. This is used to fetch the scan response
vcoubard 1157:e1ea38b576c6 1835 * from a peer if possible.
vcoubard 1157:e1ea38b576c6 1836 */
vcoubard 1132:692ddf04fc42 1837 bool scanningActive;
vcoubard 1132:692ddf04fc42 1838
vcoubard 1132:692ddf04fc42 1839 protected:
vcoubard 1157:e1ea38b576c6 1840 /**
vcoubard 1157:e1ea38b576c6 1841 * Callchain containing all registered callback handlers for timeout
vcoubard 1157:e1ea38b576c6 1842 * events.
vcoubard 1157:e1ea38b576c6 1843 */
vcoubard 1132:692ddf04fc42 1844 TimeoutEventCallbackChain_t timeoutCallbackChain;
vcoubard 1157:e1ea38b576c6 1845 /**
vcoubard 1157:e1ea38b576c6 1846 * The registered callback handler for radio notification events.
vcoubard 1157:e1ea38b576c6 1847 */
vcoubard 1132:692ddf04fc42 1848 RadioNotificationEventCallback_t radioNotificationCallback;
vcoubard 1157:e1ea38b576c6 1849 /**
vcoubard 1157:e1ea38b576c6 1850 * The registered callback handler for scanned advertisement packet
vcoubard 1157:e1ea38b576c6 1851 * notifications.
vcoubard 1157:e1ea38b576c6 1852 */
vcoubard 1132:692ddf04fc42 1853 AdvertisementReportCallback_t onAdvertisementReport;
vcoubard 1157:e1ea38b576c6 1854 /**
vcoubard 1157:e1ea38b576c6 1855 * Callchain containing all registered callback handlers for connection
vcoubard 1157:e1ea38b576c6 1856 * events.
vcoubard 1157:e1ea38b576c6 1857 */
vcoubard 1132:692ddf04fc42 1858 ConnectionEventCallbackChain_t connectionCallChain;
vcoubard 1157:e1ea38b576c6 1859 /**
vcoubard 1157:e1ea38b576c6 1860 * Callchain containing all registered callback handlers for disconnection
vcoubard 1157:e1ea38b576c6 1861 * events.
vcoubard 1157:e1ea38b576c6 1862 */
vcoubard 1132:692ddf04fc42 1863 DisconnectionEventCallbackChain_t disconnectionCallChain;
vcoubard 1132:692ddf04fc42 1864
vcoubard 1132:692ddf04fc42 1865 private:
vcoubard 1157:e1ea38b576c6 1866 /**
vcoubard 1157:e1ea38b576c6 1867 * Callchain containing all registered callback handlers for shutdown
vcoubard 1157:e1ea38b576c6 1868 * events.
vcoubard 1157:e1ea38b576c6 1869 */
vcoubard 1136:22aada733dbd 1870 GapShutdownCallbackChain_t shutdownCallChain;
vcoubard 1136:22aada733dbd 1871
vcoubard 1136:22aada733dbd 1872 private:
vcoubard 1132:692ddf04fc42 1873 /* Disallow copy and assignment. */
vcoubard 1132:692ddf04fc42 1874 Gap(const Gap &);
vcoubard 1132:692ddf04fc42 1875 Gap& operator=(const Gap &);
vcoubard 1132:692ddf04fc42 1876 };
vcoubard 1132:692ddf04fc42 1877
rgrover1 710:b2e1a2660ec2 1878 #endif // ifndef __GAP_H__