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@670:5e4aecd9af5b, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:01 2015 +0100
Revision:
670:5e4aecd9af5b
Parent:
669:7179b4a5aa7d 
Synchronized with git rev 532535b1

Author: Rohit Grover

Merge branch 'gattClient' into develop

Who changed what in which revision?

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