Package com.github.hypfvieh.bluetooth.wrapper

Class BluetoothGattDescriptor

java.lang.Object

com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject

com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor

public class BluetoothGattDescriptor
extends AbstractBluetoothObject

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

Author:

hypfvieh

Constructor Summary

Constructors

Constructor	Description
BluetoothGattDescriptor(GattDescriptor1 _descriptor, BluetoothGattCharacteristic _characteristicWrapper, String _dbusPath, org.freedesktop.dbus.connections.impl.DBusConnection _dbusConnection)

Method Summary

Modifier and Type	Method	Description
BluetoothGattCharacteristic	getCharacteristic()	Get the BluetoothGattCharacteristic instance behind this BluetoothGattDescriptor object.
List<String>	getFlags()	From bluez Documentation:
protected Class<? extends org.freedesktop.dbus.interfaces.DBusInterface>	getInterfaceClass()	DBus-Interface class used in this wrapper object.
GattDescriptor1	getRawCharacteric()	Get the raw GattDescriptor1 object behind this wrapper.
String	getUuid()	From bluez Documentation:
byte[]	getValue()	From bluez Documentation:
byte[]	readValue(Map<String,Object> _options)	Read a value from the GATT descriptor register. Supported options:
String	toString()
void	writeValue(byte[] _value, Map<String,Object> _options)	Write value to the GATT descriptor 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

BluetoothGattDescriptor

public BluetoothGattDescriptor(GattDescriptor1 _descriptor,
 BluetoothGattCharacteristic _characteristicWrapper,
 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

writeValue

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

Write value to the GATT descriptor 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 anything failed

BluezInProgressException - when operation already in progress if operation in progress

BluezNotPermittedException - if operation not permitted

BluezNotAuthorizedException - when not authorized if not authorized

BluezNotSupportedException - when operation not supported if not supported

BluezInvalidValueLengthException - if length is invalid

readValue

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

Read a value from the GATT descriptor 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 operation in progress

BluezNotPermittedException - if operation not permitted

BluezNotAuthorizedException - when not authorized if not authorized

BluezNotSupportedException - when operation not supported if not supported

getUuid

public String getUuid()

From bluez Documentation:

128-bit descriptor UUID.

Returns:

uuid, maybe null

getCharacteristic

public BluetoothGattCharacteristic getCharacteristic()

Get the BluetoothGattCharacteristic instance behind this BluetoothGattDescriptor object.

Returns:

BluetoothGattCharacteristic, maybe null

getRawCharacteric

public GattDescriptor1 getRawCharacteric()

Get the raw GattDescriptor1 object behind this wrapper.

Returns:

GattDescriptor1, maybe null

getValue

public byte[] getValue()

From bluez Documentation:

The cached value of the descriptor. This property
gets updated only after a successful read request, upon
which a PropertiesChanged signal will be emitted.

Returns:

byte array, maybe null

getFlags

public List<String> getFlags()

From bluez Documentation:

Defines how the descriptor value can be used.

Possible values:

      "read"
      "write"
      "encrypt-read"
      "encrypt-write"
      "encrypt-authenticated-read"
      "encrypt-authenticated-write"
      "secure-read" (Server Only)
      "secure-write" (Server Only)
 

Returns:

List of String, maybe null

toString

public String toString()

Overrides:

toString in class Object