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@327:0ea2b4d48212, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:32 2015 +0100
Revision:
327:0ea2b4d48212
Parent:
326:77dd705571e2
Child:
330:0a8ebc25b57c
Synchronized with git rev 1fc421ba

Author: Rohit Grover

intermediate checkin as nRFDiscoveredCharacteristic moves into GattClient implementation.

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 315:044071756a8d 20 class nRFDiscoveredCharacteristic : public DiscoveredCharacteristic {
rgrover1 315:044071756a8d 21 public:
rgrover1 315:044071756a8d 22 void setup(Gap::Handle_t connectionHandleIn,
rgrover1 325:eb6914dca928 23 ble_gatt_char_props_t propsIn,
rgrover1 315:044071756a8d 24 GattAttribute::Handle_t declHandleIn,
rgrover1 315:044071756a8d 25 GattAttribute::Handle_t valueHandleIn) {
rgrover1 315:044071756a8d 26 connHandle = connectionHandleIn;
rgrover1 315:044071756a8d 27 declHandle = declHandleIn;
rgrover1 315:044071756a8d 28 valueHandle = valueHandleIn;
rgrover1 325:eb6914dca928 29
rgrover1 325:eb6914dca928 30 props._broadcast = propsIn.broadcast;
rgrover1 325:eb6914dca928 31 props._read = propsIn.read;
rgrover1 325:eb6914dca928 32 props._writeWoResp = propsIn.write_wo_resp;
rgrover1 325:eb6914dca928 33 props._write = propsIn.write;
rgrover1 325:eb6914dca928 34 props._notify = propsIn.notify;
rgrover1 325:eb6914dca928 35 props._indicate = propsIn.indicate;
rgrover1 325:eb6914dca928 36 props._authSignedWrite = propsIn.auth_signed_wr;
rgrover1 315:044071756a8d 37 }
rgrover1 315:044071756a8d 38
rgrover1 315:044071756a8d 39 void setup(Gap::Handle_t connectionHandleIn,
rgrover1 315:044071756a8d 40 UUID::ShortUUIDBytes_t uuidIn,
rgrover1 325:eb6914dca928 41 ble_gatt_char_props_t propsIn,
rgrover1 315:044071756a8d 42 GattAttribute::Handle_t declHandleIn,
rgrover1 315:044071756a8d 43 GattAttribute::Handle_t valueHandleIn) {
rgrover1 315:044071756a8d 44 connHandle = connectionHandleIn;
rgrover1 315:044071756a8d 45 uuid = uuidIn;
rgrover1 315:044071756a8d 46 declHandle = declHandleIn;
rgrover1 315:044071756a8d 47 valueHandle = valueHandleIn;
rgrover1 325:eb6914dca928 48
rgrover1 325:eb6914dca928 49 props._broadcast = propsIn.broadcast;
rgrover1 325:eb6914dca928 50 props._read = propsIn.read;
rgrover1 325:eb6914dca928 51 props._writeWoResp = propsIn.write_wo_resp;
rgrover1 325:eb6914dca928 52 props._write = propsIn.write;
rgrover1 325:eb6914dca928 53 props._notify = propsIn.notify;
rgrover1 325:eb6914dca928 54 props._indicate = propsIn.indicate;
rgrover1 325:eb6914dca928 55 props._authSignedWrite = propsIn.auth_signed_wr;
rgrover1 315:044071756a8d 56 }
rgrover1 315:044071756a8d 57
rgrover1 327:0ea2b4d48212 58 #if 0
rgrover1 315:044071756a8d 59 public:
rgrover1 315:044071756a8d 60 /**
rgrover1 315:044071756a8d 61 * Initiate (or continue) a read for the value attribute, optionally at a
rgrover1 315:044071756a8d 62 * given offset. If the Characteristic or Descriptor to be read is longer
rgrover1 315:044071756a8d 63 * than ATT_MTU - 1, this function must be called multiple times with
rgrover1 315:044071756a8d 64 * appropriate offset to read the complete value.
rgrover1 315:044071756a8d 65 *
rgrover1 315:044071756a8d 66 * @return BLE_ERROR_NONE if a read has been initiated, else
rgrover1 315:044071756a8d 67 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 326:77dd705571e2 68 * BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1 326:77dd705571e2 69 * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties.
rgrover1 315:044071756a8d 70 */
rgrover1 315:044071756a8d 71 virtual ble_error_t read(uint16_t offset = 0) const {
rgrover1 327:0ea2b4d48212 72
rgrover1 327:0ea2b4d48212 73 printf("in nRFDiscoveredCharacteristic::read\r\n");
rgrover1 327:0ea2b4d48212 74 ble_error_t err = DiscoveredCharacteristic::read(offset);
rgrover1 327:0ea2b4d48212 75 if (err != BLE_ERROR_NONE) {
rgrover1 327:0ea2b4d48212 76 return err;
rgrover1 326:77dd705571e2 77 }
rgrover1 326:77dd705571e2 78
rgrover1 315:044071756a8d 79 uint32_t rc = sd_ble_gattc_read(connHandle, valueHandle, offset);
rgrover1 315:044071756a8d 80 if (rc == NRF_SUCCESS) {
rgrover1 315:044071756a8d 81 return BLE_ERROR_NONE;
rgrover1 315:044071756a8d 82 }
rgrover1 315:044071756a8d 83 switch (rc) {
rgrover1 315:044071756a8d 84 case NRF_ERROR_BUSY:
rgrover1 315:044071756a8d 85 return BLE_STACK_BUSY;
rgrover1 315:044071756a8d 86 case BLE_ERROR_INVALID_CONN_HANDLE:
rgrover1 315:044071756a8d 87 case NRF_ERROR_INVALID_STATE:
rgrover1 315:044071756a8d 88 case NRF_ERROR_INVALID_ADDR:
rgrover1 315:044071756a8d 89 default:
rgrover1 315:044071756a8d 90 return BLE_ERROR_INVALID_STATE;
rgrover1 315:044071756a8d 91 }
rgrover1 315:044071756a8d 92 }
rgrover1 324:1cb5b26ecaca 93
rgrover1 324:1cb5b26ecaca 94 /**
rgrover1 324:1cb5b26ecaca 95 * Perform a write without response procedure.
rgrover1 324:1cb5b26ecaca 96 *
rgrover1 324:1cb5b26ecaca 97 * @param length
rgrover1 324:1cb5b26ecaca 98 * The amount of data being written.
rgrover1 324:1cb5b26ecaca 99 * @param value
rgrover1 324:1cb5b26ecaca 100 * The bytes being written.
rgrover1 324:1cb5b26ecaca 101 *
rgrover1 324:1cb5b26ecaca 102 * @note It is important to note that a write without response will
rgrover1 324:1cb5b26ecaca 103 * <b>consume an application buffer</b>, and will therefore
rgrover1 324:1cb5b26ecaca 104 * generate a onDataWritten() callback when the packet has been
rgrover1 324:1cb5b26ecaca 105 * transmitted. The application should ensure that the buffer is
rgrover1 324:1cb5b26ecaca 106 * valid until the callback.
rgrover1 324:1cb5b26ecaca 107 *
rgrover1 324:1cb5b26ecaca 108 * @retval BLE_ERROR_NONE Successfully started the Write procedure, else
rgrover1 324:1cb5b26ecaca 109 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 324:1cb5b26ecaca 110 * BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1 326:77dd705571e2 111 * BLE_ERROR_NO_MEM if there are no available buffers left to process the request or
rgrover1 326:77dd705571e2 112 * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties.
rgrover1 324:1cb5b26ecaca 113 */
rgrover1 324:1cb5b26ecaca 114 virtual ble_error_t writeWoResponse(uint16_t length, const uint8_t *value) const {
rgrover1 327:0ea2b4d48212 115 ble_error_t err = DiscoveredCharacteristic::writeWoResponse(length, value);
rgrover1 327:0ea2b4d48212 116 if (err != BLE_ERROR_NONE) {
rgrover1 327:0ea2b4d48212 117 return err;
rgrover1 326:77dd705571e2 118 }
rgrover1 326:77dd705571e2 119
rgrover1 324:1cb5b26ecaca 120 ble_gattc_write_params_t writeParams = {
rgrover1 324:1cb5b26ecaca 121 .write_op = BLE_GATT_OP_WRITE_CMD,
rgrover1 324:1cb5b26ecaca 122 // .flags = 0,
rgrover1 324:1cb5b26ecaca 123 .handle = valueHandle,
rgrover1 324:1cb5b26ecaca 124 .offset = 0,
rgrover1 324:1cb5b26ecaca 125 .len = length,
rgrover1 324:1cb5b26ecaca 126 .p_value = const_cast<uint8_t *>(value),
rgrover1 324:1cb5b26ecaca 127 };
rgrover1 324:1cb5b26ecaca 128
rgrover1 324:1cb5b26ecaca 129 uint32_t rc = sd_ble_gattc_write(connHandle, &writeParams);
rgrover1 324:1cb5b26ecaca 130 if (rc == NRF_SUCCESS) {
rgrover1 324:1cb5b26ecaca 131 return BLE_ERROR_NONE;
rgrover1 324:1cb5b26ecaca 132 }
rgrover1 324:1cb5b26ecaca 133 switch (rc) {
rgrover1 324:1cb5b26ecaca 134 case NRF_ERROR_BUSY:
rgrover1 324:1cb5b26ecaca 135 return BLE_STACK_BUSY;
rgrover1 324:1cb5b26ecaca 136 case BLE_ERROR_NO_TX_BUFFERS:
rgrover1 324:1cb5b26ecaca 137 return BLE_ERROR_NO_MEM;
rgrover1 324:1cb5b26ecaca 138 case BLE_ERROR_INVALID_CONN_HANDLE:
rgrover1 324:1cb5b26ecaca 139 case NRF_ERROR_INVALID_STATE:
rgrover1 324:1cb5b26ecaca 140 case NRF_ERROR_INVALID_ADDR:
rgrover1 324:1cb5b26ecaca 141 default:
rgrover1 324:1cb5b26ecaca 142 return BLE_ERROR_INVALID_STATE;
rgrover1 324:1cb5b26ecaca 143 }
rgrover1 324:1cb5b26ecaca 144 }
rgrover1 327:0ea2b4d48212 145 #endif
rgrover1 315:044071756a8d 146 };
rgrover1 315:044071756a8d 147
rgrover1 315:044071756a8d 148 #endif /* __NRF_DISCOVERED_CHARACTERISTIC_H__ */