Michael Galis / nRF51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of nRF51822 by Nordic Semiconductor

nRFDiscoveredCharacteristic.h@332:b054000833d4, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:32 2015 +0100
Revision:
332:b054000833d4
Parent:
330:0a8ebc25b57c
Child:
333:8eedcd324853
Synchronized with git rev 5a4e62f1

Author: Rohit Grover

one massive commit to integrate with GattClient.

DiscoveredCharacteristic still needs to setup gattc pointers.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 315:044071756a8d 1 /* mbed Microcontroller Library
rgrover1 315:044071756a8d 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 315:044071756a8d 3 *
rgrover1 315:044071756a8d 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 315:044071756a8d 5 * you may not use this file except in compliance with the License.
rgrover1 315:044071756a8d 6 * You may obtain a copy of the License at
rgrover1 315:044071756a8d 7 *
rgrover1 315:044071756a8d 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 315:044071756a8d 9 *
rgrover1 315:044071756a8d 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 315:044071756a8d 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 315:044071756a8d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 315:044071756a8d 13 * See the License for the specific language governing permissions and
rgrover1 315:044071756a8d 14 * limitations under the License.
rgrover1 315:044071756a8d 15 */
rgrover1 315:044071756a8d 16
rgrover1 315:044071756a8d 17 #ifndef __NRF_DISCOVERED_CHARACTERISTIC_H__
rgrover1 315:044071756a8d 18 #define __NRF_DISCOVERED_CHARACTERISTIC_H__
rgrover1 315:044071756a8d 19
rgrover1 332:b054000833d4 20 #include "ble_gatt.h"
rgrover1 332:b054000833d4 21
rgrover1 315:044071756a8d 22 class nRFDiscoveredCharacteristic : public DiscoveredCharacteristic {
rgrover1 315:044071756a8d 23 public:
rgrover1 330:0a8ebc25b57c 24 void setup(GattClient *gattcIn,
rgrover1 330:0a8ebc25b57c 25 Gap::Handle_t connectionHandleIn,
rgrover1 330:0a8ebc25b57c 26 ble_gatt_char_props_t propsIn,
rgrover1 330:0a8ebc25b57c 27 GattAttribute::Handle_t declHandleIn,
rgrover1 330:0a8ebc25b57c 28 GattAttribute::Handle_t valueHandleIn) {
rgrover1 330:0a8ebc25b57c 29 gattc = gattcIn;
rgrover1 315:044071756a8d 30 connHandle = connectionHandleIn;
rgrover1 315:044071756a8d 31 declHandle = declHandleIn;
rgrover1 315:044071756a8d 32 valueHandle = valueHandleIn;
rgrover1 325:eb6914dca928 33
rgrover1 325:eb6914dca928 34 props._broadcast = propsIn.broadcast;
rgrover1 325:eb6914dca928 35 props._read = propsIn.read;
rgrover1 325:eb6914dca928 36 props._writeWoResp = propsIn.write_wo_resp;
rgrover1 325:eb6914dca928 37 props._write = propsIn.write;
rgrover1 325:eb6914dca928 38 props._notify = propsIn.notify;
rgrover1 325:eb6914dca928 39 props._indicate = propsIn.indicate;
rgrover1 325:eb6914dca928 40 props._authSignedWrite = propsIn.auth_signed_wr;
rgrover1 315:044071756a8d 41 }
rgrover1 315:044071756a8d 42
rgrover1 330:0a8ebc25b57c 43 void setup(GattClient *gattcIn,
rgrover1 330:0a8ebc25b57c 44 Gap::Handle_t connectionHandleIn,
rgrover1 330:0a8ebc25b57c 45 UUID::ShortUUIDBytes_t uuidIn,
rgrover1 330:0a8ebc25b57c 46 ble_gatt_char_props_t propsIn,
rgrover1 330:0a8ebc25b57c 47 GattAttribute::Handle_t declHandleIn,
rgrover1 330:0a8ebc25b57c 48 GattAttribute::Handle_t valueHandleIn) {
rgrover1 330:0a8ebc25b57c 49 gattc = gattcIn;
rgrover1 315:044071756a8d 50 connHandle = connectionHandleIn;
rgrover1 315:044071756a8d 51 uuid = uuidIn;
rgrover1 315:044071756a8d 52 declHandle = declHandleIn;
rgrover1 315:044071756a8d 53 valueHandle = valueHandleIn;
rgrover1 325:eb6914dca928 54
rgrover1 325:eb6914dca928 55 props._broadcast = propsIn.broadcast;
rgrover1 325:eb6914dca928 56 props._read = propsIn.read;
rgrover1 325:eb6914dca928 57 props._writeWoResp = propsIn.write_wo_resp;
rgrover1 325:eb6914dca928 58 props._write = propsIn.write;
rgrover1 325:eb6914dca928 59 props._notify = propsIn.notify;
rgrover1 325:eb6914dca928 60 props._indicate = propsIn.indicate;
rgrover1 325:eb6914dca928 61 props._authSignedWrite = propsIn.auth_signed_wr;
rgrover1 315:044071756a8d 62 }
rgrover1 315:044071756a8d 63
rgrover1 327:0ea2b4d48212 64 #if 0
rgrover1 315:044071756a8d 65 public:
rgrover1 315:044071756a8d 66 /**
rgrover1 315:044071756a8d 67 * Initiate (or continue) a read for the value attribute, optionally at a
rgrover1 315:044071756a8d 68 * given offset. If the Characteristic or Descriptor to be read is longer
rgrover1 315:044071756a8d 69 * than ATT_MTU - 1, this function must be called multiple times with
rgrover1 315:044071756a8d 70 * appropriate offset to read the complete value.
rgrover1 315:044071756a8d 71 *
rgrover1 315:044071756a8d 72 * @return BLE_ERROR_NONE if a read has been initiated, else
rgrover1 315:044071756a8d 73 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 326:77dd705571e2 74 * BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1 326:77dd705571e2 75 * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties.
rgrover1 315:044071756a8d 76 */
rgrover1 315:044071756a8d 77 virtual ble_error_t read(uint16_t offset = 0) const {
rgrover1 327:0ea2b4d48212 78
rgrover1 327:0ea2b4d48212 79 printf("in nRFDiscoveredCharacteristic::read\r\n");
rgrover1 327:0ea2b4d48212 80 ble_error_t err = DiscoveredCharacteristic::read(offset);
rgrover1 327:0ea2b4d48212 81 if (err != BLE_ERROR_NONE) {
rgrover1 327:0ea2b4d48212 82 return err;
rgrover1 326:77dd705571e2 83 }
rgrover1 326:77dd705571e2 84
rgrover1 315:044071756a8d 85 uint32_t rc = sd_ble_gattc_read(connHandle, valueHandle, offset);
rgrover1 315:044071756a8d 86 if (rc == NRF_SUCCESS) {
rgrover1 315:044071756a8d 87 return BLE_ERROR_NONE;
rgrover1 315:044071756a8d 88 }
rgrover1 315:044071756a8d 89 switch (rc) {
rgrover1 315:044071756a8d 90 case NRF_ERROR_BUSY:
rgrover1 315:044071756a8d 91 return BLE_STACK_BUSY;
rgrover1 315:044071756a8d 92 case BLE_ERROR_INVALID_CONN_HANDLE:
rgrover1 315:044071756a8d 93 case NRF_ERROR_INVALID_STATE:
rgrover1 315:044071756a8d 94 case NRF_ERROR_INVALID_ADDR:
rgrover1 315:044071756a8d 95 default:
rgrover1 315:044071756a8d 96 return BLE_ERROR_INVALID_STATE;
rgrover1 315:044071756a8d 97 }
rgrover1 315:044071756a8d 98 }
rgrover1 324:1cb5b26ecaca 99
rgrover1 324:1cb5b26ecaca 100 /**
rgrover1 324:1cb5b26ecaca 101 * Perform a write without response procedure.
rgrover1 324:1cb5b26ecaca 102 *
rgrover1 324:1cb5b26ecaca 103 * @param length
rgrover1 324:1cb5b26ecaca 104 * The amount of data being written.
rgrover1 324:1cb5b26ecaca 105 * @param value
rgrover1 324:1cb5b26ecaca 106 * The bytes being written.
rgrover1 324:1cb5b26ecaca 107 *
rgrover1 324:1cb5b26ecaca 108 * @note It is important to note that a write without response will
rgrover1 324:1cb5b26ecaca 109 * <b>consume an application buffer</b>, and will therefore
rgrover1 324:1cb5b26ecaca 110 * generate a onDataWritten() callback when the packet has been
rgrover1 324:1cb5b26ecaca 111 * transmitted. The application should ensure that the buffer is
rgrover1 324:1cb5b26ecaca 112 * valid until the callback.
rgrover1 324:1cb5b26ecaca 113 *
rgrover1 324:1cb5b26ecaca 114 * @retval BLE_ERROR_NONE Successfully started the Write procedure, else
rgrover1 324:1cb5b26ecaca 115 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 324:1cb5b26ecaca 116 * BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1 326:77dd705571e2 117 * BLE_ERROR_NO_MEM if there are no available buffers left to process the request or
rgrover1 326:77dd705571e2 118 * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties.
rgrover1 324:1cb5b26ecaca 119 */
rgrover1 324:1cb5b26ecaca 120 virtual ble_error_t writeWoResponse(uint16_t length, const uint8_t *value) const {
rgrover1 327:0ea2b4d48212 121 ble_error_t err = DiscoveredCharacteristic::writeWoResponse(length, value);
rgrover1 327:0ea2b4d48212 122 if (err != BLE_ERROR_NONE) {
rgrover1 327:0ea2b4d48212 123 return err;
rgrover1 326:77dd705571e2 124 }
rgrover1 326:77dd705571e2 125
rgrover1 324:1cb5b26ecaca 126 ble_gattc_write_params_t writeParams = {
rgrover1 324:1cb5b26ecaca 127 .write_op = BLE_GATT_OP_WRITE_CMD,
rgrover1 324:1cb5b26ecaca 128 // .flags = 0,
rgrover1 324:1cb5b26ecaca 129 .handle = valueHandle,
rgrover1 324:1cb5b26ecaca 130 .offset = 0,
rgrover1 324:1cb5b26ecaca 131 .len = length,
rgrover1 324:1cb5b26ecaca 132 .p_value = const_cast<uint8_t *>(value),
rgrover1 324:1cb5b26ecaca 133 };
rgrover1 324:1cb5b26ecaca 134
rgrover1 324:1cb5b26ecaca 135 uint32_t rc = sd_ble_gattc_write(connHandle, &writeParams);
rgrover1 324:1cb5b26ecaca 136 if (rc == NRF_SUCCESS) {
rgrover1 324:1cb5b26ecaca 137 return BLE_ERROR_NONE;
rgrover1 324:1cb5b26ecaca 138 }
rgrover1 324:1cb5b26ecaca 139 switch (rc) {
rgrover1 324:1cb5b26ecaca 140 case NRF_ERROR_BUSY:
rgrover1 324:1cb5b26ecaca 141 return BLE_STACK_BUSY;
rgrover1 324:1cb5b26ecaca 142 case BLE_ERROR_NO_TX_BUFFERS:
rgrover1 324:1cb5b26ecaca 143 return BLE_ERROR_NO_MEM;
rgrover1 324:1cb5b26ecaca 144 case BLE_ERROR_INVALID_CONN_HANDLE:
rgrover1 324:1cb5b26ecaca 145 case NRF_ERROR_INVALID_STATE:
rgrover1 324:1cb5b26ecaca 146 case NRF_ERROR_INVALID_ADDR:
rgrover1 324:1cb5b26ecaca 147 default:
rgrover1 324:1cb5b26ecaca 148 return BLE_ERROR_INVALID_STATE;
rgrover1 324:1cb5b26ecaca 149 }
rgrover1 324:1cb5b26ecaca 150 }
rgrover1 327:0ea2b4d48212 151 #endif
rgrover1 315:044071756a8d 152 };
rgrover1 315:044071756a8d 153
rgrover1 315:044071756a8d 154 #endif /* __NRF_DISCOVERED_CHARACTERISTIC_H__ */