Alex Cordonnier / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Fork of BLE_API by Bluetooth Low Energy

ble/GattClient.h@741:d6dceefb844e, 2015-07-21 (annotated)

Committer:
rgrover1
Date:
Tue Jul 21 13:25:38 2015 +0100
Revision:
741:d6dceefb844e
Parent:
740:8d52f0f8efd9
Child:
742:861ed7eb186d
Synchronized with git rev da20f2e2

Author: Andrew Fernandes

Change DiscoveredCharacteristic API to return long or short UUIDs.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 716:11b41f651697 1 /* mbed Microcontroller Library
rgrover1 716:11b41f651697 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 716:11b41f651697 3 *
rgrover1 716:11b41f651697 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 716:11b41f651697 5 * you may not use this file except in compliance with the License.
rgrover1 716:11b41f651697 6 * You may obtain a copy of the License at
rgrover1 716:11b41f651697 7 *
rgrover1 716:11b41f651697 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 716:11b41f651697 9 *
rgrover1 716:11b41f651697 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 716:11b41f651697 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 716:11b41f651697 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 716:11b41f651697 13 * See the License for the specific language governing permissions and
rgrover1 716:11b41f651697 14 * limitations under the License.
rgrover1 716:11b41f651697 15 */
rgrover1 716:11b41f651697 16
rgrover1 716:11b41f651697 17 #ifndef __GATT_CLIENT_H__
rgrover1 716:11b41f651697 18 #define __GATT_CLIENT_H__
rgrover1 716:11b41f651697 19
rgrover1 716:11b41f651697 20 #include "Gap.h"
rgrover1 716:11b41f651697 21 #include "GattAttribute.h"
rgrover1 716:11b41f651697 22 #include "ServiceDiscovery.h"
rgrover1 716:11b41f651697 23
rgrover1 716:11b41f651697 24 #include "GattCallbackParamTypes.h"
rgrover1 716:11b41f651697 25
rgrover1 716:11b41f651697 26 class GattClient {
rgrover1 716:11b41f651697 27 public:
rgrover1 716:11b41f651697 28 typedef void (*ReadCallback_t)(const GattReadCallbackParams *params);
rgrover1 716:11b41f651697 29
rgrover1 716:11b41f651697 30 enum WriteOp_t {
rgrover1 728:997ba5e7b3b6 31 GATT_OP_WRITE_REQ = 0x01, /**< Write Request. */
rgrover1 728:997ba5e7b3b6 32 GATT_OP_WRITE_CMD = 0x02, /**< Write Command. */
rgrover1 716:11b41f651697 33 };
rgrover1 716:11b41f651697 34
rgrover1 716:11b41f651697 35 typedef void (*WriteCallback_t)(const GattWriteCallbackParams *params);
rgrover1 716:11b41f651697 36
rgrover1 737:79d95f9b93be 37 typedef void (*HVXCallback_t)(const GattHVXCallbackParams *params);
rgrover1 737:79d95f9b93be 38
rgrover1 716:11b41f651697 39 /*
rgrover1 716:11b41f651697 40 * The following functions are meant to be overridden in the platform-specific sub-class.
rgrover1 716:11b41f651697 41 */
rgrover1 716:11b41f651697 42 public:
rgrover1 716:11b41f651697 43 /**
rgrover1 728:997ba5e7b3b6 44 * Launch service discovery. Once launched, application callbacks will be
rgrover1 728:997ba5e7b3b6 45 * invoked for matching services/characteristics. isServiceDiscoveryActive()
rgrover1 728:997ba5e7b3b6 46 * can be used to determine status; and a termination callback (if setup)
rgrover1 728:997ba5e7b3b6 47 * will be invoked at the end. Service discovery can be terminated prematurely
rgrover1 728:997ba5e7b3b6 48 * if needed using terminateServiceDiscovery().
rgrover1 716:11b41f651697 49 *
rgrover1 716:11b41f651697 50 * @param connectionHandle
rgrover1 716:11b41f651697 51 * Handle for the connection with the peer.
rgrover1 716:11b41f651697 52 * @param sc
rgrover1 716:11b41f651697 53 * This is the application callback for matching service. Taken as
rgrover1 716:11b41f651697 54 * NULL by default. Note: service discovery may still be active
rgrover1 716:11b41f651697 55 * when this callback is issued; calling asynchronous BLE-stack
rgrover1 716:11b41f651697 56 * APIs from within this application callback might cause the
rgrover1 716:11b41f651697 57 * stack to abort service discovery. If this becomes an issue, it
rgrover1 716:11b41f651697 58 * may be better to make local copy of the discoveredService and
rgrover1 716:11b41f651697 59 * wait for service discovery to terminate before operating on the
rgrover1 716:11b41f651697 60 * service.
rgrover1 716:11b41f651697 61 * @param cc
rgrover1 716:11b41f651697 62 * This is the application callback for matching characteristic.
rgrover1 716:11b41f651697 63 * Taken as NULL by default. Note: service discovery may still be
rgrover1 716:11b41f651697 64 * active when this callback is issued; calling asynchronous
rgrover1 716:11b41f651697 65 * BLE-stack APIs from within this application callback might cause
rgrover1 716:11b41f651697 66 * the stack to abort service discovery. If this becomes an issue,
rgrover1 716:11b41f651697 67 * it may be better to make local copy of the discoveredCharacteristic
rgrover1 716:11b41f651697 68 * and wait for service discovery to terminate before operating on the
rgrover1 716:11b41f651697 69 * characteristic.
rgrover1 716:11b41f651697 70 * @param matchingServiceUUID
rgrover1 716:11b41f651697 71 * UUID based filter for specifying a service in which the application is
rgrover1 716:11b41f651697 72 * interested. By default it is set as the wildcard UUID_UNKNOWN,
rgrover1 716:11b41f651697 73 * in which case it matches all services. If characteristic-UUID
rgrover1 716:11b41f651697 74 * filter (below) is set to the wildcard value, then a service
rgrover1 716:11b41f651697 75 * callback will be invoked for the matching service (or for every
rgrover1 716:11b41f651697 76 * service if the service filter is a wildcard).
rgrover1 716:11b41f651697 77 * @param matchingCharacteristicUUIDIn
rgrover1 716:11b41f651697 78 * UUID based filter for specifying characteristic in which the application
rgrover1 716:11b41f651697 79 * is interested. By default it is set as the wildcard UUID_UKNOWN
rgrover1 716:11b41f651697 80 * to match against any characteristic. If both service-UUID
rgrover1 716:11b41f651697 81 * filter and characteristic-UUID filter are used with non- wildcard
rgrover1 716:11b41f651697 82 * values, then only a single characteristic callback is
rgrover1 716:11b41f651697 83 * invoked for the matching characteristic.
rgrover1 716:11b41f651697 84 *
rgrover1 716:11b41f651697 85 * @note Using wildcard values for both service-UUID and characteristic-
rgrover1 716:11b41f651697 86 * UUID will result in complete service discovery--callbacks being
rgrover1 716:11b41f651697 87 * called for every service and characteristic.
rgrover1 716:11b41f651697 88 *
rgrover1 716:11b41f651697 89 * @note Providing NULL for the characteristic callback will result in
rgrover1 716:11b41f651697 90 * characteristic discovery being skipped for each matching
rgrover1 716:11b41f651697 91 * service. This allows for an inexpensive method to discover only
rgrover1 716:11b41f651697 92 * services.
rgrover1 716:11b41f651697 93 *
rgrover1 716:11b41f651697 94 * @return
rgrover1 716:11b41f651697 95 * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error.
rgrover1 716:11b41f651697 96 */
rgrover1 716:11b41f651697 97 virtual ble_error_t launchServiceDiscovery(Gap::Handle_t connectionHandle,
rgrover1 716:11b41f651697 98 ServiceDiscovery::ServiceCallback_t sc = NULL,
rgrover1 716:11b41f651697 99 ServiceDiscovery::CharacteristicCallback_t cc = NULL,
rgrover1 716:11b41f651697 100 const UUID &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN),
rgrover1 716:11b41f651697 101 const UUID &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN)) {
rgrover1 734:4872b70437ce 102 /* avoid compiler warnings about unused variables */
rgrover1 734:4872b70437ce 103 (void)connectionHandle;
rgrover1 734:4872b70437ce 104 (void)sc;
rgrover1 734:4872b70437ce 105 (void)cc;
rgrover1 734:4872b70437ce 106 (void)matchingServiceUUID;
rgrover1 734:4872b70437ce 107 (void)matchingCharacteristicUUIDIn;
rgrover1 734:4872b70437ce 108
rgrover1 728:997ba5e7b3b6 109 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 716:11b41f651697 110 }
rgrover1 716:11b41f651697 111
rgrover1 716:11b41f651697 112 /**
rgrover1 716:11b41f651697 113 * Launch service discovery for services. Once launched, service discovery will remain
rgrover1 716:11b41f651697 114 * active with service-callbacks being issued back into the application for matching
rgrover1 716:11b41f651697 115 * services. isServiceDiscoveryActive() can be used to
rgrover1 716:11b41f651697 116 * determine status; and a termination callback (if setup) will be invoked
rgrover1 716:11b41f651697 117 * at the end. Service discovery can be terminated prematurely if needed
rgrover1 716:11b41f651697 118 * using terminateServiceDiscovery().
rgrover1 716:11b41f651697 119 *
rgrover1 716:11b41f651697 120 * @param connectionHandle
rgrover1 716:11b41f651697 121 * Handle for the connection with the peer.
rgrover1 716:11b41f651697 122 * @param sc
rgrover1 716:11b41f651697 123 * This is the application callback for matching service. Note: service discovery may still be active
rgrover1 716:11b41f651697 124 * when this callback is issued; calling asynchronous BLE-stack
rgrover1 716:11b41f651697 125 * APIs from within this application callback might cause the
rgrover1 716:11b41f651697 126 * stack to abort service discovery. If this becomes an issue, it
rgrover1 716:11b41f651697 127 * may be better to make local copy of the discoveredService and
rgrover1 716:11b41f651697 128 * wait for service discovery to terminate before operating on the
rgrover1 716:11b41f651697 129 * service.
rgrover1 716:11b41f651697 130 * @param matchingServiceUUID
rgrover1 716:11b41f651697 131 * UUID based filter for specifying a service in which the application is
rgrover1 716:11b41f651697 132 * interested. By default it is set as the wildcard UUID_UNKNOWN,
rgrover1 716:11b41f651697 133 * in which case it matches all services.
rgrover1 716:11b41f651697 134 *
rgrover1 716:11b41f651697 135 * @return
rgrover1 716:11b41f651697 136 * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error.
rgrover1 716:11b41f651697 137 */
rgrover1 716:11b41f651697 138 virtual ble_error_t discoverServices(Gap::Handle_t connectionHandle,
rgrover1 716:11b41f651697 139 ServiceDiscovery::ServiceCallback_t callback,
rgrover1 716:11b41f651697 140 const UUID &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN)) {
rgrover1 741:d6dceefb844e 141 /* avoid compiler warnings about unused variables */
rgrover1 741:d6dceefb844e 142 (void)connectionHandle;
rgrover1 741:d6dceefb844e 143 (void)callback;
rgrover1 741:d6dceefb844e 144 (void)matchingServiceUUID;
rgrover1 741:d6dceefb844e 145
rgrover1 741:d6dceefb844e 146 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 716:11b41f651697 147 }
rgrover1 716:11b41f651697 148
rgrover1 716:11b41f651697 149 /**
rgrover1 716:11b41f651697 150 * Launch service discovery for services. Once launched, service discovery will remain
rgrover1 716:11b41f651697 151 * active with service-callbacks being issued back into the application for matching
rgrover1 716:11b41f651697 152 * services. isServiceDiscoveryActive() can be used to
rgrover1 716:11b41f651697 153 * determine status; and a termination callback (if setup) will be invoked
rgrover1 716:11b41f651697 154 * at the end. Service discovery can be terminated prematurely if needed
rgrover1 716:11b41f651697 155 * using terminateServiceDiscovery().
rgrover1 716:11b41f651697 156 *
rgrover1 716:11b41f651697 157 * @param connectionHandle
rgrover1 716:11b41f651697 158 * Handle for the connection with the peer.
rgrover1 716:11b41f651697 159 * @param sc
rgrover1 716:11b41f651697 160 * This is the application callback for matching service. Note: service discovery may still be active
rgrover1 716:11b41f651697 161 * when this callback is issued; calling asynchronous BLE-stack
rgrover1 716:11b41f651697 162 * APIs from within this application callback might cause the
rgrover1 716:11b41f651697 163 * stack to abort service discovery. If this becomes an issue, it
rgrover1 716:11b41f651697 164 * may be better to make local copy of the discoveredService and
rgrover1 716:11b41f651697 165 * wait for service discovery to terminate before operating on the
rgrover1 716:11b41f651697 166 * service.
rgrover1 716:11b41f651697 167 * @param startHandle, endHandle
rgrover1 716:11b41f651697 168 * Handle range within which to limit the search
rgrover1 716:11b41f651697 169 *
rgrover1 716:11b41f651697 170 * @return
rgrover1 716:11b41f651697 171 * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error.
rgrover1 716:11b41f651697 172 */
rgrover1 716:11b41f651697 173 virtual ble_error_t discoverServices(Gap::Handle_t connectionHandle,
rgrover1 716:11b41f651697 174 ServiceDiscovery::ServiceCallback_t callback,
rgrover1 716:11b41f651697 175 GattAttribute::Handle_t startHandle,
rgrover1 716:11b41f651697 176 GattAttribute::Handle_t endHandle) {
rgrover1 734:4872b70437ce 177 /* avoid compiler warnings about unused variables */
rgrover1 734:4872b70437ce 178 (void)connectionHandle;
rgrover1 734:4872b70437ce 179 (void)callback;
rgrover1 734:4872b70437ce 180 (void)startHandle;
rgrover1 734:4872b70437ce 181 (void)endHandle;
rgrover1 734:4872b70437ce 182
rgrover1 728:997ba5e7b3b6 183 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 716:11b41f651697 184 }
rgrover1 716:11b41f651697 185
rgrover1 716:11b41f651697 186 /**
rgrover1 716:11b41f651697 187 * Is service-discovery currently active?
rgrover1 716:11b41f651697 188 */
rgrover1 716:11b41f651697 189 virtual bool isServiceDiscoveryActive(void) const {
rgrover1 741:d6dceefb844e 190 return false; /* default implementation; override this API if this capability is supported. */
rgrover1 716:11b41f651697 191 }
rgrover1 716:11b41f651697 192
rgrover1 716:11b41f651697 193 /**
rgrover1 716:11b41f651697 194 * Terminate an ongoing service-discovery. This should result in an
rgrover1 716:11b41f651697 195 * invocation of the TerminationCallback if service-discovery is active.
rgrover1 716:11b41f651697 196 */
rgrover1 716:11b41f651697 197 virtual void terminateServiceDiscovery(void) {
rgrover1 741:d6dceefb844e 198 /* default implementation; override this API if this capability is supported. */
rgrover1 716:11b41f651697 199 }
rgrover1 716:11b41f651697 200
rgrover1 716:11b41f651697 201 /* Initiate a Gatt Client read procedure by attribute-handle. */
rgrover1 716:11b41f651697 202 virtual ble_error_t read(Gap::Handle_t connHandle, GattAttribute::Handle_t attributeHandle, uint16_t offset) const {
rgrover1 734:4872b70437ce 203 /* avoid compiler warnings about unused variables */
rgrover1 734:4872b70437ce 204 (void)connHandle;
rgrover1 734:4872b70437ce 205 (void)attributeHandle;
rgrover1 734:4872b70437ce 206 (void)offset;
rgrover1 734:4872b70437ce 207
rgrover1 728:997ba5e7b3b6 208 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 716:11b41f651697 209 }
rgrover1 716:11b41f651697 210
rgrover1 716:11b41f651697 211 /**
rgrover1 716:11b41f651697 212 * Initiate a GATT Client write procedure.
rgrover1 716:11b41f651697 213 *
rgrover1 716:11b41f651697 214 * @param[in] cmd
rgrover1 716:11b41f651697 215 * Command can be either a write-request (which generates a
rgrover1 716:11b41f651697 216 * matching response from the peripheral), or a write-command,
rgrover1 716:11b41f651697 217 * which doesn't require the connected peer to respond.
rgrover1 716:11b41f651697 218 * @param[in] connHandle
rgrover1 716:11b41f651697 219 * Connection handle.
rgrover1 716:11b41f651697 220 * @param[in] attributeHandle
rgrover1 716:11b41f651697 221 * handle for the target attribtue on the remote GATT server.
rgrover1 716:11b41f651697 222 * @param[in] length
rgrover1 716:11b41f651697 223 * length of the new value.
rgrover1 716:11b41f651697 224 * @param[in] value
rgrover1 716:11b41f651697 225 * new value being written.
rgrover1 716:11b41f651697 226 */
rgrover1 716:11b41f651697 227 virtual ble_error_t write(GattClient::WriteOp_t cmd,
rgrover1 716:11b41f651697 228 Gap::Handle_t connHandle,
rgrover1 716:11b41f651697 229 GattAttribute::Handle_t attributeHandle,
rgrover1 716:11b41f651697 230 size_t length,
rgrover1 716:11b41f651697 231 const uint8_t *value) const {
rgrover1 734:4872b70437ce 232 /* avoid compiler warnings about unused variables */
rgrover1 734:4872b70437ce 233 (void)cmd;
rgrover1 734:4872b70437ce 234 (void)connHandle;
rgrover1 734:4872b70437ce 235 (void)attributeHandle;
rgrover1 734:4872b70437ce 236 (void)length;
rgrover1 734:4872b70437ce 237 (void)value;
rgrover1 734:4872b70437ce 238
rgrover1 728:997ba5e7b3b6 239 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 728:997ba5e7b3b6 240 }
rgrover1 728:997ba5e7b3b6 241
rgrover1 728:997ba5e7b3b6 242 /* Event callback handlers. */
rgrover1 728:997ba5e7b3b6 243 public:
rgrover1 728:997ba5e7b3b6 244 /**
rgrover1 728:997ba5e7b3b6 245 * Setup a callback for read response events.
rgrover1 728:997ba5e7b3b6 246 */
rgrover1 728:997ba5e7b3b6 247 void onDataRead(ReadCallback_t callback) {
rgrover1 728:997ba5e7b3b6 248 onDataReadCallback = callback;
rgrover1 728:997ba5e7b3b6 249 }
rgrover1 728:997ba5e7b3b6 250
rgrover1 728:997ba5e7b3b6 251 /**
rgrover1 728:997ba5e7b3b6 252 * Setup a callback for write response events.
rgrover1 728:997ba5e7b3b6 253 * @Note: write commands (issued using writeWoResponse) don't generate a response.
rgrover1 728:997ba5e7b3b6 254 */
rgrover1 728:997ba5e7b3b6 255 void onDataWrite(WriteCallback_t callback) {
rgrover1 728:997ba5e7b3b6 256 onDataWriteCallback = callback;
rgrover1 720:ce8a760a4504 257 }
rgrover1 720:ce8a760a4504 258
rgrover1 716:11b41f651697 259 /**
rgrover1 716:11b41f651697 260 * Setup callback for when serviceDiscovery terminates.
rgrover1 716:11b41f651697 261 */
rgrover1 716:11b41f651697 262 virtual void onServiceDiscoveryTermination(ServiceDiscovery::TerminationCallback_t callback) {
rgrover1 734:4872b70437ce 263 (void)callback; /* avoid compiler warnings about ununsed variables */
rgrover1 734:4872b70437ce 264
rgrover1 741:d6dceefb844e 265 /* default implementation; override this API if this capability is supported. */
rgrover1 716:11b41f651697 266 }
rgrover1 716:11b41f651697 267
rgrover1 737:79d95f9b93be 268 /**
rgrover1 737:79d95f9b93be 269 * Setup a callback for when GattClient receives an update event
rgrover1 737:79d95f9b93be 270 * corresponding to a change in value of a characteristic on the remote
rgrover1 737:79d95f9b93be 271 * GattServer.
rgrover1 737:79d95f9b93be 272 */
rgrover1 737:79d95f9b93be 273 void onHVX(HVXCallback_t callback) {
rgrover1 737:79d95f9b93be 274 onHVXCallback = callback;
rgrover1 737:79d95f9b93be 275 }
rgrover1 737:79d95f9b93be 276
rgrover1 716:11b41f651697 277 protected:
rgrover1 716:11b41f651697 278 GattClient() {
rgrover1 716:11b41f651697 279 /* empty */
rgrover1 716:11b41f651697 280 }
rgrover1 716:11b41f651697 281
rgrover1 728:997ba5e7b3b6 282 /* Entry points for the underlying stack to report events back to the user. */
rgrover1 728:997ba5e7b3b6 283 public:
rgrover1 728:997ba5e7b3b6 284 void processReadResponse(const GattReadCallbackParams *params) {
rgrover1 728:997ba5e7b3b6 285 if (onDataReadCallback) {
rgrover1 728:997ba5e7b3b6 286 onDataReadCallback(params);
rgrover1 728:997ba5e7b3b6 287 }
rgrover1 728:997ba5e7b3b6 288 }
rgrover1 728:997ba5e7b3b6 289
rgrover1 728:997ba5e7b3b6 290 void processWriteResponse(const GattWriteCallbackParams *params) {
rgrover1 728:997ba5e7b3b6 291 if (onDataWriteCallback) {
rgrover1 728:997ba5e7b3b6 292 onDataWriteCallback(params);
rgrover1 728:997ba5e7b3b6 293 }
rgrover1 728:997ba5e7b3b6 294 }
rgrover1 728:997ba5e7b3b6 295
rgrover1 737:79d95f9b93be 296 void processHVXEvent(const GattHVXCallbackParams *params) {
rgrover1 737:79d95f9b93be 297 if (onHVXCallback) {
rgrover1 737:79d95f9b93be 298 onHVXCallback(params);
rgrover1 737:79d95f9b93be 299 }
rgrover1 737:79d95f9b93be 300 }
rgrover1 737:79d95f9b93be 301
rgrover1 728:997ba5e7b3b6 302 protected:
rgrover1 728:997ba5e7b3b6 303 ReadCallback_t onDataReadCallback;
rgrover1 728:997ba5e7b3b6 304 WriteCallback_t onDataWriteCallback;
rgrover1 737:79d95f9b93be 305 HVXCallback_t onHVXCallback;
rgrover1 728:997ba5e7b3b6 306
rgrover1 716:11b41f651697 307 private:
rgrover1 716:11b41f651697 308 /* disallow copy and assignment */
rgrover1 716:11b41f651697 309 GattClient(const GattClient &);
rgrover1 716:11b41f651697 310 GattClient& operator=(const GattClient &);
rgrover1 716:11b41f651697 311 };
rgrover1 716:11b41f651697 312
rgrover1 716:11b41f651697 313 #endif // ifndef __GATT_CLIENT_H__