Jason Garner / nRF51822

fork

Fork of nRF51822 by Nordic Semiconductor

nRF51GattClient.h@344:2a44e5fd26bc, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:34 2015 +0100
Revision:
344:2a44e5fd26bc
Child:
345:dfde56236c36
Synchronized with git rev c796271c

Author: Rohit Grover

Merge branch 'gattClient' into develop

Who changed what in which revision?

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