Tomasz Trela / BLE_API

wersion 1.9

Fork of BLE_API by Bluetooth Low Energy

ble/Gap.h@765:4cd91998cd48, 2015-08-07 (annotated)

Committer:
rgrover1
Date:
Fri Aug 07 15:53:50 2015 +0100
Revision:
765:4cd91998cd48
Parent:
764:1e560f0d45e1
Child:
766:03f1a26f132f
Synchronized with git rev 97d939ca

Author: Rohit Grover

Minor updates to the implementation. Add a local struct to describe ADV fields.

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