Rene Miedema / ble_test

abc

Fork of BLE_API by Bluetooth Low Energy

public/BLEDevice.h@390:4bf41689c7f9, 2015-05-13 (annotated)

Committer:
rgrover1
Date:
Wed May 13 08:51:08 2015 +0100
Revision:
390:4bf41689c7f9
Parent:
387:7faa54079669
Child:
391:6f42075be548
Synchronized with git rev 96327396

Author: Rohit Grover

improved documentation for setScanningParams()

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