test
Dependents: BLE_PowerBank_HeyFaradey
Fork of BLE_API by
Diff: ble/DiscoveredCharacteristic.h
- Revision:
- 933:3ec277a0d780
- Parent:
- 931:97e69faa4a5c
- Child:
- 934:5e3acddfcd82
--- a/ble/DiscoveredCharacteristic.h Thu Nov 26 12:52:05 2015 +0000 +++ b/ble/DiscoveredCharacteristic.h Thu Nov 26 12:52:06 2015 +0000 @@ -29,7 +29,7 @@ class DiscoveredCharacteristic { public: struct Properties_t { - uint8_t _broadcast :1; /**< Broadcasting the value permitted. */ + uint8_t _broadcast :1; /**< Broadcasting of the value permitted. */ uint8_t _read :1; /**< Reading the value permitted. */ uint8_t _writeWoResp :1; /**< Writing the value with Write Command permitted. */ uint8_t _write :1; /**< Writing the value with Write Request permitted. */ @@ -47,8 +47,8 @@ bool authSignedWrite(void) const {return _authSignedWrite;} private: - operator uint8_t() const; /* Disallow implicit conversion into an integer. */ - operator unsigned() const; /* Disallow implicit conversion into an integer. */ + operator uint8_t() const; /* disallow implicit conversion into an integer */ + operator unsigned() const; /* disallow implicit conversion into an integer */ }; /** @@ -72,19 +72,17 @@ /** * Initiate (or continue) a read for the value attribute, optionally at a - * given offset. If the characteristic or descriptor to be read is longer + * given offset. If the Characteristic or Descriptor to be read is longer * than ATT_MTU - 1, this function must be called multiple times with * appropriate offset to read the complete value. * - * @return BLE_ERROR_NONE if a read has been initiated, or + * @return BLE_ERROR_NONE if a read has been initiated, else * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or - * BLE_STACK_BUSY if some client procedure is already in progress, or + * BLE_STACK_BUSY if some client procedure already in progress, or * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties. */ ble_error_t read(uint16_t offset = 0) const; - ble_error_t read(uint16_t offset, const GattClient::ReadCallback_t& onRead) const; - /** * Perform a write without response procedure. * @@ -99,9 +97,9 @@ * writeWoResponse operations; the user may want to use the onDataSent() * callback for flow-control. * - * @retval BLE_ERROR_NONE Successfully started the Write procedure, or + * @retval BLE_ERROR_NONE Successfully started the Write procedure, else * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or - * BLE_STACK_BUSY if some client procedure is already in progress, or + * BLE_STACK_BUSY if some client procedure already in progress, or * BLE_ERROR_NO_MEM if there are no available buffers left to process the request, or * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties. */ @@ -112,7 +110,7 @@ * * @param callback * @param matchingUUID - * Filter for descriptors. Defaults to wildcard which will discover all descriptors. + * filter for descriptors. Defaults to wildcard which will discover all descriptors. * * @return BLE_ERROR_NONE if descriptor discovery is launched successfully; else an appropriate error. */ @@ -129,19 +127,14 @@ * @note It is important to note that a write will generate * an onDataWritten() callback when the peer acknowledges the request. * - * @retval BLE_ERROR_NONE Successfully started the Write procedure, or + * @retval BLE_ERROR_NONE Successfully started the Write procedure, else * BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or - * BLE_STACK_BUSY if some client procedure is already in progress, or + * BLE_STACK_BUSY if some client procedure already in progress, or * BLE_ERROR_NO_MEM if there are no available buffers left to process the request, or * BLE_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties. */ ble_error_t write(uint16_t length, const uint8_t *value) const; - /** - * Same as above but register the callback wich will be called once the data has been written - */ - ble_error_t write(uint16_t length, const uint8_t *value, const GattClient::WriteCallback_t& onRead) const; - void setupLongUUID(UUID::LongUUIDBytes_t longUUID) { uuid.setupLong(longUUID); }