nRF51822 | Mbed

Nordic Semiconductor » Code » nRF51822

Dependents: BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate writable_gatt ... more

nRFDiscoveredCharacteristic.h@324:1cb5b26ecaca, 2015-06-19 (annotated)

Committer:: rgrover1
Date:: Fri Jun 19 15:55:31 2015 +0100
Revision:: 324:1cb5b26ecaca
Parent:: 317:943ad03c93ef
Child:: 325:eb6914dca928

Synchronized with git rev 7cf266a3

Author: Rohit Grover

introduce nRFDiscoveredCharacteristic::writeWoResponse()

Who changed what in which revision?

User	Revision	Line number	New 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	315:044071756a8d	23	Properties_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	props = propsIn;
rgrover1	315:044071756a8d	28	declHandle = declHandleIn;
rgrover1	315:044071756a8d	29	valueHandle = valueHandleIn;
rgrover1	315:044071756a8d	30	}
rgrover1	315:044071756a8d	31
rgrover1	315:044071756a8d	32	void setup(Gap::Handle_t connectionHandleIn,
rgrover1	315:044071756a8d	33	UUID::ShortUUIDBytes_t uuidIn,
rgrover1	315:044071756a8d	34	Properties_t propsIn,
rgrover1	315:044071756a8d	35	GattAttribute::Handle_t declHandleIn,
rgrover1	315:044071756a8d	36	GattAttribute::Handle_t valueHandleIn) {
rgrover1	315:044071756a8d	37	connHandle = connectionHandleIn;
rgrover1	315:044071756a8d	38	uuid = uuidIn;
rgrover1	315:044071756a8d	39	props = propsIn;
rgrover1	315:044071756a8d	40	declHandle = declHandleIn;
rgrover1	315:044071756a8d	41	valueHandle = valueHandleIn;
rgrover1	315:044071756a8d	42	}
rgrover1	315:044071756a8d	43
rgrover1	315:044071756a8d	44	public:
rgrover1	315:044071756a8d	45	/**
rgrover1	315:044071756a8d	46	* Initiate (or continue) a read for the value attribute, optionally at a
rgrover1	315:044071756a8d	47	* given offset. If the Characteristic or Descriptor to be read is longer
rgrover1	315:044071756a8d	48	* than ATT_MTU - 1, this function must be called multiple times with
rgrover1	315:044071756a8d	49	* appropriate offset to read the complete value.
rgrover1	315:044071756a8d	50	*
rgrover1	315:044071756a8d	51	* @return BLE_ERROR_NONE if a read has been initiated, else
rgrover1	315:044071756a8d	52	* BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1	315:044071756a8d	53	* BLE_STACK_BUSY if some client procedure already in progress.
rgrover1	315:044071756a8d	54	*/
rgrover1	315:044071756a8d	55	virtual ble_error_t read(uint16_t offset = 0) const {
rgrover1	315:044071756a8d	56	uint32_t rc = sd_ble_gattc_read(connHandle, valueHandle, offset);
rgrover1	315:044071756a8d	57	if (rc == NRF_SUCCESS) {
rgrover1	315:044071756a8d	58	return BLE_ERROR_NONE;
rgrover1	315:044071756a8d	59	}
rgrover1	315:044071756a8d	60	switch (rc) {
rgrover1	315:044071756a8d	61	case NRF_ERROR_BUSY:
rgrover1	315:044071756a8d	62	return BLE_STACK_BUSY;
rgrover1	315:044071756a8d	63	case BLE_ERROR_INVALID_CONN_HANDLE:
rgrover1	315:044071756a8d	64	case NRF_ERROR_INVALID_STATE:
rgrover1	315:044071756a8d	65	case NRF_ERROR_INVALID_ADDR:
rgrover1	315:044071756a8d	66	default:
rgrover1	315:044071756a8d	67	return BLE_ERROR_INVALID_STATE;
rgrover1	315:044071756a8d	68	}
rgrover1	315:044071756a8d	69	}
rgrover1	324:1cb5b26ecaca	70
rgrover1	324:1cb5b26ecaca	71	/**
rgrover1	324:1cb5b26ecaca	72	* Perform a write without response procedure.
rgrover1	324:1cb5b26ecaca	73	*
rgrover1	324:1cb5b26ecaca	74	* @param length
rgrover1	324:1cb5b26ecaca	75	* The amount of data being written.
rgrover1	324:1cb5b26ecaca	76	* @param value
rgrover1	324:1cb5b26ecaca	77	* The bytes being written.
rgrover1	324:1cb5b26ecaca	78	*
rgrover1	324:1cb5b26ecaca	79	* @note It is important to note that a write without response will
rgrover1	324:1cb5b26ecaca	80	* <b>consume an application buffer</b>, and will therefore
rgrover1	324:1cb5b26ecaca	81	* generate a onDataWritten() callback when the packet has been
rgrover1	324:1cb5b26ecaca	82	* transmitted. The application should ensure that the buffer is
rgrover1	324:1cb5b26ecaca	83	* valid until the callback.
rgrover1	324:1cb5b26ecaca	84	*
rgrover1	324:1cb5b26ecaca	85	* @retval BLE_ERROR_NONE Successfully started the Write procedure, else
rgrover1	324:1cb5b26ecaca	86	* BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1	324:1cb5b26ecaca	87	* BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1	324:1cb5b26ecaca	88	* BLE_ERROR_NO_MEM if there are no available buffers left to process the request.
rgrover1	324:1cb5b26ecaca	89	*/
rgrover1	324:1cb5b26ecaca	90	virtual ble_error_t writeWoResponse(uint16_t length, const uint8_t *value) const {
rgrover1	324:1cb5b26ecaca	91	ble_gattc_write_params_t writeParams = {
rgrover1	324:1cb5b26ecaca	92	.write_op = BLE_GATT_OP_WRITE_CMD,
rgrover1	324:1cb5b26ecaca	93	// .flags = 0,
rgrover1	324:1cb5b26ecaca	94	.handle = valueHandle,
rgrover1	324:1cb5b26ecaca	95	.offset = 0,
rgrover1	324:1cb5b26ecaca	96	.len = length,
rgrover1	324:1cb5b26ecaca	97	.p_value = const_cast<uint8_t *>(value),
rgrover1	324:1cb5b26ecaca	98	};
rgrover1	324:1cb5b26ecaca	99
rgrover1	324:1cb5b26ecaca	100	uint32_t rc = sd_ble_gattc_write(connHandle, &writeParams);
rgrover1	324:1cb5b26ecaca	101	if (rc == NRF_SUCCESS) {
rgrover1	324:1cb5b26ecaca	102	return BLE_ERROR_NONE;
rgrover1	324:1cb5b26ecaca	103	}
rgrover1	324:1cb5b26ecaca	104	switch (rc) {
rgrover1	324:1cb5b26ecaca	105	case NRF_ERROR_BUSY:
rgrover1	324:1cb5b26ecaca	106	return BLE_STACK_BUSY;
rgrover1	324:1cb5b26ecaca	107	case BLE_ERROR_NO_TX_BUFFERS:
rgrover1	324:1cb5b26ecaca	108	return BLE_ERROR_NO_MEM;
rgrover1	324:1cb5b26ecaca	109	case BLE_ERROR_INVALID_CONN_HANDLE:
rgrover1	324:1cb5b26ecaca	110	case NRF_ERROR_INVALID_STATE:
rgrover1	324:1cb5b26ecaca	111	case NRF_ERROR_INVALID_ADDR:
rgrover1	324:1cb5b26ecaca	112	default:
rgrover1	324:1cb5b26ecaca	113	return BLE_ERROR_INVALID_STATE;
rgrover1	324:1cb5b26ecaca	114	}
rgrover1	324:1cb5b26ecaca	115	}
rgrover1	315:044071756a8d	116	};
rgrover1	315:044071756a8d	117
rgrover1	315:044071756a8d	118	#endif /* __NRF_DISCOVERED_CHARACTERISTIC_H__ */