aapje monkey / BLE_API

Bike service

Fork of BLE_API by Bluetooth Low Energy

ble/Gap.h@1087:4c6e11878033, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 08:51:48 2016 +0000
Revision:
1087:4c6e11878033
Parent:
1086:75d4e8ce277d
Child:
1088:709ebced28ab
Synchronized with git rev 3c15a7df

Author: Rohit Grover

minor re-organization

Who changed what in which revision?

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