Alex Cordonnier / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Fork of BLE_API by Bluetooth Low Energy

ble/Gap.h@860:0d41e4eb3d0a, 2015-11-02 (annotated)

Committer:
rgrover1
Date:
Mon Nov 02 09:09:07 2015 +0000
Revision:
860:0d41e4eb3d0a
Parent:
859:2a1cb15098ba
Child:
861:2afa79e3ed0a
Synchronized with git rev 249cabae

Author: Rohit Grover

Merge pull request #82 from jrobeson/patch-1



use the github url public url in module.json

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