Alex Cordonnier / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Fork of BLE_API by Bluetooth Low Energy

public/GattClient.h@501:ff6801633d2c, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:03 2015 +0100
Revision:
501:ff6801633d2c
Parent:
497:926d444599e8
Child:
503:4e69a47047c5
Synchronized with git rev 1a9e68e1

Author: Rohit Grover

ReadCallback_t moves into GattClient.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 490:58a0313fffb5 1 /* mbed Microcontroller Library
rgrover1 490:58a0313fffb5 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 490:58a0313fffb5 3 *
rgrover1 490:58a0313fffb5 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 490:58a0313fffb5 5 * you may not use this file except in compliance with the License.
rgrover1 490:58a0313fffb5 6 * You may obtain a copy of the License at
rgrover1 490:58a0313fffb5 7 *
rgrover1 490:58a0313fffb5 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 490:58a0313fffb5 9 *
rgrover1 490:58a0313fffb5 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 490:58a0313fffb5 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 490:58a0313fffb5 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 490:58a0313fffb5 13 * See the License for the specific language governing permissions and
rgrover1 490:58a0313fffb5 14 * limitations under the License.
rgrover1 490:58a0313fffb5 15 */
rgrover1 490:58a0313fffb5 16
rgrover1 490:58a0313fffb5 17 #ifndef __GATT_CLIENT_H__
rgrover1 490:58a0313fffb5 18 #define __GATT_CLIENT_H__
rgrover1 490:58a0313fffb5 19
rgrover1 495:b0d77b1db2df 20 #include "blecommon.h"
rgrover1 495:b0d77b1db2df 21 #include "Gap.h"
rgrover1 495:b0d77b1db2df 22 #include "GattAttribute.h"
rgrover1 497:926d444599e8 23 #include "ServiceDiscovery.h"
rgrover1 495:b0d77b1db2df 24
rgrover1 490:58a0313fffb5 25 class GattClient {
rgrover1 495:b0d77b1db2df 26 public:
rgrover1 497:926d444599e8 27 enum Command_t {
rgrover1 497:926d444599e8 28 OP_WRITE_CMD
rgrover1 497:926d444599e8 29 };
rgrover1 497:926d444599e8 30
rgrover1 501:ff6801633d2c 31 struct ReadResponse_t {
rgrover1 501:ff6801633d2c 32 GattAttribute::Handle_t handle; /**< Attribute Handle. */
rgrover1 501:ff6801633d2c 33 uint16_t offset; /**< Offset of the attribute data. */
rgrover1 501:ff6801633d2c 34 uint16_t len; /**< Attribute data length. */
rgrover1 501:ff6801633d2c 35 const uint8_t *data; /**< Attribute data, variable length. */
rgrover1 501:ff6801633d2c 36 };
rgrover1 501:ff6801633d2c 37 typedef void (*ReadCallback_t)(const ReadResponse_t *params);
rgrover1 501:ff6801633d2c 38
rgrover1 497:926d444599e8 39 public:
rgrover1 497:926d444599e8 40 /**
rgrover1 497:926d444599e8 41 * Launch service discovery. Once launched, service discovery will remain
rgrover1 497:926d444599e8 42 * active with callbacks being issued back into the application for matching
rgrover1 497:926d444599e8 43 * services/characteristics. isActive() can be used to determine status; and
rgrover1 497:926d444599e8 44 * a termination callback (if setup) will be invoked at the end. Service
rgrover1 497:926d444599e8 45 * discovery can be terminated prematurely if needed using terminate().
rgrover1 497:926d444599e8 46 *
rgrover1 497:926d444599e8 47 * @param connectionHandle
rgrover1 497:926d444599e8 48 * Handle for the connection with the peer.
rgrover1 497:926d444599e8 49 * @param sc
rgrover1 497:926d444599e8 50 * This is the application callback for matching service.
rgrover1 497:926d444599e8 51 * @param cc
rgrover1 497:926d444599e8 52 * This is the application callback for matching characteristic.
rgrover1 497:926d444599e8 53 * @param matchingServiceUUID
rgrover1 497:926d444599e8 54 * UUID based filter for specifying a service in which the application is
rgrover1 497:926d444599e8 55 * interested.
rgrover1 497:926d444599e8 56 * @param matchingCharacteristicUUIDIn
rgrover1 497:926d444599e8 57 * UUID based filter for specifying characteristic in which the application
rgrover1 497:926d444599e8 58 * is interested.
rgrover1 497:926d444599e8 59 *
rgrover1 497:926d444599e8 60 * @Note Using wildcard values for both service-UUID and characteristic-
rgrover1 497:926d444599e8 61 * UUID will result in complete service discovery--callbacks being
rgrover1 497:926d444599e8 62 * called for every service and characteristic.
rgrover1 497:926d444599e8 63 *
rgrover1 497:926d444599e8 64 * @return
rgrover1 497:926d444599e8 65 * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error.
rgrover1 497:926d444599e8 66 */
rgrover1 497:926d444599e8 67 virtual ble_error_t launchServiceDiscovery(Gap::Handle_t connectionHandle,
rgrover1 497:926d444599e8 68 ServiceDiscovery::ServiceCallback_t sc = NULL,
rgrover1 497:926d444599e8 69 ServiceDiscovery::CharacteristicCallback_t cc = NULL,
rgrover1 497:926d444599e8 70 const UUID &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN),
rgrover1 497:926d444599e8 71 const UUID &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN)) = 0;
rgrover1 497:926d444599e8 72
rgrover1 497:926d444599e8 73 virtual void onServiceDiscoveryTermination(ServiceDiscovery::TerminationCallback_t callback) = 0;
rgrover1 497:926d444599e8 74
rgrover1 497:926d444599e8 75 /**
rgrover1 497:926d444599e8 76 * Is service-discovery currently active?
rgrover1 497:926d444599e8 77 */
rgrover1 497:926d444599e8 78 virtual bool isServiceDiscoveryActive(void) const = 0;
rgrover1 497:926d444599e8 79
rgrover1 497:926d444599e8 80 /**
rgrover1 497:926d444599e8 81 * Terminate an ongoing service-discovery. This should result in an
rgrover1 497:926d444599e8 82 * invocation of the TerminationCallback if service-discovery is active.
rgrover1 497:926d444599e8 83 */
rgrover1 497:926d444599e8 84 virtual void terminateServiceDiscovery(void) = 0;
rgrover1 497:926d444599e8 85
rgrover1 495:b0d77b1db2df 86 /* Initiate a Gatt Client read procedure by attribute-handle.*/
rgrover1 495:b0d77b1db2df 87 virtual ble_error_t read(Gap::Handle_t connHandle, GattAttribute::Handle_t attributeHandle, uint16_t offset) const = 0;
rgrover1 495:b0d77b1db2df 88
rgrover1 497:926d444599e8 89 virtual ble_error_t write(GattClient::Command_t cmd, Gap::Handle_t connHandle, size_t length, const uint8_t *value) const = 0;
rgrover1 497:926d444599e8 90
rgrover1 490:58a0313fffb5 91 #if 0
rgrover1 490:58a0313fffb5 92 public:
rgrover1 490:58a0313fffb5 93 /* Event callback handlers. */
rgrover1 490:58a0313fffb5 94 typedef void (*EventCallback_t)(GattAttribute::Handle_t attributeHandle);
rgrover1 490:58a0313fffb5 95 typedef void (*ServerEventCallback_t)(void); /**< independent of any particular attribute */
rgrover1 490:58a0313fffb5 96
rgrover1 490:58a0313fffb5 97 friend class BLEDevice;
rgrover1 490:58a0313fffb5 98 private:
rgrover1 490:58a0313fffb5 99 /* These functions must be defined in the sub-class */
rgrover1 490:58a0313fffb5 100 virtual ble_error_t addService(GattService &) = 0;
rgrover1 490:58a0313fffb5 101 virtual ble_error_t readValue(GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP) = 0;
rgrover1 490:58a0313fffb5 102 virtual ble_error_t readValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP) = 0;
rgrover1 490:58a0313fffb5 103 virtual ble_error_t updateValue(GattAttribute::Handle_t, const uint8_t[], uint16_t, bool localOnly = false) = 0;
rgrover1 490:58a0313fffb5 104 virtual ble_error_t updateValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t, const uint8_t[], uint16_t, bool localOnly = false) = 0;
rgrover1 490:58a0313fffb5 105 virtual ble_error_t initializeGATTDatabase(void) = 0;
rgrover1 490:58a0313fffb5 106
rgrover1 490:58a0313fffb5 107 // ToDo: For updateValue, check the CCCD to see if the value we are
rgrover1 490:58a0313fffb5 108 // updating has the notify or indicate bits sent, and if BOTH are set
rgrover1 490:58a0313fffb5 109 // be sure to call sd_ble_gatts_hvx() twice with notify then indicate!
rgrover1 490:58a0313fffb5 110 // Strange use case, but valid and must be covered!
rgrover1 490:58a0313fffb5 111
rgrover1 490:58a0313fffb5 112 void setOnDataSent(void (*callback)(unsigned count)) {onDataSent.add(callback);}
rgrover1 490:58a0313fffb5 113 template <typename T>
rgrover1 490:58a0313fffb5 114 void setOnDataSent(T *objPtr, void (T::*memberPtr)(unsigned count)) {
rgrover1 490:58a0313fffb5 115 onDataSent.add(objPtr, memberPtr);
rgrover1 490:58a0313fffb5 116 }
rgrover1 490:58a0313fffb5 117 void setOnDataWritten(void (*callback)(const GattCharacteristicWriteCBParams *eventDataP)) {onDataWritten.add(callback);}
rgrover1 490:58a0313fffb5 118 template <typename T>
rgrover1 490:58a0313fffb5 119 void setOnDataWritten(T *objPtr, void (T::*memberPtr)(const GattCharacteristicWriteCBParams *context)) {
rgrover1 490:58a0313fffb5 120 onDataWritten.add(objPtr, memberPtr);
rgrover1 490:58a0313fffb5 121 }
rgrover1 490:58a0313fffb5 122
rgrover1 490:58a0313fffb5 123 /**
rgrover1 490:58a0313fffb5 124 * A virtual function to allow underlying stacks to indicate if they support
rgrover1 490:58a0313fffb5 125 * onDataRead(). It should be overridden to return true as applicable.
rgrover1 490:58a0313fffb5 126 */
rgrover1 490:58a0313fffb5 127 virtual bool isOnDataReadAvailable() const {
rgrover1 490:58a0313fffb5 128 return false;
rgrover1 490:58a0313fffb5 129 }
rgrover1 490:58a0313fffb5 130 ble_error_t setOnDataRead(void (*callback)(const GattCharacteristicReadCBParams *eventDataP)) {
rgrover1 490:58a0313fffb5 131 if (!isOnDataReadAvailable()) {
rgrover1 490:58a0313fffb5 132 return BLE_ERROR_NOT_IMPLEMENTED;
rgrover1 490:58a0313fffb5 133 }
rgrover1 490:58a0313fffb5 134
rgrover1 490:58a0313fffb5 135 onDataRead.add(callback);
rgrover1 490:58a0313fffb5 136 return BLE_ERROR_NONE;
rgrover1 490:58a0313fffb5 137 }
rgrover1 490:58a0313fffb5 138 template <typename T>
rgrover1 490:58a0313fffb5 139 ble_error_t setOnDataRead(T *objPtr, void (T::*memberPtr)(const GattCharacteristicReadCBParams *context)) {
rgrover1 490:58a0313fffb5 140 if (!isOnDataReadAvailable()) {
rgrover1 490:58a0313fffb5 141 return BLE_ERROR_NOT_IMPLEMENTED;
rgrover1 490:58a0313fffb5 142 }
rgrover1 490:58a0313fffb5 143
rgrover1 490:58a0313fffb5 144 onDataRead.add(objPtr, memberPtr);
rgrover1 490:58a0313fffb5 145 return BLE_ERROR_NONE;
rgrover1 490:58a0313fffb5 146 }
rgrover1 490:58a0313fffb5 147 void setOnUpdatesEnabled(EventCallback_t callback) {onUpdatesEnabled = callback;}
rgrover1 490:58a0313fffb5 148 void setOnUpdatesDisabled(EventCallback_t callback) {onUpdatesDisabled = callback;}
rgrover1 490:58a0313fffb5 149 void setOnConfirmationReceived(EventCallback_t callback) {onConfirmationReceived = callback;}
rgrover1 490:58a0313fffb5 150
rgrover1 490:58a0313fffb5 151 protected:
rgrover1 490:58a0313fffb5 152 void handleDataWrittenEvent(const GattCharacteristicWriteCBParams *params) {
rgrover1 490:58a0313fffb5 153 if (onDataWritten.hasCallbacksAttached()) {
rgrover1 490:58a0313fffb5 154 onDataWritten.call(params);
rgrover1 490:58a0313fffb5 155 }
rgrover1 490:58a0313fffb5 156 }
rgrover1 490:58a0313fffb5 157
rgrover1 490:58a0313fffb5 158 void handleDataReadEvent(const GattCharacteristicReadCBParams *params) {
rgrover1 490:58a0313fffb5 159 if (onDataRead.hasCallbacksAttached()) {
rgrover1 490:58a0313fffb5 160 onDataRead.call(params);
rgrover1 490:58a0313fffb5 161 }
rgrover1 490:58a0313fffb5 162 }
rgrover1 490:58a0313fffb5 163
rgrover1 490:58a0313fffb5 164 void handleEvent(GattServerEvents::gattEvent_e type, GattAttribute::Handle_t charHandle) {
rgrover1 490:58a0313fffb5 165 switch (type) {
rgrover1 490:58a0313fffb5 166 case GattServerEvents::GATT_EVENT_UPDATES_ENABLED:
rgrover1 490:58a0313fffb5 167 if (onUpdatesEnabled) {
rgrover1 490:58a0313fffb5 168 onUpdatesEnabled(charHandle);
rgrover1 490:58a0313fffb5 169 }
rgrover1 490:58a0313fffb5 170 break;
rgrover1 490:58a0313fffb5 171 case GattServerEvents::GATT_EVENT_UPDATES_DISABLED:
rgrover1 490:58a0313fffb5 172 if (onUpdatesDisabled) {
rgrover1 490:58a0313fffb5 173 onUpdatesDisabled(charHandle);
rgrover1 490:58a0313fffb5 174 }
rgrover1 490:58a0313fffb5 175 break;
rgrover1 490:58a0313fffb5 176 case GattServerEvents::GATT_EVENT_CONFIRMATION_RECEIVED:
rgrover1 490:58a0313fffb5 177 if (onConfirmationReceived) {
rgrover1 490:58a0313fffb5 178 onConfirmationReceived(charHandle);
rgrover1 490:58a0313fffb5 179 }
rgrover1 490:58a0313fffb5 180 break;
rgrover1 490:58a0313fffb5 181 default:
rgrover1 490:58a0313fffb5 182 break;
rgrover1 490:58a0313fffb5 183 }
rgrover1 490:58a0313fffb5 184 }
rgrover1 490:58a0313fffb5 185
rgrover1 490:58a0313fffb5 186 void handleDataSentEvent(unsigned count) {
rgrover1 490:58a0313fffb5 187 if (onDataSent.hasCallbacksAttached()) {
rgrover1 490:58a0313fffb5 188 onDataSent.call(count);
rgrover1 490:58a0313fffb5 189 }
rgrover1 490:58a0313fffb5 190 }
rgrover1 490:58a0313fffb5 191
rgrover1 490:58a0313fffb5 192 protected:
rgrover1 490:58a0313fffb5 193 uint8_t serviceCount;
rgrover1 490:58a0313fffb5 194 uint8_t characteristicCount;
rgrover1 490:58a0313fffb5 195
rgrover1 490:58a0313fffb5 196 private:
rgrover1 490:58a0313fffb5 197 CallChainOfFunctionPointersWithContext<unsigned> onDataSent;
rgrover1 490:58a0313fffb5 198 CallChainOfFunctionPointersWithContext<const GattCharacteristicWriteCBParams *> onDataWritten;
rgrover1 490:58a0313fffb5 199 CallChainOfFunctionPointersWithContext<const GattCharacteristicReadCBParams *> onDataRead;
rgrover1 490:58a0313fffb5 200 EventCallback_t onUpdatesEnabled;
rgrover1 490:58a0313fffb5 201 EventCallback_t onUpdatesDisabled;
rgrover1 490:58a0313fffb5 202 EventCallback_t onConfirmationReceived;
rgrover1 490:58a0313fffb5 203 #endif
rgrover1 490:58a0313fffb5 204
rgrover1 490:58a0313fffb5 205 protected:
rgrover1 490:58a0313fffb5 206 GattClient() {
rgrover1 490:58a0313fffb5 207 /* empty */
rgrover1 490:58a0313fffb5 208 }
rgrover1 490:58a0313fffb5 209
rgrover1 490:58a0313fffb5 210 private:
rgrover1 490:58a0313fffb5 211 /* disallow copy and assignment */
rgrover1 490:58a0313fffb5 212 GattClient(const GattClient &);
rgrover1 490:58a0313fffb5 213 GattClient& operator=(const GattClient &);
rgrover1 490:58a0313fffb5 214 };
rgrover1 490:58a0313fffb5 215
rgrover1 490:58a0313fffb5 216 #endif // ifndef __GATT_CLIENT_H__