Marco Ferreira / BLE_API

just a fork

Fork of BLE_API by Bluetooth Low Energy

ble/Gap.h@919:c5b9fac295f5, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 12:52:04 2015 +0000
Revision:
919:c5b9fac295f5
Parent:
913:690bea02c431
Child:
920:d18cff0c4b09
Synchronized with git rev dfc03ce0

Author: Vincent Coubard

Convert Gap::timeout callback to a callback chain. Add 'boolean'

conversion and function operator syntax to

CallChainOfFunctionPointerWithContext

Who changed what in which revision?

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