Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

public/DiscoveredCharacteristic.h@524:6e97ab392e2a, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:06 2015 +0100
Revision:
524:6e97ab392e2a
Child:
565:a3fb221c0813
Synchronized with git rev 43177a02

Author: Rohit Grover

remove un-necessary comments in GattClient.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 524:6e97ab392e2a 1 /* mbed Microcontroller Library
rgrover1 524:6e97ab392e2a 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 524:6e97ab392e2a 3 *
rgrover1 524:6e97ab392e2a 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 524:6e97ab392e2a 5 * you may not use this file except in compliance with the License.
rgrover1 524:6e97ab392e2a 6 * You may obtain a copy of the License at
rgrover1 524:6e97ab392e2a 7 *
rgrover1 524:6e97ab392e2a 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 524:6e97ab392e2a 9 *
rgrover1 524:6e97ab392e2a 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 524:6e97ab392e2a 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 524:6e97ab392e2a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 524:6e97ab392e2a 13 * See the License for the specific language governing permissions and
rgrover1 524:6e97ab392e2a 14 * limitations under the License.
rgrover1 524:6e97ab392e2a 15 */
rgrover1 524:6e97ab392e2a 16
rgrover1 524:6e97ab392e2a 17 #ifndef __DISCOVERED_CHARACTERISTIC_H__
rgrover1 524:6e97ab392e2a 18 #define __DISCOVERED_CHARACTERISTIC_H__
rgrover1 524:6e97ab392e2a 19
rgrover1 524:6e97ab392e2a 20 #include "UUID.h"
rgrover1 524:6e97ab392e2a 21 #include "Gap.h"
rgrover1 524:6e97ab392e2a 22 #include "GattAttribute.h"
rgrover1 524:6e97ab392e2a 23 #include "GattClient.h"
rgrover1 524:6e97ab392e2a 24
rgrover1 524:6e97ab392e2a 25 /**
rgrover1 524:6e97ab392e2a 26 * Structure for holding information about the service and the characteristics
rgrover1 524:6e97ab392e2a 27 * found during the discovery process.
rgrover1 524:6e97ab392e2a 28 */
rgrover1 524:6e97ab392e2a 29 class DiscoveredCharacteristic {
rgrover1 524:6e97ab392e2a 30 public:
rgrover1 524:6e97ab392e2a 31 struct Properties_t {
rgrover1 524:6e97ab392e2a 32 uint8_t _broadcast :1; /**< Broadcasting of the value permitted. */
rgrover1 524:6e97ab392e2a 33 uint8_t _read :1; /**< Reading the value permitted. */
rgrover1 524:6e97ab392e2a 34 uint8_t _writeWoResp :1; /**< Writing the value with Write Command permitted. */
rgrover1 524:6e97ab392e2a 35 uint8_t _write :1; /**< Writing the value with Write Request permitted. */
rgrover1 524:6e97ab392e2a 36 uint8_t _notify :1; /**< Notications of the value permitted. */
rgrover1 524:6e97ab392e2a 37 uint8_t _indicate :1; /**< Indications of the value permitted. */
rgrover1 524:6e97ab392e2a 38 uint8_t _authSignedWrite :1; /**< Writing the value with Signed Write Command permitted. */
rgrover1 524:6e97ab392e2a 39
rgrover1 524:6e97ab392e2a 40 public:
rgrover1 524:6e97ab392e2a 41 bool broadcast(void) const {return _broadcast; }
rgrover1 524:6e97ab392e2a 42 bool read(void) const {return _read; }
rgrover1 524:6e97ab392e2a 43 bool writeWoResp(void) const {return _writeWoResp; }
rgrover1 524:6e97ab392e2a 44 bool write(void) const {return _write; }
rgrover1 524:6e97ab392e2a 45 bool notify(void) const {return _notify; }
rgrover1 524:6e97ab392e2a 46 bool indicate(void) const {return _indicate; }
rgrover1 524:6e97ab392e2a 47 bool authSignedWrite(void) const {return _authSignedWrite;}
rgrover1 524:6e97ab392e2a 48
rgrover1 524:6e97ab392e2a 49 private:
rgrover1 524:6e97ab392e2a 50 operator uint8_t() const; /* disallow implicit conversion into an integer */
rgrover1 524:6e97ab392e2a 51 operator unsigned() const; /* disallow implicit conversion into an integer */
rgrover1 524:6e97ab392e2a 52 };
rgrover1 524:6e97ab392e2a 53
rgrover1 524:6e97ab392e2a 54 /**
rgrover1 524:6e97ab392e2a 55 * Initiate (or continue) a read for the value attribute, optionally at a
rgrover1 524:6e97ab392e2a 56 * given offset. If the Characteristic or Descriptor to be read is longer
rgrover1 524:6e97ab392e2a 57 * than ATT_MTU - 1, this function must be called multiple times with
rgrover1 524:6e97ab392e2a 58 * appropriate offset to read the complete value.
rgrover1 524:6e97ab392e2a 59 *
rgrover1 524:6e97ab392e2a 60 * @return BLE_ERROR_NONE if a read has been initiated, else
rgrover1 524:6e97ab392e2a 61 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 524:6e97ab392e2a 62 * BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1 524:6e97ab392e2a 63 * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties.
rgrover1 524:6e97ab392e2a 64 */
rgrover1 524:6e97ab392e2a 65 ble_error_t read(uint16_t offset = 0) const;
rgrover1 524:6e97ab392e2a 66
rgrover1 524:6e97ab392e2a 67 /**
rgrover1 524:6e97ab392e2a 68 * Perform a write without response procedure.
rgrover1 524:6e97ab392e2a 69 *
rgrover1 524:6e97ab392e2a 70 * @param length
rgrover1 524:6e97ab392e2a 71 * The amount of data being written.
rgrover1 524:6e97ab392e2a 72 * @param value
rgrover1 524:6e97ab392e2a 73 * The bytes being written.
rgrover1 524:6e97ab392e2a 74 *
rgrover1 524:6e97ab392e2a 75 * @note It is important to note that a write without response will generate
rgrover1 524:6e97ab392e2a 76 * an onDataSent() callback when the packet has been transmitted. There
rgrover1 524:6e97ab392e2a 77 * will be a BLE-stack specific limit to the number of pending
rgrover1 524:6e97ab392e2a 78 * writeWoResponse operations; the user may want to use the onDataSent()
rgrover1 524:6e97ab392e2a 79 * callback for flow-control.
rgrover1 524:6e97ab392e2a 80 *
rgrover1 524:6e97ab392e2a 81 * @retval BLE_ERROR_NONE Successfully started the Write procedure, else
rgrover1 524:6e97ab392e2a 82 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 524:6e97ab392e2a 83 * BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1 524:6e97ab392e2a 84 * BLE_ERROR_NO_MEM if there are no available buffers left to process the request, or
rgrover1 524:6e97ab392e2a 85 * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties.
rgrover1 524:6e97ab392e2a 86 */
rgrover1 524:6e97ab392e2a 87 ble_error_t writeWoResponse(uint16_t length, const uint8_t *value) const;
rgrover1 524:6e97ab392e2a 88
rgrover1 524:6e97ab392e2a 89 /**
rgrover1 524:6e97ab392e2a 90 * Perform a write procedure.
rgrover1 524:6e97ab392e2a 91 *
rgrover1 524:6e97ab392e2a 92 * @param length
rgrover1 524:6e97ab392e2a 93 * The amount of data being written.
rgrover1 524:6e97ab392e2a 94 * @param value
rgrover1 524:6e97ab392e2a 95 * The bytes being written.
rgrover1 524:6e97ab392e2a 96 *
rgrover1 524:6e97ab392e2a 97 * @note It is important to note that a write will generate
rgrover1 524:6e97ab392e2a 98 * an onDataWritten() callback when the peer acknowledges the request.
rgrover1 524:6e97ab392e2a 99 *
rgrover1 524:6e97ab392e2a 100 * @retval BLE_ERROR_NONE Successfully started the Write procedure, else
rgrover1 524:6e97ab392e2a 101 * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
rgrover1 524:6e97ab392e2a 102 * BLE_STACK_BUSY if some client procedure already in progress, or
rgrover1 524:6e97ab392e2a 103 * BLE_ERROR_NO_MEM if there are no available buffers left to process the request, or
rgrover1 524:6e97ab392e2a 104 * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties.
rgrover1 524:6e97ab392e2a 105 */
rgrover1 524:6e97ab392e2a 106 ble_error_t write(uint16_t length, const uint8_t *value) const;
rgrover1 524:6e97ab392e2a 107
rgrover1 524:6e97ab392e2a 108 static void setupOnDataRead(GattClient::ReadCallback_t callback) {
rgrover1 524:6e97ab392e2a 109 onDataReadCallback = callback;
rgrover1 524:6e97ab392e2a 110 }
rgrover1 524:6e97ab392e2a 111
rgrover1 524:6e97ab392e2a 112 static void setupOnDataWrite(GattClient::WriteCallback_t callback) {
rgrover1 524:6e97ab392e2a 113 onDataWriteCallback = callback;
rgrover1 524:6e97ab392e2a 114 }
rgrover1 524:6e97ab392e2a 115
rgrover1 524:6e97ab392e2a 116 void setupLongUUID(UUID::LongUUIDBytes_t longUUID) {
rgrover1 524:6e97ab392e2a 117 uuid.setupLong(longUUID);
rgrover1 524:6e97ab392e2a 118 }
rgrover1 524:6e97ab392e2a 119
rgrover1 524:6e97ab392e2a 120 public:
rgrover1 524:6e97ab392e2a 121 UUID::ShortUUIDBytes_t getShortUUID(void) const {
rgrover1 524:6e97ab392e2a 122 return uuid.getShortUUID();
rgrover1 524:6e97ab392e2a 123 }
rgrover1 524:6e97ab392e2a 124
rgrover1 524:6e97ab392e2a 125 const Properties_t& getProperties(void) const {
rgrover1 524:6e97ab392e2a 126 return props;
rgrover1 524:6e97ab392e2a 127 }
rgrover1 524:6e97ab392e2a 128
rgrover1 524:6e97ab392e2a 129 const GattAttribute::Handle_t& getDeclHandle(void) const {
rgrover1 524:6e97ab392e2a 130 return declHandle;
rgrover1 524:6e97ab392e2a 131 }
rgrover1 524:6e97ab392e2a 132 const GattAttribute::Handle_t& getValueHandle(void) const {
rgrover1 524:6e97ab392e2a 133 return valueHandle;
rgrover1 524:6e97ab392e2a 134 }
rgrover1 524:6e97ab392e2a 135
rgrover1 524:6e97ab392e2a 136 public:
rgrover1 524:6e97ab392e2a 137 DiscoveredCharacteristic() : gattc(NULL),
rgrover1 524:6e97ab392e2a 138 uuid(UUID::ShortUUIDBytes_t(0)),
rgrover1 524:6e97ab392e2a 139 props(),
rgrover1 524:6e97ab392e2a 140 declHandle(GattAttribute::INVALID_HANDLE),
rgrover1 524:6e97ab392e2a 141 valueHandle(GattAttribute::INVALID_HANDLE) {
rgrover1 524:6e97ab392e2a 142 /* empty */
rgrover1 524:6e97ab392e2a 143 }
rgrover1 524:6e97ab392e2a 144
rgrover1 524:6e97ab392e2a 145 protected:
rgrover1 524:6e97ab392e2a 146 GattClient *gattc;
rgrover1 524:6e97ab392e2a 147
rgrover1 524:6e97ab392e2a 148 protected:
rgrover1 524:6e97ab392e2a 149 UUID uuid;
rgrover1 524:6e97ab392e2a 150 Properties_t props;
rgrover1 524:6e97ab392e2a 151 GattAttribute::Handle_t declHandle;
rgrover1 524:6e97ab392e2a 152 GattAttribute::Handle_t valueHandle;
rgrover1 524:6e97ab392e2a 153
rgrover1 524:6e97ab392e2a 154 Gap::Handle_t connHandle;
rgrover1 524:6e97ab392e2a 155
rgrover1 524:6e97ab392e2a 156 public:
rgrover1 524:6e97ab392e2a 157 static GattClient::ReadCallback_t onDataReadCallback;
rgrover1 524:6e97ab392e2a 158 static GattClient::WriteCallback_t onDataWriteCallback;
rgrover1 524:6e97ab392e2a 159 };
rgrover1 524:6e97ab392e2a 160
rgrover1 524:6e97ab392e2a 161 #endif /*__DISCOVERED_CHARACTERISTIC_H__*/