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

Committer:
rgrover1
Date:
Fri Jun 19 15:55:32 2015 +0100
Revision:
330:0a8ebc25b57c
Parent:
327:0ea2b4d48212
Child:
332:b054000833d4
Synchronized with git rev 168eed4e

Author: Rohit Grover

nRFDiscoveredCharacteristic::setup() takes a GattClient poitner

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