Andrew Fox / BLE_API

add "LE Device Address" 0x1B to advertising data types

Fork of BLE_API by Bluetooth Low Energy

Embed: (wiki syntax)

« Back to documentation index

DiscoveredCharacteristic Class Reference
Public Member Functions | Friends

DiscoveredCharacteristic Class Reference

Representation of a characteristic discovered during a GattClient discovery procedure (see GattClient::launchServiceDiscovery ). More...

#include <DiscoveredCharacteristic.h>

Public Member Functions

ble_error_t read (uint16_t offset=0) const
 Initiate (or continue) a read for the value attribute, optionally at a given offset.
ble_error_t read (uint16_t offset, const GattClient::ReadCallback_t &onRead) const
 Same as read(uint16_t) const but allow the user to register a callback which will be fired once the read is done.
ble_error_t writeWoResponse (uint16_t length, const uint8_t *value) const
 Perform a write without response procedure.
ble_error_t discoverDescriptors (const CharacteristicDescriptorDiscovery::DiscoveryCallback_t &onDescriptorDiscovered, const CharacteristicDescriptorDiscovery::TerminationCallback_t &onTermination) const
 Initiate a GATT Characteristic Descriptor Discovery procedure for descriptors within this characteristic.
ble_error_t write (uint16_t length, const uint8_t *value) const
 Perform a write procedure.
ble_error_t write (uint16_t length, const uint8_t *value, const GattClient::WriteCallback_t &onWrite) const
 Same as write(uint16_t, const uint8_t *) const but register a callback which will be called once the data has been written.
const UUID & getUUID (void) const
 Get the UUID of the discovered characteristic.
const Properties_t & getProperties (void) const
 Get the properties of this characteristic.
GattAttribute::Handle_t getDeclHandle (void) const
 Get the declaration handle of this characteristic.
GattAttribute::Handle_t getValueHandle (void) const
 Return the handle used to access the value of this characteristic.
GattAttribute::Handle_t getLastHandle (void) const
 Return the last handle of the characteristic definition.
GattClient * getGattClient ()
 Return the GattClient which can operate on this characteristic.
const GattClient * getGattClient () const
 Return the GattClient which can operate on this characteristic.
Gap::Handle_t getConnectionHandle () const
 Return the connection handle to the GattServer which contain this characteristic.

Friends

bool operator== (const DiscoveredCharacteristic &lhs, const DiscoveredCharacteristic &rhs)
 "Equal to" operator for DiscoveredCharacteristic
bool operator!= (const DiscoveredCharacteristic &lhs, const DiscoveredCharacteristic &rhs)
 "Not equal to" operator for DiscoveredCharacteristic

Detailed Description

Representation of a characteristic discovered during a GattClient discovery procedure (see GattClient::launchServiceDiscovery ).

Provide detailed informations about a discovered characteristic like:

Definition at line 43 of file DiscoveredCharacteristic.h.

Member Function Documentation

ble_error_t discoverDescriptors ( const CharacteristicDescriptorDiscovery::DiscoveryCallback_t &  onDescriptorDiscovered,
const CharacteristicDescriptorDiscovery::TerminationCallback_t &  onTermination 
) const

Initiate a GATT Characteristic Descriptor Discovery procedure for descriptors within this characteristic.

Parameters:
[in]onDescriptorDiscoveredThis callback will be called every time a descriptor is discovered
[in]onTerminationThis callback will be called when the discovery process is over.
Returns:
BLE_ERROR_NONE if descriptor discovery is launched successfully; else an appropriate error.

Definition at line 154 of file DiscoveredCharacteristic.cpp.

Gap::Handle_t getConnectionHandle (  ) const

Return the connection handle to the GattServer which contain this characteristic.

Returns:
the connection handle to the GattServer which contain this characteristic.

Definition at line 271 of file DiscoveredCharacteristic.h.

GattAttribute::Handle_t getDeclHandle ( void   ) const

Get the declaration handle of this characteristic.

The declaration handle is the first handle of a characteristic definition. The value accessible at this handle contains the following informations:

  • The characteristics properties (see Properties_t). This value can be accessed by using getProperties .
  • The characteristic value attribute handle. This field can be accessed by using getValueHandle .
  • The characteristic UUID, this value can be accessed by using the function getUUID .
    Returns:
    the declaration handle of this characteristic.

Definition at line 220 of file DiscoveredCharacteristic.h.

const GattClient* getGattClient (  ) const

Return the GattClient which can operate on this characteristic.

Returns:
The GattClient which can operate on this characteristic.

Definition at line 261 of file DiscoveredCharacteristic.h.

GattClient* getGattClient (  )

Return the GattClient which can operate on this characteristic.

Returns:
The GattClient which can operate on this characteristic.

Definition at line 253 of file DiscoveredCharacteristic.h.

GattAttribute::Handle_t getLastHandle ( void   ) const

Return the last handle of the characteristic definition.

A Characteristic definition can contain a lot of handles:

  • one for the declaration (see getDeclHandle)
  • one for the value (see getValueHandle)
  • zero of more for the characteristic descriptors. This handle is the last handle of the characteristic definition.
    Returns:
    The last handle of this characteristic definition.

Definition at line 245 of file DiscoveredCharacteristic.h.

const Properties_t& getProperties ( void   ) const

Get the properties of this characteristic.

Returns:
the set of properties of this characteristic

Definition at line 203 of file DiscoveredCharacteristic.h.

const UUID& getUUID ( void   ) const

Get the UUID of the discovered characteristic.

Returns:
the UUID of this characteristic

Definition at line 195 of file DiscoveredCharacteristic.h.

GattAttribute::Handle_t getValueHandle ( void   ) const

Return the handle used to access the value of this characteristic.

This handle is the one provided in the characteristic declaration value. Usually, it is equal to getDeclHandle() + 1. But it is not always the case. Anyway, users are allowed to use getDeclHandle() + 1 to access the value of a characteristic.

Returns:
The handle to access the value of this characteristic.

Definition at line 232 of file DiscoveredCharacteristic.h.

ble_error_t read ( uint16_t  offset,
const GattClient::ReadCallback_t &  onRead 
) const

Same as read(uint16_t) const but allow the user to register a callback which will be fired once the read is done.

Parameters:
offset[in]The position - in the characteristic value bytes stream - where the read operation begin.
onRead[in]Continuation of the read operation

Definition at line 69 of file DiscoveredCharacteristic.cpp.

ble_error_t read ( uint16_t  offset = 0 ) const

Initiate (or continue) a read for the value attribute, optionally at a 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.

Parameters:
offset[in]The position - in the characteristic value bytes stream - where the read operation begin.
Returns:
BLE_ERROR_NONE if a read has been initiated, or 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_ERROR_OPERATION_NOT_PERMITTED due to the characteristic's properties.

Definition at line 21 of file DiscoveredCharacteristic.cpp.

ble_error_t write ( uint16_t  length,
const uint8_t *  value 
) const

Perform a write procedure.

Parameters:
[in]lengthThe amount of data being written.
[in]valueThe bytes being written.
Note:
It is important to note that a write will generate an onDataWritten() callback when the peer acknowledges the request.
Return values:
BLE_ERROR_NONESuccessfully started the Write procedure, or 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_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.

Definition at line 81 of file DiscoveredCharacteristic.cpp.

ble_error_t write ( uint16_t  length,
const uint8_t *  value,
const GattClient::WriteCallback_t &  onWrite 
) const

Same as write(uint16_t, const uint8_t *) const but register a callback which will be called once the data has been written.

Parameters:
[in]lengthThe amount of bytes to write.
[in]valueThe bytes to write.
[in]onReadContinuation callback for the write operation

Definition at line 143 of file DiscoveredCharacteristic.cpp.

ble_error_t writeWoResponse ( uint16_t  length,
const uint8_t *  value 
) const

Perform a write without response procedure.

Parameters:
[in]lengthThe amount of data being written.
[in]valueThe bytes being written.
Note:
It is important to note that a write without response will generate an onDataSent() callback when the packet has been transmitted. There will be a BLE-stack specific limit to the number of pending writeWoResponse operations; the user may want to use the onDataSent() callback for flow-control.
Return values:
BLE_ERROR_NONESuccessfully started the Write procedure, or 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_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.

Definition at line 95 of file DiscoveredCharacteristic.cpp.

Friends And Related Function Documentation

bool operator!= ( const DiscoveredCharacteristic &  lhs,
const DiscoveredCharacteristic &  rhs 
) [friend]

"Not equal to" operator for DiscoveredCharacteristic

Parameters:
lhs[in]The right hand side of the expression
rhs[in]The left hand side of the expression
Returns:
true if operands are not equals, false otherwise.

Definition at line 301 of file DiscoveredCharacteristic.h.

bool operator== ( const DiscoveredCharacteristic &  lhs,
const DiscoveredCharacteristic &  rhs 
) [friend]

"Equal to" operator for DiscoveredCharacteristic

Parameters:
lhs[in]The left hand side of the equality expression
rhs[in]The right hand side of the equality expression
Returns:
true if operands are equals, false otherwise.

Definition at line 283 of file DiscoveredCharacteristic.h.

Generated on Fri Jul 15 2022 20:49:45 by  doxygen 1.7.2