org.eclipse.kura.bluetooth.le

Interface BluetoothLeGattCharacteristic

@ProviderType
public interface BluetoothLeGattCharacteristic

BluetoothLeGattCharacteristic represents a GATT characteristic. If an application uses value notifications, it has to keep a reference to the corresponding GATT characteristic to avoid that the garbage collector deletes it and removes the associated consumer.

Since:

1.3

Method Summary

Modifier and Type	Method and Description
void	disableValueNotifications() Disables notifications of the value and unregisters the consumer object passed through the corresponding enable method.
void	enableValueNotifications(java.util.function.Consumer<byte[]> callback) Enables notifications for the value and calls accept function of the Consumer object.
BluetoothLeGattDescriptor	findDescriptor(java.util.UUID uuid) Find a BluetoothLeGattDescriptor specifying the UUID of the descriptor.
BluetoothLeGattDescriptor	findDescriptor(java.util.UUID uuid, long timeout) Find a BluetoothLeGattDescriptor specifying the UUID of the descriptor and the timeout in seconds.
java.util.List<BluetoothLeGattDescriptor>	findDescriptors() Returns a list of BluetoothLeGattDescriptors available on this characteristic.
java.util.List<BluetoothLeGattCharacteristicProperties>	getProperties() Returns the list of BluetoothLeGattCharacteristicProperties this characteristic has.
BluetoothLeGattService	getService() Returns the service to which this characteristic belongs to.
java.util.UUID	getUUID() Get the UUID of this characteristic.
byte[]	getValue() Returns the cached value of this characteristic, if any.
boolean	isNotifying() Returns true if notification for changes of this characteristic are activated.
byte[]	readValue() Reads the value of this characteristic.
void	writeValue(byte[] value) Writes the value of this characteristic.

Method Detail

findDescriptor

BluetoothLeGattDescriptor findDescriptor(java.util.UUID uuid)
                                  throws KuraBluetoothResourceNotFoundException

Find a BluetoothLeGattDescriptor specifying the UUID of the descriptor.

Parameters:

uuid - The UUID of the GATT descriptor

Returns:

The BluetoothLeGattDescriptor

Throws:

KuraBluetoothResourceNotFoundException

findDescriptor

BluetoothLeGattDescriptor findDescriptor(java.util.UUID uuid,
                                         long timeout)
                                  throws KuraBluetoothResourceNotFoundException

Find a BluetoothLeGattDescriptor specifying the UUID of the descriptor and the timeout in seconds.

Parameters:

uuid - The UUID of the GATT descriptor

timeout - The timeout for retrieving the characteristic

Returns:

The BluetoothLeGattDescriptor

Throws:

KuraBluetoothResourceNotFoundException

Since:

1.4

findDescriptors

java.util.List<BluetoothLeGattDescriptor> findDescriptors()
                                                   throws KuraBluetoothResourceNotFoundException

Returns a list of BluetoothLeGattDescriptors available on this characteristic.

Returns:

A list of BluetoothLeGattDescriptor

Throws:

KuraBluetoothResourceNotFoundException

readValue

byte[] readValue()
          throws KuraBluetoothIOException

Reads the value of this characteristic.

Returns:

A byte[] containing the value of this characteristic.

Throws:

KuraBluetoothIOException

enableValueNotifications

void enableValueNotifications(java.util.function.Consumer<byte[]> callback)
                       throws KuraBluetoothNotificationException

Enables notifications for the value and calls accept function of the Consumer object. It enables notifications for this characteristic at BLE level. If an application uses value notifications, it has to keep a reference to the corresponding GATT characteristic to avoid that the garbage collector deletes it and removes the associated consumer.

Parameters:

callback - A Consumer object. Its accept function will be called when a notification is issued.

Throws:

KuraBluetoothNotificationException

disableValueNotifications

void disableValueNotifications()
                        throws KuraBluetoothNotificationException

Disables notifications of the value and unregisters the consumer object passed through the corresponding enable method. It disables notifications at BLE level for this characteristic.

Throws:

KuraBluetoothNotificationException

writeValue

void writeValue(byte[] value)
         throws KuraBluetoothIOException

Writes the value of this characteristic.

Parameters:

value - The data as byte[] to be written

Throws:

KuraBluetoothIOException

getUUID

java.util.UUID getUUID()

Get the UUID of this characteristic.

Returns:

The 128 byte UUID of this characteristic, NULL if an error occurred

getService

BluetoothLeGattService getService()

Returns the service to which this characteristic belongs to.

Returns:

The BluetoothLeGattService.

getValue

byte[] getValue()

Returns the cached value of this characteristic, if any.

Returns:

The cached value of this characteristic.

isNotifying

boolean isNotifying()

Returns true if notification for changes of this characteristic are activated.

Returns:

True if notificatios are activated.

getProperties

java.util.List<BluetoothLeGattCharacteristicProperties> getProperties()

Returns the list of BluetoothLeGattCharacteristicProperties this characteristic has.

Returns:

A list of BluetoothLeGattCharacteristicProperties for this characteristic.