Oscar Ariza / nRF51822

nordic

Fork of nRF51822 by Nordic Semiconductor

source/nRF5xGattClient.h@548:8550af084edc, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 10:19:05 2016 +0000
Revision:
548:8550af084edc
Parent:
546:d834e6591aee
Child:
549:920e941cbe1e
Synchronized with git rev c778aa8a

Author: Vincent Coubard

Rename characteristic descriptors discovery activity and termination function

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vcoubard 543:1bf9c597f44f 1 /* mbed Microcontroller Library
vcoubard 543:1bf9c597f44f 2 * Copyright (c) 2006-2013 ARM Limited
vcoubard 543:1bf9c597f44f 3 *
vcoubard 543:1bf9c597f44f 4 * Licensed under the Apache License, Version 2.0 (the "License");
vcoubard 543:1bf9c597f44f 5 * you may not use this file except in compliance with the License.
vcoubard 543:1bf9c597f44f 6 * You may obtain a copy of the License at
vcoubard 543:1bf9c597f44f 7 *
vcoubard 543:1bf9c597f44f 8 * http://www.apache.org/licenses/LICENSE-2.0
vcoubard 543:1bf9c597f44f 9 *
vcoubard 543:1bf9c597f44f 10 * Unless required by applicable law or agreed to in writing, software
vcoubard 543:1bf9c597f44f 11 * distributed under the License is distributed on an "AS IS" BASIS,
vcoubard 543:1bf9c597f44f 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vcoubard 543:1bf9c597f44f 13 * See the License for the specific language governing permissions and
vcoubard 543:1bf9c597f44f 14 * limitations under the License.
vcoubard 543:1bf9c597f44f 15 */
vcoubard 543:1bf9c597f44f 16
vcoubard 543:1bf9c597f44f 17 #ifndef __NRF51822_GATT_CLIENT_H__
vcoubard 543:1bf9c597f44f 18 #define __NRF51822_GATT_CLIENT_H__
vcoubard 543:1bf9c597f44f 19
vcoubard 543:1bf9c597f44f 20 #include "ble/GattClient.h"
vcoubard 543:1bf9c597f44f 21 #include "nRF5xServiceDiscovery.h"
vcoubard 543:1bf9c597f44f 22 #include "nRF5xCharacteristicDescriptorDiscoverer.h"
vcoubard 543:1bf9c597f44f 23
vcoubard 543:1bf9c597f44f 24 class nRF5xGattClient : public GattClient
vcoubard 543:1bf9c597f44f 25 {
vcoubard 543:1bf9c597f44f 26 public:
vcoubard 543:1bf9c597f44f 27 static nRF5xGattClient &getInstance();
vcoubard 543:1bf9c597f44f 28
vcoubard 543:1bf9c597f44f 29 /**
vcoubard 543:1bf9c597f44f 30 * When using S110, all Gatt client features will return
vcoubard 543:1bf9c597f44f 31 * BLE_ERROR_NOT_IMPLEMENTED
vcoubard 543:1bf9c597f44f 32 */
vcoubard 543:1bf9c597f44f 33 #if !defined(TARGET_MCU_NRF51_16K_S110) && !defined(TARGET_MCU_NRF51_32K_S110)
vcoubard 543:1bf9c597f44f 34
vcoubard 543:1bf9c597f44f 35 /**
vcoubard 543:1bf9c597f44f 36 * Launch service discovery. Once launched, service discovery will remain
vcoubard 543:1bf9c597f44f 37 * active with callbacks being issued back into the application for matching
vcoubard 543:1bf9c597f44f 38 * services/characteristics. isActive() can be used to determine status; and
vcoubard 543:1bf9c597f44f 39 * a termination callback (if setup) will be invoked at the end. Service
vcoubard 543:1bf9c597f44f 40 * discovery can be terminated prematurely if needed using terminate().
vcoubard 543:1bf9c597f44f 41 *
vcoubard 543:1bf9c597f44f 42 * @param connectionHandle
vcoubard 543:1bf9c597f44f 43 * Handle for the connection with the peer.
vcoubard 543:1bf9c597f44f 44 * @param sc
vcoubard 543:1bf9c597f44f 45 * This is the application callback for matching service. Taken as
vcoubard 543:1bf9c597f44f 46 * NULL by default. Note: service discovery may still be active
vcoubard 543:1bf9c597f44f 47 * when this callback is issued; calling asynchronous BLE-stack
vcoubard 543:1bf9c597f44f 48 * APIs from within this application callback might cause the
vcoubard 543:1bf9c597f44f 49 * stack to abort service discovery. If this becomes an issue, it
vcoubard 543:1bf9c597f44f 50 * may be better to make local copy of the discoveredService and
vcoubard 543:1bf9c597f44f 51 * wait for service discovery to terminate before operating on the
vcoubard 543:1bf9c597f44f 52 * service.
vcoubard 543:1bf9c597f44f 53 * @param cc
vcoubard 543:1bf9c597f44f 54 * This is the application callback for matching characteristic.
vcoubard 543:1bf9c597f44f 55 * Taken as NULL by default. Note: service discovery may still be
vcoubard 543:1bf9c597f44f 56 * active when this callback is issued; calling asynchronous
vcoubard 543:1bf9c597f44f 57 * BLE-stack APIs from within this application callback might cause
vcoubard 543:1bf9c597f44f 58 * the stack to abort service discovery. If this becomes an issue,
vcoubard 543:1bf9c597f44f 59 * it may be better to make local copy of the discoveredCharacteristic
vcoubard 543:1bf9c597f44f 60 * and wait for service discovery to terminate before operating on the
vcoubard 543:1bf9c597f44f 61 * characteristic.
vcoubard 543:1bf9c597f44f 62 * @param matchingServiceUUID
vcoubard 543:1bf9c597f44f 63 * UUID based filter for specifying a service in which the application is
vcoubard 543:1bf9c597f44f 64 * interested. By default it is set as the wildcard UUID_UNKNOWN,
vcoubard 543:1bf9c597f44f 65 * in which case it matches all services. If characteristic-UUID
vcoubard 543:1bf9c597f44f 66 * filter (below) is set to the wildcard value, then a service
vcoubard 543:1bf9c597f44f 67 * callback will be invoked for the matching service (or for every
vcoubard 543:1bf9c597f44f 68 * service if the service filter is a wildcard).
vcoubard 543:1bf9c597f44f 69 * @param matchingCharacteristicUUIDIn
vcoubard 543:1bf9c597f44f 70 * UUID based filter for specifying characteristic in which the application
vcoubard 543:1bf9c597f44f 71 * is interested. By default it is set as the wildcard UUID_UKNOWN
vcoubard 543:1bf9c597f44f 72 * to match against any characteristic. If both service-UUID
vcoubard 543:1bf9c597f44f 73 * filter and characteristic-UUID filter are used with non- wildcard
vcoubard 543:1bf9c597f44f 74 * values, then only a single characteristic callback is
vcoubard 543:1bf9c597f44f 75 * invoked for the matching characteristic.
vcoubard 543:1bf9c597f44f 76 *
vcoubard 543:1bf9c597f44f 77 * @Note Using wildcard values for both service-UUID and characteristic-
vcoubard 543:1bf9c597f44f 78 * UUID will result in complete service discovery--callbacks being
vcoubard 543:1bf9c597f44f 79 * called for every service and characteristic.
vcoubard 543:1bf9c597f44f 80 *
vcoubard 543:1bf9c597f44f 81 * @return
vcoubard 543:1bf9c597f44f 82 * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error.
vcoubard 543:1bf9c597f44f 83 */
vcoubard 543:1bf9c597f44f 84 virtual ble_error_t launchServiceDiscovery(Gap::Handle_t connectionHandle,
vcoubard 543:1bf9c597f44f 85 ServiceDiscovery::ServiceCallback_t sc = NULL,
vcoubard 543:1bf9c597f44f 86 ServiceDiscovery::CharacteristicCallback_t cc = NULL,
vcoubard 543:1bf9c597f44f 87 const UUID &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN),
vcoubard 543:1bf9c597f44f 88 const UUID &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN));
vcoubard 543:1bf9c597f44f 89
vcoubard 543:1bf9c597f44f 90 virtual void onServiceDiscoveryTermination(ServiceDiscovery::TerminationCallback_t callback) {
vcoubard 543:1bf9c597f44f 91 discovery.onTermination(callback);
vcoubard 543:1bf9c597f44f 92 }
vcoubard 543:1bf9c597f44f 93
vcoubard 543:1bf9c597f44f 94 /**
vcoubard 543:1bf9c597f44f 95 * Is service-discovery currently active?
vcoubard 543:1bf9c597f44f 96 */
vcoubard 543:1bf9c597f44f 97 virtual bool isServiceDiscoveryActive(void) const {
vcoubard 543:1bf9c597f44f 98 return discovery.isActive();
vcoubard 543:1bf9c597f44f 99 }
vcoubard 543:1bf9c597f44f 100
vcoubard 543:1bf9c597f44f 101 /**
vcoubard 543:1bf9c597f44f 102 * Terminate an ongoing service-discovery. This should result in an
vcoubard 543:1bf9c597f44f 103 * invocation of the TerminationCallback if service-discovery is active.
vcoubard 543:1bf9c597f44f 104 */
vcoubard 543:1bf9c597f44f 105 virtual void terminateServiceDiscovery(void) {
vcoubard 543:1bf9c597f44f 106 discovery.terminate();
vcoubard 543:1bf9c597f44f 107 }
vcoubard 543:1bf9c597f44f 108
vcoubard 543:1bf9c597f44f 109 /**
vcoubard 543:1bf9c597f44f 110 * @brief Implementation of GattClient::discoverCharacteristicDescriptors
vcoubard 543:1bf9c597f44f 111 * @see GattClient::discoverCharacteristicDescriptors
vcoubard 543:1bf9c597f44f 112 */
vcoubard 543:1bf9c597f44f 113 virtual ble_error_t discoverCharacteristicDescriptors(
vcoubard 543:1bf9c597f44f 114 const DiscoveredCharacteristic& characteristic,
vcoubard 546:d834e6591aee 115 const CharacteristicDescriptorDiscovery::DiscoveryCallback_t& discoveryCallback,
vcoubard 546:d834e6591aee 116 const CharacteristicDescriptorDiscovery::TerminationCallback_t& terminationCallback
vcoubard 543:1bf9c597f44f 117 );
vcoubard 543:1bf9c597f44f 118
vcoubard 543:1bf9c597f44f 119 /**
vcoubard 543:1bf9c597f44f 120 * @brief Implementation of GattClient::isCharacteristicDiscoveryActive
vcoubard 543:1bf9c597f44f 121 * @see GattClient::isCharacteristicDiscoveryActive
vcoubard 543:1bf9c597f44f 122 */
vcoubard 548:8550af084edc 123 virtual bool isCharacteristicDescriptorsDiscoveryActive(const DiscoveredCharacteristic& characteristic) const;
vcoubard 543:1bf9c597f44f 124
vcoubard 543:1bf9c597f44f 125 /**
vcoubard 543:1bf9c597f44f 126 * @brief Implementation of GattClient::terminateCharacteristicDiscovery
vcoubard 543:1bf9c597f44f 127 * @see GattClient::terminateCharacteristicDiscovery
vcoubard 543:1bf9c597f44f 128 */
vcoubard 548:8550af084edc 129 virtual void terminateCharacteristicDescriptorsDiscovery(const DiscoveredCharacteristic& characteristic);
vcoubard 543:1bf9c597f44f 130
vcoubard 543:1bf9c597f44f 131 virtual ble_error_t read(Gap::Handle_t connHandle, GattAttribute::Handle_t attributeHandle, uint16_t offset) const {
vcoubard 543:1bf9c597f44f 132 uint32_t rc = sd_ble_gattc_read(connHandle, attributeHandle, offset);
vcoubard 543:1bf9c597f44f 133 if (rc == NRF_SUCCESS) {
vcoubard 543:1bf9c597f44f 134 return BLE_ERROR_NONE;
vcoubard 543:1bf9c597f44f 135 }
vcoubard 543:1bf9c597f44f 136 switch (rc) {
vcoubard 543:1bf9c597f44f 137 case NRF_ERROR_BUSY:
vcoubard 543:1bf9c597f44f 138 return BLE_STACK_BUSY;
vcoubard 543:1bf9c597f44f 139 case BLE_ERROR_INVALID_CONN_HANDLE:
vcoubard 543:1bf9c597f44f 140 case NRF_ERROR_INVALID_STATE:
vcoubard 543:1bf9c597f44f 141 case NRF_ERROR_INVALID_ADDR:
vcoubard 543:1bf9c597f44f 142 default:
vcoubard 543:1bf9c597f44f 143 return BLE_ERROR_INVALID_STATE;
vcoubard 543:1bf9c597f44f 144 }
vcoubard 543:1bf9c597f44f 145 }
vcoubard 543:1bf9c597f44f 146
vcoubard 543:1bf9c597f44f 147 virtual ble_error_t write(GattClient::WriteOp_t cmd, Gap::Handle_t connHandle, GattAttribute::Handle_t attributeHandle, size_t length, const uint8_t *value) const {
vcoubard 543:1bf9c597f44f 148 ble_gattc_write_params_t writeParams;
vcoubard 543:1bf9c597f44f 149 writeParams.write_op = cmd;
vcoubard 543:1bf9c597f44f 150 writeParams.flags = 0; /* this is inconsequential */
vcoubard 543:1bf9c597f44f 151 writeParams.handle = attributeHandle;
vcoubard 543:1bf9c597f44f 152 writeParams.offset = 0;
vcoubard 543:1bf9c597f44f 153 writeParams.len = length;
vcoubard 543:1bf9c597f44f 154 writeParams.p_value = const_cast<uint8_t *>(value);
vcoubard 543:1bf9c597f44f 155
vcoubard 543:1bf9c597f44f 156 uint32_t rc = sd_ble_gattc_write(connHandle, &writeParams);
vcoubard 543:1bf9c597f44f 157 if (rc == NRF_SUCCESS) {
vcoubard 543:1bf9c597f44f 158 return BLE_ERROR_NONE;
vcoubard 543:1bf9c597f44f 159 }
vcoubard 543:1bf9c597f44f 160 switch (rc) {
vcoubard 543:1bf9c597f44f 161 case NRF_ERROR_BUSY:
vcoubard 543:1bf9c597f44f 162 return BLE_STACK_BUSY;
vcoubard 543:1bf9c597f44f 163 case BLE_ERROR_NO_TX_BUFFERS:
vcoubard 543:1bf9c597f44f 164 return BLE_ERROR_NO_MEM;
vcoubard 543:1bf9c597f44f 165 case BLE_ERROR_INVALID_CONN_HANDLE:
vcoubard 543:1bf9c597f44f 166 case NRF_ERROR_INVALID_STATE:
vcoubard 543:1bf9c597f44f 167 case NRF_ERROR_INVALID_ADDR:
vcoubard 543:1bf9c597f44f 168 default:
vcoubard 543:1bf9c597f44f 169 return BLE_ERROR_INVALID_STATE;
vcoubard 543:1bf9c597f44f 170 }
vcoubard 543:1bf9c597f44f 171 }
vcoubard 543:1bf9c597f44f 172
vcoubard 543:1bf9c597f44f 173 public:
vcoubard 543:1bf9c597f44f 174 nRF5xGattClient() : discovery(this) {
vcoubard 543:1bf9c597f44f 175 /* empty */
vcoubard 543:1bf9c597f44f 176 }
vcoubard 543:1bf9c597f44f 177
vcoubard 543:1bf9c597f44f 178 friend void bleGattcEventHandler(const ble_evt_t *p_ble_evt);
vcoubard 543:1bf9c597f44f 179
vcoubard 543:1bf9c597f44f 180 private:
vcoubard 543:1bf9c597f44f 181 nRF5xGattClient(const nRF5xGattClient &);
vcoubard 543:1bf9c597f44f 182 const nRF5xGattClient& operator=(const nRF5xGattClient &);
vcoubard 543:1bf9c597f44f 183
vcoubard 543:1bf9c597f44f 184 private:
vcoubard 543:1bf9c597f44f 185 nRF5xServiceDiscovery discovery;
vcoubard 543:1bf9c597f44f 186 nRF5xCharacteristicDescriptorDiscoverer characteristicDescriptorDiscoverer;
vcoubard 543:1bf9c597f44f 187
vcoubard 543:1bf9c597f44f 188 #endif // if !S110
vcoubard 543:1bf9c597f44f 189 };
vcoubard 543:1bf9c597f44f 190
rgrover1 389:db85a09c27ef 191 #endif // ifndef __NRF51822_GATT_CLIENT_H__