Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

public/BLEDevice.h@524:6e97ab392e2a, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:06 2015 +0100
Revision:
524:6e97ab392e2a
Parent:
518:54731cc463b3
Child:
526:caa67c3187a0
Synchronized with git rev 43177a02

Author: Rohit Grover

remove un-necessary comments in GattClient.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 257:7a50601356cc 1 /* mbed Microcontroller Library
rgrover1 257:7a50601356cc 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 257:7a50601356cc 3 *
rgrover1 257:7a50601356cc 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 257:7a50601356cc 5 * you may not use this file except in compliance with the License.
rgrover1 257:7a50601356cc 6 * You may obtain a copy of the License at
rgrover1 257:7a50601356cc 7 *
rgrover1 257:7a50601356cc 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 257:7a50601356cc 9 *
rgrover1 257:7a50601356cc 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 257:7a50601356cc 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 257:7a50601356cc 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 257:7a50601356cc 13 * See the License for the specific language governing permissions and
rgrover1 257:7a50601356cc 14 * limitations under the License.
rgrover1 257:7a50601356cc 15 */
rgrover1 257:7a50601356cc 16
rgrover1 257:7a50601356cc 17 #ifndef __BLE_DEVICE__
rgrover1 257:7a50601356cc 18 #define __BLE_DEVICE__
rgrover1 257:7a50601356cc 19
rgrover1 257:7a50601356cc 20 #include "blecommon.h"
rgrover1 257:7a50601356cc 21 #include "Gap.h"
rgrover1 257:7a50601356cc 22 #include "GattServer.h"
rgrover1 524:6e97ab392e2a 23 #include "GattClient.h"
rgrover1 524:6e97ab392e2a 24 #include "BLEDeviceInstanceBase.h"
rgrover1 524:6e97ab392e2a 25
rgrover1 524:6e97ab392e2a 26 #include "GapAdvertisingData.h"
rgrover1 524:6e97ab392e2a 27 #include "GapAdvertisingParams.h"
rgrover1 514:1fa338281798 28 #include "GapScanningParams.h"
rgrover1 524:6e97ab392e2a 29
rgrover1 434:bd1f1cc10277 30
rgrover1 257:7a50601356cc 31 /**
rgrover1 257:7a50601356cc 32 * The base class used to abstract away BLE capable radio transceivers or SOCs,
rgrover1 257:7a50601356cc 33 * to enable this BLE API to work with any radio transparently.
rgrover1 257:7a50601356cc 34 */
rgrover1 257:7a50601356cc 35 class BLEDevice
rgrover1 257:7a50601356cc 36 {
rgrover1 257:7a50601356cc 37 public:
rgrover1 257:7a50601356cc 38 /**
rgrover1 257:7a50601356cc 39 * Initialize the BLE controller. This should be called before using
rgrover1 257:7a50601356cc 40 * anything else in the BLE_API.
rgrover1 411:cf2cce37ad73 41 *
rgrover1 411:cf2cce37ad73 42 * init() hands control to the underlying BLE module to accomplish
rgrover1 411:cf2cce37ad73 43 * initialization. This initialization may tacitly depend on other hardware
rgrover1 411:cf2cce37ad73 44 * setup (such as clocks or power-modes) which happens early on during
rgrover1 411:cf2cce37ad73 45 * system startup. It may not be safe to call init() from global static
rgrover1 411:cf2cce37ad73 46 * context where ordering is compiler specific and can't be guaranteed--it
rgrover1 411:cf2cce37ad73 47 * is safe to call BLEDevice::init() from within main().
rgrover1 257:7a50601356cc 48 */
rgrover1 257:7a50601356cc 49 ble_error_t init();
rgrover1 411:cf2cce37ad73 50
rgrover1 257:7a50601356cc 51 ble_error_t reset(void);
rgrover1 257:7a50601356cc 52
rgrover1 257:7a50601356cc 53 /**
rgrover1 257:7a50601356cc 54 * Purge the BLE stack of GATT and GAP state. init() must be called afterwards to re-instate services and GAP state.
rgrover1 257:7a50601356cc 55 */
rgrover1 257:7a50601356cc 56 ble_error_t shutdown(void);
rgrover1 257:7a50601356cc 57
rgrover1 257:7a50601356cc 58 /* GAP specific APIs */
rgrover1 257:7a50601356cc 59 public:
rgrover1 257:7a50601356cc 60 /**
rgrover1 257:7a50601356cc 61 * Set the BTLE MAC address and type.
rgrover1 257:7a50601356cc 62 * @return BLE_ERROR_NONE on success.
rgrover1 257:7a50601356cc 63 */
rgrover1 450:47aa4a9161a7 64 ble_error_t setAddress(Gap::AddressType_t type, const Gap::Address_t address);
rgrover1 257:7a50601356cc 65
rgrover1 257:7a50601356cc 66 /**
rgrover1 257:7a50601356cc 67 * Fetch the BTLE MAC address and type.
rgrover1 257:7a50601356cc 68 * @return BLE_ERROR_NONE on success.
rgrover1 257:7a50601356cc 69 */
rgrover1 450:47aa4a9161a7 70 ble_error_t getAddress(Gap::AddressType_t *typeP, Gap::Address_t address);
rgrover1 257:7a50601356cc 71
rgrover1 257:7a50601356cc 72 /**
rgrover1 257:7a50601356cc 73 * @param[in] advType
rgrover1 257:7a50601356cc 74 * The GAP advertising mode to use for this device. Valid
rgrover1 257:7a50601356cc 75 * values are defined in AdvertisingType:
rgrover1 257:7a50601356cc 76 *
rgrover1 257:7a50601356cc 77 * \par ADV_NON_CONNECTABLE_UNDIRECTED
rgrover1 257:7a50601356cc 78 * All connections to the peripheral device will be refused.
rgrover1 257:7a50601356cc 79 *
rgrover1 257:7a50601356cc 80 * \par ADV_CONNECTABLE_DIRECTED
rgrover1 257:7a50601356cc 81 * Only connections from a pre-defined central device will be
rgrover1 257:7a50601356cc 82 * accepted.
rgrover1 257:7a50601356cc 83 *
rgrover1 257:7a50601356cc 84 * \par ADV_CONNECTABLE_UNDIRECTED
rgrover1 257:7a50601356cc 85 * Any central device can connect to this peripheral.
rgrover1 257:7a50601356cc 86 *
rgrover1 257:7a50601356cc 87 * \par ADV_SCANNABLE_UNDIRECTED
rgrover1 300:d9a39f759a6a 88 * Include support for Scan Response payloads.
rgrover1 257:7a50601356cc 89 *
rgrover1 257:7a50601356cc 90 * \par
rgrover1 257:7a50601356cc 91 * See Bluetooth Core Specification 4.0 (Vol. 3), Part C,
rgrover1 257:7a50601356cc 92 * Section 9.3 and Core Specification 4.0 (Vol. 6), Part B,
rgrover1 257:7a50601356cc 93 * Section 2.3.1 for further information on GAP connection
rgrover1 257:7a50601356cc 94 * modes
rgrover1 257:7a50601356cc 95 */
rgrover1 257:7a50601356cc 96 void setAdvertisingType(GapAdvertisingParams::AdvertisingType);
rgrover1 257:7a50601356cc 97
rgrover1 257:7a50601356cc 98 /**
rgrover1 257:7a50601356cc 99 * @param[in] interval
rgrover1 325:501ad8b8bbe5 100 * Advertising interval in units of milliseconds. Advertising
rgrover1 325:501ad8b8bbe5 101 * is disabled if interval is 0. If interval is smaller than
rgrover1 325:501ad8b8bbe5 102 * the minimum supported value, then the minimum supported
rgrover1 325:501ad8b8bbe5 103 * value is used instead.
rgrover1 257:7a50601356cc 104 *
rgrover1 257:7a50601356cc 105 * \par
rgrover1 257:7a50601356cc 106 * Decreasing this value will allow central devices to detect
rgrover1 257:7a50601356cc 107 * your peripheral faster at the expense of more power being
rgrover1 257:7a50601356cc 108 * used by the radio due to the higher data transmit rate.
rgrover1 257:7a50601356cc 109 *
rgrover1 257:7a50601356cc 110 * \par
rgrover1 257:7a50601356cc 111 * This field must be set to 0 if connectionMode is equal
rgrover1 257:7a50601356cc 112 * to ADV_CONNECTABLE_DIRECTED
rgrover1 257:7a50601356cc 113 *
rgrover1 257:7a50601356cc 114 * \par
rgrover1 257:7a50601356cc 115 * See Bluetooth Core Specification, Vol 3., Part C,
rgrover1 257:7a50601356cc 116 * Appendix A for suggested advertising intervals.
rgrover1 334:6bc1223306b9 117 *
rgrover1 334:6bc1223306b9 118 * @Note: [WARNING] This API previously used 0.625ms as the unit for its
rgrover1 334:6bc1223306b9 119 * 'interval' argument. That required an explicit conversion from
rgrover1 334:6bc1223306b9 120 * milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
rgrover1 334:6bc1223306b9 121 * no longer required as the new units are milliseconds. Any application
rgrover1 334:6bc1223306b9 122 * code depending on the old semantics would need to be updated accordingly.
rgrover1 257:7a50601356cc 123 */
rgrover1 257:7a50601356cc 124 void setAdvertisingInterval(uint16_t interval);
rgrover1 257:7a50601356cc 125
rgrover1 257:7a50601356cc 126 /**
rgrover1 325:501ad8b8bbe5 127 * @return Minimum Advertising interval in milliseconds.
rgrover1 325:501ad8b8bbe5 128 */
rgrover1 325:501ad8b8bbe5 129 uint16_t getMinAdvertisingInterval(void) const;
rgrover1 325:501ad8b8bbe5 130 /**
rgrover1 325:501ad8b8bbe5 131 * @return Minimum Advertising interval in milliseconds for non connectible mode.
rgrover1 325:501ad8b8bbe5 132 */
rgrover1 325:501ad8b8bbe5 133 uint16_t getMinNonConnectableAdvertisingInterval(void) const;
rgrover1 325:501ad8b8bbe5 134 /**
rgrover1 325:501ad8b8bbe5 135 * @return Maximum Advertising interval in milliseconds.
rgrover1 325:501ad8b8bbe5 136 */
rgrover1 325:501ad8b8bbe5 137 uint16_t getMaxAdvertisingInterval(void) const;
rgrover1 325:501ad8b8bbe5 138
rgrover1 325:501ad8b8bbe5 139 /**
rgrover1 257:7a50601356cc 140 * @param[in] timeout
rgrover1 257:7a50601356cc 141 * Advertising timeout between 0x1 and 0x3FFF (1 and 16383)
rgrover1 257:7a50601356cc 142 * in seconds. Enter 0 to disable the advertising timeout.
rgrover1 257:7a50601356cc 143 */
rgrover1 257:7a50601356cc 144 void setAdvertisingTimeout(uint16_t timeout);
rgrover1 257:7a50601356cc 145
rgrover1 257:7a50601356cc 146 /**
rgrover1 257:7a50601356cc 147 * Please refer to the APIs above.
rgrover1 257:7a50601356cc 148 */
rgrover1 257:7a50601356cc 149 void setAdvertisingParams(const GapAdvertisingParams &advParams);
rgrover1 257:7a50601356cc 150
rgrover1 257:7a50601356cc 151 /**
rgrover1 409:37a4202649dd 152 * @return Read back advertising parameters. Useful for storing and
rgrover1 409:37a4202649dd 153 * restoring parameters rapidly.
rgrover1 409:37a4202649dd 154 */
rgrover1 410:af8f2d1b67b6 155 const GapAdvertisingParams &getAdvertisingParams(void) const;
rgrover1 409:37a4202649dd 156
rgrover1 409:37a4202649dd 157 /**
rgrover1 257:7a50601356cc 158 * This API is typically used as an internal helper to udpate the transport
rgrover1 257:7a50601356cc 159 * backend with advertising data before starting to advertise. It may also
rgrover1 257:7a50601356cc 160 * be explicity used to dynamically reset the accumulated advertising
rgrover1 257:7a50601356cc 161 * payload and scanResponse; to do this, the application can clear and re-
rgrover1 257:7a50601356cc 162 * accumulate a new advertising payload (and scanResponse) before using this
rgrover1 257:7a50601356cc 163 * API.
rgrover1 257:7a50601356cc 164 */
rgrover1 257:7a50601356cc 165 ble_error_t setAdvertisingPayload(void);
rgrover1 257:7a50601356cc 166
rgrover1 257:7a50601356cc 167 /**
rgrover1 409:37a4202649dd 168 * Set advertising data using object.
rgrover1 409:37a4202649dd 169 */
rgrover1 409:37a4202649dd 170 ble_error_t setAdvertisingData(const GapAdvertisingData &advData);
rgrover1 409:37a4202649dd 171
rgrover1 409:37a4202649dd 172 /**
rgrover1 409:37a4202649dd 173 * @return Read back advertising data. Useful for storing and
rgrover1 409:37a4202649dd 174 * restoring payload.
rgrover1 409:37a4202649dd 175 */
rgrover1 410:af8f2d1b67b6 176 const GapAdvertisingData &getAdvertisingData(void) const;
rgrover1 409:37a4202649dd 177
rgrover1 409:37a4202649dd 178 /**
rgrover1 257:7a50601356cc 179 * Reset any advertising payload prepared from prior calls to
rgrover1 257:7a50601356cc 180 * accumulateAdvertisingPayload().
rgrover1 343:4d2576324b62 181 *
rgrover1 343:4d2576324b62 182 * Note: This should be followed by a call to setAdvertisingPayload() or
rgrover1 343:4d2576324b62 183 * startAdvertising() before the update takes effect.
rgrover1 257:7a50601356cc 184 */
rgrover1 257:7a50601356cc 185 void clearAdvertisingPayload(void);
rgrover1 257:7a50601356cc 186
rgrover1 257:7a50601356cc 187 /**
rgrover1 257:7a50601356cc 188 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 257:7a50601356cc 189 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 257:7a50601356cc 190 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 257:7a50601356cc 191 * small.
rgrover1 257:7a50601356cc 192 *
rgrover1 257:7a50601356cc 193 * @param flags
rgrover1 257:7a50601356cc 194 * The flags to be added. Multiple flags may be specified in
rgrover1 257:7a50601356cc 195 * combination.
rgrover1 257:7a50601356cc 196 */
rgrover1 257:7a50601356cc 197 ble_error_t accumulateAdvertisingPayload(uint8_t flags);
rgrover1 257:7a50601356cc 198
rgrover1 257:7a50601356cc 199 /**
rgrover1 257:7a50601356cc 200 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 257:7a50601356cc 201 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 257:7a50601356cc 202 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 257:7a50601356cc 203 * small.
rgrover1 257:7a50601356cc 204 *
rgrover1 257:7a50601356cc 205 * @param app
rgrover1 257:7a50601356cc 206 * The appearance of the peripheral.
rgrover1 257:7a50601356cc 207 */
rgrover1 257:7a50601356cc 208 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app);
rgrover1 257:7a50601356cc 209
rgrover1 257:7a50601356cc 210 /**
rgrover1 257:7a50601356cc 211 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 257:7a50601356cc 212 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 257:7a50601356cc 213 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 257:7a50601356cc 214 * small.
rgrover1 257:7a50601356cc 215 *
rgrover1 257:7a50601356cc 216 * @param app
rgrover1 257:7a50601356cc 217 * The max transmit power to be used by the controller. This is
rgrover1 257:7a50601356cc 218 * only a hint.
rgrover1 257:7a50601356cc 219 */
rgrover1 257:7a50601356cc 220 ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power);
rgrover1 257:7a50601356cc 221
rgrover1 257:7a50601356cc 222 /**
rgrover1 257:7a50601356cc 223 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 257:7a50601356cc 224 * advertising payload. Please note that the payload is limited to 31 bytes.
rgrover1 257:7a50601356cc 225 * The SCAN_RESPONSE message may be used as an additional 31 bytes if the
rgrover1 257:7a50601356cc 226 * advertising payload proves to be too small.
rgrover1 257:7a50601356cc 227 *
rgrover1 257:7a50601356cc 228 * @param type The type which describes the variable length data.
rgrover1 257:7a50601356cc 229 * @param data data bytes.
rgrover1 257:7a50601356cc 230 * @param len length of data.
rgrover1 257:7a50601356cc 231 */
rgrover1 257:7a50601356cc 232 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len);
rgrover1 257:7a50601356cc 233
rgrover1 257:7a50601356cc 234 /**
rgrover1 257:7a50601356cc 235 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 257:7a50601356cc 236 * scanResponse payload.
rgrover1 257:7a50601356cc 237 *
rgrover1 257:7a50601356cc 238 * @param type The type which describes the variable length data.
rgrover1 257:7a50601356cc 239 * @param data data bytes.
rgrover1 257:7a50601356cc 240 * @param len length of data.
rgrover1 257:7a50601356cc 241 */
rgrover1 257:7a50601356cc 242 ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len);
rgrover1 257:7a50601356cc 243
rgrover1 257:7a50601356cc 244 /**
rgrover1 343:4d2576324b62 245 * Reset any scan response prepared from prior calls to
rgrover1 343:4d2576324b62 246 * accumulateScanResponse().
rgrover1 343:4d2576324b62 247 *
rgrover1 343:4d2576324b62 248 * Note: This should be followed by a call to setAdvertisingPayload() or
rgrover1 343:4d2576324b62 249 * startAdvertising() before the update takes effect.
rgrover1 343:4d2576324b62 250 */
rgrover1 343:4d2576324b62 251 void clearScanResponse(void);
rgrover1 343:4d2576324b62 252
rgrover1 343:4d2576324b62 253 /**
rgrover1 257:7a50601356cc 254 * Start advertising (GAP Discoverable, Connectable modes, Broadcast
rgrover1 257:7a50601356cc 255 * Procedure).
rgrover1 257:7a50601356cc 256 */
rgrover1 257:7a50601356cc 257 ble_error_t startAdvertising(void);
rgrover1 257:7a50601356cc 258
rgrover1 257:7a50601356cc 259 /**
rgrover1 257:7a50601356cc 260 * Stop advertising (GAP Discoverable, Connectable modes, Broadcast
rgrover1 257:7a50601356cc 261 * Procedure).
rgrover1 257:7a50601356cc 262 */
rgrover1 257:7a50601356cc 263 ble_error_t stopAdvertising(void);
rgrover1 257:7a50601356cc 264
rgrover1 335:dea9e14b7ddc 265 /**
rgrover1 380:2109a08c311c 266 * Setup parameters for GAP scanning--i.e. observer mode.
rgrover1 380:2109a08c311c 267 * @param interval Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 380:2109a08c311c 268 * @param window Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 380:2109a08c311c 269 * @param timeout Scan timeout (in seconds) between 0x0001 and 0xFFFF, 0x0000 disables timeout.
rgrover1 396:039ee79c9924 270 * @param activeScanning Set to True if active-scanning is required. This is used to fetch the
rgrover1 396:039ee79c9924 271 * scan response from a peer if possible.
rgrover1 390:4bf41689c7f9 272 *
rgrover1 390:4bf41689c7f9 273 * The scanning window divided by the interval determines the duty cycle for
rgrover1 390:4bf41689c7f9 274 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 390:4bf41689c7f9 275 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 390:4bf41689c7f9 276 * to have the interval and window set to the same value. In this case,
rgrover1 390:4bf41689c7f9 277 * scanning is continuous, with a change of scanning frequency once every
rgrover1 390:4bf41689c7f9 278 * interval.
rgrover1 390:4bf41689c7f9 279 *
rgrover1 390:4bf41689c7f9 280 * Once the scanning parameters have been configured, scanning can be
rgrover1 390:4bf41689c7f9 281 * enabled by using startScan().
rgrover1 390:4bf41689c7f9 282 *
rgrover1 390:4bf41689c7f9 283 * @Note: The scan interval and window are recommendations to the BLE stack.
rgrover1 380:2109a08c311c 284 */
rgrover1 394:598368c24bbb 285 ble_error_t setScanParams(uint16_t interval = GapScanningParams::SCAN_INTERVAL_MAX,
rgrover1 394:598368c24bbb 286 uint16_t window = GapScanningParams::SCAN_WINDOW_MAX,
rgrover1 394:598368c24bbb 287 uint16_t timeout = 0,
rgrover1 394:598368c24bbb 288 bool activeScanning = false);
rgrover1 392:3201f029c2eb 289 ble_error_t setScanInterval(uint16_t interval);
rgrover1 392:3201f029c2eb 290 ble_error_t setScanWindow (uint16_t window);
rgrover1 392:3201f029c2eb 291 ble_error_t setScanTimeout (uint16_t timeout);
rgrover1 395:4124520c17fc 292 void setActiveScan (bool activeScanning);
rgrover1 380:2109a08c311c 293
rgrover1 380:2109a08c311c 294 /**
rgrover1 380:2109a08c311c 295 * Start scanning (Observer Procedure) based on the scan-params currently
rgrover1 380:2109a08c311c 296 * in effect.
rgrover1 380:2109a08c311c 297 *
rgrover1 380:2109a08c311c 298 * @param callback The application callback to be invoked upon receiving
rgrover1 380:2109a08c311c 299 * every advertisement report. Can be passed in as NULL, in which case
rgrover1 380:2109a08c311c 300 * scanning may not be enabled at all.
rgrover1 380:2109a08c311c 301 */
rgrover1 406:cec6778acc66 302 ble_error_t startScan(void (*callback)(const Gap::AdvertisementCallbackParams_t *params));
rgrover1 380:2109a08c311c 303
rgrover1 380:2109a08c311c 304 /**
rgrover1 407:ca6b956b33d1 305 * Start scanning (Observer Procedure) based on the scan-params currently
rgrover1 407:ca6b956b33d1 306 * in effect.
rgrover1 407:ca6b956b33d1 307 *
rgrover1 407:ca6b956b33d1 308 * @param[in] object
rgrover1 407:ca6b956b33d1 309 * @param[in] callbackMember
rgrover1 407:ca6b956b33d1 310 * The above pair of parameters define the callback object
rgrover1 407:ca6b956b33d1 311 * and member function to receive the advertisement params.
rgrover1 407:ca6b956b33d1 312 */
rgrover1 407:ca6b956b33d1 313 template<typename T>
rgrover1 407:ca6b956b33d1 314 ble_error_t startScan(T *object, void (T::*memberCallback)(const Gap::AdvertisementCallbackParams_t *params));
rgrover1 407:ca6b956b33d1 315
rgrover1 407:ca6b956b33d1 316 /**
rgrover1 380:2109a08c311c 317 * Stop scanning. The current scanning parameters remain in effect.
rgrover1 380:2109a08c311c 318 *
rgrover1 380:2109a08c311c 319 * @retval BLE_ERROR_NONE if successfully stopped scanning procedure.
rgrover1 380:2109a08c311c 320 */
rgrover1 392:3201f029c2eb 321 ble_error_t stopScan(void);
rgrover1 380:2109a08c311c 322
rgrover1 446:4fdb01767cff 323 /**
rgrover1 524:6e97ab392e2a 324 * Create a connection (GAP Link Establishment).
rgrover1 524:6e97ab392e2a 325 * @param peerAddr
rgrover1 524:6e97ab392e2a 326 * 48-bit address, LSB format.
rgrover1 524:6e97ab392e2a 327 * @param peerAddrType
rgrover1 524:6e97ab392e2a 328 * Address type of the peer.
rgrover1 524:6e97ab392e2a 329 * @param connectionParams
rgrover1 524:6e97ab392e2a 330 * Connection parameters.
rgrover1 524:6e97ab392e2a 331 * @param scanParams
rgrover1 524:6e97ab392e2a 332 * Paramters to be used while scanning for the peer.
rgrover1 524:6e97ab392e2a 333 * @return BLE_ERROR_NONE if connection establishment procedure is started
rgrover1 524:6e97ab392e2a 334 * successfully. The onConnection callback (if set) will be invoked upon
rgrover1 524:6e97ab392e2a 335 * a connection event.
rgrover1 524:6e97ab392e2a 336 */
rgrover1 524:6e97ab392e2a 337 ble_error_t connect(const Gap::Address_t peerAddr,
rgrover1 524:6e97ab392e2a 338 Gap::AddressType_t peerAddrType = Gap::ADDR_TYPE_RANDOM_STATIC,
rgrover1 524:6e97ab392e2a 339 const Gap::ConnectionParams_t *connectionParams = NULL,
rgrover1 524:6e97ab392e2a 340 const GapScanningParams *scanParams = NULL);
rgrover1 524:6e97ab392e2a 341
rgrover1 524:6e97ab392e2a 342 /**
rgrover1 335:dea9e14b7ddc 343 * This call initiates the disconnection procedure, and its completion will
rgrover1 335:dea9e14b7ddc 344 * be communicated to the application with an invocation of the
rgrover1 335:dea9e14b7ddc 345 * onDisconnection callback.
rgrover1 335:dea9e14b7ddc 346 *
rgrover1 335:dea9e14b7ddc 347 * @param reason
rgrover1 335:dea9e14b7ddc 348 * The reason for disconnection to be sent back to the peer.
rgrover1 335:dea9e14b7ddc 349 */
rgrover1 257:7a50601356cc 350 ble_error_t disconnect(Gap::DisconnectionReason_t reason);
rgrover1 257:7a50601356cc 351
rgrover1 257:7a50601356cc 352 /* APIs to set GAP callbacks. */
rgrover1 257:7a50601356cc 353 void onTimeout(Gap::EventCallback_t timeoutCallback);
rgrover1 257:7a50601356cc 354
rgrover1 257:7a50601356cc 355 void onConnection(Gap::ConnectionEventCallback_t connectionCallback);
rgrover1 257:7a50601356cc 356 /**
rgrover1 257:7a50601356cc 357 * Used to setup a callback for GAP disconnection.
rgrover1 257:7a50601356cc 358 */
rgrover1 257:7a50601356cc 359 void onDisconnection(Gap::DisconnectionEventCallback_t disconnectionCallback);
rgrover1 257:7a50601356cc 360
rgrover1 257:7a50601356cc 361 /**
rgrover1 257:7a50601356cc 362 * Append to a chain of callbacks to be invoked upon disconnection; these
rgrover1 257:7a50601356cc 363 * callbacks receive no context and are therefore different from the
rgrover1 257:7a50601356cc 364 * onDisconnection callback.
rgrover1 257:7a50601356cc 365 */
rgrover1 257:7a50601356cc 366 template<typename T>
rgrover1 257:7a50601356cc 367 void addToDisconnectionCallChain(T *tptr, void (T::*mptr)(void));
rgrover1 257:7a50601356cc 368
rgrover1 257:7a50601356cc 369 /**
rgrover1 261:b275bfc773b9 370 * Add a callback for the GATT event DATA_SENT (which is triggered when
rgrover1 261:b275bfc773b9 371 * updates are sent out by GATT in the form of notifications).
rgrover1 259:a95264ad705c 372 *
rgrover1 259:a95264ad705c 373 * @Note: it is possible to chain together multiple onDataSent callbacks
rgrover1 259:a95264ad705c 374 * (potentially from different modules of an application) to receive updates
rgrover1 260:ea7f9f14cc15 375 * to characteristics.
rgrover1 259:a95264ad705c 376 *
rgrover1 259:a95264ad705c 377 * @Note: it is also possible to setup a callback into a member function of
rgrover1 259:a95264ad705c 378 * some object.
rgrover1 257:7a50601356cc 379 */
rgrover1 259:a95264ad705c 380 void onDataSent(void (*callback)(unsigned count));
rgrover1 259:a95264ad705c 381 template <typename T> void onDataSent(T * objPtr, void (T::*memberPtr)(unsigned count));
rgrover1 257:7a50601356cc 382
rgrover1 257:7a50601356cc 383 /**
rgrover1 257:7a50601356cc 384 * Setup a callback for when a characteristic has its value updated by a
rgrover1 257:7a50601356cc 385 * client.
rgrover1 257:7a50601356cc 386 *
rgrover1 257:7a50601356cc 387 * @Note: it is possible to chain together multiple onDataWritten callbacks
rgrover1 257:7a50601356cc 388 * (potentially from different modules of an application) to receive updates
rgrover1 257:7a50601356cc 389 * to characteristics. Many services, such as DFU and UART add their own
rgrover1 257:7a50601356cc 390 * onDataWritten callbacks behind the scenes to trap interesting events.
rgrover1 257:7a50601356cc 391 *
rgrover1 257:7a50601356cc 392 * @Note: it is also possible to setup a callback into a member function of
rgrover1 257:7a50601356cc 393 * some object.
rgrover1 257:7a50601356cc 394 */
rgrover1 524:6e97ab392e2a 395 void onDataWritten(void (*callback)(const GattWriteCallbackParams *eventDataP));
rgrover1 524:6e97ab392e2a 396 template <typename T> void onDataWritten(T * objPtr, void (T::*memberPtr)(const GattWriteCallbackParams *context));
rgrover1 257:7a50601356cc 397
rgrover1 300:d9a39f759a6a 398 /**
rgrover1 300:d9a39f759a6a 399 * Setup a callback for when a characteristic is being read by a client.
rgrover1 300:d9a39f759a6a 400 *
rgrover1 300:d9a39f759a6a 401 * @Note: this functionality may not be available on all underlying stacks.
rgrover1 300:d9a39f759a6a 402 * You could use GattCharacteristic::setReadAuthorizationCallback() as an
rgrover1 300:d9a39f759a6a 403 * alternative.
rgrover1 300:d9a39f759a6a 404 *
rgrover1 300:d9a39f759a6a 405 * @Note: it is possible to chain together multiple onDataRead callbacks
rgrover1 300:d9a39f759a6a 406 * (potentially from different modules of an application) to receive updates
rgrover1 300:d9a39f759a6a 407 * to characteristics. Services may add their own onDataRead callbacks
rgrover1 300:d9a39f759a6a 408 * behind the scenes to trap interesting events.
rgrover1 300:d9a39f759a6a 409 *
rgrover1 300:d9a39f759a6a 410 * @Note: it is also possible to setup a callback into a member function of
rgrover1 300:d9a39f759a6a 411 * some object.
rgrover1 300:d9a39f759a6a 412 *
rgrover1 300:d9a39f759a6a 413 * @return BLE_ERROR_NOT_IMPLEMENTED if this functionality isn't available;
rgrover1 300:d9a39f759a6a 414 * else BLE_ERROR_NONE.
rgrover1 300:d9a39f759a6a 415 */
rgrover1 524:6e97ab392e2a 416 ble_error_t onDataRead(void (*callback)(const GattReadCallbackParams *eventDataP));
rgrover1 524:6e97ab392e2a 417 template <typename T> ble_error_t onDataRead(T * objPtr, void (T::*memberPtr)(const GattReadCallbackParams *context));
rgrover1 300:d9a39f759a6a 418
rgrover1 257:7a50601356cc 419 void onUpdatesEnabled(GattServer::EventCallback_t callback);
rgrover1 257:7a50601356cc 420 void onUpdatesDisabled(GattServer::EventCallback_t callback);
rgrover1 257:7a50601356cc 421 void onConfirmationReceived(GattServer::EventCallback_t callback);
rgrover1 257:7a50601356cc 422
rgrover1 257:7a50601356cc 423 /**
rgrover1 341:8a104d9d80c1 424 * Radio Notification is a feature that enables ACTIVE and INACTIVE
rgrover1 341:8a104d9d80c1 425 * (nACTIVE) signals from the stack that notify the application when the
rgrover1 341:8a104d9d80c1 426 * radio is in use. The signal is sent using software interrupt.
rgrover1 341:8a104d9d80c1 427 *
rgrover1 341:8a104d9d80c1 428 * The ACTIVE signal is sent before the Radio Event starts. The nACTIVE
rgrover1 341:8a104d9d80c1 429 * signal is sent at the end of the Radio Event. These signals can be used
rgrover1 341:8a104d9d80c1 430 * by the application programmer to synchronize application logic with radio
rgrover1 341:8a104d9d80c1 431 * activity. For example, the ACTIVE signal can be used to shut off external
rgrover1 341:8a104d9d80c1 432 * devices to manage peak current drawn during periods when the radio is on,
rgrover1 341:8a104d9d80c1 433 * or to trigger sensor data collection for transmission in the Radio Event.
rgrover1 341:8a104d9d80c1 434 *
rgrover1 341:8a104d9d80c1 435 * @param callback
rgrover1 341:8a104d9d80c1 436 * The application handler to be invoked in response to a radio
rgrover1 341:8a104d9d80c1 437 * ACTIVE/INACTIVE event.
rgrover1 341:8a104d9d80c1 438 */
rgrover1 341:8a104d9d80c1 439 void onRadioNotification(Gap::RadioNotificationEventCallback_t callback);
rgrover1 341:8a104d9d80c1 440
rgrover1 341:8a104d9d80c1 441 /**
rgrover1 257:7a50601356cc 442 * Add a service declaration to the local server ATT table. Also add the
rgrover1 257:7a50601356cc 443 * characteristics contained within.
rgrover1 257:7a50601356cc 444 */
rgrover1 257:7a50601356cc 445 ble_error_t addService(GattService &service);
rgrover1 257:7a50601356cc 446
rgrover1 336:896e159d3af6 447 /**
rgrover1 336:896e159d3af6 448 * Returns the current GAP state of the device using a bitmask which
rgrover1 336:896e159d3af6 449 * describes whether the device is advertising and/or connected.
rgrover1 336:896e159d3af6 450 */
rgrover1 257:7a50601356cc 451 Gap::GapState_t getGapState(void) const;
rgrover1 257:7a50601356cc 452
rgrover1 257:7a50601356cc 453 /**
rgrover1 257:7a50601356cc 454 * @param[in/out] lengthP
rgrover1 257:7a50601356cc 455 * input: Length in bytes to be read,
rgrover1 257:7a50601356cc 456 * output: Total length of attribute value upon successful return.
rgrover1 257:7a50601356cc 457 */
rgrover1 328:1fd12f67ed7a 458 ble_error_t readCharacteristicValue(GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP);
rgrover1 342:152bd9c825d6 459 /**
rgrover1 342:152bd9c825d6 460 * A version of the same as above with connection handle parameter to allow fetches for connection-specific multivalued attribtues (such as the CCCDs).
rgrover1 342:152bd9c825d6 461 */
rgrover1 342:152bd9c825d6 462 ble_error_t readCharacteristicValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP);
rgrover1 257:7a50601356cc 463
rgrover1 257:7a50601356cc 464 /**
rgrover1 257:7a50601356cc 465 * @param localOnly
rgrover1 257:7a50601356cc 466 * Only update the characteristic locally regardless of notify/indicate flags in the CCCD.
rgrover1 257:7a50601356cc 467 */
rgrover1 328:1fd12f67ed7a 468 ble_error_t updateCharacteristicValue(GattAttribute::Handle_t attributeHandle, const uint8_t *value, uint16_t size, bool localOnly = false);
rgrover1 342:152bd9c825d6 469 /**
rgrover1 342:152bd9c825d6 470 * A version of the same as above with connection handle parameter to allow updates for connection-specific multivalued attribtues (such as the CCCDs).
rgrover1 342:152bd9c825d6 471 */
rgrover1 524:6e97ab392e2a 472 ble_error_t updateCharacteristicValue(Gap::Handle_t connectionHandle,
rgrover1 524:6e97ab392e2a 473 GattAttribute::Handle_t attributeHandle,
rgrover1 524:6e97ab392e2a 474 const uint8_t *value,
rgrover1 524:6e97ab392e2a 475 uint16_t size,
rgrover1 524:6e97ab392e2a 476 bool localOnly = false);
rgrover1 257:7a50601356cc 477
rgrover1 257:7a50601356cc 478 /**
rgrover1 257:7a50601356cc 479 * Yield control to the BLE stack or to other tasks waiting for events. This
rgrover1 257:7a50601356cc 480 * is a sleep function which will return when there is an application
rgrover1 257:7a50601356cc 481 * specific interrupt, but the MCU might wake up several times before
rgrover1 257:7a50601356cc 482 * returning (to service the stack). This is not always interchangeable with
rgrover1 257:7a50601356cc 483 * WFE().
rgrover1 257:7a50601356cc 484 */
rgrover1 257:7a50601356cc 485 void waitForEvent(void);
rgrover1 257:7a50601356cc 486
rgrover1 257:7a50601356cc 487 ble_error_t getPreferredConnectionParams(Gap::ConnectionParams_t *params);
rgrover1 257:7a50601356cc 488 ble_error_t setPreferredConnectionParams(const Gap::ConnectionParams_t *params);
rgrover1 257:7a50601356cc 489 ble_error_t updateConnectionParams(Gap::Handle_t handle, const Gap::ConnectionParams_t *params);
rgrover1 257:7a50601356cc 490
rgrover1 257:7a50601356cc 491 /**
rgrover1 257:7a50601356cc 492 * This call allows the application to get the BLE stack version information.
rgrover1 257:7a50601356cc 493 *
rgrover1 257:7a50601356cc 494 * @return A pointer to a const string representing the version.
rgrover1 257:7a50601356cc 495 * Note: The string is owned by the BLE_API.
rgrover1 257:7a50601356cc 496 */
rgrover1 257:7a50601356cc 497 const char *getVersion(void);
rgrover1 257:7a50601356cc 498
rgrover1 257:7a50601356cc 499 /**
rgrover1 257:7a50601356cc 500 * Set the device name characteristic in the GAP service.
rgrover1 257:7a50601356cc 501 * @param deviceName The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
rgrover1 257:7a50601356cc 502 */
rgrover1 257:7a50601356cc 503 ble_error_t setDeviceName(const uint8_t *deviceName);
rgrover1 257:7a50601356cc 504
rgrover1 257:7a50601356cc 505 /**
rgrover1 257:7a50601356cc 506 * Get the value of the device name characteristic in the GAP service.
rgrover1 257:7a50601356cc 507 * @param[out] deviceName Pointer to an empty buffer where the UTF-8 *non NULL-
rgrover1 257:7a50601356cc 508 * terminated* string will be placed. Set this
rgrover1 257:7a50601356cc 509 * value to NULL in order to obtain the deviceName-length
rgrover1 257:7a50601356cc 510 * from the 'length' parameter.
rgrover1 257:7a50601356cc 511 *
rgrover1 257:7a50601356cc 512 * @param[in/out] lengthP (on input) Length of the buffer pointed to by deviceName;
rgrover1 257:7a50601356cc 513 * (on output) the complete device name length (without the
rgrover1 257:7a50601356cc 514 * null terminator).
rgrover1 257:7a50601356cc 515 *
rgrover1 257:7a50601356cc 516 * @note If the device name is longer than the size of the supplied buffer,
rgrover1 257:7a50601356cc 517 * length will return the complete device name length,
rgrover1 257:7a50601356cc 518 * and not the number of bytes actually returned in deviceName.
rgrover1 257:7a50601356cc 519 * The application may use this information to retry with a suitable buffer size.
rgrover1 257:7a50601356cc 520 *
rgrover1 257:7a50601356cc 521 * Sample use:
rgrover1 257:7a50601356cc 522 * uint8_t deviceName[20];
rgrover1 257:7a50601356cc 523 * unsigned length = sizeof(deviceName);
rgrover1 257:7a50601356cc 524 * ble.getDeviceName(deviceName, &length);
rgrover1 257:7a50601356cc 525 * if (length < sizeof(deviceName)) {
rgrover1 257:7a50601356cc 526 * deviceName[length] = 0;
rgrover1 257:7a50601356cc 527 * }
rgrover1 257:7a50601356cc 528 * DEBUG("length: %u, deviceName: %s\r\n", length, deviceName);
rgrover1 257:7a50601356cc 529 */
rgrover1 257:7a50601356cc 530 ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP);
rgrover1 257:7a50601356cc 531
rgrover1 257:7a50601356cc 532 /**
rgrover1 257:7a50601356cc 533 * Set the appearance characteristic in the GAP service.
rgrover1 257:7a50601356cc 534 * @param[in] appearance The new value for the device-appearance.
rgrover1 257:7a50601356cc 535 */
rgrover1 257:7a50601356cc 536 ble_error_t setAppearance(uint16_t appearance);
rgrover1 257:7a50601356cc 537
rgrover1 257:7a50601356cc 538 /**
rgrover1 257:7a50601356cc 539 * Set the appearance characteristic in the GAP service.
rgrover1 257:7a50601356cc 540 * @param[out] appearance The new value for the device-appearance.
rgrover1 257:7a50601356cc 541 */
rgrover1 257:7a50601356cc 542 ble_error_t getAppearance(uint16_t *appearanceP);
rgrover1 257:7a50601356cc 543
rgrover1 257:7a50601356cc 544 /**
rgrover1 257:7a50601356cc 545 * Set the radio's transmit power.
rgrover1 257:7a50601356cc 546 * @param[in] txPower Radio transmit power in dBm.
rgrover1 257:7a50601356cc 547 */
rgrover1 257:7a50601356cc 548 ble_error_t setTxPower(int8_t txPower);
rgrover1 257:7a50601356cc 549
rgrover1 305:71367f7cd078 550 /**
rgrover1 305:71367f7cd078 551 * Query the underlying stack for permitted arguments for setTxPower().
rgrover1 305:71367f7cd078 552 *
rgrover1 305:71367f7cd078 553 * @param[out] valueArrayPP
rgrover1 305:71367f7cd078 554 * Out parameter to receive the immutable array of Tx values.
rgrover1 305:71367f7cd078 555 * @param[out] countP
rgrover1 305:71367f7cd078 556 * Out parameter to receive the array's size.
rgrover1 305:71367f7cd078 557 */
rgrover1 305:71367f7cd078 558 void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP);
rgrover1 305:71367f7cd078 559
rgrover1 347:20be4234c6fe 560 /**
rgrover1 347:20be4234c6fe 561 * Enable the BLE stack's Security Manager. The Security Manager implements
rgrover1 347:20be4234c6fe 562 * the actual cryptographic algorithms and protocol exchanges that allow two
rgrover1 347:20be4234c6fe 563 * devices to securely exchange data and privately detect each other.
rgrover1 347:20be4234c6fe 564 * Calling this API is a prerequisite for encryption and pairing (bonding).
rgrover1 357:d4bb5d2b837a 565 *
rgrover1 357:d4bb5d2b837a 566 * @param[in] enableBonding Allow for bonding.
rgrover1 357:d4bb5d2b837a 567 * @param[in] requireMITM Require protection for man-in-the-middle attacks.
rgrover1 357:d4bb5d2b837a 568 * @param[in] iocaps To specify IO capabilities of this peripheral,
rgrover1 357:d4bb5d2b837a 569 * such as availability of a display or keyboard to
rgrover1 357:d4bb5d2b837a 570 * support out-of-band exchanges of security data.
rgrover1 357:d4bb5d2b837a 571 * @param[in] passkey To specify a static passkey.
rgrover1 357:d4bb5d2b837a 572 *
rgrover1 357:d4bb5d2b837a 573 * @return BLE_ERROR_NONE on success.
rgrover1 347:20be4234c6fe 574 */
rgrover1 357:d4bb5d2b837a 575 ble_error_t initializeSecurity(bool enableBonding = true,
rgrover1 357:d4bb5d2b837a 576 bool requireMITM = true,
rgrover1 357:d4bb5d2b837a 577 Gap::SecurityIOCapabilities_t iocaps = Gap::IO_CAPS_NONE,
rgrover1 357:d4bb5d2b837a 578 const Gap::Passkey_t passkey = NULL);
rgrover1 347:20be4234c6fe 579
rgrover1 368:89726b616c1b 580 /**
rgrover1 368:89726b616c1b 581 * Setup a callback for when the security setup procedure (key generation
rgrover1 368:89726b616c1b 582 * and exchange) for a link has started. This will be skipped for bonded
rgrover1 368:89726b616c1b 583 * devices. The callback is passed in parameters received from the peer's
rgrover1 368:89726b616c1b 584 * security request: bool allowBonding, bool requireMITM, and
rgrover1 368:89726b616c1b 585 * SecurityIOCapabilities_t.
rgrover1 368:89726b616c1b 586 */
rgrover1 368:89726b616c1b 587 void onSecuritySetupInitiated(Gap::SecuritySetupInitiatedCallback_t callback);
rgrover1 368:89726b616c1b 588
rgrover1 368:89726b616c1b 589 /**
rgrover1 368:89726b616c1b 590 * Setup a callback for when the security setup procedure (key generation
rgrover1 368:89726b616c1b 591 * and exchange) for a link has completed. This will be skipped for bonded
rgrover1 368:89726b616c1b 592 * devices. The callback is passed in the success/failure status of the
rgrover1 368:89726b616c1b 593 * security setup procedure.
rgrover1 368:89726b616c1b 594 */
rgrover1 368:89726b616c1b 595 void onSecuritySetupCompleted(Gap::SecuritySetupCompletedCallback_t callback);
rgrover1 368:89726b616c1b 596
rgrover1 368:89726b616c1b 597 /**
rgrover1 368:89726b616c1b 598 * Setup a callback for when a link with the peer is secured. For bonded
rgrover1 368:89726b616c1b 599 * devices, subsequent reconnections with bonded peer will result only in
rgrover1 368:89726b616c1b 600 * this callback when the link is secured and setup procedures will not
rgrover1 368:89726b616c1b 601 * occur unless the bonding information is either lost or deleted on either
rgrover1 368:89726b616c1b 602 * or both sides. The callback is passed in a Gap::SecurityMode_t according
rgrover1 368:89726b616c1b 603 * to the level of security in effect for the secured link.
rgrover1 368:89726b616c1b 604 */
rgrover1 368:89726b616c1b 605 void onLinkSecured(Gap::LinkSecuredCallback_t callback);
rgrover1 368:89726b616c1b 606
rgrover1 368:89726b616c1b 607 /**
rgrover1 368:89726b616c1b 608 * Setup a callback for successful bonding; i.e. that link-specific security
rgrover1 368:89726b616c1b 609 * context is stored persistently for a peer device.
rgrover1 368:89726b616c1b 610 */
rgrover1 368:89726b616c1b 611 void onSecurityContextStored(Gap::HandleSpecificEvent_t callback);
rgrover1 368:89726b616c1b 612
rgrover1 368:89726b616c1b 613 /**
rgrover1 369:9a76cc068644 614 * Setup a callback for when the passkey needs to be displayed on a
rgrover1 369:9a76cc068644 615 * peripheral with DISPLAY capability. This happens when security is
rgrover1 369:9a76cc068644 616 * configured to prevent Man-In-The-Middle attacks, and a PIN (or passkey)
rgrover1 369:9a76cc068644 617 * needs to be exchanged between the peers to authenticate the connection
rgrover1 369:9a76cc068644 618 * attempt.
rgrover1 369:9a76cc068644 619 */
rgrover1 369:9a76cc068644 620 void onPasskeyDisplay(Gap::PasskeyDisplayCallback_t callback);
rgrover1 369:9a76cc068644 621
rgrover1 369:9a76cc068644 622 /**
rgrover1 368:89726b616c1b 623 * Get the security status of a connection.
rgrover1 368:89726b616c1b 624 *
rgrover1 368:89726b616c1b 625 * @param[in] connectionHandle Handle to identify the connection.
rgrover1 368:89726b616c1b 626 * @param[out] securityStatusP security status.
rgrover1 368:89726b616c1b 627 *
rgrover1 368:89726b616c1b 628 * @return BLE_SUCCESS Or appropriate error code indicating reason for failure.
rgrover1 368:89726b616c1b 629 */
rgrover1 368:89726b616c1b 630 ble_error_t getLinkSecurity(Gap::Handle_t connectionHandle, Gap::LinkSecurityStatus_t *securityStatusP);
rgrover1 368:89726b616c1b 631
rgrover1 371:6c73b5970f2d 632 /**
rgrover1 371:6c73b5970f2d 633 * Delete all peer device context and all related bonding information from
rgrover1 371:6c73b5970f2d 634 * the database within the security manager.
rgrover1 371:6c73b5970f2d 635 *
rgrover1 371:6c73b5970f2d 636 * @retval BLE_ERROR_NONE On success, else an error code indicating reason for failure.
rgrover1 371:6c73b5970f2d 637 * @retval BLE_ERROR_INVALID_STATE If the API is called without module initialization and/or
rgrover1 371:6c73b5970f2d 638 * application registration.
rgrover1 371:6c73b5970f2d 639 */
rgrover1 371:6c73b5970f2d 640 ble_error_t purgeAllBondingState(void);
rgrover1 371:6c73b5970f2d 641
rgrover1 524:6e97ab392e2a 642 /**
rgrover1 524:6e97ab392e2a 643 * Launch service discovery. Once launched, service discovery will remain
rgrover1 524:6e97ab392e2a 644 * active with callbacks being issued back into the application for matching
rgrover1 524:6e97ab392e2a 645 * services/characteristics. isServiceDiscoveryActive() can be used to
rgrover1 524:6e97ab392e2a 646 * determine status; and a termination callback (if setup) will be invoked
rgrover1 524:6e97ab392e2a 647 * at the end. Service discovery can be terminated prematurely if needed
rgrover1 524:6e97ab392e2a 648 * using terminateServiceDiscovery().
rgrover1 524:6e97ab392e2a 649 *
rgrover1 524:6e97ab392e2a 650 * @param connectionHandle
rgrover1 524:6e97ab392e2a 651 * Handle for the connection with the peer.
rgrover1 524:6e97ab392e2a 652 * @param sc
rgrover1 524:6e97ab392e2a 653 * This is the application callback for matching service. Taken as
rgrover1 524:6e97ab392e2a 654 * NULL by default. Note: service discovery may still be active
rgrover1 524:6e97ab392e2a 655 * when this callback is issued; calling asynchronous BLE-stack
rgrover1 524:6e97ab392e2a 656 * APIs from within this application callback might cause the
rgrover1 524:6e97ab392e2a 657 * stack to abort service discovery. If this becomes an issue, it
rgrover1 524:6e97ab392e2a 658 * may be better to make local copy of the discoveredService and
rgrover1 524:6e97ab392e2a 659 * wait for service discovery to terminate before operating on the
rgrover1 524:6e97ab392e2a 660 * service.
rgrover1 524:6e97ab392e2a 661 * @param cc
rgrover1 524:6e97ab392e2a 662 * This is the application callback for matching characteristic.
rgrover1 524:6e97ab392e2a 663 * Taken as NULL by default. Note: service discovery may still be
rgrover1 524:6e97ab392e2a 664 * active when this callback is issued; calling asynchronous
rgrover1 524:6e97ab392e2a 665 * BLE-stack APIs from within this application callback might cause
rgrover1 524:6e97ab392e2a 666 * the stack to abort service discovery. If this becomes an issue,
rgrover1 524:6e97ab392e2a 667 * it may be better to make local copy of the discoveredCharacteristic
rgrover1 524:6e97ab392e2a 668 * and wait for service discovery to terminate before operating on the
rgrover1 524:6e97ab392e2a 669 * characteristic.
rgrover1 524:6e97ab392e2a 670 * @param matchingServiceUUID
rgrover1 524:6e97ab392e2a 671 * UUID based filter for specifying a service in which the application is
rgrover1 524:6e97ab392e2a 672 * interested. By default it is set as the wildcard UUID_UNKNOWN,
rgrover1 524:6e97ab392e2a 673 * in which case it matches all services. If characteristic-UUID
rgrover1 524:6e97ab392e2a 674 * filter (below) is set to the wildcard value, then a service
rgrover1 524:6e97ab392e2a 675 * callback will be invoked for the matching service (or for every
rgrover1 524:6e97ab392e2a 676 * service if the service filter is a wildcard).
rgrover1 524:6e97ab392e2a 677 * @param matchingCharacteristicUUIDIn
rgrover1 524:6e97ab392e2a 678 * UUID based filter for specifying characteristic in which the application
rgrover1 524:6e97ab392e2a 679 * is interested. By default it is set as the wildcard UUID_UKNOWN
rgrover1 524:6e97ab392e2a 680 * to match against any characteristic. If both service-UUID
rgrover1 524:6e97ab392e2a 681 * filter and characteristic-UUID filter are used with non- wildcard
rgrover1 524:6e97ab392e2a 682 * values, then only a single characteristic callback is
rgrover1 524:6e97ab392e2a 683 * invoked for the matching characteristic.
rgrover1 524:6e97ab392e2a 684 *
rgrover1 524:6e97ab392e2a 685 * @Note Using wildcard values for both service-UUID and characteristic-
rgrover1 524:6e97ab392e2a 686 * UUID will result in complete service discovery--callbacks being
rgrover1 524:6e97ab392e2a 687 * called for every service and characteristic.
rgrover1 524:6e97ab392e2a 688 *
rgrover1 524:6e97ab392e2a 689 * @return
rgrover1 524:6e97ab392e2a 690 * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error.
rgrover1 524:6e97ab392e2a 691 */
rgrover1 524:6e97ab392e2a 692 ble_error_t launchServiceDiscovery(Gap::Handle_t connectionHandle,
rgrover1 524:6e97ab392e2a 693 ServiceDiscovery::ServiceCallback_t sc = NULL,
rgrover1 524:6e97ab392e2a 694 ServiceDiscovery::CharacteristicCallback_t cc = NULL,
rgrover1 524:6e97ab392e2a 695 const UUID &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN),
rgrover1 524:6e97ab392e2a 696 const UUID &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN));
rgrover1 524:6e97ab392e2a 697
rgrover1 524:6e97ab392e2a 698 /**
rgrover1 524:6e97ab392e2a 699 * Setup callback for when serviceDiscovery terminates.
rgrover1 524:6e97ab392e2a 700 */
rgrover1 524:6e97ab392e2a 701 void onServiceDiscoveryTermination(ServiceDiscovery::TerminationCallback_t callback);
rgrover1 524:6e97ab392e2a 702
rgrover1 524:6e97ab392e2a 703 /**
rgrover1 524:6e97ab392e2a 704 * Is service-discovery currently active?
rgrover1 524:6e97ab392e2a 705 */
rgrover1 524:6e97ab392e2a 706 bool isServiceDiscoveryActive(void);
rgrover1 524:6e97ab392e2a 707
rgrover1 524:6e97ab392e2a 708 /**
rgrover1 524:6e97ab392e2a 709 * Terminate an ongoing service-discovery. This should result in an
rgrover1 524:6e97ab392e2a 710 * invocation of the TerminationCallback if service-discovery is active.
rgrover1 524:6e97ab392e2a 711 */
rgrover1 524:6e97ab392e2a 712 void terminateServiceDiscovery(void);
rgrover1 524:6e97ab392e2a 713
rgrover1 257:7a50601356cc 714 public:
rgrover1 383:7bd527ea7280 715 BLEDevice() : transport(createBLEDeviceInstance()), advParams(), advPayload(), scanResponse(), needToSetAdvPayload(true), scanningParams() {
rgrover1 257:7a50601356cc 716 advPayload.clear();
rgrover1 257:7a50601356cc 717 scanResponse.clear();
rgrover1 257:7a50601356cc 718 }
rgrover1 257:7a50601356cc 719
rgrover1 257:7a50601356cc 720 private:
rgrover1 257:7a50601356cc 721 BLEDeviceInstanceBase *const transport; /* the device specific backend */
rgrover1 257:7a50601356cc 722
rgrover1 257:7a50601356cc 723 GapAdvertisingParams advParams;
rgrover1 257:7a50601356cc 724 GapAdvertisingData advPayload;
rgrover1 257:7a50601356cc 725 GapAdvertisingData scanResponse;
rgrover1 257:7a50601356cc 726
rgrover1 257:7a50601356cc 727 /* Accumulation of AD structures in the advertisement payload should
rgrover1 257:7a50601356cc 728 * eventually result in a call to the target's setAdvertisingData() before
rgrover1 257:7a50601356cc 729 * the server begins advertising. This flag marks the status of the pending update.*/
rgrover1 257:7a50601356cc 730 bool needToSetAdvPayload;
rgrover1 380:2109a08c311c 731
rgrover1 380:2109a08c311c 732 GapScanningParams scanningParams;
rgrover1 257:7a50601356cc 733 };
rgrover1 257:7a50601356cc 734
rgrover1 257:7a50601356cc 735 /* BLEDevice methods. Most of these simply forward the calls to the underlying
rgrover1 257:7a50601356cc 736 * transport.*/
rgrover1 257:7a50601356cc 737
rgrover1 257:7a50601356cc 738 inline ble_error_t
rgrover1 257:7a50601356cc 739 BLEDevice::reset(void)
rgrover1 257:7a50601356cc 740 {
rgrover1 257:7a50601356cc 741 return transport->reset();
rgrover1 257:7a50601356cc 742 }
rgrover1 257:7a50601356cc 743
rgrover1 257:7a50601356cc 744 inline ble_error_t
rgrover1 257:7a50601356cc 745 BLEDevice::shutdown(void)
rgrover1 257:7a50601356cc 746 {
rgrover1 257:7a50601356cc 747 clearAdvertisingPayload();
rgrover1 257:7a50601356cc 748 return transport->shutdown();
rgrover1 257:7a50601356cc 749 }
rgrover1 257:7a50601356cc 750
rgrover1 257:7a50601356cc 751 inline ble_error_t
rgrover1 450:47aa4a9161a7 752 BLEDevice::setAddress(Gap::AddressType_t type, const Gap::Address_t address)
rgrover1 257:7a50601356cc 753 {
rgrover1 257:7a50601356cc 754 return transport->getGap().setAddress(type, address);
rgrover1 257:7a50601356cc 755 }
rgrover1 257:7a50601356cc 756
rgrover1 257:7a50601356cc 757 inline ble_error_t
rgrover1 450:47aa4a9161a7 758 BLEDevice::getAddress(Gap::AddressType_t *typeP, Gap::Address_t address)
rgrover1 257:7a50601356cc 759 {
rgrover1 257:7a50601356cc 760 return transport->getGap().getAddress(typeP, address);
rgrover1 257:7a50601356cc 761 }
rgrover1 257:7a50601356cc 762
rgrover1 257:7a50601356cc 763 inline void
rgrover1 257:7a50601356cc 764 BLEDevice::setAdvertisingType(GapAdvertisingParams::AdvertisingType advType)
rgrover1 257:7a50601356cc 765 {
rgrover1 257:7a50601356cc 766 advParams.setAdvertisingType(advType);
rgrover1 257:7a50601356cc 767 }
rgrover1 257:7a50601356cc 768
rgrover1 257:7a50601356cc 769 inline void
rgrover1 257:7a50601356cc 770 BLEDevice::setAdvertisingInterval(uint16_t interval)
rgrover1 257:7a50601356cc 771 {
rgrover1 325:501ad8b8bbe5 772 if (interval == 0) {
rgrover1 325:501ad8b8bbe5 773 stopAdvertising();
rgrover1 325:501ad8b8bbe5 774 } else if (interval < getMinAdvertisingInterval()) {
rgrover1 325:501ad8b8bbe5 775 interval = getMinAdvertisingInterval();
rgrover1 325:501ad8b8bbe5 776 }
rgrover1 325:501ad8b8bbe5 777 advParams.setInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(interval));
rgrover1 325:501ad8b8bbe5 778 }
rgrover1 325:501ad8b8bbe5 779
rgrover1 325:501ad8b8bbe5 780 inline uint16_t
rgrover1 325:501ad8b8bbe5 781 BLEDevice::getMinAdvertisingInterval(void) const {
rgrover1 325:501ad8b8bbe5 782 return transport->getGap().getMinAdvertisingInterval();
rgrover1 325:501ad8b8bbe5 783 }
rgrover1 325:501ad8b8bbe5 784
rgrover1 325:501ad8b8bbe5 785 inline uint16_t
rgrover1 325:501ad8b8bbe5 786 BLEDevice::getMinNonConnectableAdvertisingInterval(void) const {
rgrover1 325:501ad8b8bbe5 787 return transport->getGap().getMinNonConnectableAdvertisingInterval();
rgrover1 325:501ad8b8bbe5 788 }
rgrover1 325:501ad8b8bbe5 789
rgrover1 325:501ad8b8bbe5 790 inline uint16_t
rgrover1 325:501ad8b8bbe5 791 BLEDevice::getMaxAdvertisingInterval(void) const {
rgrover1 325:501ad8b8bbe5 792 return transport->getGap().getMaxAdvertisingInterval();
rgrover1 257:7a50601356cc 793 }
rgrover1 257:7a50601356cc 794
rgrover1 257:7a50601356cc 795 inline void
rgrover1 257:7a50601356cc 796 BLEDevice::setAdvertisingTimeout(uint16_t timeout)
rgrover1 257:7a50601356cc 797 {
rgrover1 257:7a50601356cc 798 advParams.setTimeout(timeout);
rgrover1 257:7a50601356cc 799 }
rgrover1 257:7a50601356cc 800
rgrover1 257:7a50601356cc 801 inline void
rgrover1 257:7a50601356cc 802 BLEDevice::setAdvertisingParams(const GapAdvertisingParams &newAdvParams)
rgrover1 257:7a50601356cc 803 {
rgrover1 257:7a50601356cc 804 advParams = newAdvParams;
rgrover1 257:7a50601356cc 805 }
rgrover1 257:7a50601356cc 806
rgrover1 410:af8f2d1b67b6 807 inline const GapAdvertisingParams &
rgrover1 410:af8f2d1b67b6 808 BLEDevice::getAdvertisingParams(void) const
rgrover1 409:37a4202649dd 809 {
rgrover1 409:37a4202649dd 810 return advParams;
rgrover1 409:37a4202649dd 811 }
rgrover1 409:37a4202649dd 812
rgrover1 257:7a50601356cc 813 inline void
rgrover1 257:7a50601356cc 814 BLEDevice::clearAdvertisingPayload(void)
rgrover1 257:7a50601356cc 815 {
rgrover1 257:7a50601356cc 816 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 817 advPayload.clear();
rgrover1 257:7a50601356cc 818 }
rgrover1 257:7a50601356cc 819
rgrover1 257:7a50601356cc 820 inline ble_error_t
rgrover1 257:7a50601356cc 821 BLEDevice::accumulateAdvertisingPayload(uint8_t flags)
rgrover1 257:7a50601356cc 822 {
rgrover1 257:7a50601356cc 823 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 824 return advPayload.addFlags(flags);
rgrover1 257:7a50601356cc 825 }
rgrover1 257:7a50601356cc 826
rgrover1 257:7a50601356cc 827 inline ble_error_t
rgrover1 257:7a50601356cc 828 BLEDevice::accumulateAdvertisingPayload(GapAdvertisingData::Appearance app)
rgrover1 257:7a50601356cc 829 {
rgrover1 257:7a50601356cc 830 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 831 transport->getGap().setAppearance(app);
rgrover1 257:7a50601356cc 832 return advPayload.addAppearance(app);
rgrover1 257:7a50601356cc 833 }
rgrover1 257:7a50601356cc 834
rgrover1 257:7a50601356cc 835 inline ble_error_t
rgrover1 257:7a50601356cc 836 BLEDevice::accumulateAdvertisingPayloadTxPower(int8_t txPower)
rgrover1 257:7a50601356cc 837 {
rgrover1 257:7a50601356cc 838 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 839 return advPayload.addTxPower(txPower);
rgrover1 257:7a50601356cc 840 }
rgrover1 257:7a50601356cc 841
rgrover1 257:7a50601356cc 842 inline ble_error_t
rgrover1 257:7a50601356cc 843 BLEDevice::accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len)
rgrover1 257:7a50601356cc 844 {
rgrover1 257:7a50601356cc 845 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 846 if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
rgrover1 257:7a50601356cc 847 transport->getGap().setDeviceName(data);
rgrover1 257:7a50601356cc 848 }
rgrover1 257:7a50601356cc 849 return advPayload.addData(type, data, len);
rgrover1 257:7a50601356cc 850 }
rgrover1 257:7a50601356cc 851
rgrover1 257:7a50601356cc 852 inline ble_error_t
rgrover1 257:7a50601356cc 853 BLEDevice::accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len)
rgrover1 257:7a50601356cc 854 {
rgrover1 257:7a50601356cc 855 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 856 return scanResponse.addData(type, data, len);
rgrover1 257:7a50601356cc 857 }
rgrover1 257:7a50601356cc 858
rgrover1 343:4d2576324b62 859 inline void
rgrover1 343:4d2576324b62 860 BLEDevice::clearScanResponse(void)
rgrover1 343:4d2576324b62 861 {
rgrover1 343:4d2576324b62 862 needToSetAdvPayload = true;
rgrover1 343:4d2576324b62 863 scanResponse.clear();
rgrover1 343:4d2576324b62 864 }
rgrover1 343:4d2576324b62 865
rgrover1 257:7a50601356cc 866 inline ble_error_t
rgrover1 257:7a50601356cc 867 BLEDevice::setAdvertisingPayload(void) {
rgrover1 257:7a50601356cc 868 needToSetAdvPayload = false;
rgrover1 257:7a50601356cc 869 return transport->getGap().setAdvertisingData(advPayload, scanResponse);
rgrover1 257:7a50601356cc 870 }
rgrover1 257:7a50601356cc 871
rgrover1 257:7a50601356cc 872 inline ble_error_t
rgrover1 409:37a4202649dd 873 BLEDevice::setAdvertisingData(const GapAdvertisingData& newPayload)
rgrover1 409:37a4202649dd 874 {
rgrover1 409:37a4202649dd 875 advPayload = newPayload;
rgrover1 409:37a4202649dd 876
rgrover1 409:37a4202649dd 877 return setAdvertisingPayload();
rgrover1 409:37a4202649dd 878 }
rgrover1 409:37a4202649dd 879
rgrover1 410:af8f2d1b67b6 880 inline const GapAdvertisingData &
rgrover1 410:af8f2d1b67b6 881 BLEDevice::getAdvertisingData(void) const {
rgrover1 409:37a4202649dd 882 return advPayload;
rgrover1 409:37a4202649dd 883 }
rgrover1 409:37a4202649dd 884
rgrover1 409:37a4202649dd 885 inline ble_error_t
rgrover1 257:7a50601356cc 886 BLEDevice::startAdvertising(void)
rgrover1 257:7a50601356cc 887 {
rgrover1 257:7a50601356cc 888 ble_error_t rc;
rgrover1 257:7a50601356cc 889 if ((rc = transport->getGattServer().initializeGATTDatabase()) != BLE_ERROR_NONE) {
rgrover1 257:7a50601356cc 890 return rc;
rgrover1 257:7a50601356cc 891 }
rgrover1 257:7a50601356cc 892 if (needToSetAdvPayload) {
rgrover1 257:7a50601356cc 893 if ((rc = setAdvertisingPayload()) != BLE_ERROR_NONE) {
rgrover1 257:7a50601356cc 894 return rc;
rgrover1 257:7a50601356cc 895 }
rgrover1 257:7a50601356cc 896 }
rgrover1 257:7a50601356cc 897
rgrover1 257:7a50601356cc 898 return transport->getGap().startAdvertising(advParams);
rgrover1 257:7a50601356cc 899 }
rgrover1 257:7a50601356cc 900
rgrover1 257:7a50601356cc 901 inline ble_error_t
rgrover1 257:7a50601356cc 902 BLEDevice::stopAdvertising(void)
rgrover1 257:7a50601356cc 903 {
rgrover1 257:7a50601356cc 904 return transport->getGap().stopAdvertising();
rgrover1 257:7a50601356cc 905 }
rgrover1 257:7a50601356cc 906
rgrover1 257:7a50601356cc 907 inline ble_error_t
rgrover1 394:598368c24bbb 908 BLEDevice::setScanParams(uint16_t interval, uint16_t window, uint16_t timeout, bool activeScanning) {
rgrover1 384:48412313df56 909 ble_error_t rc;
rgrover1 384:48412313df56 910 if (((rc = scanningParams.setInterval(interval)) == BLE_ERROR_NONE) &&
rgrover1 384:48412313df56 911 ((rc = scanningParams.setWindow(window)) == BLE_ERROR_NONE) &&
rgrover1 384:48412313df56 912 ((rc = scanningParams.setTimeout(timeout)) == BLE_ERROR_NONE)) {
rgrover1 394:598368c24bbb 913 scanningParams.setActiveScanning(activeScanning);
rgrover1 384:48412313df56 914 return BLE_ERROR_NONE;
rgrover1 384:48412313df56 915 }
rgrover1 384:48412313df56 916
rgrover1 384:48412313df56 917 return rc;
rgrover1 384:48412313df56 918 }
rgrover1 384:48412313df56 919
rgrover1 384:48412313df56 920 inline ble_error_t
rgrover1 392:3201f029c2eb 921 BLEDevice::setScanInterval(uint16_t interval) {
rgrover1 384:48412313df56 922 return scanningParams.setInterval(interval);
rgrover1 384:48412313df56 923 }
rgrover1 384:48412313df56 924
rgrover1 384:48412313df56 925 inline ble_error_t
rgrover1 392:3201f029c2eb 926 BLEDevice::setScanWindow(uint16_t window) {
rgrover1 384:48412313df56 927 return scanningParams.setWindow(window);
rgrover1 384:48412313df56 928 }
rgrover1 384:48412313df56 929
rgrover1 384:48412313df56 930 inline ble_error_t
rgrover1 392:3201f029c2eb 931 BLEDevice::setScanTimeout(uint16_t timeout) {
rgrover1 384:48412313df56 932 return scanningParams.setTimeout(timeout);
rgrover1 384:48412313df56 933 }
rgrover1 384:48412313df56 934
rgrover1 394:598368c24bbb 935 inline void
rgrover1 394:598368c24bbb 936 BLEDevice::setActiveScan(bool activeScanning) {
rgrover1 394:598368c24bbb 937 return scanningParams.setActiveScanning(activeScanning);
rgrover1 394:598368c24bbb 938 }
rgrover1 394:598368c24bbb 939
rgrover1 384:48412313df56 940 inline ble_error_t
rgrover1 406:cec6778acc66 941 BLEDevice::startScan(void (*callback)(const Gap::AdvertisementCallbackParams_t *params)) {
rgrover1 392:3201f029c2eb 942 return transport->getGap().startScan(scanningParams, callback);
rgrover1 385:6e66d1c6de00 943 }
rgrover1 385:6e66d1c6de00 944
rgrover1 407:ca6b956b33d1 945 template<typename T>
rgrover1 407:ca6b956b33d1 946 inline ble_error_t
rgrover1 407:ca6b956b33d1 947 BLEDevice::startScan(T *object, void (T::*memberCallback)(const Gap::AdvertisementCallbackParams_t *params)) {
rgrover1 407:ca6b956b33d1 948 return transport->getGap().startScan(scanningParams, object, memberCallback);
rgrover1 407:ca6b956b33d1 949 }
rgrover1 407:ca6b956b33d1 950
rgrover1 385:6e66d1c6de00 951 inline ble_error_t
rgrover1 392:3201f029c2eb 952 BLEDevice::stopScan(void) {
rgrover1 392:3201f029c2eb 953 return transport->getGap().stopScan();
rgrover1 387:7faa54079669 954 }
rgrover1 387:7faa54079669 955
rgrover1 387:7faa54079669 956 inline ble_error_t
rgrover1 524:6e97ab392e2a 957 BLEDevice::connect(const Gap::Address_t peerAddr,
rgrover1 524:6e97ab392e2a 958 Gap::AddressType_t peerAddrType,
rgrover1 524:6e97ab392e2a 959 const Gap::ConnectionParams_t *connectionParams,
rgrover1 524:6e97ab392e2a 960 const GapScanningParams *scanParams) {
rgrover1 524:6e97ab392e2a 961 return transport->getGap().connect(peerAddr, peerAddrType, connectionParams, scanParams);
rgrover1 524:6e97ab392e2a 962 }
rgrover1 524:6e97ab392e2a 963
rgrover1 524:6e97ab392e2a 964 inline ble_error_t
rgrover1 257:7a50601356cc 965 BLEDevice::disconnect(Gap::DisconnectionReason_t reason)
rgrover1 257:7a50601356cc 966 {
rgrover1 257:7a50601356cc 967 return transport->getGap().disconnect(reason);
rgrover1 257:7a50601356cc 968 }
rgrover1 257:7a50601356cc 969
rgrover1 257:7a50601356cc 970 inline void
rgrover1 257:7a50601356cc 971 BLEDevice::onTimeout(Gap::EventCallback_t timeoutCallback)
rgrover1 257:7a50601356cc 972 {
rgrover1 257:7a50601356cc 973 transport->getGap().setOnTimeout(timeoutCallback);
rgrover1 257:7a50601356cc 974 }
rgrover1 257:7a50601356cc 975
rgrover1 257:7a50601356cc 976 inline void
rgrover1 257:7a50601356cc 977 BLEDevice::onConnection(Gap::ConnectionEventCallback_t connectionCallback)
rgrover1 257:7a50601356cc 978 {
rgrover1 257:7a50601356cc 979 transport->getGap().setOnConnection(connectionCallback);
rgrover1 257:7a50601356cc 980 }
rgrover1 257:7a50601356cc 981
rgrover1 257:7a50601356cc 982 inline void
rgrover1 257:7a50601356cc 983 BLEDevice::onDisconnection(Gap::DisconnectionEventCallback_t disconnectionCallback)
rgrover1 257:7a50601356cc 984 {
rgrover1 257:7a50601356cc 985 transport->getGap().setOnDisconnection(disconnectionCallback);
rgrover1 257:7a50601356cc 986 }
rgrover1 257:7a50601356cc 987
rgrover1 257:7a50601356cc 988 template<typename T>
rgrover1 257:7a50601356cc 989 inline void
rgrover1 257:7a50601356cc 990 BLEDevice::addToDisconnectionCallChain(T *tptr, void (T::*mptr)(void)) {
rgrover1 257:7a50601356cc 991 transport->getGap().addToDisconnectionCallChain(tptr, mptr);
rgrover1 257:7a50601356cc 992 }
rgrover1 257:7a50601356cc 993
rgrover1 257:7a50601356cc 994 inline void
rgrover1 259:a95264ad705c 995 BLEDevice::onDataSent(void (*callback)(unsigned count)) {
rgrover1 257:7a50601356cc 996 transport->getGattServer().setOnDataSent(callback);
rgrover1 257:7a50601356cc 997 }
rgrover1 257:7a50601356cc 998
rgrover1 259:a95264ad705c 999 template <typename T> inline void
rgrover1 259:a95264ad705c 1000 BLEDevice::onDataSent(T *objPtr, void (T::*memberPtr)(unsigned count)) {
rgrover1 259:a95264ad705c 1001 transport->getGattServer().setOnDataSent(objPtr, memberPtr);
rgrover1 259:a95264ad705c 1002 }
rgrover1 259:a95264ad705c 1003
rgrover1 257:7a50601356cc 1004 inline void
rgrover1 524:6e97ab392e2a 1005 BLEDevice::onDataWritten(void (*callback)(const GattWriteCallbackParams *eventDataP)) {
rgrover1 257:7a50601356cc 1006 transport->getGattServer().setOnDataWritten(callback);
rgrover1 257:7a50601356cc 1007 }
rgrover1 257:7a50601356cc 1008
rgrover1 257:7a50601356cc 1009 template <typename T> inline void
rgrover1 524:6e97ab392e2a 1010 BLEDevice::onDataWritten(T *objPtr, void (T::*memberPtr)(const GattWriteCallbackParams *context)) {
rgrover1 257:7a50601356cc 1011 transport->getGattServer().setOnDataWritten(objPtr, memberPtr);
rgrover1 257:7a50601356cc 1012 }
rgrover1 257:7a50601356cc 1013
rgrover1 300:d9a39f759a6a 1014 inline ble_error_t
rgrover1 524:6e97ab392e2a 1015 BLEDevice::onDataRead(void (*callback)(const GattReadCallbackParams *eventDataP)) {
rgrover1 300:d9a39f759a6a 1016 return transport->getGattServer().setOnDataRead(callback);
rgrover1 300:d9a39f759a6a 1017 }
rgrover1 300:d9a39f759a6a 1018
rgrover1 300:d9a39f759a6a 1019 template <typename T> inline ble_error_t
rgrover1 524:6e97ab392e2a 1020 BLEDevice::onDataRead(T *objPtr, void (T::*memberPtr)(const GattReadCallbackParams *context)) {
rgrover1 300:d9a39f759a6a 1021 return transport->getGattServer().setOnDataRead(objPtr, memberPtr);
rgrover1 300:d9a39f759a6a 1022 }
rgrover1 300:d9a39f759a6a 1023
rgrover1 257:7a50601356cc 1024 inline void
rgrover1 257:7a50601356cc 1025 BLEDevice::onUpdatesEnabled(GattServer::EventCallback_t callback)
rgrover1 257:7a50601356cc 1026 {
rgrover1 257:7a50601356cc 1027 transport->getGattServer().setOnUpdatesEnabled(callback);
rgrover1 257:7a50601356cc 1028 }
rgrover1 257:7a50601356cc 1029
rgrover1 257:7a50601356cc 1030 inline void
rgrover1 257:7a50601356cc 1031 BLEDevice::onUpdatesDisabled(GattServer::EventCallback_t callback)
rgrover1 257:7a50601356cc 1032 {
rgrover1 257:7a50601356cc 1033 transport->getGattServer().setOnUpdatesDisabled(callback);
rgrover1 257:7a50601356cc 1034 }
rgrover1 257:7a50601356cc 1035
rgrover1 257:7a50601356cc 1036 inline void
rgrover1 257:7a50601356cc 1037 BLEDevice::onConfirmationReceived(GattServer::EventCallback_t callback)
rgrover1 257:7a50601356cc 1038 {
rgrover1 257:7a50601356cc 1039 transport->getGattServer().setOnConfirmationReceived(callback);
rgrover1 257:7a50601356cc 1040 }
rgrover1 257:7a50601356cc 1041
rgrover1 341:8a104d9d80c1 1042 inline void
rgrover1 341:8a104d9d80c1 1043 BLEDevice::onRadioNotification(Gap::RadioNotificationEventCallback_t callback)
rgrover1 341:8a104d9d80c1 1044 {
rgrover1 341:8a104d9d80c1 1045 transport->getGap().setOnRadioNotification(callback);
rgrover1 341:8a104d9d80c1 1046 }
rgrover1 341:8a104d9d80c1 1047
rgrover1 353:5ed63cda3038 1048 inline ble_error_t
rgrover1 257:7a50601356cc 1049 BLEDevice::addService(GattService &service)
rgrover1 257:7a50601356cc 1050 {
rgrover1 257:7a50601356cc 1051 return transport->getGattServer().addService(service);
rgrover1 257:7a50601356cc 1052 }
rgrover1 257:7a50601356cc 1053
rgrover1 257:7a50601356cc 1054 inline Gap::GapState_t
rgrover1 257:7a50601356cc 1055 BLEDevice::getGapState(void) const
rgrover1 257:7a50601356cc 1056 {
rgrover1 257:7a50601356cc 1057 return transport->getGap().getState();
rgrover1 257:7a50601356cc 1058 }
rgrover1 257:7a50601356cc 1059
rgrover1 328:1fd12f67ed7a 1060 inline ble_error_t BLEDevice::readCharacteristicValue(GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP)
rgrover1 257:7a50601356cc 1061 {
rgrover1 328:1fd12f67ed7a 1062 return transport->getGattServer().readValue(attributeHandle, buffer, lengthP);
rgrover1 257:7a50601356cc 1063 }
rgrover1 257:7a50601356cc 1064
rgrover1 524:6e97ab392e2a 1065 inline ble_error_t BLEDevice::readCharacteristicValue(Gap::Handle_t connectionHandle,
rgrover1 524:6e97ab392e2a 1066 GattAttribute::Handle_t attributeHandle,
rgrover1 524:6e97ab392e2a 1067 uint8_t *buffer,
rgrover1 524:6e97ab392e2a 1068 uint16_t *lengthP)
rgrover1 342:152bd9c825d6 1069 {
rgrover1 342:152bd9c825d6 1070 return transport->getGattServer().readValue(connectionHandle, attributeHandle, buffer, lengthP);
rgrover1 342:152bd9c825d6 1071 }
rgrover1 342:152bd9c825d6 1072
rgrover1 257:7a50601356cc 1073 inline ble_error_t
rgrover1 328:1fd12f67ed7a 1074 BLEDevice::updateCharacteristicValue(GattAttribute::Handle_t attributeHandle, const uint8_t *value, uint16_t size, bool localOnly)
rgrover1 257:7a50601356cc 1075 {
rgrover1 328:1fd12f67ed7a 1076 return transport->getGattServer().updateValue(attributeHandle, const_cast<uint8_t *>(value), size, localOnly);
rgrover1 257:7a50601356cc 1077 }
rgrover1 257:7a50601356cc 1078
rgrover1 342:152bd9c825d6 1079 inline ble_error_t
rgrover1 524:6e97ab392e2a 1080 BLEDevice::updateCharacteristicValue(Gap::Handle_t connectionHandle,
rgrover1 524:6e97ab392e2a 1081 GattAttribute::Handle_t attributeHandle,
rgrover1 524:6e97ab392e2a 1082 const uint8_t *value,
rgrover1 524:6e97ab392e2a 1083 uint16_t size,
rgrover1 524:6e97ab392e2a 1084 bool localOnly)
rgrover1 342:152bd9c825d6 1085 {
rgrover1 342:152bd9c825d6 1086 return transport->getGattServer().updateValue(connectionHandle, attributeHandle, const_cast<uint8_t *>(value), size, localOnly);
rgrover1 342:152bd9c825d6 1087 }
rgrover1 342:152bd9c825d6 1088
rgrover1 257:7a50601356cc 1089 inline void
rgrover1 257:7a50601356cc 1090 BLEDevice::waitForEvent(void)
rgrover1 257:7a50601356cc 1091 {
rgrover1 257:7a50601356cc 1092 transport->waitForEvent();
rgrover1 257:7a50601356cc 1093 }
rgrover1 257:7a50601356cc 1094
rgrover1 257:7a50601356cc 1095 inline ble_error_t
rgrover1 257:7a50601356cc 1096 BLEDevice::getPreferredConnectionParams(Gap::ConnectionParams_t *params)
rgrover1 257:7a50601356cc 1097 {
rgrover1 257:7a50601356cc 1098 return transport->getGap().getPreferredConnectionParams(params);
rgrover1 257:7a50601356cc 1099 }
rgrover1 257:7a50601356cc 1100
rgrover1 257:7a50601356cc 1101 inline ble_error_t
rgrover1 257:7a50601356cc 1102 BLEDevice::setPreferredConnectionParams(const Gap::ConnectionParams_t *params)
rgrover1 257:7a50601356cc 1103 {
rgrover1 257:7a50601356cc 1104 return transport->getGap().setPreferredConnectionParams(params);
rgrover1 257:7a50601356cc 1105 }
rgrover1 257:7a50601356cc 1106
rgrover1 257:7a50601356cc 1107 inline ble_error_t
rgrover1 257:7a50601356cc 1108 BLEDevice::updateConnectionParams(Gap::Handle_t handle, const Gap::ConnectionParams_t *params) {
rgrover1 257:7a50601356cc 1109 return transport->getGap().updateConnectionParams(handle, params);
rgrover1 257:7a50601356cc 1110 }
rgrover1 257:7a50601356cc 1111
rgrover1 257:7a50601356cc 1112 inline const char *
rgrover1 257:7a50601356cc 1113 BLEDevice::getVersion(void)
rgrover1 257:7a50601356cc 1114 {
rgrover1 257:7a50601356cc 1115 return transport->getVersion();
rgrover1 257:7a50601356cc 1116 }
rgrover1 257:7a50601356cc 1117
rgrover1 257:7a50601356cc 1118 inline ble_error_t
rgrover1 257:7a50601356cc 1119 BLEDevice::setDeviceName(const uint8_t *deviceName)
rgrover1 257:7a50601356cc 1120 {
rgrover1 257:7a50601356cc 1121 return transport->getGap().setDeviceName(deviceName);
rgrover1 257:7a50601356cc 1122 }
rgrover1 257:7a50601356cc 1123
rgrover1 257:7a50601356cc 1124 inline ble_error_t
rgrover1 257:7a50601356cc 1125 BLEDevice::getDeviceName(uint8_t *deviceName, unsigned *lengthP)
rgrover1 257:7a50601356cc 1126 {
rgrover1 257:7a50601356cc 1127 return transport->getGap().getDeviceName(deviceName, lengthP);
rgrover1 257:7a50601356cc 1128 }
rgrover1 257:7a50601356cc 1129
rgrover1 257:7a50601356cc 1130 inline ble_error_t
rgrover1 257:7a50601356cc 1131 BLEDevice::setAppearance(uint16_t appearance)
rgrover1 257:7a50601356cc 1132 {
rgrover1 257:7a50601356cc 1133 return transport->getGap().setAppearance(appearance);
rgrover1 257:7a50601356cc 1134 }
rgrover1 257:7a50601356cc 1135
rgrover1 257:7a50601356cc 1136 inline ble_error_t
rgrover1 257:7a50601356cc 1137 BLEDevice::getAppearance(uint16_t *appearanceP)
rgrover1 257:7a50601356cc 1138 {
rgrover1 257:7a50601356cc 1139 return transport->getGap().getAppearance(appearanceP);
rgrover1 257:7a50601356cc 1140 }
rgrover1 257:7a50601356cc 1141
rgrover1 257:7a50601356cc 1142 inline ble_error_t
rgrover1 257:7a50601356cc 1143 BLEDevice::setTxPower(int8_t txPower)
rgrover1 257:7a50601356cc 1144 {
rgrover1 524:6e97ab392e2a 1145 return transport->setTxPower(txPower);
rgrover1 257:7a50601356cc 1146 }
rgrover1 257:7a50601356cc 1147
rgrover1 305:71367f7cd078 1148 inline void
rgrover1 305:71367f7cd078 1149 BLEDevice::getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP)
rgrover1 305:71367f7cd078 1150 {
rgrover1 524:6e97ab392e2a 1151 transport->getPermittedTxPowerValues(valueArrayPP, countP);
rgrover1 305:71367f7cd078 1152 }
rgrover1 305:71367f7cd078 1153
rgrover1 347:20be4234c6fe 1154 inline ble_error_t
rgrover1 357:d4bb5d2b837a 1155 BLEDevice::initializeSecurity(bool enableBonding,
rgrover1 357:d4bb5d2b837a 1156 bool requireMITM,
rgrover1 357:d4bb5d2b837a 1157 Gap::SecurityIOCapabilities_t iocaps,
rgrover1 357:d4bb5d2b837a 1158 const Gap::Passkey_t passkey)
rgrover1 347:20be4234c6fe 1159 {
rgrover1 357:d4bb5d2b837a 1160 return transport->initializeSecurity(enableBonding, requireMITM, iocaps, passkey);
rgrover1 347:20be4234c6fe 1161 }
rgrover1 347:20be4234c6fe 1162
rgrover1 369:9a76cc068644 1163 inline void
rgrover1 370:678fdba95a62 1164 BLEDevice::onSecuritySetupInitiated(Gap::SecuritySetupInitiatedCallback_t callback)
rgrover1 370:678fdba95a62 1165 {
rgrover1 370:678fdba95a62 1166 transport->getGap().setOnSecuritySetupInitiated(callback);
rgrover1 370:678fdba95a62 1167 }
rgrover1 370:678fdba95a62 1168
rgrover1 370:678fdba95a62 1169 inline void
rgrover1 370:678fdba95a62 1170 BLEDevice::onSecuritySetupCompleted(Gap::SecuritySetupCompletedCallback_t callback)
rgrover1 370:678fdba95a62 1171 {
rgrover1 370:678fdba95a62 1172 transport->getGap().setOnSecuritySetupCompleted(callback);
rgrover1 370:678fdba95a62 1173 }
rgrover1 370:678fdba95a62 1174
rgrover1 370:678fdba95a62 1175 inline void
rgrover1 370:678fdba95a62 1176 BLEDevice::onLinkSecured(Gap::LinkSecuredCallback_t callback)
rgrover1 370:678fdba95a62 1177 {
rgrover1 370:678fdba95a62 1178 transport->getGap().setOnLinkSecured(callback);
rgrover1 370:678fdba95a62 1179 }
rgrover1 370:678fdba95a62 1180
rgrover1 370:678fdba95a62 1181 inline void
rgrover1 370:678fdba95a62 1182 BLEDevice::onSecurityContextStored(Gap::HandleSpecificEvent_t callback)
rgrover1 370:678fdba95a62 1183 {
rgrover1 370:678fdba95a62 1184 transport->getGap().setOnSecurityContextStored(callback);
rgrover1 370:678fdba95a62 1185 }
rgrover1 370:678fdba95a62 1186
rgrover1 370:678fdba95a62 1187 inline void
rgrover1 369:9a76cc068644 1188 BLEDevice::onPasskeyDisplay(Gap::PasskeyDisplayCallback_t callback)
rgrover1 369:9a76cc068644 1189 {
rgrover1 369:9a76cc068644 1190 return transport->getGap().setOnPasskeyDisplay(callback);
rgrover1 369:9a76cc068644 1191 }
rgrover1 369:9a76cc068644 1192
rgrover1 370:678fdba95a62 1193 inline ble_error_t
rgrover1 370:678fdba95a62 1194 BLEDevice::getLinkSecurity(Gap::Handle_t connectionHandle, Gap::LinkSecurityStatus_t *securityStatusP)
rgrover1 370:678fdba95a62 1195 {
rgrover1 370:678fdba95a62 1196 return transport->getGap().getLinkSecurity(connectionHandle, securityStatusP);
rgrover1 370:678fdba95a62 1197 }
rgrover1 370:678fdba95a62 1198
rgrover1 371:6c73b5970f2d 1199 inline ble_error_t
rgrover1 371:6c73b5970f2d 1200 BLEDevice::purgeAllBondingState(void)
rgrover1 371:6c73b5970f2d 1201 {
rgrover1 371:6c73b5970f2d 1202 return transport->getGap().purgeAllBondingState();
rgrover1 371:6c73b5970f2d 1203 }
rgrover1 371:6c73b5970f2d 1204
rgrover1 524:6e97ab392e2a 1205 inline ble_error_t
rgrover1 524:6e97ab392e2a 1206 BLEDevice::launchServiceDiscovery(Gap::Handle_t connectionHandle,
rgrover1 524:6e97ab392e2a 1207 ServiceDiscovery::ServiceCallback_t sc,
rgrover1 524:6e97ab392e2a 1208 ServiceDiscovery::CharacteristicCallback_t cc,
rgrover1 524:6e97ab392e2a 1209 const UUID &matchingServiceUUID,
rgrover1 524:6e97ab392e2a 1210 const UUID &matchingCharacteristicUUID)
rgrover1 524:6e97ab392e2a 1211 {
rgrover1 524:6e97ab392e2a 1212 return transport->getGattClient().launchServiceDiscovery(connectionHandle, sc, cc, matchingServiceUUID, matchingCharacteristicUUID);
rgrover1 524:6e97ab392e2a 1213 }
rgrover1 524:6e97ab392e2a 1214
rgrover1 524:6e97ab392e2a 1215 inline void
rgrover1 524:6e97ab392e2a 1216 BLEDevice::onServiceDiscoveryTermination(ServiceDiscovery::TerminationCallback_t callback)
rgrover1 524:6e97ab392e2a 1217 {
rgrover1 524:6e97ab392e2a 1218 transport->getGattClient().onServiceDiscoveryTermination(callback);
rgrover1 524:6e97ab392e2a 1219 }
rgrover1 524:6e97ab392e2a 1220
rgrover1 524:6e97ab392e2a 1221 /**
rgrover1 524:6e97ab392e2a 1222 * Is service-discovery currently active?
rgrover1 524:6e97ab392e2a 1223 */
rgrover1 524:6e97ab392e2a 1224 inline bool
rgrover1 524:6e97ab392e2a 1225 BLEDevice::isServiceDiscoveryActive(void)
rgrover1 524:6e97ab392e2a 1226 {
rgrover1 524:6e97ab392e2a 1227 return transport->getGattClient().isServiceDiscoveryActive();
rgrover1 524:6e97ab392e2a 1228 }
rgrover1 524:6e97ab392e2a 1229
rgrover1 524:6e97ab392e2a 1230 /**
rgrover1 524:6e97ab392e2a 1231 * Terminate an ongoing service-discovery. This should result in an
rgrover1 524:6e97ab392e2a 1232 * invocation of the TerminationCallback if service-discovery is active.
rgrover1 524:6e97ab392e2a 1233 */
rgrover1 524:6e97ab392e2a 1234 inline void
rgrover1 524:6e97ab392e2a 1235 BLEDevice::terminateServiceDiscovery(void)
rgrover1 524:6e97ab392e2a 1236 {
rgrover1 524:6e97ab392e2a 1237 transport->getGattClient().terminateServiceDiscovery();
rgrover1 524:6e97ab392e2a 1238 }
rgrover1 524:6e97ab392e2a 1239
rgrover1 524:6e97ab392e2a 1240
rgrover1 257:7a50601356cc 1241 #endif // ifndef __BLE_DEVICE__