abc

Fork of BLE_API by Bluetooth Low Energy

Committer:
rgrover1
Date:
Fri May 08 15:35:46 2015 +0100
Revision:
349:b8b2b3973c47
Parent:
347:20be4234c6fe
Child:
353:5ed63cda3038
Synchronized with git rev 0e8731df
Author: Rohit Grover
Add APIs to setup callbacks for events related to security/bonding.

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 257:7a50601356cc 23 #include "BLEDeviceInstanceBase.h"
rgrover1 257:7a50601356cc 24
rgrover1 257:7a50601356cc 25 /**
rgrover1 257:7a50601356cc 26 * The base class used to abstract away BLE capable radio transceivers or SOCs,
rgrover1 257:7a50601356cc 27 * to enable this BLE API to work with any radio transparently.
rgrover1 257:7a50601356cc 28 */
rgrover1 257:7a50601356cc 29 class BLEDevice
rgrover1 257:7a50601356cc 30 {
rgrover1 257:7a50601356cc 31 public:
rgrover1 257:7a50601356cc 32 /**
rgrover1 257:7a50601356cc 33 * Initialize the BLE controller. This should be called before using
rgrover1 257:7a50601356cc 34 * anything else in the BLE_API.
rgrover1 257:7a50601356cc 35 */
rgrover1 257:7a50601356cc 36 ble_error_t init();
rgrover1 257:7a50601356cc 37 ble_error_t reset(void);
rgrover1 257:7a50601356cc 38
rgrover1 257:7a50601356cc 39 /**
rgrover1 257:7a50601356cc 40 * Purge the BLE stack of GATT and GAP state. init() must be called afterwards to re-instate services and GAP state.
rgrover1 257:7a50601356cc 41 */
rgrover1 257:7a50601356cc 42 ble_error_t shutdown(void);
rgrover1 257:7a50601356cc 43
rgrover1 257:7a50601356cc 44 /* GAP specific APIs */
rgrover1 257:7a50601356cc 45 public:
rgrover1 257:7a50601356cc 46 /**
rgrover1 257:7a50601356cc 47 * Set the BTLE MAC address and type.
rgrover1 257:7a50601356cc 48 * @return BLE_ERROR_NONE on success.
rgrover1 257:7a50601356cc 49 */
rgrover1 257:7a50601356cc 50 ble_error_t setAddress(Gap::addr_type_t type, const Gap::address_t address);
rgrover1 257:7a50601356cc 51
rgrover1 257:7a50601356cc 52 /**
rgrover1 257:7a50601356cc 53 * Fetch the BTLE MAC address and type.
rgrover1 257:7a50601356cc 54 * @return BLE_ERROR_NONE on success.
rgrover1 257:7a50601356cc 55 */
rgrover1 257:7a50601356cc 56 ble_error_t getAddress(Gap::addr_type_t *typeP, Gap::address_t address);
rgrover1 257:7a50601356cc 57
rgrover1 257:7a50601356cc 58 /**
rgrover1 257:7a50601356cc 59 * @param[in] advType
rgrover1 257:7a50601356cc 60 * The GAP advertising mode to use for this device. Valid
rgrover1 257:7a50601356cc 61 * values are defined in AdvertisingType:
rgrover1 257:7a50601356cc 62 *
rgrover1 257:7a50601356cc 63 * \par ADV_NON_CONNECTABLE_UNDIRECTED
rgrover1 257:7a50601356cc 64 * All connections to the peripheral device will be refused.
rgrover1 257:7a50601356cc 65 *
rgrover1 257:7a50601356cc 66 * \par ADV_CONNECTABLE_DIRECTED
rgrover1 257:7a50601356cc 67 * Only connections from a pre-defined central device will be
rgrover1 257:7a50601356cc 68 * accepted.
rgrover1 257:7a50601356cc 69 *
rgrover1 257:7a50601356cc 70 * \par ADV_CONNECTABLE_UNDIRECTED
rgrover1 257:7a50601356cc 71 * Any central device can connect to this peripheral.
rgrover1 257:7a50601356cc 72 *
rgrover1 257:7a50601356cc 73 * \par ADV_SCANNABLE_UNDIRECTED
rgrover1 300:d9a39f759a6a 74 * Include support for Scan Response payloads.
rgrover1 257:7a50601356cc 75 *
rgrover1 257:7a50601356cc 76 * \par
rgrover1 257:7a50601356cc 77 * See Bluetooth Core Specification 4.0 (Vol. 3), Part C,
rgrover1 257:7a50601356cc 78 * Section 9.3 and Core Specification 4.0 (Vol. 6), Part B,
rgrover1 257:7a50601356cc 79 * Section 2.3.1 for further information on GAP connection
rgrover1 257:7a50601356cc 80 * modes
rgrover1 257:7a50601356cc 81 */
rgrover1 257:7a50601356cc 82 void setAdvertisingType(GapAdvertisingParams::AdvertisingType);
rgrover1 257:7a50601356cc 83
rgrover1 257:7a50601356cc 84 /**
rgrover1 257:7a50601356cc 85 * @param[in] interval
rgrover1 325:501ad8b8bbe5 86 * Advertising interval in units of milliseconds. Advertising
rgrover1 325:501ad8b8bbe5 87 * is disabled if interval is 0. If interval is smaller than
rgrover1 325:501ad8b8bbe5 88 * the minimum supported value, then the minimum supported
rgrover1 325:501ad8b8bbe5 89 * value is used instead.
rgrover1 257:7a50601356cc 90 *
rgrover1 257:7a50601356cc 91 * \par
rgrover1 257:7a50601356cc 92 * Decreasing this value will allow central devices to detect
rgrover1 257:7a50601356cc 93 * your peripheral faster at the expense of more power being
rgrover1 257:7a50601356cc 94 * used by the radio due to the higher data transmit rate.
rgrover1 257:7a50601356cc 95 *
rgrover1 257:7a50601356cc 96 * \par
rgrover1 257:7a50601356cc 97 * This field must be set to 0 if connectionMode is equal
rgrover1 257:7a50601356cc 98 * to ADV_CONNECTABLE_DIRECTED
rgrover1 257:7a50601356cc 99 *
rgrover1 257:7a50601356cc 100 * \par
rgrover1 257:7a50601356cc 101 * See Bluetooth Core Specification, Vol 3., Part C,
rgrover1 257:7a50601356cc 102 * Appendix A for suggested advertising intervals.
rgrover1 334:6bc1223306b9 103 *
rgrover1 334:6bc1223306b9 104 * @Note: [WARNING] This API previously used 0.625ms as the unit for its
rgrover1 334:6bc1223306b9 105 * 'interval' argument. That required an explicit conversion from
rgrover1 334:6bc1223306b9 106 * milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
rgrover1 334:6bc1223306b9 107 * no longer required as the new units are milliseconds. Any application
rgrover1 334:6bc1223306b9 108 * code depending on the old semantics would need to be updated accordingly.
rgrover1 257:7a50601356cc 109 */
rgrover1 257:7a50601356cc 110 void setAdvertisingInterval(uint16_t interval);
rgrover1 257:7a50601356cc 111
rgrover1 257:7a50601356cc 112 /**
rgrover1 325:501ad8b8bbe5 113 * @return Minimum Advertising interval in milliseconds.
rgrover1 325:501ad8b8bbe5 114 */
rgrover1 325:501ad8b8bbe5 115 uint16_t getMinAdvertisingInterval(void) const;
rgrover1 325:501ad8b8bbe5 116 /**
rgrover1 325:501ad8b8bbe5 117 * @return Minimum Advertising interval in milliseconds for non connectible mode.
rgrover1 325:501ad8b8bbe5 118 */
rgrover1 325:501ad8b8bbe5 119 uint16_t getMinNonConnectableAdvertisingInterval(void) const;
rgrover1 325:501ad8b8bbe5 120 /**
rgrover1 325:501ad8b8bbe5 121 * @return Maximum Advertising interval in milliseconds.
rgrover1 325:501ad8b8bbe5 122 */
rgrover1 325:501ad8b8bbe5 123 uint16_t getMaxAdvertisingInterval(void) const;
rgrover1 325:501ad8b8bbe5 124
rgrover1 325:501ad8b8bbe5 125 /**
rgrover1 257:7a50601356cc 126 * @param[in] timeout
rgrover1 257:7a50601356cc 127 * Advertising timeout between 0x1 and 0x3FFF (1 and 16383)
rgrover1 257:7a50601356cc 128 * in seconds. Enter 0 to disable the advertising timeout.
rgrover1 257:7a50601356cc 129 */
rgrover1 257:7a50601356cc 130 void setAdvertisingTimeout(uint16_t timeout);
rgrover1 257:7a50601356cc 131
rgrover1 257:7a50601356cc 132 /**
rgrover1 257:7a50601356cc 133 * Please refer to the APIs above.
rgrover1 257:7a50601356cc 134 */
rgrover1 257:7a50601356cc 135 void setAdvertisingParams(const GapAdvertisingParams &advParams);
rgrover1 257:7a50601356cc 136
rgrover1 257:7a50601356cc 137 /**
rgrover1 257:7a50601356cc 138 * This API is typically used as an internal helper to udpate the transport
rgrover1 257:7a50601356cc 139 * backend with advertising data before starting to advertise. It may also
rgrover1 257:7a50601356cc 140 * be explicity used to dynamically reset the accumulated advertising
rgrover1 257:7a50601356cc 141 * payload and scanResponse; to do this, the application can clear and re-
rgrover1 257:7a50601356cc 142 * accumulate a new advertising payload (and scanResponse) before using this
rgrover1 257:7a50601356cc 143 * API.
rgrover1 257:7a50601356cc 144 */
rgrover1 257:7a50601356cc 145 ble_error_t setAdvertisingPayload(void);
rgrover1 257:7a50601356cc 146
rgrover1 257:7a50601356cc 147 /**
rgrover1 257:7a50601356cc 148 * Reset any advertising payload prepared from prior calls to
rgrover1 257:7a50601356cc 149 * accumulateAdvertisingPayload().
rgrover1 343:4d2576324b62 150 *
rgrover1 343:4d2576324b62 151 * Note: This should be followed by a call to setAdvertisingPayload() or
rgrover1 343:4d2576324b62 152 * startAdvertising() before the update takes effect.
rgrover1 257:7a50601356cc 153 */
rgrover1 257:7a50601356cc 154 void clearAdvertisingPayload(void);
rgrover1 257:7a50601356cc 155
rgrover1 257:7a50601356cc 156 /**
rgrover1 257:7a50601356cc 157 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 257:7a50601356cc 158 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 257:7a50601356cc 159 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 257:7a50601356cc 160 * small.
rgrover1 257:7a50601356cc 161 *
rgrover1 257:7a50601356cc 162 * @param flags
rgrover1 257:7a50601356cc 163 * The flags to be added. Multiple flags may be specified in
rgrover1 257:7a50601356cc 164 * combination.
rgrover1 257:7a50601356cc 165 */
rgrover1 257:7a50601356cc 166 ble_error_t accumulateAdvertisingPayload(uint8_t flags);
rgrover1 257:7a50601356cc 167
rgrover1 257:7a50601356cc 168 /**
rgrover1 257:7a50601356cc 169 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 257:7a50601356cc 170 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 257:7a50601356cc 171 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 257:7a50601356cc 172 * small.
rgrover1 257:7a50601356cc 173 *
rgrover1 257:7a50601356cc 174 * @param app
rgrover1 257:7a50601356cc 175 * The appearance of the peripheral.
rgrover1 257:7a50601356cc 176 */
rgrover1 257:7a50601356cc 177 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app);
rgrover1 257:7a50601356cc 178
rgrover1 257:7a50601356cc 179 /**
rgrover1 257:7a50601356cc 180 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 257:7a50601356cc 181 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 257:7a50601356cc 182 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 257:7a50601356cc 183 * small.
rgrover1 257:7a50601356cc 184 *
rgrover1 257:7a50601356cc 185 * @param app
rgrover1 257:7a50601356cc 186 * The max transmit power to be used by the controller. This is
rgrover1 257:7a50601356cc 187 * only a hint.
rgrover1 257:7a50601356cc 188 */
rgrover1 257:7a50601356cc 189 ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power);
rgrover1 257:7a50601356cc 190
rgrover1 257:7a50601356cc 191 /**
rgrover1 257:7a50601356cc 192 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 257:7a50601356cc 193 * advertising payload. Please note that the payload is limited to 31 bytes.
rgrover1 257:7a50601356cc 194 * The SCAN_RESPONSE message may be used as an additional 31 bytes if the
rgrover1 257:7a50601356cc 195 * advertising payload proves to be too small.
rgrover1 257:7a50601356cc 196 *
rgrover1 257:7a50601356cc 197 * @param type The type which describes the variable length data.
rgrover1 257:7a50601356cc 198 * @param data data bytes.
rgrover1 257:7a50601356cc 199 * @param len length of data.
rgrover1 257:7a50601356cc 200 */
rgrover1 257:7a50601356cc 201 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len);
rgrover1 257:7a50601356cc 202
rgrover1 257:7a50601356cc 203 /**
rgrover1 257:7a50601356cc 204 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 257:7a50601356cc 205 * scanResponse payload.
rgrover1 257:7a50601356cc 206 *
rgrover1 257:7a50601356cc 207 * @param type The type which describes the variable length data.
rgrover1 257:7a50601356cc 208 * @param data data bytes.
rgrover1 257:7a50601356cc 209 * @param len length of data.
rgrover1 257:7a50601356cc 210 */
rgrover1 257:7a50601356cc 211 ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len);
rgrover1 257:7a50601356cc 212
rgrover1 257:7a50601356cc 213 /**
rgrover1 343:4d2576324b62 214 * Reset any scan response prepared from prior calls to
rgrover1 343:4d2576324b62 215 * accumulateScanResponse().
rgrover1 343:4d2576324b62 216 *
rgrover1 343:4d2576324b62 217 * Note: This should be followed by a call to setAdvertisingPayload() or
rgrover1 343:4d2576324b62 218 * startAdvertising() before the update takes effect.
rgrover1 343:4d2576324b62 219 */
rgrover1 343:4d2576324b62 220 void clearScanResponse(void);
rgrover1 343:4d2576324b62 221
rgrover1 343:4d2576324b62 222 /**
rgrover1 257:7a50601356cc 223 * Start advertising (GAP Discoverable, Connectable modes, Broadcast
rgrover1 257:7a50601356cc 224 * Procedure).
rgrover1 257:7a50601356cc 225 */
rgrover1 257:7a50601356cc 226 ble_error_t startAdvertising(void);
rgrover1 257:7a50601356cc 227
rgrover1 257:7a50601356cc 228 /**
rgrover1 257:7a50601356cc 229 * Stop advertising (GAP Discoverable, Connectable modes, Broadcast
rgrover1 257:7a50601356cc 230 * Procedure).
rgrover1 257:7a50601356cc 231 */
rgrover1 257:7a50601356cc 232 ble_error_t stopAdvertising(void);
rgrover1 257:7a50601356cc 233
rgrover1 335:dea9e14b7ddc 234 /**
rgrover1 335:dea9e14b7ddc 235 * This call initiates the disconnection procedure, and its completion will
rgrover1 335:dea9e14b7ddc 236 * be communicated to the application with an invocation of the
rgrover1 335:dea9e14b7ddc 237 * onDisconnection callback.
rgrover1 335:dea9e14b7ddc 238 *
rgrover1 335:dea9e14b7ddc 239 * @param reason
rgrover1 335:dea9e14b7ddc 240 * The reason for disconnection to be sent back to the peer.
rgrover1 335:dea9e14b7ddc 241 */
rgrover1 257:7a50601356cc 242 ble_error_t disconnect(Gap::DisconnectionReason_t reason);
rgrover1 257:7a50601356cc 243
rgrover1 257:7a50601356cc 244 /* APIs to set GAP callbacks. */
rgrover1 257:7a50601356cc 245 void onTimeout(Gap::EventCallback_t timeoutCallback);
rgrover1 257:7a50601356cc 246
rgrover1 257:7a50601356cc 247 void onConnection(Gap::ConnectionEventCallback_t connectionCallback);
rgrover1 257:7a50601356cc 248 /**
rgrover1 257:7a50601356cc 249 * Used to setup a callback for GAP disconnection.
rgrover1 257:7a50601356cc 250 */
rgrover1 257:7a50601356cc 251 void onDisconnection(Gap::DisconnectionEventCallback_t disconnectionCallback);
rgrover1 257:7a50601356cc 252
rgrover1 257:7a50601356cc 253 /**
rgrover1 257:7a50601356cc 254 * Append to a chain of callbacks to be invoked upon disconnection; these
rgrover1 257:7a50601356cc 255 * callbacks receive no context and are therefore different from the
rgrover1 257:7a50601356cc 256 * onDisconnection callback.
rgrover1 257:7a50601356cc 257 */
rgrover1 257:7a50601356cc 258 template<typename T>
rgrover1 257:7a50601356cc 259 void addToDisconnectionCallChain(T *tptr, void (T::*mptr)(void));
rgrover1 257:7a50601356cc 260
rgrover1 257:7a50601356cc 261 /**
rgrover1 261:b275bfc773b9 262 * Add a callback for the GATT event DATA_SENT (which is triggered when
rgrover1 261:b275bfc773b9 263 * updates are sent out by GATT in the form of notifications).
rgrover1 259:a95264ad705c 264 *
rgrover1 259:a95264ad705c 265 * @Note: it is possible to chain together multiple onDataSent callbacks
rgrover1 259:a95264ad705c 266 * (potentially from different modules of an application) to receive updates
rgrover1 260:ea7f9f14cc15 267 * to characteristics.
rgrover1 259:a95264ad705c 268 *
rgrover1 259:a95264ad705c 269 * @Note: it is also possible to setup a callback into a member function of
rgrover1 259:a95264ad705c 270 * some object.
rgrover1 257:7a50601356cc 271 */
rgrover1 259:a95264ad705c 272 void onDataSent(void (*callback)(unsigned count));
rgrover1 259:a95264ad705c 273 template <typename T> void onDataSent(T * objPtr, void (T::*memberPtr)(unsigned count));
rgrover1 257:7a50601356cc 274
rgrover1 257:7a50601356cc 275 /**
rgrover1 257:7a50601356cc 276 * Setup a callback for when a characteristic has its value updated by a
rgrover1 257:7a50601356cc 277 * client.
rgrover1 257:7a50601356cc 278 *
rgrover1 257:7a50601356cc 279 * @Note: it is possible to chain together multiple onDataWritten callbacks
rgrover1 257:7a50601356cc 280 * (potentially from different modules of an application) to receive updates
rgrover1 257:7a50601356cc 281 * to characteristics. Many services, such as DFU and UART add their own
rgrover1 257:7a50601356cc 282 * onDataWritten callbacks behind the scenes to trap interesting events.
rgrover1 257:7a50601356cc 283 *
rgrover1 257:7a50601356cc 284 * @Note: it is also possible to setup a callback into a member function of
rgrover1 257:7a50601356cc 285 * some object.
rgrover1 257:7a50601356cc 286 */
rgrover1 257:7a50601356cc 287 void onDataWritten(void (*callback)(const GattCharacteristicWriteCBParams *eventDataP));
rgrover1 257:7a50601356cc 288 template <typename T> void onDataWritten(T * objPtr, void (T::*memberPtr)(const GattCharacteristicWriteCBParams *context));
rgrover1 257:7a50601356cc 289
rgrover1 300:d9a39f759a6a 290 /**
rgrover1 300:d9a39f759a6a 291 * Setup a callback for when a characteristic is being read by a client.
rgrover1 300:d9a39f759a6a 292 *
rgrover1 300:d9a39f759a6a 293 * @Note: this functionality may not be available on all underlying stacks.
rgrover1 300:d9a39f759a6a 294 * You could use GattCharacteristic::setReadAuthorizationCallback() as an
rgrover1 300:d9a39f759a6a 295 * alternative.
rgrover1 300:d9a39f759a6a 296 *
rgrover1 300:d9a39f759a6a 297 * @Note: it is possible to chain together multiple onDataRead callbacks
rgrover1 300:d9a39f759a6a 298 * (potentially from different modules of an application) to receive updates
rgrover1 300:d9a39f759a6a 299 * to characteristics. Services may add their own onDataRead callbacks
rgrover1 300:d9a39f759a6a 300 * behind the scenes to trap interesting events.
rgrover1 300:d9a39f759a6a 301 *
rgrover1 300:d9a39f759a6a 302 * @Note: it is also possible to setup a callback into a member function of
rgrover1 300:d9a39f759a6a 303 * some object.
rgrover1 300:d9a39f759a6a 304 *
rgrover1 300:d9a39f759a6a 305 * @return BLE_ERROR_NOT_IMPLEMENTED if this functionality isn't available;
rgrover1 300:d9a39f759a6a 306 * else BLE_ERROR_NONE.
rgrover1 300:d9a39f759a6a 307 */
rgrover1 300:d9a39f759a6a 308 ble_error_t onDataRead(void (*callback)(const GattCharacteristicReadCBParams *eventDataP));
rgrover1 300:d9a39f759a6a 309 template <typename T> ble_error_t onDataRead(T * objPtr, void (T::*memberPtr)(const GattCharacteristicReadCBParams *context));
rgrover1 300:d9a39f759a6a 310
rgrover1 257:7a50601356cc 311 void onUpdatesEnabled(GattServer::EventCallback_t callback);
rgrover1 257:7a50601356cc 312 void onUpdatesDisabled(GattServer::EventCallback_t callback);
rgrover1 257:7a50601356cc 313 void onConfirmationReceived(GattServer::EventCallback_t callback);
rgrover1 257:7a50601356cc 314
rgrover1 257:7a50601356cc 315 /**
rgrover1 341:8a104d9d80c1 316 * Radio Notification is a feature that enables ACTIVE and INACTIVE
rgrover1 341:8a104d9d80c1 317 * (nACTIVE) signals from the stack that notify the application when the
rgrover1 341:8a104d9d80c1 318 * radio is in use. The signal is sent using software interrupt.
rgrover1 341:8a104d9d80c1 319 *
rgrover1 341:8a104d9d80c1 320 * The ACTIVE signal is sent before the Radio Event starts. The nACTIVE
rgrover1 341:8a104d9d80c1 321 * signal is sent at the end of the Radio Event. These signals can be used
rgrover1 341:8a104d9d80c1 322 * by the application programmer to synchronize application logic with radio
rgrover1 341:8a104d9d80c1 323 * activity. For example, the ACTIVE signal can be used to shut off external
rgrover1 341:8a104d9d80c1 324 * devices to manage peak current drawn during periods when the radio is on,
rgrover1 341:8a104d9d80c1 325 * or to trigger sensor data collection for transmission in the Radio Event.
rgrover1 341:8a104d9d80c1 326 *
rgrover1 341:8a104d9d80c1 327 * @param callback
rgrover1 341:8a104d9d80c1 328 * The application handler to be invoked in response to a radio
rgrover1 341:8a104d9d80c1 329 * ACTIVE/INACTIVE event.
rgrover1 341:8a104d9d80c1 330 */
rgrover1 341:8a104d9d80c1 331 void onRadioNotification(Gap::RadioNotificationEventCallback_t callback);
rgrover1 341:8a104d9d80c1 332
rgrover1 341:8a104d9d80c1 333 /**
rgrover1 349:b8b2b3973c47 334 * Setup a callback for when the security procedure for a link has started.
rgrover1 349:b8b2b3973c47 335 */
rgrover1 349:b8b2b3973c47 336 void setOnSecuritySetupStarted(Gap::HandleSpecificEvent_t callback);
rgrover1 349:b8b2b3973c47 337
rgrover1 349:b8b2b3973c47 338 /**
rgrover1 349:b8b2b3973c47 339 * Setup a callback for when the security procedure for a link has
rgrover1 349:b8b2b3973c47 340 * completed.
rgrover1 349:b8b2b3973c47 341 */
rgrover1 349:b8b2b3973c47 342 void setOnSecuritySetupCompleted(Gap::HandleSpecificEvent_t callback);
rgrover1 349:b8b2b3973c47 343
rgrover1 349:b8b2b3973c47 344 /**
rgrover1 349:b8b2b3973c47 345 * Setup a callback for when a link with the peer is secured. For bonded
rgrover1 349:b8b2b3973c47 346 * devices, subsequent reconnections with bonded peer will result only in
rgrover1 349:b8b2b3973c47 347 * this callback when the link is secured and setup procedures will not
rgrover1 349:b8b2b3973c47 348 * occur unless the bonding information is either lost or deleted on either
rgrover1 349:b8b2b3973c47 349 * or both sides.
rgrover1 349:b8b2b3973c47 350 */
rgrover1 349:b8b2b3973c47 351 void setOnLinkSecured(Gap::HandleSpecificEvent_t callback);
rgrover1 349:b8b2b3973c47 352
rgrover1 349:b8b2b3973c47 353 /**
rgrover1 349:b8b2b3973c47 354 * Setup a callback for bonding; i.e. that link-specific security context
rgrover1 349:b8b2b3973c47 355 * is stored persistently for a peer device.
rgrover1 349:b8b2b3973c47 356 */
rgrover1 349:b8b2b3973c47 357 void setOnSecurityContextStored(Gap::HandleSpecificEvent_t callback);
rgrover1 349:b8b2b3973c47 358
rgrover1 349:b8b2b3973c47 359 /**
rgrover1 257:7a50601356cc 360 * Add a service declaration to the local server ATT table. Also add the
rgrover1 257:7a50601356cc 361 * characteristics contained within.
rgrover1 257:7a50601356cc 362 */
rgrover1 257:7a50601356cc 363 ble_error_t addService(GattService &service);
rgrover1 257:7a50601356cc 364
rgrover1 336:896e159d3af6 365 /**
rgrover1 336:896e159d3af6 366 * Returns the current GAP state of the device using a bitmask which
rgrover1 336:896e159d3af6 367 * describes whether the device is advertising and/or connected.
rgrover1 336:896e159d3af6 368 */
rgrover1 257:7a50601356cc 369 Gap::GapState_t getGapState(void) const;
rgrover1 257:7a50601356cc 370
rgrover1 257:7a50601356cc 371 /**
rgrover1 257:7a50601356cc 372 * @param[in/out] lengthP
rgrover1 257:7a50601356cc 373 * input: Length in bytes to be read,
rgrover1 257:7a50601356cc 374 * output: Total length of attribute value upon successful return.
rgrover1 257:7a50601356cc 375 */
rgrover1 328:1fd12f67ed7a 376 ble_error_t readCharacteristicValue(GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP);
rgrover1 342:152bd9c825d6 377 /**
rgrover1 342:152bd9c825d6 378 * 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 379 */
rgrover1 342:152bd9c825d6 380 ble_error_t readCharacteristicValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP);
rgrover1 257:7a50601356cc 381
rgrover1 257:7a50601356cc 382 /**
rgrover1 257:7a50601356cc 383 * @param localOnly
rgrover1 257:7a50601356cc 384 * Only update the characteristic locally regardless of notify/indicate flags in the CCCD.
rgrover1 257:7a50601356cc 385 */
rgrover1 328:1fd12f67ed7a 386 ble_error_t updateCharacteristicValue(GattAttribute::Handle_t attributeHandle, const uint8_t *value, uint16_t size, bool localOnly = false);
rgrover1 342:152bd9c825d6 387 /**
rgrover1 342:152bd9c825d6 388 * 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 389 */
rgrover1 342:152bd9c825d6 390 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 391
rgrover1 257:7a50601356cc 392 /**
rgrover1 257:7a50601356cc 393 * Yield control to the BLE stack or to other tasks waiting for events. This
rgrover1 257:7a50601356cc 394 * is a sleep function which will return when there is an application
rgrover1 257:7a50601356cc 395 * specific interrupt, but the MCU might wake up several times before
rgrover1 257:7a50601356cc 396 * returning (to service the stack). This is not always interchangeable with
rgrover1 257:7a50601356cc 397 * WFE().
rgrover1 257:7a50601356cc 398 */
rgrover1 257:7a50601356cc 399 void waitForEvent(void);
rgrover1 257:7a50601356cc 400
rgrover1 257:7a50601356cc 401 ble_error_t getPreferredConnectionParams(Gap::ConnectionParams_t *params);
rgrover1 257:7a50601356cc 402 ble_error_t setPreferredConnectionParams(const Gap::ConnectionParams_t *params);
rgrover1 257:7a50601356cc 403 ble_error_t updateConnectionParams(Gap::Handle_t handle, const Gap::ConnectionParams_t *params);
rgrover1 257:7a50601356cc 404
rgrover1 257:7a50601356cc 405 /**
rgrover1 257:7a50601356cc 406 * This call allows the application to get the BLE stack version information.
rgrover1 257:7a50601356cc 407 *
rgrover1 257:7a50601356cc 408 * @return A pointer to a const string representing the version.
rgrover1 257:7a50601356cc 409 * Note: The string is owned by the BLE_API.
rgrover1 257:7a50601356cc 410 */
rgrover1 257:7a50601356cc 411 const char *getVersion(void);
rgrover1 257:7a50601356cc 412
rgrover1 257:7a50601356cc 413 /**
rgrover1 257:7a50601356cc 414 * Set the device name characteristic in the GAP service.
rgrover1 257:7a50601356cc 415 * @param deviceName The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
rgrover1 257:7a50601356cc 416 */
rgrover1 257:7a50601356cc 417 ble_error_t setDeviceName(const uint8_t *deviceName);
rgrover1 257:7a50601356cc 418
rgrover1 257:7a50601356cc 419 /**
rgrover1 257:7a50601356cc 420 * Get the value of the device name characteristic in the GAP service.
rgrover1 257:7a50601356cc 421 * @param[out] deviceName Pointer to an empty buffer where the UTF-8 *non NULL-
rgrover1 257:7a50601356cc 422 * terminated* string will be placed. Set this
rgrover1 257:7a50601356cc 423 * value to NULL in order to obtain the deviceName-length
rgrover1 257:7a50601356cc 424 * from the 'length' parameter.
rgrover1 257:7a50601356cc 425 *
rgrover1 257:7a50601356cc 426 * @param[in/out] lengthP (on input) Length of the buffer pointed to by deviceName;
rgrover1 257:7a50601356cc 427 * (on output) the complete device name length (without the
rgrover1 257:7a50601356cc 428 * null terminator).
rgrover1 257:7a50601356cc 429 *
rgrover1 257:7a50601356cc 430 * @note If the device name is longer than the size of the supplied buffer,
rgrover1 257:7a50601356cc 431 * length will return the complete device name length,
rgrover1 257:7a50601356cc 432 * and not the number of bytes actually returned in deviceName.
rgrover1 257:7a50601356cc 433 * The application may use this information to retry with a suitable buffer size.
rgrover1 257:7a50601356cc 434 *
rgrover1 257:7a50601356cc 435 * Sample use:
rgrover1 257:7a50601356cc 436 * uint8_t deviceName[20];
rgrover1 257:7a50601356cc 437 * unsigned length = sizeof(deviceName);
rgrover1 257:7a50601356cc 438 * ble.getDeviceName(deviceName, &length);
rgrover1 257:7a50601356cc 439 * if (length < sizeof(deviceName)) {
rgrover1 257:7a50601356cc 440 * deviceName[length] = 0;
rgrover1 257:7a50601356cc 441 * }
rgrover1 257:7a50601356cc 442 * DEBUG("length: %u, deviceName: %s\r\n", length, deviceName);
rgrover1 257:7a50601356cc 443 */
rgrover1 257:7a50601356cc 444 ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP);
rgrover1 257:7a50601356cc 445
rgrover1 257:7a50601356cc 446 /**
rgrover1 257:7a50601356cc 447 * Set the appearance characteristic in the GAP service.
rgrover1 257:7a50601356cc 448 * @param[in] appearance The new value for the device-appearance.
rgrover1 257:7a50601356cc 449 */
rgrover1 257:7a50601356cc 450 ble_error_t setAppearance(uint16_t appearance);
rgrover1 257:7a50601356cc 451
rgrover1 257:7a50601356cc 452 /**
rgrover1 257:7a50601356cc 453 * Set the appearance characteristic in the GAP service.
rgrover1 257:7a50601356cc 454 * @param[out] appearance The new value for the device-appearance.
rgrover1 257:7a50601356cc 455 */
rgrover1 257:7a50601356cc 456 ble_error_t getAppearance(uint16_t *appearanceP);
rgrover1 257:7a50601356cc 457
rgrover1 257:7a50601356cc 458 /**
rgrover1 257:7a50601356cc 459 * Set the radio's transmit power.
rgrover1 257:7a50601356cc 460 * @param[in] txPower Radio transmit power in dBm.
rgrover1 257:7a50601356cc 461 */
rgrover1 257:7a50601356cc 462 ble_error_t setTxPower(int8_t txPower);
rgrover1 257:7a50601356cc 463
rgrover1 305:71367f7cd078 464 /**
rgrover1 305:71367f7cd078 465 * Query the underlying stack for permitted arguments for setTxPower().
rgrover1 305:71367f7cd078 466 *
rgrover1 305:71367f7cd078 467 * @param[out] valueArrayPP
rgrover1 305:71367f7cd078 468 * Out parameter to receive the immutable array of Tx values.
rgrover1 305:71367f7cd078 469 * @param[out] countP
rgrover1 305:71367f7cd078 470 * Out parameter to receive the array's size.
rgrover1 305:71367f7cd078 471 */
rgrover1 305:71367f7cd078 472 void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP);
rgrover1 305:71367f7cd078 473
rgrover1 347:20be4234c6fe 474 /**
rgrover1 347:20be4234c6fe 475 * Enable the BLE stack's Security Manager. The Security Manager implements
rgrover1 347:20be4234c6fe 476 * the actual cryptographic algorithms and protocol exchanges that allow two
rgrover1 347:20be4234c6fe 477 * devices to securely exchange data and privately detect each other.
rgrover1 347:20be4234c6fe 478 * Calling this API is a prerequisite for encryption and pairing (bonding).
rgrover1 347:20be4234c6fe 479 */
rgrover1 347:20be4234c6fe 480 ble_error_t initializeSecurity(void);
rgrover1 347:20be4234c6fe 481
rgrover1 257:7a50601356cc 482 public:
rgrover1 257:7a50601356cc 483 BLEDevice() : transport(createBLEDeviceInstance()), advParams(), advPayload(), scanResponse(), needToSetAdvPayload(true) {
rgrover1 257:7a50601356cc 484 advPayload.clear();
rgrover1 257:7a50601356cc 485 scanResponse.clear();
rgrover1 257:7a50601356cc 486 }
rgrover1 257:7a50601356cc 487
rgrover1 257:7a50601356cc 488 private:
rgrover1 257:7a50601356cc 489 BLEDeviceInstanceBase *const transport; /* the device specific backend */
rgrover1 257:7a50601356cc 490
rgrover1 257:7a50601356cc 491 GapAdvertisingParams advParams;
rgrover1 257:7a50601356cc 492 GapAdvertisingData advPayload;
rgrover1 257:7a50601356cc 493 GapAdvertisingData scanResponse;
rgrover1 257:7a50601356cc 494
rgrover1 257:7a50601356cc 495 /* Accumulation of AD structures in the advertisement payload should
rgrover1 257:7a50601356cc 496 * eventually result in a call to the target's setAdvertisingData() before
rgrover1 257:7a50601356cc 497 * the server begins advertising. This flag marks the status of the pending update.*/
rgrover1 257:7a50601356cc 498 bool needToSetAdvPayload;
rgrover1 257:7a50601356cc 499 };
rgrover1 257:7a50601356cc 500
rgrover1 257:7a50601356cc 501 /* BLEDevice methods. Most of these simply forward the calls to the underlying
rgrover1 257:7a50601356cc 502 * transport.*/
rgrover1 257:7a50601356cc 503
rgrover1 257:7a50601356cc 504 inline ble_error_t
rgrover1 257:7a50601356cc 505 BLEDevice::reset(void)
rgrover1 257:7a50601356cc 506 {
rgrover1 257:7a50601356cc 507 return transport->reset();
rgrover1 257:7a50601356cc 508 }
rgrover1 257:7a50601356cc 509
rgrover1 257:7a50601356cc 510 inline ble_error_t
rgrover1 257:7a50601356cc 511 BLEDevice::shutdown(void)
rgrover1 257:7a50601356cc 512 {
rgrover1 257:7a50601356cc 513 clearAdvertisingPayload();
rgrover1 257:7a50601356cc 514 return transport->shutdown();
rgrover1 257:7a50601356cc 515 }
rgrover1 257:7a50601356cc 516
rgrover1 257:7a50601356cc 517 inline ble_error_t
rgrover1 257:7a50601356cc 518 BLEDevice::setAddress(Gap::addr_type_t type, const Gap::address_t address)
rgrover1 257:7a50601356cc 519 {
rgrover1 257:7a50601356cc 520 return transport->getGap().setAddress(type, address);
rgrover1 257:7a50601356cc 521 }
rgrover1 257:7a50601356cc 522
rgrover1 257:7a50601356cc 523 inline ble_error_t
rgrover1 257:7a50601356cc 524 BLEDevice::getAddress(Gap::addr_type_t *typeP, Gap::address_t address)
rgrover1 257:7a50601356cc 525 {
rgrover1 257:7a50601356cc 526 return transport->getGap().getAddress(typeP, address);
rgrover1 257:7a50601356cc 527 }
rgrover1 257:7a50601356cc 528
rgrover1 257:7a50601356cc 529 inline void
rgrover1 257:7a50601356cc 530 BLEDevice::setAdvertisingType(GapAdvertisingParams::AdvertisingType advType)
rgrover1 257:7a50601356cc 531 {
rgrover1 257:7a50601356cc 532 advParams.setAdvertisingType(advType);
rgrover1 257:7a50601356cc 533 }
rgrover1 257:7a50601356cc 534
rgrover1 257:7a50601356cc 535 inline void
rgrover1 257:7a50601356cc 536 BLEDevice::setAdvertisingInterval(uint16_t interval)
rgrover1 257:7a50601356cc 537 {
rgrover1 325:501ad8b8bbe5 538 if (interval == 0) {
rgrover1 325:501ad8b8bbe5 539 stopAdvertising();
rgrover1 325:501ad8b8bbe5 540 } else if (interval < getMinAdvertisingInterval()) {
rgrover1 325:501ad8b8bbe5 541 interval = getMinAdvertisingInterval();
rgrover1 325:501ad8b8bbe5 542 }
rgrover1 325:501ad8b8bbe5 543 advParams.setInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(interval));
rgrover1 325:501ad8b8bbe5 544 }
rgrover1 325:501ad8b8bbe5 545
rgrover1 325:501ad8b8bbe5 546 inline uint16_t
rgrover1 325:501ad8b8bbe5 547 BLEDevice::getMinAdvertisingInterval(void) const {
rgrover1 325:501ad8b8bbe5 548 return transport->getGap().getMinAdvertisingInterval();
rgrover1 325:501ad8b8bbe5 549 }
rgrover1 325:501ad8b8bbe5 550
rgrover1 325:501ad8b8bbe5 551 inline uint16_t
rgrover1 325:501ad8b8bbe5 552 BLEDevice::getMinNonConnectableAdvertisingInterval(void) const {
rgrover1 325:501ad8b8bbe5 553 return transport->getGap().getMinNonConnectableAdvertisingInterval();
rgrover1 325:501ad8b8bbe5 554 }
rgrover1 325:501ad8b8bbe5 555
rgrover1 325:501ad8b8bbe5 556 inline uint16_t
rgrover1 325:501ad8b8bbe5 557 BLEDevice::getMaxAdvertisingInterval(void) const {
rgrover1 325:501ad8b8bbe5 558 return transport->getGap().getMaxAdvertisingInterval();
rgrover1 257:7a50601356cc 559 }
rgrover1 257:7a50601356cc 560
rgrover1 257:7a50601356cc 561 inline void
rgrover1 257:7a50601356cc 562 BLEDevice::setAdvertisingTimeout(uint16_t timeout)
rgrover1 257:7a50601356cc 563 {
rgrover1 257:7a50601356cc 564 advParams.setTimeout(timeout);
rgrover1 257:7a50601356cc 565 }
rgrover1 257:7a50601356cc 566
rgrover1 257:7a50601356cc 567 inline void
rgrover1 257:7a50601356cc 568 BLEDevice::setAdvertisingParams(const GapAdvertisingParams &newAdvParams)
rgrover1 257:7a50601356cc 569 {
rgrover1 257:7a50601356cc 570 advParams = newAdvParams;
rgrover1 257:7a50601356cc 571 }
rgrover1 257:7a50601356cc 572
rgrover1 257:7a50601356cc 573 inline void
rgrover1 257:7a50601356cc 574 BLEDevice::clearAdvertisingPayload(void)
rgrover1 257:7a50601356cc 575 {
rgrover1 257:7a50601356cc 576 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 577 advPayload.clear();
rgrover1 257:7a50601356cc 578 }
rgrover1 257:7a50601356cc 579
rgrover1 257:7a50601356cc 580 inline ble_error_t
rgrover1 257:7a50601356cc 581 BLEDevice::accumulateAdvertisingPayload(uint8_t flags)
rgrover1 257:7a50601356cc 582 {
rgrover1 257:7a50601356cc 583 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 584 return advPayload.addFlags(flags);
rgrover1 257:7a50601356cc 585 }
rgrover1 257:7a50601356cc 586
rgrover1 257:7a50601356cc 587 inline ble_error_t
rgrover1 257:7a50601356cc 588 BLEDevice::accumulateAdvertisingPayload(GapAdvertisingData::Appearance app)
rgrover1 257:7a50601356cc 589 {
rgrover1 257:7a50601356cc 590 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 591 transport->getGap().setAppearance(app);
rgrover1 257:7a50601356cc 592 return advPayload.addAppearance(app);
rgrover1 257:7a50601356cc 593 }
rgrover1 257:7a50601356cc 594
rgrover1 257:7a50601356cc 595 inline ble_error_t
rgrover1 257:7a50601356cc 596 BLEDevice::accumulateAdvertisingPayloadTxPower(int8_t txPower)
rgrover1 257:7a50601356cc 597 {
rgrover1 257:7a50601356cc 598 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 599 return advPayload.addTxPower(txPower);
rgrover1 257:7a50601356cc 600 }
rgrover1 257:7a50601356cc 601
rgrover1 257:7a50601356cc 602 inline ble_error_t
rgrover1 257:7a50601356cc 603 BLEDevice::accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len)
rgrover1 257:7a50601356cc 604 {
rgrover1 257:7a50601356cc 605 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 606 if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
rgrover1 257:7a50601356cc 607 transport->getGap().setDeviceName(data);
rgrover1 257:7a50601356cc 608 }
rgrover1 257:7a50601356cc 609 return advPayload.addData(type, data, len);
rgrover1 257:7a50601356cc 610 }
rgrover1 257:7a50601356cc 611
rgrover1 257:7a50601356cc 612 inline ble_error_t
rgrover1 257:7a50601356cc 613 BLEDevice::accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len)
rgrover1 257:7a50601356cc 614 {
rgrover1 257:7a50601356cc 615 needToSetAdvPayload = true;
rgrover1 257:7a50601356cc 616 return scanResponse.addData(type, data, len);
rgrover1 257:7a50601356cc 617 }
rgrover1 257:7a50601356cc 618
rgrover1 343:4d2576324b62 619 inline void
rgrover1 343:4d2576324b62 620 BLEDevice::clearScanResponse(void)
rgrover1 343:4d2576324b62 621 {
rgrover1 343:4d2576324b62 622 needToSetAdvPayload = true;
rgrover1 343:4d2576324b62 623 scanResponse.clear();
rgrover1 343:4d2576324b62 624 }
rgrover1 343:4d2576324b62 625
rgrover1 257:7a50601356cc 626 inline ble_error_t
rgrover1 257:7a50601356cc 627 BLEDevice::setAdvertisingPayload(void) {
rgrover1 257:7a50601356cc 628 needToSetAdvPayload = false;
rgrover1 257:7a50601356cc 629 return transport->getGap().setAdvertisingData(advPayload, scanResponse);
rgrover1 257:7a50601356cc 630 }
rgrover1 257:7a50601356cc 631
rgrover1 257:7a50601356cc 632 inline ble_error_t
rgrover1 257:7a50601356cc 633 BLEDevice::startAdvertising(void)
rgrover1 257:7a50601356cc 634 {
rgrover1 257:7a50601356cc 635 ble_error_t rc;
rgrover1 257:7a50601356cc 636 if ((rc = transport->getGattServer().initializeGATTDatabase()) != BLE_ERROR_NONE) {
rgrover1 257:7a50601356cc 637 return rc;
rgrover1 257:7a50601356cc 638 }
rgrover1 257:7a50601356cc 639 if (needToSetAdvPayload) {
rgrover1 257:7a50601356cc 640 if ((rc = setAdvertisingPayload()) != BLE_ERROR_NONE) {
rgrover1 257:7a50601356cc 641 return rc;
rgrover1 257:7a50601356cc 642 }
rgrover1 257:7a50601356cc 643 }
rgrover1 257:7a50601356cc 644
rgrover1 257:7a50601356cc 645 return transport->getGap().startAdvertising(advParams);
rgrover1 257:7a50601356cc 646 }
rgrover1 257:7a50601356cc 647
rgrover1 257:7a50601356cc 648 inline ble_error_t
rgrover1 257:7a50601356cc 649 BLEDevice::stopAdvertising(void)
rgrover1 257:7a50601356cc 650 {
rgrover1 257:7a50601356cc 651 return transport->getGap().stopAdvertising();
rgrover1 257:7a50601356cc 652 }
rgrover1 257:7a50601356cc 653
rgrover1 257:7a50601356cc 654 inline ble_error_t
rgrover1 257:7a50601356cc 655 BLEDevice::disconnect(Gap::DisconnectionReason_t reason)
rgrover1 257:7a50601356cc 656 {
rgrover1 257:7a50601356cc 657 return transport->getGap().disconnect(reason);
rgrover1 257:7a50601356cc 658 }
rgrover1 257:7a50601356cc 659
rgrover1 257:7a50601356cc 660 inline void
rgrover1 257:7a50601356cc 661 BLEDevice::onTimeout(Gap::EventCallback_t timeoutCallback)
rgrover1 257:7a50601356cc 662 {
rgrover1 257:7a50601356cc 663 transport->getGap().setOnTimeout(timeoutCallback);
rgrover1 257:7a50601356cc 664 }
rgrover1 257:7a50601356cc 665
rgrover1 257:7a50601356cc 666 inline void
rgrover1 257:7a50601356cc 667 BLEDevice::onConnection(Gap::ConnectionEventCallback_t connectionCallback)
rgrover1 257:7a50601356cc 668 {
rgrover1 257:7a50601356cc 669 transport->getGap().setOnConnection(connectionCallback);
rgrover1 257:7a50601356cc 670 }
rgrover1 257:7a50601356cc 671
rgrover1 257:7a50601356cc 672 inline void
rgrover1 257:7a50601356cc 673 BLEDevice::onDisconnection(Gap::DisconnectionEventCallback_t disconnectionCallback)
rgrover1 257:7a50601356cc 674 {
rgrover1 257:7a50601356cc 675 transport->getGap().setOnDisconnection(disconnectionCallback);
rgrover1 257:7a50601356cc 676 }
rgrover1 257:7a50601356cc 677
rgrover1 257:7a50601356cc 678 template<typename T>
rgrover1 257:7a50601356cc 679 inline void
rgrover1 257:7a50601356cc 680 BLEDevice::addToDisconnectionCallChain(T *tptr, void (T::*mptr)(void)) {
rgrover1 257:7a50601356cc 681 transport->getGap().addToDisconnectionCallChain(tptr, mptr);
rgrover1 257:7a50601356cc 682 }
rgrover1 257:7a50601356cc 683
rgrover1 257:7a50601356cc 684 inline void
rgrover1 259:a95264ad705c 685 BLEDevice::onDataSent(void (*callback)(unsigned count)) {
rgrover1 257:7a50601356cc 686 transport->getGattServer().setOnDataSent(callback);
rgrover1 257:7a50601356cc 687 }
rgrover1 257:7a50601356cc 688
rgrover1 259:a95264ad705c 689 template <typename T> inline void
rgrover1 259:a95264ad705c 690 BLEDevice::onDataSent(T *objPtr, void (T::*memberPtr)(unsigned count)) {
rgrover1 259:a95264ad705c 691 transport->getGattServer().setOnDataSent(objPtr, memberPtr);
rgrover1 259:a95264ad705c 692 }
rgrover1 259:a95264ad705c 693
rgrover1 257:7a50601356cc 694 inline void
rgrover1 257:7a50601356cc 695 BLEDevice::onDataWritten(void (*callback)(const GattCharacteristicWriteCBParams *eventDataP)) {
rgrover1 257:7a50601356cc 696 transport->getGattServer().setOnDataWritten(callback);
rgrover1 257:7a50601356cc 697 }
rgrover1 257:7a50601356cc 698
rgrover1 257:7a50601356cc 699 template <typename T> inline void
rgrover1 257:7a50601356cc 700 BLEDevice::onDataWritten(T *objPtr, void (T::*memberPtr)(const GattCharacteristicWriteCBParams *context)) {
rgrover1 257:7a50601356cc 701 transport->getGattServer().setOnDataWritten(objPtr, memberPtr);
rgrover1 257:7a50601356cc 702 }
rgrover1 257:7a50601356cc 703
rgrover1 300:d9a39f759a6a 704 inline ble_error_t
rgrover1 300:d9a39f759a6a 705 BLEDevice::onDataRead(void (*callback)(const GattCharacteristicReadCBParams *eventDataP)) {
rgrover1 300:d9a39f759a6a 706 return transport->getGattServer().setOnDataRead(callback);
rgrover1 300:d9a39f759a6a 707 }
rgrover1 300:d9a39f759a6a 708
rgrover1 300:d9a39f759a6a 709 template <typename T> inline ble_error_t
rgrover1 300:d9a39f759a6a 710 BLEDevice::onDataRead(T *objPtr, void (T::*memberPtr)(const GattCharacteristicReadCBParams *context)) {
rgrover1 300:d9a39f759a6a 711 return transport->getGattServer().setOnDataRead(objPtr, memberPtr);
rgrover1 300:d9a39f759a6a 712 }
rgrover1 300:d9a39f759a6a 713
rgrover1 257:7a50601356cc 714 inline void
rgrover1 257:7a50601356cc 715 BLEDevice::onUpdatesEnabled(GattServer::EventCallback_t callback)
rgrover1 257:7a50601356cc 716 {
rgrover1 257:7a50601356cc 717 transport->getGattServer().setOnUpdatesEnabled(callback);
rgrover1 257:7a50601356cc 718 }
rgrover1 257:7a50601356cc 719
rgrover1 257:7a50601356cc 720 inline void
rgrover1 257:7a50601356cc 721 BLEDevice::onUpdatesDisabled(GattServer::EventCallback_t callback)
rgrover1 257:7a50601356cc 722 {
rgrover1 257:7a50601356cc 723 transport->getGattServer().setOnUpdatesDisabled(callback);
rgrover1 257:7a50601356cc 724 }
rgrover1 257:7a50601356cc 725
rgrover1 257:7a50601356cc 726 inline void
rgrover1 257:7a50601356cc 727 BLEDevice::onConfirmationReceived(GattServer::EventCallback_t callback)
rgrover1 257:7a50601356cc 728 {
rgrover1 257:7a50601356cc 729 transport->getGattServer().setOnConfirmationReceived(callback);
rgrover1 257:7a50601356cc 730 }
rgrover1 257:7a50601356cc 731
rgrover1 341:8a104d9d80c1 732 inline void
rgrover1 341:8a104d9d80c1 733 BLEDevice::onRadioNotification(Gap::RadioNotificationEventCallback_t callback)
rgrover1 341:8a104d9d80c1 734 {
rgrover1 341:8a104d9d80c1 735 transport->getGap().setOnRadioNotification(callback);
rgrover1 341:8a104d9d80c1 736 }
rgrover1 341:8a104d9d80c1 737
rgrover1 349:b8b2b3973c47 738 inline void
rgrover1 349:b8b2b3973c47 739 BLEDevice::setOnSecuritySetupStarted(Gap::HandleSpecificEvent_t callback)
rgrover1 349:b8b2b3973c47 740 {
rgrover1 349:b8b2b3973c47 741 transport->getGap().setOnSecuritySetupStarted(callback);
rgrover1 349:b8b2b3973c47 742 }
rgrover1 349:b8b2b3973c47 743
rgrover1 349:b8b2b3973c47 744 inline void
rgrover1 349:b8b2b3973c47 745 BLEDevice::setOnSecuritySetupCompleted(Gap::HandleSpecificEvent_t callback)
rgrover1 349:b8b2b3973c47 746 {
rgrover1 349:b8b2b3973c47 747 transport->getGap().setOnSecuritySetupCompleted(callback);
rgrover1 349:b8b2b3973c47 748 }
rgrover1 349:b8b2b3973c47 749
rgrover1 349:b8b2b3973c47 750 inline void
rgrover1 349:b8b2b3973c47 751 BLEDevice::setOnLinkSecured(Gap::HandleSpecificEvent_t callback)
rgrover1 349:b8b2b3973c47 752 {
rgrover1 349:b8b2b3973c47 753 transport->getGap().setOnLinkSecured(callback);
rgrover1 349:b8b2b3973c47 754 }
rgrover1 349:b8b2b3973c47 755
rgrover1 349:b8b2b3973c47 756 inline void
rgrover1 349:b8b2b3973c47 757 BLEDevice::setOnSecurityContextStored(Gap::HandleSpecificEvent_t callback)
rgrover1 349:b8b2b3973c47 758 {
rgrover1 349:b8b2b3973c47 759 transport->getGap().setOnSecurityContextStored(callback);
rgrover1 349:b8b2b3973c47 760 }
rgrover1 349:b8b2b3973c47 761
rgrover1 257:7a50601356cc 762 inline ble_error_t
rgrover1 257:7a50601356cc 763 BLEDevice::addService(GattService &service)
rgrover1 257:7a50601356cc 764 {
rgrover1 257:7a50601356cc 765 return transport->getGattServer().addService(service);
rgrover1 257:7a50601356cc 766 }
rgrover1 257:7a50601356cc 767
rgrover1 257:7a50601356cc 768 inline Gap::GapState_t
rgrover1 257:7a50601356cc 769 BLEDevice::getGapState(void) const
rgrover1 257:7a50601356cc 770 {
rgrover1 257:7a50601356cc 771 return transport->getGap().getState();
rgrover1 257:7a50601356cc 772 }
rgrover1 257:7a50601356cc 773
rgrover1 328:1fd12f67ed7a 774 inline ble_error_t BLEDevice::readCharacteristicValue(GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP)
rgrover1 257:7a50601356cc 775 {
rgrover1 328:1fd12f67ed7a 776 return transport->getGattServer().readValue(attributeHandle, buffer, lengthP);
rgrover1 257:7a50601356cc 777 }
rgrover1 257:7a50601356cc 778
rgrover1 342:152bd9c825d6 779 inline ble_error_t BLEDevice::readCharacteristicValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP)
rgrover1 342:152bd9c825d6 780 {
rgrover1 342:152bd9c825d6 781 return transport->getGattServer().readValue(connectionHandle, attributeHandle, buffer, lengthP);
rgrover1 342:152bd9c825d6 782 }
rgrover1 342:152bd9c825d6 783
rgrover1 257:7a50601356cc 784 inline ble_error_t
rgrover1 328:1fd12f67ed7a 785 BLEDevice::updateCharacteristicValue(GattAttribute::Handle_t attributeHandle, const uint8_t *value, uint16_t size, bool localOnly)
rgrover1 257:7a50601356cc 786 {
rgrover1 328:1fd12f67ed7a 787 return transport->getGattServer().updateValue(attributeHandle, const_cast<uint8_t *>(value), size, localOnly);
rgrover1 257:7a50601356cc 788 }
rgrover1 257:7a50601356cc 789
rgrover1 342:152bd9c825d6 790 inline ble_error_t
rgrover1 342:152bd9c825d6 791 BLEDevice::updateCharacteristicValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, const uint8_t *value, uint16_t size, bool localOnly)
rgrover1 342:152bd9c825d6 792 {
rgrover1 342:152bd9c825d6 793 return transport->getGattServer().updateValue(connectionHandle, attributeHandle, const_cast<uint8_t *>(value), size, localOnly);
rgrover1 342:152bd9c825d6 794 }
rgrover1 342:152bd9c825d6 795
rgrover1 257:7a50601356cc 796 inline void
rgrover1 257:7a50601356cc 797 BLEDevice::waitForEvent(void)
rgrover1 257:7a50601356cc 798 {
rgrover1 257:7a50601356cc 799 transport->waitForEvent();
rgrover1 257:7a50601356cc 800 }
rgrover1 257:7a50601356cc 801
rgrover1 257:7a50601356cc 802 inline ble_error_t
rgrover1 257:7a50601356cc 803 BLEDevice::getPreferredConnectionParams(Gap::ConnectionParams_t *params)
rgrover1 257:7a50601356cc 804 {
rgrover1 257:7a50601356cc 805 return transport->getGap().getPreferredConnectionParams(params);
rgrover1 257:7a50601356cc 806 }
rgrover1 257:7a50601356cc 807
rgrover1 257:7a50601356cc 808 inline ble_error_t
rgrover1 257:7a50601356cc 809 BLEDevice::setPreferredConnectionParams(const Gap::ConnectionParams_t *params)
rgrover1 257:7a50601356cc 810 {
rgrover1 257:7a50601356cc 811 return transport->getGap().setPreferredConnectionParams(params);
rgrover1 257:7a50601356cc 812 }
rgrover1 257:7a50601356cc 813
rgrover1 257:7a50601356cc 814 inline ble_error_t
rgrover1 257:7a50601356cc 815 BLEDevice::updateConnectionParams(Gap::Handle_t handle, const Gap::ConnectionParams_t *params) {
rgrover1 257:7a50601356cc 816 return transport->getGap().updateConnectionParams(handle, params);
rgrover1 257:7a50601356cc 817 }
rgrover1 257:7a50601356cc 818
rgrover1 257:7a50601356cc 819 inline const char *
rgrover1 257:7a50601356cc 820 BLEDevice::getVersion(void)
rgrover1 257:7a50601356cc 821 {
rgrover1 257:7a50601356cc 822 return transport->getVersion();
rgrover1 257:7a50601356cc 823 }
rgrover1 257:7a50601356cc 824
rgrover1 257:7a50601356cc 825 inline ble_error_t
rgrover1 257:7a50601356cc 826 BLEDevice::setDeviceName(const uint8_t *deviceName)
rgrover1 257:7a50601356cc 827 {
rgrover1 257:7a50601356cc 828 return transport->getGap().setDeviceName(deviceName);
rgrover1 257:7a50601356cc 829 }
rgrover1 257:7a50601356cc 830
rgrover1 257:7a50601356cc 831 inline ble_error_t
rgrover1 257:7a50601356cc 832 BLEDevice::getDeviceName(uint8_t *deviceName, unsigned *lengthP)
rgrover1 257:7a50601356cc 833 {
rgrover1 257:7a50601356cc 834 return transport->getGap().getDeviceName(deviceName, lengthP);
rgrover1 257:7a50601356cc 835 }
rgrover1 257:7a50601356cc 836
rgrover1 257:7a50601356cc 837 inline ble_error_t
rgrover1 257:7a50601356cc 838 BLEDevice::setAppearance(uint16_t appearance)
rgrover1 257:7a50601356cc 839 {
rgrover1 257:7a50601356cc 840 return transport->getGap().setAppearance(appearance);
rgrover1 257:7a50601356cc 841 }
rgrover1 257:7a50601356cc 842
rgrover1 257:7a50601356cc 843 inline ble_error_t
rgrover1 257:7a50601356cc 844 BLEDevice::getAppearance(uint16_t *appearanceP)
rgrover1 257:7a50601356cc 845 {
rgrover1 257:7a50601356cc 846 return transport->getGap().getAppearance(appearanceP);
rgrover1 257:7a50601356cc 847 }
rgrover1 257:7a50601356cc 848
rgrover1 257:7a50601356cc 849 inline ble_error_t
rgrover1 257:7a50601356cc 850 BLEDevice::setTxPower(int8_t txPower)
rgrover1 257:7a50601356cc 851 {
rgrover1 257:7a50601356cc 852 return transport->setTxPower(txPower);
rgrover1 257:7a50601356cc 853 }
rgrover1 257:7a50601356cc 854
rgrover1 305:71367f7cd078 855 inline void
rgrover1 305:71367f7cd078 856 BLEDevice::getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP)
rgrover1 305:71367f7cd078 857 {
rgrover1 305:71367f7cd078 858 transport->getPermittedTxPowerValues(valueArrayPP, countP);
rgrover1 305:71367f7cd078 859 }
rgrover1 305:71367f7cd078 860
rgrover1 347:20be4234c6fe 861 inline ble_error_t
rgrover1 347:20be4234c6fe 862 BLEDevice::initializeSecurity(void)
rgrover1 347:20be4234c6fe 863 {
rgrover1 347:20be4234c6fe 864 return transport->initializeSecurity();
rgrover1 347:20be4234c6fe 865 }
rgrover1 347:20be4234c6fe 866
rgrover1 257:7a50601356cc 867 #endif // ifndef __BLE_DEVICE__