Productize / nRF51822

library for BLE_GAP_backpack

Dependencies:   nrf51-sdk

Fork of nRF51822 by Nordic Semiconductor

source/nRF5xGattClient.h@388:db85a09c27ef, 2015-07-21 (annotated)

Committer:
rgrover1
Date:
Tue Jul 21 13:23:44 2015 +0100
Revision:
388:db85a09c27ef
Child:
416:5b7d26035f2b
Synchronized with git rev 0eb58d86

Author: Rohit Grover

rename nRF51... to nRF5x...

This prepares us to support nRF52.

Who changed what in which revision?

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