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@497:926d444599e8, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:03 2015 +0100
Revision:
497:926d444599e8
Parent:
495:b0d77b1db2df
Child:
501:ff6801633d2c
Synchronized with git rev a7c6dc1a

Author: Rohit Grover

one massive commit to move towards 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 497:926d444599e8 31 public:
rgrover1 497:926d444599e8 32 /**
rgrover1 497:926d444599e8 33 * Launch service discovery. Once launched, service discovery will remain
rgrover1 497:926d444599e8 34 * active with callbacks being issued back into the application for matching
rgrover1 497:926d444599e8 35 * services/characteristics. isActive() can be used to determine status; and
rgrover1 497:926d444599e8 36 * a termination callback (if setup) will be invoked at the end. Service
rgrover1 497:926d444599e8 37 * discovery can be terminated prematurely if needed using terminate().
rgrover1 497:926d444599e8 38 *
rgrover1 497:926d444599e8 39 * @param connectionHandle
rgrover1 497:926d444599e8 40 * Handle for the connection with the peer.
rgrover1 497:926d444599e8 41 * @param sc
rgrover1 497:926d444599e8 42 * This is the application callback for matching service.
rgrover1 497:926d444599e8 43 * @param cc
rgrover1 497:926d444599e8 44 * This is the application callback for matching characteristic.
rgrover1 497:926d444599e8 45 * @param matchingServiceUUID
rgrover1 497:926d444599e8 46 * UUID based filter for specifying a service in which the application is
rgrover1 497:926d444599e8 47 * interested.
rgrover1 497:926d444599e8 48 * @param matchingCharacteristicUUIDIn
rgrover1 497:926d444599e8 49 * UUID based filter for specifying characteristic in which the application
rgrover1 497:926d444599e8 50 * is interested.
rgrover1 497:926d444599e8 51 *
rgrover1 497:926d444599e8 52 * @Note Using wildcard values for both service-UUID and characteristic-
rgrover1 497:926d444599e8 53 * UUID will result in complete service discovery--callbacks being
rgrover1 497:926d444599e8 54 * called for every service and characteristic.
rgrover1 497:926d444599e8 55 *
rgrover1 497:926d444599e8 56 * @return
rgrover1 497:926d444599e8 57 * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error.
rgrover1 497:926d444599e8 58 */
rgrover1 497:926d444599e8 59 virtual ble_error_t launchServiceDiscovery(Gap::Handle_t connectionHandle,
rgrover1 497:926d444599e8 60 ServiceDiscovery::ServiceCallback_t sc = NULL,
rgrover1 497:926d444599e8 61 ServiceDiscovery::CharacteristicCallback_t cc = NULL,
rgrover1 497:926d444599e8 62 const UUID &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN),
rgrover1 497:926d444599e8 63 const UUID &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN)) = 0;
rgrover1 497:926d444599e8 64
rgrover1 497:926d444599e8 65 virtual void onServiceDiscoveryTermination(ServiceDiscovery::TerminationCallback_t callback) = 0;
rgrover1 497:926d444599e8 66
rgrover1 497:926d444599e8 67 /**
rgrover1 497:926d444599e8 68 * Is service-discovery currently active?
rgrover1 497:926d444599e8 69 */
rgrover1 497:926d444599e8 70 virtual bool isServiceDiscoveryActive(void) const = 0;
rgrover1 497:926d444599e8 71
rgrover1 497:926d444599e8 72 /**
rgrover1 497:926d444599e8 73 * Terminate an ongoing service-discovery. This should result in an
rgrover1 497:926d444599e8 74 * invocation of the TerminationCallback if service-discovery is active.
rgrover1 497:926d444599e8 75 */
rgrover1 497:926d444599e8 76 virtual void terminateServiceDiscovery(void) = 0;
rgrover1 497:926d444599e8 77
rgrover1 495:b0d77b1db2df 78 /* Initiate a Gatt Client read procedure by attribute-handle.*/
rgrover1 495:b0d77b1db2df 79 virtual ble_error_t read(Gap::Handle_t connHandle, GattAttribute::Handle_t attributeHandle, uint16_t offset) const = 0;
rgrover1 495:b0d77b1db2df 80
rgrover1 497:926d444599e8 81 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 82
rgrover1 490:58a0313fffb5 83 #if 0
rgrover1 490:58a0313fffb5 84 public:
rgrover1 490:58a0313fffb5 85 /* Event callback handlers. */
rgrover1 490:58a0313fffb5 86 typedef void (*EventCallback_t)(GattAttribute::Handle_t attributeHandle);
rgrover1 490:58a0313fffb5 87 typedef void (*ServerEventCallback_t)(void); /**< independent of any particular attribute */
rgrover1 490:58a0313fffb5 88
rgrover1 490:58a0313fffb5 89 friend class BLEDevice;
rgrover1 490:58a0313fffb5 90 private:
rgrover1 490:58a0313fffb5 91 /* These functions must be defined in the sub-class */
rgrover1 490:58a0313fffb5 92 virtual ble_error_t addService(GattService &) = 0;
rgrover1 490:58a0313fffb5 93 virtual ble_error_t readValue(GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP) = 0;
rgrover1 490:58a0313fffb5 94 virtual ble_error_t readValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP) = 0;
rgrover1 490:58a0313fffb5 95 virtual ble_error_t updateValue(GattAttribute::Handle_t, const uint8_t[], uint16_t, bool localOnly = false) = 0;
rgrover1 490:58a0313fffb5 96 virtual ble_error_t updateValue(Gap::Handle_t connectionHandle, GattAttribute::Handle_t, const uint8_t[], uint16_t, bool localOnly = false) = 0;
rgrover1 490:58a0313fffb5 97 virtual ble_error_t initializeGATTDatabase(void) = 0;
rgrover1 490:58a0313fffb5 98
rgrover1 490:58a0313fffb5 99 // ToDo: For updateValue, check the CCCD to see if the value we are
rgrover1 490:58a0313fffb5 100 // updating has the notify or indicate bits sent, and if BOTH are set
rgrover1 490:58a0313fffb5 101 // be sure to call sd_ble_gatts_hvx() twice with notify then indicate!
rgrover1 490:58a0313fffb5 102 // Strange use case, but valid and must be covered!
rgrover1 490:58a0313fffb5 103
rgrover1 490:58a0313fffb5 104 void setOnDataSent(void (*callback)(unsigned count)) {onDataSent.add(callback);}
rgrover1 490:58a0313fffb5 105 template <typename T>
rgrover1 490:58a0313fffb5 106 void setOnDataSent(T *objPtr, void (T::*memberPtr)(unsigned count)) {
rgrover1 490:58a0313fffb5 107 onDataSent.add(objPtr, memberPtr);
rgrover1 490:58a0313fffb5 108 }
rgrover1 490:58a0313fffb5 109 void setOnDataWritten(void (*callback)(const GattCharacteristicWriteCBParams *eventDataP)) {onDataWritten.add(callback);}
rgrover1 490:58a0313fffb5 110 template <typename T>
rgrover1 490:58a0313fffb5 111 void setOnDataWritten(T *objPtr, void (T::*memberPtr)(const GattCharacteristicWriteCBParams *context)) {
rgrover1 490:58a0313fffb5 112 onDataWritten.add(objPtr, memberPtr);
rgrover1 490:58a0313fffb5 113 }
rgrover1 490:58a0313fffb5 114
rgrover1 490:58a0313fffb5 115 /**
rgrover1 490:58a0313fffb5 116 * A virtual function to allow underlying stacks to indicate if they support
rgrover1 490:58a0313fffb5 117 * onDataRead(). It should be overridden to return true as applicable.
rgrover1 490:58a0313fffb5 118 */
rgrover1 490:58a0313fffb5 119 virtual bool isOnDataReadAvailable() const {
rgrover1 490:58a0313fffb5 120 return false;
rgrover1 490:58a0313fffb5 121 }
rgrover1 490:58a0313fffb5 122 ble_error_t setOnDataRead(void (*callback)(const GattCharacteristicReadCBParams *eventDataP)) {
rgrover1 490:58a0313fffb5 123 if (!isOnDataReadAvailable()) {
rgrover1 490:58a0313fffb5 124 return BLE_ERROR_NOT_IMPLEMENTED;
rgrover1 490:58a0313fffb5 125 }
rgrover1 490:58a0313fffb5 126
rgrover1 490:58a0313fffb5 127 onDataRead.add(callback);
rgrover1 490:58a0313fffb5 128 return BLE_ERROR_NONE;
rgrover1 490:58a0313fffb5 129 }
rgrover1 490:58a0313fffb5 130 template <typename T>
rgrover1 490:58a0313fffb5 131 ble_error_t setOnDataRead(T *objPtr, void (T::*memberPtr)(const GattCharacteristicReadCBParams *context)) {
rgrover1 490:58a0313fffb5 132 if (!isOnDataReadAvailable()) {
rgrover1 490:58a0313fffb5 133 return BLE_ERROR_NOT_IMPLEMENTED;
rgrover1 490:58a0313fffb5 134 }
rgrover1 490:58a0313fffb5 135
rgrover1 490:58a0313fffb5 136 onDataRead.add(objPtr, memberPtr);
rgrover1 490:58a0313fffb5 137 return BLE_ERROR_NONE;
rgrover1 490:58a0313fffb5 138 }
rgrover1 490:58a0313fffb5 139 void setOnUpdatesEnabled(EventCallback_t callback) {onUpdatesEnabled = callback;}
rgrover1 490:58a0313fffb5 140 void setOnUpdatesDisabled(EventCallback_t callback) {onUpdatesDisabled = callback;}
rgrover1 490:58a0313fffb5 141 void setOnConfirmationReceived(EventCallback_t callback) {onConfirmationReceived = callback;}
rgrover1 490:58a0313fffb5 142
rgrover1 490:58a0313fffb5 143 protected:
rgrover1 490:58a0313fffb5 144 void handleDataWrittenEvent(const GattCharacteristicWriteCBParams *params) {
rgrover1 490:58a0313fffb5 145 if (onDataWritten.hasCallbacksAttached()) {
rgrover1 490:58a0313fffb5 146 onDataWritten.call(params);
rgrover1 490:58a0313fffb5 147 }
rgrover1 490:58a0313fffb5 148 }
rgrover1 490:58a0313fffb5 149
rgrover1 490:58a0313fffb5 150 void handleDataReadEvent(const GattCharacteristicReadCBParams *params) {
rgrover1 490:58a0313fffb5 151 if (onDataRead.hasCallbacksAttached()) {
rgrover1 490:58a0313fffb5 152 onDataRead.call(params);
rgrover1 490:58a0313fffb5 153 }
rgrover1 490:58a0313fffb5 154 }
rgrover1 490:58a0313fffb5 155
rgrover1 490:58a0313fffb5 156 void handleEvent(GattServerEvents::gattEvent_e type, GattAttribute::Handle_t charHandle) {
rgrover1 490:58a0313fffb5 157 switch (type) {
rgrover1 490:58a0313fffb5 158 case GattServerEvents::GATT_EVENT_UPDATES_ENABLED:
rgrover1 490:58a0313fffb5 159 if (onUpdatesEnabled) {
rgrover1 490:58a0313fffb5 160 onUpdatesEnabled(charHandle);
rgrover1 490:58a0313fffb5 161 }
rgrover1 490:58a0313fffb5 162 break;
rgrover1 490:58a0313fffb5 163 case GattServerEvents::GATT_EVENT_UPDATES_DISABLED:
rgrover1 490:58a0313fffb5 164 if (onUpdatesDisabled) {
rgrover1 490:58a0313fffb5 165 onUpdatesDisabled(charHandle);
rgrover1 490:58a0313fffb5 166 }
rgrover1 490:58a0313fffb5 167 break;
rgrover1 490:58a0313fffb5 168 case GattServerEvents::GATT_EVENT_CONFIRMATION_RECEIVED:
rgrover1 490:58a0313fffb5 169 if (onConfirmationReceived) {
rgrover1 490:58a0313fffb5 170 onConfirmationReceived(charHandle);
rgrover1 490:58a0313fffb5 171 }
rgrover1 490:58a0313fffb5 172 break;
rgrover1 490:58a0313fffb5 173 default:
rgrover1 490:58a0313fffb5 174 break;
rgrover1 490:58a0313fffb5 175 }
rgrover1 490:58a0313fffb5 176 }
rgrover1 490:58a0313fffb5 177
rgrover1 490:58a0313fffb5 178 void handleDataSentEvent(unsigned count) {
rgrover1 490:58a0313fffb5 179 if (onDataSent.hasCallbacksAttached()) {
rgrover1 490:58a0313fffb5 180 onDataSent.call(count);
rgrover1 490:58a0313fffb5 181 }
rgrover1 490:58a0313fffb5 182 }
rgrover1 490:58a0313fffb5 183
rgrover1 490:58a0313fffb5 184 protected:
rgrover1 490:58a0313fffb5 185 uint8_t serviceCount;
rgrover1 490:58a0313fffb5 186 uint8_t characteristicCount;
rgrover1 490:58a0313fffb5 187
rgrover1 490:58a0313fffb5 188 private:
rgrover1 490:58a0313fffb5 189 CallChainOfFunctionPointersWithContext<unsigned> onDataSent;
rgrover1 490:58a0313fffb5 190 CallChainOfFunctionPointersWithContext<const GattCharacteristicWriteCBParams *> onDataWritten;
rgrover1 490:58a0313fffb5 191 CallChainOfFunctionPointersWithContext<const GattCharacteristicReadCBParams *> onDataRead;
rgrover1 490:58a0313fffb5 192 EventCallback_t onUpdatesEnabled;
rgrover1 490:58a0313fffb5 193 EventCallback_t onUpdatesDisabled;
rgrover1 490:58a0313fffb5 194 EventCallback_t onConfirmationReceived;
rgrover1 490:58a0313fffb5 195 #endif
rgrover1 490:58a0313fffb5 196
rgrover1 490:58a0313fffb5 197 protected:
rgrover1 490:58a0313fffb5 198 GattClient() {
rgrover1 490:58a0313fffb5 199 /* empty */
rgrover1 490:58a0313fffb5 200 }
rgrover1 490:58a0313fffb5 201
rgrover1 490:58a0313fffb5 202 private:
rgrover1 490:58a0313fffb5 203 /* disallow copy and assignment */
rgrover1 490:58a0313fffb5 204 GattClient(const GattClient &);
rgrover1 490:58a0313fffb5 205 GattClient& operator=(const GattClient &);
rgrover1 490:58a0313fffb5 206 };
rgrover1 490:58a0313fffb5 207
rgrover1 490:58a0313fffb5 208 #endif // ifndef __GATT_CLIENT_H__