Jörg Küfen / BLE_API

fka mod

Fork of BLE_API by Bluetooth Low Energy

ble/Gap.h@786:d6d7087d8377, 2015-08-11 (annotated)

Committer:
rgrover1
Date:
Tue Aug 11 15:13:13 2015 +0100
Revision:
786:d6d7087d8377
Parent:
785:c74f567162d4
Child:
800:3bf180b7a3a5
Synchronized with git rev 1b265c4e

Author: Rohit Grover

minor cosmetic change to the comment header for GapAdvertisingParams.

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