com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus Show documentation
Show all versions of bluez-dbus Show documentation
Java native bluetooth library which uses bluez via dbus (linux only)
package com.github.hypfvieh.bluetooth.wrapper;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.bluez.GattCharacteristic1;
import org.bluez.GattDescriptor1;
import org.bluez.exceptions.BluezFailedException;
import org.bluez.exceptions.BluezInProgressException;
import org.bluez.exceptions.BluezInvalidOffsetException;
import org.bluez.exceptions.BluezInvalidValueLengthException;
import org.bluez.exceptions.BluezNotAuthorizedException;
import org.bluez.exceptions.BluezNotPermittedException;
import org.bluez.exceptions.BluezNotSupportedException;
import org.freedesktop.dbus.connections.impl.DBusConnection;
import org.freedesktop.dbus.interfaces.DBusInterface;
import com.github.hypfvieh.DbusHelper;
/**
* Wrapper class which represents a GATT characteristic on a remote device.
*
* @author hypfvieh
*
*/
public class BluetoothGattCharacteristic extends AbstractBluetoothObject {
private final GattCharacteristic1 gattCharacteristic;
private final BluetoothGattService gattService;
private final Map descriptorByUuid = new LinkedHashMap<>();
public BluetoothGattCharacteristic(GattCharacteristic1 _gattCharacteristic, BluetoothGattService _service, String _dbusPath, DBusConnection _dbusConnection) {
super(BluetoothDeviceType.GATT_CHARACTERISTIC, _dbusConnection, _dbusPath);
gattCharacteristic = _gattCharacteristic;
gattService = _service;
}
/**
* {@inheritDoc}
*/
@Override
protected Class getInterfaceClass() {
return GattCharacteristic1.class;
}
/**
* Re-queries the GattCharacteristics from the device.
*/
public void refreshGattDescriptors() {
descriptorByUuid.clear();
Set findNodes = DbusHelper.findNodes(getDbusConnection(), getDbusPath());
Map remoteObjects = getRemoteObjects(findNodes, getDbusPath(), GattDescriptor1.class);
for (Entry entry : remoteObjects.entrySet()) {
BluetoothGattDescriptor btDescriptor = new BluetoothGattDescriptor(entry.getValue(), this, entry.getKey(), getDbusConnection());
descriptorByUuid.put(btDescriptor.getUuid(), btDescriptor);
}
}
/**
* Get the currently available GATT descriptors.
* Will issue a query if {@link #refreshGattDescriptors()} wasn't called before.
* @return List, maybe empty but never null
*/
public List getGattDescriptors() {
if (descriptorByUuid.isEmpty()) {
refreshGattDescriptors();
}
return new ArrayList<>(descriptorByUuid.values());
}
/**
* Return the {@link BluetoothGattDescriptor} object for the given UUID.
* @param _uuid uuid
* @return maybe null if not found
*/
public BluetoothGattDescriptor getGattDescriptorByUuid(String _uuid) {
if (descriptorByUuid.isEmpty()) {
refreshGattDescriptors();
}
return descriptorByUuid.get(_uuid);
}
/**
* Write value to the GATT characteristic register.
* Supported options:
*
* "offset": uint16 offset
* "device": Object Device (Server only)
*
* @param _value value to write
* @param _options options to use
* @throws BluezFailedException on failure if operation failed
* @throws BluezInProgressException when operation already in progress if operation is already in progress
* @throws BluezNotPermittedException if operation is not permitted
* @throws BluezNotAuthorizedException when not authorized if not authorized
* @throws BluezNotSupportedException when operation not supported if not supported
* @throws BluezInvalidValueLengthException if invalid length
*/
public void writeValue(byte[] _value, Map _options) throws BluezFailedException, BluezInProgressException, BluezNotPermittedException, BluezNotAuthorizedException, BluezNotSupportedException, BluezInvalidValueLengthException {
gattCharacteristic.WriteValue(_value, optionsToVariantMap(_options));
}
/**
* Read a value from the GATT characteristics register.
* Supported options:
*
* "offset": uint16 offset
* "device": Object Device (Server only)
*
* @param _options options to use
* @return byte array, maybe null
* @throws BluezFailedException on failure if anything failed
* @throws BluezInProgressException when operation already in progress if already in progress
* @throws BluezNotPermittedException if not permitted
* @throws BluezNotAuthorizedException when not authorized if not authorized
* @throws BluezNotSupportedException when operation not supported if not supported
* @throws BluezInvalidOffsetException if offset is invalid
*/
public byte[] readValue(Map _options) throws BluezFailedException, BluezInProgressException, BluezNotPermittedException, BluezNotAuthorizedException, BluezNotSupportedException, BluezInvalidOffsetException {
return gattCharacteristic.ReadValue(optionsToVariantMap(_options));
}
/**
* From bluez Documentation:
*
* 128-bit characteristic UUID.
*
* @return uuid, maybe null
*/
public String getUuid() {
return getTyped("UUID", String.class);
}
/**
* Returns the {@link BluetoothGattService} object which provides this {@link BluetoothGattCharacteristic}.
* @return GattService, maybe null
*/
public BluetoothGattService getService() {
return gattService;
}
/**
* Get the raw {@link GattCharacteristic1} object behind this wrapper.
* @return {@link GattCharacteristic1}, maybe null
*/
public GattCharacteristic1 getRawGattCharacteristic() {
return gattCharacteristic;
}
/**
* 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.
*
* @return cached characteristics value, maybe null
*/
public byte[] getValue() {
List typed = getTyped("UUIDs", ArrayList.class);
if (typed != null) {
return byteListToByteArray(typed);
}
return null;
}
/**
* From bluez Documentation:
* True, if notifications or indications on this characteristic are currently enabled.
* @return maybe null if feature is not supported
*/
public Boolean isNotifying() {
return getTyped("Notifying", Boolean.class);
}
/**
* 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)
*
* @return string, maybe null
*/
public String getFlags() {
return getTyped("Flags", String.class);
}
/**
* From bluez Documentation:
*
* Starts a notification session from this characteristic
* if it supports value notifications or indications.
*
*
* @throws BluezFailedException on failure if operation failed
* @throws BluezInProgressException when operation already in progress if operation already in progress
* @throws BluezNotSupportedException when operation not supported if operation is not supported
* @throws BluezNotPermittedException if access is not permitted
*/
public void startNotify() throws BluezFailedException, BluezInProgressException, BluezNotSupportedException, BluezNotPermittedException {
gattCharacteristic.StartNotify();
}
/**
* 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
*/
public void stopNotify() throws BluezFailedException {
gattCharacteristic.StopNotify();
}
@Override
public String toString() {
return getClass().getSimpleName() + " [gattCharacteristic=" + gattCharacteristic
+ ", gattService=" + gattService.getDbusPath() + ", getBluetoothType()="
+ getBluetoothType().name() + ", getDbusPath()=" + getDbusPath() + "]";
}
}