Bluetooth Low Energy / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

public/BLEDevice.h@642:f7c865bde6ff, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:58 2015 +0100
Revision:
642:f7c865bde6ff
Parent:
599:5de2eb6aefda
Child:
646:1c59b84fd7e6
Synchronized with git rev a7c6dc1a

Author: Rohit Grover

one massive commit to move towards GattClient.

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