abc

Fork of BLE_API by Bluetooth Low Energy

Committer:
rgrover1
Date:
Mon Jun 08 10:41:17 2015 +0100
Revision:
411:af8f2d1b67b6
Parent:
410:37a4202649dd
Child:
412:cf2cce37ad73
Synchronized with git rev b29089e8
Author: Rohit Grover
minor improvements to the new APIs for getAdvParams/Data().

Who changed what in which revision?

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