Nordic Semiconductor / 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.

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate writable_gatt ... more

nRFDiscoveredCharacteristic.h@325:eb6914dca928, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:31 2015 +0100
Revision:
325:eb6914dca928
Parent:
324:1cb5b26ecaca
Child:
326:77dd705571e2
Synchronized with git rev 4ec5b944

Author: Rohit Grover

nRFDiscoveredCharacteristic: handle setup of properties correctly.

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 315:044071756a8d 58 public:
rgrover1 315:044071756a8d 59 /**
rgrover1 315:044071756a8d 60 * Initiate (or continue) a read for the value attribute, optionally at a
rgrover1 315:044071756a8d 61 * given offset. If the Characteristic or Descriptor to be read is longer
rgrover1 315:044071756a8d 62 * than ATT_MTU - 1, this function must be called multiple times with
rgrover1 315:044071756a8d 63 * appropriate offset to read the complete value.
rgrover1 315:044071756a8d 64 *
rgrover1 315:044071756a8d 65 * @return BLE_ERROR_NONE if a read has been initiated, else
rgrover1 315:044071756a8d 66 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 315:044071756a8d 67 * BLE_STACK_BUSY if some client procedure already in progress.
rgrover1 315:044071756a8d 68 */
rgrover1 315:044071756a8d 69 virtual ble_error_t read(uint16_t offset = 0) const {
rgrover1 315:044071756a8d 70 uint32_t rc = sd_ble_gattc_read(connHandle, valueHandle, offset);
rgrover1 315:044071756a8d 71 if (rc == NRF_SUCCESS) {
rgrover1 315:044071756a8d 72 return BLE_ERROR_NONE;
rgrover1 315:044071756a8d 73 }
rgrover1 315:044071756a8d 74 switch (rc) {
rgrover1 315:044071756a8d 75 case NRF_ERROR_BUSY:
rgrover1 315:044071756a8d 76 return BLE_STACK_BUSY;
rgrover1 315:044071756a8d 77 case BLE_ERROR_INVALID_CONN_HANDLE:
rgrover1 315:044071756a8d 78 case NRF_ERROR_INVALID_STATE:
rgrover1 315:044071756a8d 79 case NRF_ERROR_INVALID_ADDR:
rgrover1 315:044071756a8d 80 default:
rgrover1 315:044071756a8d 81 return BLE_ERROR_INVALID_STATE;
rgrover1 315:044071756a8d 82 }
rgrover1 315:044071756a8d 83 }
rgrover1 324:1cb5b26ecaca 84
rgrover1 324:1cb5b26ecaca 85 /**
rgrover1 324:1cb5b26ecaca 86 * Perform a write without response procedure.
rgrover1 324:1cb5b26ecaca 87 *
rgrover1 324:1cb5b26ecaca 88 * @param length
rgrover1 324:1cb5b26ecaca 89 * The amount of data being written.
rgrover1 324:1cb5b26ecaca 90 * @param value
rgrover1 324:1cb5b26ecaca 91 * The bytes being written.
rgrover1 324:1cb5b26ecaca 92 *
rgrover1 324:1cb5b26ecaca 93 * @note It is important to note that a write without response will
rgrover1 324:1cb5b26ecaca 94 * <b>consume an application buffer</b>, and will therefore
rgrover1 324:1cb5b26ecaca 95 * generate a onDataWritten() callback when the packet has been
rgrover1 324:1cb5b26ecaca 96 * transmitted. The application should ensure that the buffer is
rgrover1 324:1cb5b26ecaca 97 * valid until the callback.
rgrover1 324:1cb5b26ecaca 98 *
rgrover1 324:1cb5b26ecaca 99 * @retval BLE_ERROR_NONE Successfully started the Write procedure, else
rgrover1 324:1cb5b26ecaca 100 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 324:1cb5b26ecaca 101 * BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1 324:1cb5b26ecaca 102 * BLE_ERROR_NO_MEM if there are no available buffers left to process the request.
rgrover1 324:1cb5b26ecaca 103 */
rgrover1 324:1cb5b26ecaca 104 virtual ble_error_t writeWoResponse(uint16_t length, const uint8_t *value) const {
rgrover1 324:1cb5b26ecaca 105 ble_gattc_write_params_t writeParams = {
rgrover1 324:1cb5b26ecaca 106 .write_op = BLE_GATT_OP_WRITE_CMD,
rgrover1 324:1cb5b26ecaca 107 // .flags = 0,
rgrover1 324:1cb5b26ecaca 108 .handle = valueHandle,
rgrover1 324:1cb5b26ecaca 109 .offset = 0,
rgrover1 324:1cb5b26ecaca 110 .len = length,
rgrover1 324:1cb5b26ecaca 111 .p_value = const_cast<uint8_t *>(value),
rgrover1 324:1cb5b26ecaca 112 };
rgrover1 324:1cb5b26ecaca 113
rgrover1 324:1cb5b26ecaca 114 uint32_t rc = sd_ble_gattc_write(connHandle, &writeParams);
rgrover1 324:1cb5b26ecaca 115 if (rc == NRF_SUCCESS) {
rgrover1 324:1cb5b26ecaca 116 return BLE_ERROR_NONE;
rgrover1 324:1cb5b26ecaca 117 }
rgrover1 324:1cb5b26ecaca 118 switch (rc) {
rgrover1 324:1cb5b26ecaca 119 case NRF_ERROR_BUSY:
rgrover1 324:1cb5b26ecaca 120 return BLE_STACK_BUSY;
rgrover1 324:1cb5b26ecaca 121 case BLE_ERROR_NO_TX_BUFFERS:
rgrover1 324:1cb5b26ecaca 122 return BLE_ERROR_NO_MEM;
rgrover1 324:1cb5b26ecaca 123 case BLE_ERROR_INVALID_CONN_HANDLE:
rgrover1 324:1cb5b26ecaca 124 case NRF_ERROR_INVALID_STATE:
rgrover1 324:1cb5b26ecaca 125 case NRF_ERROR_INVALID_ADDR:
rgrover1 324:1cb5b26ecaca 126 default:
rgrover1 324:1cb5b26ecaca 127 return BLE_ERROR_INVALID_STATE;
rgrover1 324:1cb5b26ecaca 128 }
rgrover1 324:1cb5b26ecaca 129 }
rgrover1 315:044071756a8d 130 };
rgrover1 315:044071756a8d 131
rgrover1 315:044071756a8d 132 #endif /* __NRF_DISCOVERED_CHARACTERISTIC_H__ */