Package com.github.hypfvieh.bluetooth.wrapper

Class BluetoothGattCharacteristic

java.lang.Object

com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject

com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic

public class BluetoothGattCharacteristic
extends AbstractBluetoothObject

Wrapper class which represents a GATT characteristic on a remote device.

Author:

hypfvieh

Constructor Summary

Constructors

Constructor	Description
BluetoothGattCharacteristic(GattCharacteristic1 _gattCharacteristic, BluetoothGattService _service, String _dbusPath, org.freedesktop.dbus.connections.impl.DBusConnection _dbusConnection)

Method Summary

Modifier and Type	Method	Description
List<String>	getFlags()	From bluez Documentation:
BluetoothGattDescriptor	getGattDescriptorByUuid(String _uuid)	Return the BluetoothGattDescriptor object for the given UUID.
List<BluetoothGattDescriptor>	getGattDescriptors()	Get the currently available GATT descriptors. Will issue a query if refreshGattDescriptors() wasn't called before.
protected Class<? extends org.freedesktop.dbus.interfaces.DBusInterface>	getInterfaceClass()	DBus-Interface class used in this wrapper object.
GattCharacteristic1	getRawGattCharacteristic()	Get the raw GattCharacteristic1 object behind this wrapper.
BluetoothGattService	getService()	Returns the BluetoothGattService object which provides this BluetoothGattCharacteristic.
String	getUuid()	From bluez Documentation:
byte[]	getValue()	From bluez Documentation:
Boolean	isNotifying()	From bluez Documentation: True, if notifications or indications on this characteristic are currently enabled.
byte[]	readValue(Map<String,Object> _options)	Read a value from the GATT characteristics register. Supported options:
void	refreshGattDescriptors()	Re-queries the GattCharacteristics from the device.
void	startNotify()	From bluez Documentation:
void	stopNotify()	From bluez Documentation:
String	toString()
void	writeValue(byte[] _value, Map<String,Object> _options)	Write value to the GATT characteristic register. Supported options:

Methods inherited from class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject

byteListToByteArray, getBluetoothType, getDbusConnection, getDbusPath, getRemoteObjects, getTyped, optionsToVariantMap, setTyped, toPrimitives

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BluetoothGattCharacteristic

public BluetoothGattCharacteristic(GattCharacteristic1 _gattCharacteristic,
 BluetoothGattService _service,
 String _dbusPath,
 org.freedesktop.dbus.connections.impl.DBusConnection _dbusConnection)

Method Details

getInterfaceClass

protected Class<? extends org.freedesktop.dbus.interfaces.DBusInterface> getInterfaceClass()

DBus-Interface class used in this wrapper object.

Specified by:

getInterfaceClass in class AbstractBluetoothObject

Returns:

class which implements the interface

refreshGattDescriptors

public void refreshGattDescriptors()

Re-queries the GattCharacteristics from the device.

getGattDescriptors

public List<BluetoothGattDescriptor> getGattDescriptors()

Get the currently available GATT descriptors.
Will issue a query if refreshGattDescriptors() wasn't called before.

Returns:

List, maybe empty but never null

getGattDescriptorByUuid

public BluetoothGattDescriptor getGattDescriptorByUuid(String _uuid)

Return the BluetoothGattDescriptor object for the given UUID.

Parameters:

_uuid - uuid

Returns:

maybe null if not found

writeValue

public void writeValue(byte[] _value,
 Map<String,Object> _options)
                throws BluezFailedException,
BluezInProgressException,
BluezNotPermittedException,
BluezNotAuthorizedException,
BluezNotSupportedException,
BluezInvalidValueLengthException

Write value to the GATT characteristic register.
Supported options:

 "offset": uint16 offset
 "device": Object Device (Server only)
 

Parameters:

_value - value to write

_options - options to use

Throws:

BluezFailedException - on failure if operation failed

BluezInProgressException - when operation already in progress if operation is already in progress

BluezNotPermittedException - if operation is not permitted

BluezNotAuthorizedException - when not authorized if not authorized

BluezNotSupportedException - when operation not supported if not supported

BluezInvalidValueLengthException - if invalid length

readValue

public byte[] readValue(Map<String,Object> _options)
                 throws BluezFailedException,
BluezInProgressException,
BluezNotPermittedException,
BluezNotAuthorizedException,
BluezNotSupportedException,
BluezInvalidOffsetException

Read a value from the GATT characteristics register.
Supported options:

 "offset": uint16 offset
 "device": Object Device (Server only)
 

Parameters:

_options - options to use

Returns:

byte array, maybe null

Throws:

BluezFailedException - on failure if anything failed

BluezInProgressException - when operation already in progress if already in progress

BluezNotPermittedException - if not permitted

BluezNotAuthorizedException - when not authorized if not authorized

BluezNotSupportedException - when operation not supported if not supported

BluezInvalidOffsetException - if offset is invalid

getUuid

public String getUuid()

From bluez Documentation:

128-bit characteristic UUID.

Returns:

uuid, maybe null

getService

public BluetoothGattService getService()

Returns the BluetoothGattService object which provides this BluetoothGattCharacteristic.

Returns:

GattService, maybe null

getRawGattCharacteristic

public GattCharacteristic1 getRawGattCharacteristic()

Get the raw GattCharacteristic1 object behind this wrapper.

Returns:

GattCharacteristic1, maybe null

getValue

public byte[] getValue()

From bluez Documentation:

The cached value of the characteristic. This property
gets updated only after a successful read request and
when a notification or indication is received, upon
which a PropertiesChanged signal will be emitted.

Returns:

cached characteristics value, maybe null

isNotifying

public Boolean isNotifying()

From bluez Documentation:
True, if notifications or indications on this characteristic are currently enabled.

Returns:

maybe null if feature is not supported

getFlags

public List<String> getFlags()

From bluez Documentation:

Defines how the characteristic value can be used. See
Core spec "Table 3.5: Characteristic Properties bit
field", and "Table 3.8: Characteristic Extended
Properties bit field".

 Allowed values:
         "broadcast"
         "read"
         "write-without-response"
         "write"
         "notify"
         "indicate"
         "authenticated-signed-writes"
         "reliable-write"
         "writable-auxiliaries"
         "encrypt-read"
         "encrypt-write"
         "encrypt-authenticated-read"
         "encrypt-authenticated-write"
         "secure-read" (Server only)
         "secure-write" (Server only)
 

Returns:

List of String, maybe null

startNotify

public void startNotify()
                 throws BluezFailedException,
BluezInProgressException,
BluezNotSupportedException,
BluezNotPermittedException,
BluezNotConnectedException

From bluez Documentation:

Starts a notification session from this characteristic if it supports value notifications or indications.

Throws:

BluezFailedException - on failure if operation failed

BluezInProgressException - when operation already in progress if operation already in progress

BluezNotSupportedException - when operation not supported if operation is not supported

BluezNotPermittedException - if access is not permitted

BluezNotConnectedException - when bluez is not connected

stopNotify

public void stopNotify()
                throws BluezFailedException

From bluez Documentation:

This method will cancel any previous StartNotify transaction. Note that notifications from a characteristic are shared between sessions thus calling StopNotify will release a single session.

Throws:

BluezFailedException - on failure on any error

toString

public String toString()

Overrides:

toString in class Object