Improve readability with getHandle inline

Fork of BLE_API by Bluetooth Low Energy

Committer:
rgrover1
Date:
Mon Dec 01 14:31:17 2014 +0000
Revision:
199:6b57874115f6
Parent:
198:933961a2ac6f
Child:
227:5c4cb4553821
Synchronized with git rev 6e85b53f
Author: Rohit Grover
Uri Data must be between 0 and 18 bytes
https://github.com/mbedmicro/BLE_API/issues/6

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 106:a20be740075d 1 /* mbed Microcontroller Library
Rohit Grover 106:a20be740075d 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 106:a20be740075d 3 *
Rohit Grover 106:a20be740075d 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 106:a20be740075d 5 * you may not use this file except in compliance with the License.
Rohit Grover 106:a20be740075d 6 * You may obtain a copy of the License at
Rohit Grover 106:a20be740075d 7 *
Rohit Grover 106:a20be740075d 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 106:a20be740075d 9 *
Rohit Grover 106:a20be740075d 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 106:a20be740075d 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 106:a20be740075d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 106:a20be740075d 13 * See the License for the specific language governing permissions and
Rohit Grover 106:a20be740075d 14 * limitations under the License.
Rohit Grover 106:a20be740075d 15 */
Rohit Grover 106:a20be740075d 16
Rohit Grover 110:d5a824cee1d3 17 #ifndef __BLE_DEVICE__
Rohit Grover 110:d5a824cee1d3 18 #define __BLE_DEVICE__
Rohit Grover 110:d5a824cee1d3 19
Rohit Grover 106:a20be740075d 20 #include "Gap.h"
Rohit Grover 106:a20be740075d 21 #include "GattServer.h"
Rohit Grover 111:189ff241dae1 22 #include "BLEDeviceInstanceBase.h"
Rohit Grover 106:a20be740075d 23
Rohit Grover 106:a20be740075d 24 /**
Rohit Grover 106:a20be740075d 25 * The base class used to abstract away BLE capable radio transceivers or SOCs,
Rohit Grover 106:a20be740075d 26 * to enable this BLE API to work with any radio transparently.
Rohit Grover 106:a20be740075d 27 */
Rohit Grover 106:a20be740075d 28 class BLEDevice
Rohit Grover 106:a20be740075d 29 {
Rohit Grover 106:a20be740075d 30 public:
Rohit Grover 106:a20be740075d 31 /**
Rohit Grover 106:a20be740075d 32 * Initialize the BLE controller. This should be called before using
Rohit Grover 106:a20be740075d 33 * anything else in the BLE_API.
Rohit Grover 106:a20be740075d 34 */
Rohit Grover 106:a20be740075d 35 ble_error_t init();
Rohit Grover 106:a20be740075d 36 ble_error_t reset(void);
Rohit Grover 106:a20be740075d 37
Rohit Grover 106:a20be740075d 38 /* GAP specific APIs */
Rohit Grover 106:a20be740075d 39 public:
Rohit Grover 106:a20be740075d 40 /**
Rohit Grover 106:a20be740075d 41 * Set the BTLE MAC address and type.
Rohit Grover 123:fede41ce9407 42 * @return BLE_ERROR_NONE on success.
Rohit Grover 106:a20be740075d 43 */
rgrover1 140:407d134c179d 44 ble_error_t setAddress(Gap::addr_type_t type, const Gap::address_t address);
Rohit Grover 123:fede41ce9407 45
Rohit Grover 123:fede41ce9407 46 /**
Rohit Grover 123:fede41ce9407 47 * Fetch the BTLE MAC address and type.
Rohit Grover 123:fede41ce9407 48 * @return BLE_ERROR_NONE on success.
Rohit Grover 123:fede41ce9407 49 */
rgrover1 140:407d134c179d 50 ble_error_t getAddress(Gap::addr_type_t *typeP, Gap::address_t address);
Rohit Grover 106:a20be740075d 51
Rohit Grover 106:a20be740075d 52 /**
Rohit Grover 106:a20be740075d 53 * @param[in] advType
Rohit Grover 106:a20be740075d 54 * The GAP advertising mode to use for this device. Valid
Rohit Grover 106:a20be740075d 55 * values are defined in AdvertisingType:
Rohit Grover 106:a20be740075d 56 *
Rohit Grover 106:a20be740075d 57 * \par ADV_NON_CONNECTABLE_UNDIRECTED
Rohit Grover 106:a20be740075d 58 * All connections to the peripheral device will be refused.
Rohit Grover 106:a20be740075d 59 *
Rohit Grover 106:a20be740075d 60 * \par ADV_CONNECTABLE_DIRECTED
Rohit Grover 106:a20be740075d 61 * Only connections from a pre-defined central device will be
Rohit Grover 106:a20be740075d 62 * accepted.
Rohit Grover 106:a20be740075d 63 *
Rohit Grover 106:a20be740075d 64 * \par ADV_CONNECTABLE_UNDIRECTED
Rohit Grover 106:a20be740075d 65 * Any central device can connect to this peripheral.
Rohit Grover 106:a20be740075d 66 *
Rohit Grover 106:a20be740075d 67 * \par ADV_SCANNABLE_UNDIRECTED
Rohit Grover 106:a20be740075d 68 * Any central device can connect to this peripheral, and
Rohit Grover 106:a20be740075d 69 * the secondary Scan Response payload will be included or
Rohit Grover 106:a20be740075d 70 * available to central devices.
Rohit Grover 106:a20be740075d 71 *
Rohit Grover 106:a20be740075d 72 * \par
Rohit Grover 106:a20be740075d 73 * See Bluetooth Core Specification 4.0 (Vol. 3), Part C,
Rohit Grover 106:a20be740075d 74 * Section 9.3 and Core Specification 4.0 (Vol. 6), Part B,
Rohit Grover 106:a20be740075d 75 * Section 2.3.1 for further information on GAP connection
Rohit Grover 106:a20be740075d 76 * modes
Rohit Grover 106:a20be740075d 77 */
Rohit Grover 106:a20be740075d 78 void setAdvertisingType(GapAdvertisingParams::AdvertisingType);
Rohit Grover 106:a20be740075d 79
Rohit Grover 106:a20be740075d 80 /**
Rohit Grover 106:a20be740075d 81 * @param[in] interval
Rohit Grover 106:a20be740075d 82 * Advertising interval between 0x0020 and 0x4000 in 0.625ms
Rohit Grover 106:a20be740075d 83 * units (20ms to 10.24s). If using non-connectable mode
Rohit Grover 106:a20be740075d 84 * (ADV_NON_CONNECTABLE_UNDIRECTED) this min value is
Rohit Grover 106:a20be740075d 85 * 0x00A0 (100ms). To reduce the likelihood of collisions, the
Rohit Grover 106:a20be740075d 86 * link layer perturbs this interval by a pseudo-random delay
Rohit Grover 106:a20be740075d 87 * with a range of 0 ms to 10 ms for each advertising event.
Rohit Grover 106:a20be740075d 88 *
Rohit Grover 106:a20be740075d 89 * \par
Rohit Grover 106:a20be740075d 90 * Decreasing this value will allow central devices to detect
Rohit Grover 106:a20be740075d 91 * your peripheral faster at the expense of more power being
Rohit Grover 106:a20be740075d 92 * used by the radio due to the higher data transmit rate.
Rohit Grover 106:a20be740075d 93 *
Rohit Grover 106:a20be740075d 94 * \par
Rohit Grover 106:a20be740075d 95 * This field must be set to 0 if connectionMode is equal
Rohit Grover 106:a20be740075d 96 * to ADV_CONNECTABLE_DIRECTED
Rohit Grover 106:a20be740075d 97 *
Rohit Grover 106:a20be740075d 98 * \par
Rohit Grover 106:a20be740075d 99 * See Bluetooth Core Specification, Vol 3., Part C,
Rohit Grover 106:a20be740075d 100 * Appendix A for suggested advertising intervals.
Rohit Grover 106:a20be740075d 101 */
Rohit Grover 106:a20be740075d 102 void setAdvertisingInterval(uint16_t interval);
Rohit Grover 106:a20be740075d 103
Rohit Grover 106:a20be740075d 104 /**
Rohit Grover 106:a20be740075d 105 * @param[in] timeout
Rohit Grover 106:a20be740075d 106 * Advertising timeout between 0x1 and 0x3FFF (1 and 16383)
Rohit Grover 106:a20be740075d 107 * in seconds. Enter 0 to disable the advertising timeout.
Rohit Grover 106:a20be740075d 108 */
Rohit Grover 106:a20be740075d 109 void setAdvertisingTimeout(uint16_t timeout);
Rohit Grover 106:a20be740075d 110
Rohit Grover 106:a20be740075d 111 /**
Rohit Grover 106:a20be740075d 112 * Please refer to the APIs above.
Rohit Grover 106:a20be740075d 113 */
Rohit Grover 106:a20be740075d 114 void setAdvertisingParams(const GapAdvertisingParams &advParams);
Rohit Grover 106:a20be740075d 115
Rohit Grover 106:a20be740075d 116 /**
Rohit Grover 106:a20be740075d 117 * This API is typically used as an internal helper to udpate the transport
Rohit Grover 106:a20be740075d 118 * backend with advertising data before starting to advertise. It may also
Rohit Grover 106:a20be740075d 119 * be explicity used to dynamically reset the accumulated advertising
Rohit Grover 106:a20be740075d 120 * payload and scanResponse; to do this, the application can clear and re-
Rohit Grover 106:a20be740075d 121 * accumulate a new advertising payload (and scanResponse) before using this
Rohit Grover 106:a20be740075d 122 * API.
Rohit Grover 106:a20be740075d 123 */
Rohit Grover 106:a20be740075d 124 ble_error_t setAdvertisingPayload(void);
Rohit Grover 106:a20be740075d 125
Rohit Grover 106:a20be740075d 126 /**
Rohit Grover 106:a20be740075d 127 * Reset any advertising payload prepared from prior calls to
Rohit Grover 106:a20be740075d 128 * accumulateAdvertisingPayload().
Rohit Grover 106:a20be740075d 129 */
Rohit Grover 106:a20be740075d 130 void clearAdvertisingPayload(void);
Rohit Grover 106:a20be740075d 131
Rohit Grover 106:a20be740075d 132 /**
Rohit Grover 106:a20be740075d 133 * Accumulate an AD structure in the advertising payload. Please note that
Rohit Grover 106:a20be740075d 134 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
Rohit Grover 106:a20be740075d 135 * as an additional 31 bytes if the advertising payload proves to be too
Rohit Grover 106:a20be740075d 136 * small.
Rohit Grover 106:a20be740075d 137 *
Rohit Grover 106:a20be740075d 138 * @param flags
Rohit Grover 106:a20be740075d 139 * The flags to be added. Multiple flags may be specified in
Rohit Grover 106:a20be740075d 140 * combination.
Rohit Grover 106:a20be740075d 141 */
Rohit Grover 106:a20be740075d 142 ble_error_t accumulateAdvertisingPayload(uint8_t flags);
Rohit Grover 106:a20be740075d 143
Rohit Grover 106:a20be740075d 144 /**
Rohit Grover 106:a20be740075d 145 * Accumulate an AD structure in the advertising payload. Please note that
Rohit Grover 106:a20be740075d 146 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
Rohit Grover 106:a20be740075d 147 * as an additional 31 bytes if the advertising payload proves to be too
Rohit Grover 106:a20be740075d 148 * small.
Rohit Grover 106:a20be740075d 149 *
Rohit Grover 106:a20be740075d 150 * @param app
Rohit Grover 106:a20be740075d 151 * The appearance of the peripheral.
Rohit Grover 106:a20be740075d 152 */
Rohit Grover 106:a20be740075d 153 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app);
Rohit Grover 106:a20be740075d 154
Rohit Grover 106:a20be740075d 155 /**
Rohit Grover 106:a20be740075d 156 * Accumulate an AD structure in the advertising payload. Please note that
Rohit Grover 106:a20be740075d 157 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
Rohit Grover 106:a20be740075d 158 * as an additional 31 bytes if the advertising payload proves to be too
Rohit Grover 106:a20be740075d 159 * small.
Rohit Grover 106:a20be740075d 160 *
Rohit Grover 106:a20be740075d 161 * @param app
Rohit Grover 106:a20be740075d 162 * The max transmit power to be used by the controller. This is
Rohit Grover 106:a20be740075d 163 * only a hint.
Rohit Grover 106:a20be740075d 164 */
Rohit Grover 106:a20be740075d 165 ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power);
Rohit Grover 106:a20be740075d 166
Rohit Grover 106:a20be740075d 167 /**
Rohit Grover 106:a20be740075d 168 * Accumulate a variable length byte-stream as an AD structure in the
Rohit Grover 106:a20be740075d 169 * advertising payload. Please note that the payload is limited to 31 bytes.
Rohit Grover 106:a20be740075d 170 * The SCAN_RESPONSE message may be used as an additional 31 bytes if the
Rohit Grover 106:a20be740075d 171 * advertising payload proves to be too small.
Rohit Grover 106:a20be740075d 172 *
Rohit Grover 106:a20be740075d 173 * @param type The type which describes the variable length data.
Rohit Grover 106:a20be740075d 174 * @param data data bytes.
Rohit Grover 106:a20be740075d 175 * @param len length of data.
Rohit Grover 106:a20be740075d 176 */
Rohit Grover 106:a20be740075d 177 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len);
Rohit Grover 106:a20be740075d 178
Rohit Grover 106:a20be740075d 179 /**
Rohit Grover 106:a20be740075d 180 * Accumulate a variable length byte-stream as an AD structure in the
Rohit Grover 106:a20be740075d 181 * scanResponse payload.
Rohit Grover 106:a20be740075d 182 *
Rohit Grover 106:a20be740075d 183 * @param type The type which describes the variable length data.
Rohit Grover 106:a20be740075d 184 * @param data data bytes.
Rohit Grover 106:a20be740075d 185 * @param len length of data.
Rohit Grover 106:a20be740075d 186 */
Rohit Grover 106:a20be740075d 187 ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len);
Rohit Grover 106:a20be740075d 188
Rohit Grover 106:a20be740075d 189 /**
Rohit Grover 106:a20be740075d 190 * Start advertising (GAP Discoverable, Connectable modes, Broadcast
Rohit Grover 106:a20be740075d 191 * Procedure).
Rohit Grover 106:a20be740075d 192 */
Rohit Grover 106:a20be740075d 193 ble_error_t startAdvertising(void);
Rohit Grover 106:a20be740075d 194
Rohit Grover 106:a20be740075d 195 /**
Rohit Grover 106:a20be740075d 196 * Stop advertising (GAP Discoverable, Connectable modes, Broadcast
Rohit Grover 106:a20be740075d 197 * Procedure).
Rohit Grover 106:a20be740075d 198 */
Rohit Grover 106:a20be740075d 199 ble_error_t stopAdvertising(void);
Rohit Grover 106:a20be740075d 200
Rohit Grover 116:ca826083980e 201 ble_error_t disconnect(Gap::DisconnectionReason_t reason);
Rohit Grover 106:a20be740075d 202
Rohit Grover 106:a20be740075d 203 /* APIs to set GAP callbacks. */
Rohit Grover 106:a20be740075d 204 void onTimeout(Gap::EventCallback_t timeoutCallback);
Rohit Grover 106:a20be740075d 205
Rohit Grover 116:ca826083980e 206 void onConnection(Gap::ConnectionEventCallback_t connectionCallback);
Rohit Grover 106:a20be740075d 207 /**
Rohit Grover 106:a20be740075d 208 * Used to setup a callback for GAP disconnection.
Rohit Grover 106:a20be740075d 209 */
Rohit Grover 116:ca826083980e 210 void onDisconnection(Gap::DisconnectionEventCallback_t disconnectionCallback);
Rohit Grover 106:a20be740075d 211
Rohit Grover 106:a20be740075d 212 /**
Rohit Grover 106:a20be740075d 213 * Setup a callback for the GATT event DATA_SENT.
Rohit Grover 106:a20be740075d 214 */
Rohit Grover 116:ca826083980e 215 void onDataSent(GattServer::ServerEventCallbackWithCount_t callback);
Rohit Grover 106:a20be740075d 216
Rohit Grover 106:a20be740075d 217 /**
Rohit Grover 106:a20be740075d 218 * Setup a callback for when a characteristic has its value updated by a
Rohit Grover 106:a20be740075d 219 * client.
Rohit Grover 118:620d28e7a1ba 220 *
Rohit Grover 118:620d28e7a1ba 221 * @Note: it is possible to chain together multiple onDataWritten callbacks
Rohit Grover 118:620d28e7a1ba 222 * (potentially from different modules of an application) to receive updates
Rohit Grover 118:620d28e7a1ba 223 * to characteristics. Many services, such as DFU and UART add their own
Rohit Grover 118:620d28e7a1ba 224 * onDataWritten callbacks behind the scenes to trap interesting events.
Rohit Grover 118:620d28e7a1ba 225 *
Rohit Grover 118:620d28e7a1ba 226 * @Note: it is also possible to setup a callback into a member function of
Rohit Grover 118:620d28e7a1ba 227 * some object.
Rohit Grover 106:a20be740075d 228 */
Rohit Grover 118:620d28e7a1ba 229 void onDataWritten(void (*callback)(const GattCharacteristicWriteCBParams *eventDataP));
rgrover1 140:407d134c179d 230 template <typename T> void onDataWritten(T * objPtr, void (T::*memberPtr)(const GattCharacteristicWriteCBParams *context));
Rohit Grover 118:620d28e7a1ba 231
Rohit Grover 106:a20be740075d 232 void onUpdatesEnabled(GattServer::EventCallback_t callback);
Rohit Grover 106:a20be740075d 233 void onUpdatesDisabled(GattServer::EventCallback_t callback);
Rohit Grover 106:a20be740075d 234 void onConfirmationReceived(GattServer::EventCallback_t callback);
Rohit Grover 106:a20be740075d 235
Rohit Grover 106:a20be740075d 236 /**
Rohit Grover 106:a20be740075d 237 * Add a service declaration to the local server ATT table. Also add the
Rohit Grover 106:a20be740075d 238 * characteristics contained within.
Rohit Grover 106:a20be740075d 239 */
Rohit Grover 106:a20be740075d 240 ble_error_t addService(GattService &service);
Rohit Grover 106:a20be740075d 241
Rohit Grover 106:a20be740075d 242 Gap::GapState_t getGapState(void) const;
Rohit Grover 106:a20be740075d 243
Rohit Grover 118:620d28e7a1ba 244 /**
Rohit Grover 118:620d28e7a1ba 245 * @param[in/out] lengthP
Rohit Grover 118:620d28e7a1ba 246 * input: Length in bytes to be read,
Rohit Grover 118:620d28e7a1ba 247 * output: Total length of attribute value upon successful return.
Rohit Grover 118:620d28e7a1ba 248 */
Rohit Grover 106:a20be740075d 249 ble_error_t readCharacteristicValue(uint16_t handle, uint8_t *const buffer, uint16_t *const lengthP);
Rohit Grover 118:620d28e7a1ba 250
Rohit Grover 118:620d28e7a1ba 251 /**
Rohit Grover 118:620d28e7a1ba 252 * @param localOnly
Rohit Grover 118:620d28e7a1ba 253 * Only update the characteristic locally regardless of notify/indicate flags in the CCCD.
Rohit Grover 118:620d28e7a1ba 254 */
rgrover1 140:407d134c179d 255 ble_error_t updateCharacteristicValue(uint16_t handle, const uint8_t *value, uint16_t size, bool localOnly = false);
Rohit Grover 106:a20be740075d 256
Rohit Grover 106:a20be740075d 257 /**
Rohit Grover 106:a20be740075d 258 * Yield control to the BLE stack or to other tasks waiting for events. This
Rohit Grover 106:a20be740075d 259 * is a sleep function which will return when there is an application
Rohit Grover 106:a20be740075d 260 * specific interrupt, but the MCU might wake up several times before
Rohit Grover 106:a20be740075d 261 * returning (to service the stack). This is not always interchangeable with
Rohit Grover 106:a20be740075d 262 * WFE().
Rohit Grover 106:a20be740075d 263 */
Rohit Grover 106:a20be740075d 264 void waitForEvent(void);
Rohit Grover 106:a20be740075d 265
Rohit Grover 106:a20be740075d 266 ble_error_t getPreferredConnectionParams(Gap::ConnectionParams_t *params);
Rohit Grover 106:a20be740075d 267 ble_error_t setPreferredConnectionParams(const Gap::ConnectionParams_t *params);
Rohit Grover 106:a20be740075d 268 ble_error_t updateConnectionParams(Gap::Handle_t handle, const Gap::ConnectionParams_t *params);
Rohit Grover 108:c85ab5f1eca0 269
Rohit Grover 108:c85ab5f1eca0 270 /**
Rohit Grover 108:c85ab5f1eca0 271 * This call allows the application to get the BLE stack version information.
Rohit Grover 108:c85ab5f1eca0 272 *
Rohit Grover 108:c85ab5f1eca0 273 * @return A pointer to a const string representing the version.
Rohit Grover 108:c85ab5f1eca0 274 * Note: The string is owned by the BLE_API.
Rohit Grover 108:c85ab5f1eca0 275 */
Rohit Grover 108:c85ab5f1eca0 276 const char *getVersion(void);
Rohit Grover 108:c85ab5f1eca0 277
rgrover1 140:407d134c179d 278 /**
rgrover1 140:407d134c179d 279 * Set the device name characteristic in the GAP service.
rgrover1 140:407d134c179d 280 * @param deviceName The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
rgrover1 140:407d134c179d 281 */
rgrover1 140:407d134c179d 282 ble_error_t setDeviceName(const uint8_t *deviceName);
Rohit Grover 108:c85ab5f1eca0 283
rgrover1 140:407d134c179d 284 /**
rgrover1 140:407d134c179d 285 * Get the value of the device name characteristic in the GAP service.
rgrover1 140:407d134c179d 286 * @param[out] deviceName Pointer to an empty buffer where the UTF-8 *non NULL-
rgrover1 140:407d134c179d 287 * terminated* string will be placed. Set this
rgrover1 140:407d134c179d 288 * value to NULL in order to obtain the deviceName-length
rgrover1 140:407d134c179d 289 * from the 'length' parameter.
rgrover1 140:407d134c179d 290 *
rgrover1 140:407d134c179d 291 * @param[in/out] lengthP (on input) Length of the buffer pointed to by deviceName;
rgrover1 140:407d134c179d 292 * (on output) the complete device name length (without the
rgrover1 140:407d134c179d 293 * null terminator).
rgrover1 140:407d134c179d 294 *
rgrover1 140:407d134c179d 295 * @note If the device name is longer than the size of the supplied buffer,
rgrover1 140:407d134c179d 296 * length will return the complete device name length,
rgrover1 140:407d134c179d 297 * and not the number of bytes actually returned in deviceName.
rgrover1 140:407d134c179d 298 * The application may use this information to retry with a suitable buffer size.
rgrover1 140:407d134c179d 299 *
rgrover1 140:407d134c179d 300 * Sample use:
rgrover1 140:407d134c179d 301 * uint8_t deviceName[20];
rgrover1 140:407d134c179d 302 * unsigned length = sizeof(deviceName);
rgrover1 140:407d134c179d 303 * ble.getDeviceName(deviceName, &length);
rgrover1 140:407d134c179d 304 * if (length < sizeof(deviceName)) {
rgrover1 140:407d134c179d 305 * deviceName[length] = 0;
rgrover1 140:407d134c179d 306 * }
rgrover1 140:407d134c179d 307 * DEBUG("length: %u, deviceName: %s\r\n", length, deviceName);
rgrover1 140:407d134c179d 308 */
rgrover1 140:407d134c179d 309 ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP);
Rohit Grover 108:c85ab5f1eca0 310
rgrover1 140:407d134c179d 311 /**
rgrover1 140:407d134c179d 312 * Set the appearance characteristic in the GAP service.
rgrover1 140:407d134c179d 313 * @param[in] appearance The new value for the device-appearance.
rgrover1 140:407d134c179d 314 */
rgrover1 140:407d134c179d 315 ble_error_t setAppearance(uint16_t appearance);
Rohit Grover 108:c85ab5f1eca0 316
rgrover1 140:407d134c179d 317 /**
rgrover1 140:407d134c179d 318 * Set the appearance characteristic in the GAP service.
rgrover1 140:407d134c179d 319 * @param[out] appearance The new value for the device-appearance.
rgrover1 140:407d134c179d 320 */
rgrover1 140:407d134c179d 321 ble_error_t getAppearance(uint16_t *appearanceP);
Rohit Grover 108:c85ab5f1eca0 322
rgrover1 140:407d134c179d 323 /**
rgrover1 140:407d134c179d 324 * Set the radio's transmit power.
rgrover1 140:407d134c179d 325 * @param[in] txPower Radio transmit power in dBm.
rgrover1 140:407d134c179d 326 */
rgrover1 140:407d134c179d 327 ble_error_t setTxPower(int8_t txPower);
Rohit Grover 106:a20be740075d 328
Rohit Grover 106:a20be740075d 329 public:
Rohit Grover 106:a20be740075d 330 BLEDevice() : transport(createBLEDeviceInstance()), advParams(), advPayload(), scanResponse(), needToSetAdvPayload(true) {
Rohit Grover 106:a20be740075d 331 advPayload.clear();
Rohit Grover 106:a20be740075d 332 scanResponse.clear();
Rohit Grover 106:a20be740075d 333 }
Rohit Grover 106:a20be740075d 334
Rohit Grover 106:a20be740075d 335 private:
Rohit Grover 106:a20be740075d 336 BLEDeviceInstanceBase *const transport; /* the device specific backend */
Rohit Grover 106:a20be740075d 337
Rohit Grover 106:a20be740075d 338 GapAdvertisingParams advParams;
Rohit Grover 106:a20be740075d 339 GapAdvertisingData advPayload;
Rohit Grover 106:a20be740075d 340 GapAdvertisingData scanResponse;
Rohit Grover 106:a20be740075d 341
Rohit Grover 106:a20be740075d 342 /* Accumulation of AD structures in the advertisement payload should
Rohit Grover 106:a20be740075d 343 * eventually result in a call to the target's setAdvertisingData() before
Rohit Grover 106:a20be740075d 344 * the server begins advertising. This flag marks the status of the pending update.*/
Rohit Grover 106:a20be740075d 345 bool needToSetAdvPayload;
Rohit Grover 106:a20be740075d 346
Rohit Grover 106:a20be740075d 347 /**
Rohit Grover 106:a20be740075d 348 * DEPRECATED
Rohit Grover 106:a20be740075d 349 */
Rohit Grover 106:a20be740075d 350 public:
Rohit Grover 106:a20be740075d 351 ble_error_t setAdvertisingData(const GapAdvertisingData &ADStructures, const GapAdvertisingData &scanResponse);
Rohit Grover 106:a20be740075d 352 ble_error_t setAdvertisingData(const GapAdvertisingData &ADStructures);
Rohit Grover 106:a20be740075d 353
Rohit Grover 106:a20be740075d 354 ble_error_t startAdvertising(const GapAdvertisingParams &advParams);
Rohit Grover 106:a20be740075d 355 };
Rohit Grover 106:a20be740075d 356
Rohit Grover 106:a20be740075d 357 /* BLEDevice methods. Most of these simply forward the calls to the underlying
Rohit Grover 106:a20be740075d 358 * transport.*/
Rohit Grover 106:a20be740075d 359
Rohit Grover 106:a20be740075d 360 inline ble_error_t
Rohit Grover 106:a20be740075d 361 BLEDevice::reset(void)
Rohit Grover 106:a20be740075d 362 {
Rohit Grover 106:a20be740075d 363 return transport->reset();
Rohit Grover 106:a20be740075d 364 }
Rohit Grover 106:a20be740075d 365
Rohit Grover 106:a20be740075d 366 inline ble_error_t
rgrover1 140:407d134c179d 367 BLEDevice::setAddress(Gap::addr_type_t type, const Gap::address_t address)
Rohit Grover 106:a20be740075d 368 {
Rohit Grover 106:a20be740075d 369 return transport->getGap().setAddress(type, address);
Rohit Grover 106:a20be740075d 370 }
Rohit Grover 106:a20be740075d 371
Rohit Grover 123:fede41ce9407 372 inline ble_error_t
rgrover1 140:407d134c179d 373 BLEDevice::getAddress(Gap::addr_type_t *typeP, Gap::address_t address)
Rohit Grover 123:fede41ce9407 374 {
Rohit Grover 123:fede41ce9407 375 return transport->getGap().getAddress(typeP, address);
Rohit Grover 123:fede41ce9407 376 }
Rohit Grover 123:fede41ce9407 377
Rohit Grover 106:a20be740075d 378 inline void
Rohit Grover 106:a20be740075d 379 BLEDevice::setAdvertisingType(GapAdvertisingParams::AdvertisingType advType)
Rohit Grover 106:a20be740075d 380 {
Rohit Grover 106:a20be740075d 381 advParams.setAdvertisingType(advType);
Rohit Grover 106:a20be740075d 382 }
Rohit Grover 106:a20be740075d 383
Rohit Grover 106:a20be740075d 384 inline void
Rohit Grover 106:a20be740075d 385 BLEDevice::setAdvertisingInterval(uint16_t interval)
Rohit Grover 106:a20be740075d 386 {
Rohit Grover 106:a20be740075d 387 advParams.setInterval(interval);
Rohit Grover 106:a20be740075d 388 }
Rohit Grover 106:a20be740075d 389
Rohit Grover 106:a20be740075d 390 inline void
Rohit Grover 106:a20be740075d 391 BLEDevice::setAdvertisingTimeout(uint16_t timeout)
Rohit Grover 106:a20be740075d 392 {
Rohit Grover 106:a20be740075d 393 advParams.setTimeout(timeout);
Rohit Grover 106:a20be740075d 394 }
Rohit Grover 106:a20be740075d 395
Rohit Grover 106:a20be740075d 396 inline void
Rohit Grover 106:a20be740075d 397 BLEDevice::setAdvertisingParams(const GapAdvertisingParams &newAdvParams)
Rohit Grover 106:a20be740075d 398 {
Rohit Grover 106:a20be740075d 399 advParams = newAdvParams;
Rohit Grover 106:a20be740075d 400 }
Rohit Grover 106:a20be740075d 401
Rohit Grover 106:a20be740075d 402 inline void
Rohit Grover 106:a20be740075d 403 BLEDevice::clearAdvertisingPayload(void)
Rohit Grover 106:a20be740075d 404 {
Rohit Grover 106:a20be740075d 405 needToSetAdvPayload = true;
Rohit Grover 106:a20be740075d 406 advPayload.clear();
Rohit Grover 106:a20be740075d 407 }
Rohit Grover 106:a20be740075d 408
Rohit Grover 106:a20be740075d 409 inline ble_error_t
Rohit Grover 106:a20be740075d 410 BLEDevice::accumulateAdvertisingPayload(uint8_t flags)
Rohit Grover 106:a20be740075d 411 {
Rohit Grover 106:a20be740075d 412 needToSetAdvPayload = true;
Rohit Grover 106:a20be740075d 413 return advPayload.addFlags(flags);
Rohit Grover 106:a20be740075d 414 }
Rohit Grover 106:a20be740075d 415
Rohit Grover 106:a20be740075d 416 inline ble_error_t
Rohit Grover 106:a20be740075d 417 BLEDevice::accumulateAdvertisingPayload(GapAdvertisingData::Appearance app)
Rohit Grover 106:a20be740075d 418 {
Rohit Grover 106:a20be740075d 419 needToSetAdvPayload = true;
rgrover1 140:407d134c179d 420 transport->getGap().setAppearance(app);
Rohit Grover 106:a20be740075d 421 return advPayload.addAppearance(app);
Rohit Grover 106:a20be740075d 422 }
Rohit Grover 106:a20be740075d 423
Rohit Grover 106:a20be740075d 424 inline ble_error_t
Rohit Grover 106:a20be740075d 425 BLEDevice::accumulateAdvertisingPayloadTxPower(int8_t txPower)
Rohit Grover 106:a20be740075d 426 {
Rohit Grover 106:a20be740075d 427 needToSetAdvPayload = true;
Rohit Grover 106:a20be740075d 428 return advPayload.addTxPower(txPower);
Rohit Grover 106:a20be740075d 429 }
Rohit Grover 106:a20be740075d 430
Rohit Grover 106:a20be740075d 431 inline ble_error_t
Rohit Grover 106:a20be740075d 432 BLEDevice::accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len)
Rohit Grover 106:a20be740075d 433 {
Rohit Grover 106:a20be740075d 434 needToSetAdvPayload = true;
rgrover1 140:407d134c179d 435 if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
rgrover1 140:407d134c179d 436 transport->getGap().setDeviceName(data);
rgrover1 140:407d134c179d 437 }
Rohit Grover 106:a20be740075d 438 return advPayload.addData(type, data, len);
Rohit Grover 106:a20be740075d 439 }
Rohit Grover 106:a20be740075d 440
Rohit Grover 106:a20be740075d 441 inline ble_error_t
Rohit Grover 106:a20be740075d 442 BLEDevice::accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len)
Rohit Grover 106:a20be740075d 443 {
Rohit Grover 106:a20be740075d 444 needToSetAdvPayload = true;
Rohit Grover 106:a20be740075d 445 return scanResponse.addData(type, data, len);
Rohit Grover 106:a20be740075d 446 }
Rohit Grover 106:a20be740075d 447
Rohit Grover 106:a20be740075d 448 inline ble_error_t
Rohit Grover 106:a20be740075d 449 BLEDevice::setAdvertisingPayload(void) {
Rohit Grover 106:a20be740075d 450 needToSetAdvPayload = false;
Rohit Grover 106:a20be740075d 451 return transport->getGap().setAdvertisingData(advPayload, scanResponse);
Rohit Grover 106:a20be740075d 452 }
Rohit Grover 106:a20be740075d 453
Rohit Grover 106:a20be740075d 454 inline ble_error_t
Rohit Grover 106:a20be740075d 455 BLEDevice::startAdvertising(void)
Rohit Grover 106:a20be740075d 456 {
rgrover1 140:407d134c179d 457 ble_error_t rc;
rgrover1 140:407d134c179d 458 if ((rc = transport->getGattServer().initializeGATTDatabase()) != BLE_ERROR_NONE) {
rgrover1 140:407d134c179d 459 return rc;
rgrover1 140:407d134c179d 460 }
Rohit Grover 106:a20be740075d 461 if (needToSetAdvPayload) {
Rohit Grover 106:a20be740075d 462 if ((rc = setAdvertisingPayload()) != BLE_ERROR_NONE) {
Rohit Grover 106:a20be740075d 463 return rc;
Rohit Grover 106:a20be740075d 464 }
Rohit Grover 106:a20be740075d 465 }
Rohit Grover 106:a20be740075d 466
Rohit Grover 106:a20be740075d 467 return transport->getGap().startAdvertising(advParams);
Rohit Grover 106:a20be740075d 468 }
Rohit Grover 106:a20be740075d 469
Rohit Grover 106:a20be740075d 470 inline ble_error_t
Rohit Grover 106:a20be740075d 471 BLEDevice::stopAdvertising(void)
Rohit Grover 106:a20be740075d 472 {
Rohit Grover 106:a20be740075d 473 return transport->getGap().stopAdvertising();
Rohit Grover 106:a20be740075d 474 }
Rohit Grover 106:a20be740075d 475
Rohit Grover 106:a20be740075d 476 inline ble_error_t
Rohit Grover 116:ca826083980e 477 BLEDevice::disconnect(Gap::DisconnectionReason_t reason)
Rohit Grover 106:a20be740075d 478 {
Rohit Grover 116:ca826083980e 479 return transport->getGap().disconnect(reason);
Rohit Grover 106:a20be740075d 480 }
Rohit Grover 106:a20be740075d 481
Rohit Grover 106:a20be740075d 482 inline void
Rohit Grover 106:a20be740075d 483 BLEDevice::onTimeout(Gap::EventCallback_t timeoutCallback)
Rohit Grover 106:a20be740075d 484 {
Rohit Grover 106:a20be740075d 485 transport->getGap().setOnTimeout(timeoutCallback);
Rohit Grover 106:a20be740075d 486 }
Rohit Grover 106:a20be740075d 487
Rohit Grover 106:a20be740075d 488 inline void
Rohit Grover 116:ca826083980e 489 BLEDevice::onConnection(Gap::ConnectionEventCallback_t connectionCallback)
Rohit Grover 106:a20be740075d 490 {
Rohit Grover 106:a20be740075d 491 transport->getGap().setOnConnection(connectionCallback);
Rohit Grover 106:a20be740075d 492 }
Rohit Grover 106:a20be740075d 493
Rohit Grover 106:a20be740075d 494 inline void
Rohit Grover 116:ca826083980e 495 BLEDevice::onDisconnection(Gap::DisconnectionEventCallback_t disconnectionCallback)
Rohit Grover 106:a20be740075d 496 {
Rohit Grover 106:a20be740075d 497 transport->getGap().setOnDisconnection(disconnectionCallback);
Rohit Grover 106:a20be740075d 498 }
Rohit Grover 106:a20be740075d 499
Rohit Grover 106:a20be740075d 500 inline void
Rohit Grover 116:ca826083980e 501 BLEDevice::onDataSent(GattServer::ServerEventCallbackWithCount_t callback)
Rohit Grover 106:a20be740075d 502 {
Rohit Grover 106:a20be740075d 503 transport->getGattServer().setOnDataSent(callback);
Rohit Grover 106:a20be740075d 504 }
Rohit Grover 106:a20be740075d 505
Rohit Grover 106:a20be740075d 506 inline void
Rohit Grover 118:620d28e7a1ba 507 BLEDevice::onDataWritten(void (*callback)(const GattCharacteristicWriteCBParams *eventDataP)) {
Rohit Grover 106:a20be740075d 508 transport->getGattServer().setOnDataWritten(callback);
Rohit Grover 106:a20be740075d 509 }
Rohit Grover 106:a20be740075d 510
Rohit Grover 118:620d28e7a1ba 511 template <typename T> inline void
Rohit Grover 118:620d28e7a1ba 512 BLEDevice::onDataWritten(T *objPtr, void (T::*memberPtr)(const GattCharacteristicWriteCBParams *context)) {
Rohit Grover 118:620d28e7a1ba 513 transport->getGattServer().setOnDataWritten(objPtr, memberPtr);
Rohit Grover 118:620d28e7a1ba 514 }
Rohit Grover 118:620d28e7a1ba 515
Rohit Grover 106:a20be740075d 516 inline void
Rohit Grover 106:a20be740075d 517 BLEDevice::onUpdatesEnabled(GattServer::EventCallback_t callback)
Rohit Grover 106:a20be740075d 518 {
Rohit Grover 106:a20be740075d 519 transport->getGattServer().setOnUpdatesEnabled(callback);
Rohit Grover 106:a20be740075d 520 }
Rohit Grover 106:a20be740075d 521
Rohit Grover 106:a20be740075d 522 inline void
Rohit Grover 106:a20be740075d 523 BLEDevice::onUpdatesDisabled(GattServer::EventCallback_t callback)
Rohit Grover 106:a20be740075d 524 {
Rohit Grover 106:a20be740075d 525 transport->getGattServer().setOnUpdatesDisabled(callback);
Rohit Grover 106:a20be740075d 526 }
Rohit Grover 106:a20be740075d 527
Rohit Grover 106:a20be740075d 528 inline void
Rohit Grover 106:a20be740075d 529 BLEDevice::onConfirmationReceived(GattServer::EventCallback_t callback)
Rohit Grover 106:a20be740075d 530 {
Rohit Grover 106:a20be740075d 531 transport->getGattServer().setOnConfirmationReceived(callback);
Rohit Grover 106:a20be740075d 532 }
Rohit Grover 106:a20be740075d 533
Rohit Grover 106:a20be740075d 534 inline ble_error_t
Rohit Grover 106:a20be740075d 535 BLEDevice::addService(GattService &service)
Rohit Grover 106:a20be740075d 536 {
Rohit Grover 106:a20be740075d 537 return transport->getGattServer().addService(service);
Rohit Grover 106:a20be740075d 538 }
Rohit Grover 106:a20be740075d 539
Rohit Grover 106:a20be740075d 540 inline Gap::GapState_t
Rohit Grover 106:a20be740075d 541 BLEDevice::getGapState(void) const
Rohit Grover 106:a20be740075d 542 {
Rohit Grover 106:a20be740075d 543 return transport->getGap().getState();
Rohit Grover 106:a20be740075d 544 }
Rohit Grover 106:a20be740075d 545
Rohit Grover 106:a20be740075d 546 inline ble_error_t BLEDevice::readCharacteristicValue(uint16_t handle, uint8_t *const buffer, uint16_t *const lengthP)
Rohit Grover 106:a20be740075d 547 {
Rohit Grover 106:a20be740075d 548 return transport->getGattServer().readValue(handle, buffer, lengthP);
Rohit Grover 106:a20be740075d 549 }
Rohit Grover 106:a20be740075d 550
Rohit Grover 106:a20be740075d 551 inline ble_error_t
rgrover1 140:407d134c179d 552 BLEDevice::updateCharacteristicValue(uint16_t handle, const uint8_t *value, uint16_t size, bool localOnly)
Rohit Grover 106:a20be740075d 553 {
Rohit Grover 106:a20be740075d 554 return transport->getGattServer().updateValue(handle, const_cast<uint8_t *>(value), size, localOnly);
Rohit Grover 106:a20be740075d 555 }
Rohit Grover 106:a20be740075d 556
Rohit Grover 106:a20be740075d 557 inline void
Rohit Grover 106:a20be740075d 558 BLEDevice::waitForEvent(void)
Rohit Grover 106:a20be740075d 559 {
Rohit Grover 106:a20be740075d 560 transport->waitForEvent();
Rohit Grover 106:a20be740075d 561 }
Rohit Grover 106:a20be740075d 562
Rohit Grover 106:a20be740075d 563 inline ble_error_t
Rohit Grover 106:a20be740075d 564 BLEDevice::getPreferredConnectionParams(Gap::ConnectionParams_t *params)
Rohit Grover 106:a20be740075d 565 {
Rohit Grover 106:a20be740075d 566 return transport->getGap().getPreferredConnectionParams(params);
Rohit Grover 106:a20be740075d 567 }
Rohit Grover 106:a20be740075d 568
Rohit Grover 106:a20be740075d 569 inline ble_error_t
Rohit Grover 106:a20be740075d 570 BLEDevice::setPreferredConnectionParams(const Gap::ConnectionParams_t *params)
Rohit Grover 106:a20be740075d 571 {
Rohit Grover 106:a20be740075d 572 return transport->getGap().setPreferredConnectionParams(params);
Rohit Grover 106:a20be740075d 573 }
Rohit Grover 106:a20be740075d 574
Rohit Grover 106:a20be740075d 575 inline ble_error_t
Rohit Grover 106:a20be740075d 576 BLEDevice::updateConnectionParams(Gap::Handle_t handle, const Gap::ConnectionParams_t *params) {
Rohit Grover 106:a20be740075d 577 return transport->getGap().updateConnectionParams(handle, params);
Rohit Grover 106:a20be740075d 578 }
Rohit Grover 106:a20be740075d 579
Rohit Grover 108:c85ab5f1eca0 580 inline const char *
Rohit Grover 108:c85ab5f1eca0 581 BLEDevice::getVersion(void)
Rohit Grover 108:c85ab5f1eca0 582 {
Rohit Grover 108:c85ab5f1eca0 583 return transport->getVersion();
Rohit Grover 108:c85ab5f1eca0 584 }
Rohit Grover 108:c85ab5f1eca0 585
Rohit Grover 108:c85ab5f1eca0 586 inline ble_error_t
Rohit Grover 108:c85ab5f1eca0 587 BLEDevice::setDeviceName(const uint8_t *deviceName)
Rohit Grover 108:c85ab5f1eca0 588 {
Rohit Grover 116:ca826083980e 589 return transport->getGap().setDeviceName(deviceName);
Rohit Grover 108:c85ab5f1eca0 590 }
Rohit Grover 108:c85ab5f1eca0 591
Rohit Grover 108:c85ab5f1eca0 592 inline ble_error_t
Rohit Grover 108:c85ab5f1eca0 593 BLEDevice::getDeviceName(uint8_t *deviceName, unsigned *lengthP)
Rohit Grover 108:c85ab5f1eca0 594 {
Rohit Grover 116:ca826083980e 595 return transport->getGap().getDeviceName(deviceName, lengthP);
Rohit Grover 108:c85ab5f1eca0 596 }
Rohit Grover 108:c85ab5f1eca0 597
Rohit Grover 108:c85ab5f1eca0 598 inline ble_error_t
Rohit Grover 108:c85ab5f1eca0 599 BLEDevice::setAppearance(uint16_t appearance)
Rohit Grover 108:c85ab5f1eca0 600 {
Rohit Grover 116:ca826083980e 601 return transport->getGap().setAppearance(appearance);
Rohit Grover 108:c85ab5f1eca0 602 }
Rohit Grover 108:c85ab5f1eca0 603
Rohit Grover 108:c85ab5f1eca0 604 inline ble_error_t
Rohit Grover 108:c85ab5f1eca0 605 BLEDevice::getAppearance(uint16_t *appearanceP)
Rohit Grover 108:c85ab5f1eca0 606 {
Rohit Grover 116:ca826083980e 607 return transport->getGap().getAppearance(appearanceP);
Rohit Grover 108:c85ab5f1eca0 608 }
Rohit Grover 108:c85ab5f1eca0 609
Rohit Grover 108:c85ab5f1eca0 610 inline ble_error_t
Rohit Grover 108:c85ab5f1eca0 611 BLEDevice::setTxPower(int8_t txPower)
Rohit Grover 108:c85ab5f1eca0 612 {
Rohit Grover 108:c85ab5f1eca0 613 return transport->setTxPower(txPower);
Rohit Grover 108:c85ab5f1eca0 614 }
Rohit Grover 108:c85ab5f1eca0 615
Rohit Grover 106:a20be740075d 616 /*
Rohit Grover 106:a20be740075d 617 * ALL OF THE FOLLOWING METHODS ARE DEPRECATED
Rohit Grover 106:a20be740075d 618 */
Rohit Grover 106:a20be740075d 619
Rohit Grover 106:a20be740075d 620 inline ble_error_t
Rohit Grover 106:a20be740075d 621 BLEDevice::setAdvertisingData(const GapAdvertisingData &ADStructures, const GapAdvertisingData &scanResponse)
Rohit Grover 106:a20be740075d 622 {
Rohit Grover 106:a20be740075d 623 needToSetAdvPayload = false;
Rohit Grover 106:a20be740075d 624 return transport->getGap().setAdvertisingData(ADStructures, scanResponse);
Rohit Grover 106:a20be740075d 625 }
Rohit Grover 106:a20be740075d 626
Rohit Grover 106:a20be740075d 627 inline ble_error_t
Rohit Grover 106:a20be740075d 628 BLEDevice::setAdvertisingData(const GapAdvertisingData &ADStructures)
Rohit Grover 106:a20be740075d 629 {
Rohit Grover 106:a20be740075d 630 GapAdvertisingData scanResponse;
Rohit Grover 106:a20be740075d 631
Rohit Grover 106:a20be740075d 632 needToSetAdvPayload = false;
Rohit Grover 106:a20be740075d 633 return transport->getGap().setAdvertisingData(ADStructures, scanResponse);
Rohit Grover 106:a20be740075d 634 }
Rohit Grover 106:a20be740075d 635
Rohit Grover 106:a20be740075d 636 inline ble_error_t
Rohit Grover 106:a20be740075d 637 BLEDevice::startAdvertising(const GapAdvertisingParams &_advParams)
Rohit Grover 106:a20be740075d 638 {
Rohit Grover 106:a20be740075d 639 return transport->getGap().startAdvertising(_advParams);
Rohit Grover 106:a20be740075d 640 }
Rohit Grover 106:a20be740075d 641
rgrover1 126:fdebe4d5d62f 642 #endif // ifndef __BLE_DEVICE__