Matthew Lister / BLE_API

BLE_API

public/DiscoveredCharacteristic.h@499:db9bc083f91e, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:03 2015 +0100
Revision:
499:db9bc083f91e
Parent:
497:926d444599e8
Child:
501:ff6801633d2c
Synchronized with git rev 92f61ed8

Author: Rohit Grover

fix API header for writeWoResponse()

Who changed what in which revision?

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