Cefn Hoile / nRF51822

Attempting to publish a tree

Dependencies:   nrf51-sdk

Dependents:   microbit-dal

Fork of nRF51822 by Lancaster University

source/nRF5xGattClient.h@624:3ef324d9f2df, 2016-06-01 (annotated)

Committer:
cefn
Date:
Wed Jun 01 17:41:42 2016 +0000
Revision:
624:3ef324d9f2df
Parent:
616:a8f9b022d8fd 
Attempting to publish a tree

Who changed what in which revision?

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