is.hello.buruberi.bluetooth.stacks

Interface GattCharacteristic

public interface GattCharacteristic

Represents a gatt characteristic from a GattService.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GattCharacteristic.Permissions Marks an int as containing one of the permission constants from GattCharacteristic.
static interface	GattCharacteristic.Properties Marks an int as containing one of the property constants from GattCharacteristic.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PERMISSION_NULL Indicates no permissions could be found.
static int	PERMISSION_READ Characteristic read permission
static int	PERMISSION_READ_ENCRYPTED Allow encrypted read operations
static int	PERMISSION_READ_ENCRYPTED_MITM Allow reading with man-in-the-middle protection
static int	PERMISSION_WRITE Characteristic write permission
static int	PERMISSION_WRITE_ENCRYPTED Allow encrypted writes
static int	PERMISSION_WRITE_ENCRYPTED_MITM Allow encrypted writes with man-in-the-middle protection
static int	PERMISSION_WRITE_SIGNED Allow signed write operations
static int	PERMISSION_WRITE_SIGNED_MITM Allow signed write operations with man-in-the-middle protection
static int	PROPERTY_BROADCAST Characteristic is broadcastable.
static int	PROPERTY_EXTENDED_PROPS Characteristic has extended properties
static int	PROPERTY_INDICATE Characteristic supports indication
static int	PROPERTY_NOTIFY Characteristic supports notification
static int	PROPERTY_READ Characteristic is readable.
static int	PROPERTY_SIGNED_WRITE Characteristic supports write with signature
static int	PROPERTY_WRITE Characteristic can be written.
static int	PROPERTY_WRITE_NO_RESPONSE Characteristic can be written without response.

Method Summary

Modifier and Type	Method and Description
rx.Observable<java.util.UUID>	disableNotification(java.util.UUID descriptor, OperationTimeout timeout) Disable notification events for a given descriptor.
rx.Observable<java.util.UUID>	enableNotification(java.util.UUID descriptor, OperationTimeout timeout) Enable notification events for a given descriptor.
int	getDescriptorPermissions(java.util.UUID descriptor) Returns the permissions associated with a given descriptor.
java.util.List<java.util.UUID>	getDescriptors() Returns the descriptors of the characteristic.
int	getPermissions() Returns the permissions of this characteristic.
int	getProperties() Returns the properties of this characteristic.
GattService	getService() Returns the service that owns this characteristic.
java.util.UUID	getUuid() Returns the identifier of the characteristic.
rx.Observable<java.lang.Void>	write(GattPeripheral.WriteType writeType, byte[] payload, OperationTimeout timeout) Writes a given payload on the characteristic.

Field Detail

PROPERTY_BROADCAST

static final int PROPERTY_BROADCAST

Characteristic is broadcastable.

See Also:

Constant Field Values

PROPERTY_READ

static final int PROPERTY_READ

Characteristic is readable.

See Also:

Constant Field Values

PROPERTY_WRITE_NO_RESPONSE

static final int PROPERTY_WRITE_NO_RESPONSE

Characteristic can be written without response.

See Also:

Constant Field Values

PROPERTY_WRITE

static final int PROPERTY_WRITE

Characteristic can be written.

See Also:

Constant Field Values

PROPERTY_NOTIFY

static final int PROPERTY_NOTIFY

Characteristic supports notification

See Also:

Constant Field Values

PROPERTY_INDICATE

static final int PROPERTY_INDICATE

Characteristic supports indication

See Also:

Constant Field Values

PROPERTY_SIGNED_WRITE

static final int PROPERTY_SIGNED_WRITE

Characteristic supports write with signature

See Also:

Constant Field Values

PROPERTY_EXTENDED_PROPS

static final int PROPERTY_EXTENDED_PROPS

Characteristic has extended properties

See Also:

Constant Field Values

PERMISSION_NULL

static final int PERMISSION_NULL

Indicates no permissions could be found.

See Also:

Constant Field Values

PERMISSION_READ

static final int PERMISSION_READ

Characteristic read permission

See Also:

Constant Field Values

PERMISSION_READ_ENCRYPTED

static final int PERMISSION_READ_ENCRYPTED

Allow encrypted read operations

See Also:

Constant Field Values

PERMISSION_READ_ENCRYPTED_MITM

static final int PERMISSION_READ_ENCRYPTED_MITM

Allow reading with man-in-the-middle protection

See Also:

Constant Field Values

PERMISSION_WRITE

static final int PERMISSION_WRITE

Characteristic write permission

See Also:

Constant Field Values

PERMISSION_WRITE_ENCRYPTED

static final int PERMISSION_WRITE_ENCRYPTED

Allow encrypted writes

See Also:

Constant Field Values

PERMISSION_WRITE_ENCRYPTED_MITM

static final int PERMISSION_WRITE_ENCRYPTED_MITM

Allow encrypted writes with man-in-the-middle protection

See Also:

Constant Field Values

PERMISSION_WRITE_SIGNED

static final int PERMISSION_WRITE_SIGNED

Allow signed write operations

See Also:

Constant Field Values

PERMISSION_WRITE_SIGNED_MITM

static final int PERMISSION_WRITE_SIGNED_MITM

Allow signed write operations with man-in-the-middle protection

See Also:

Constant Field Values

Method Detail

getUuid

java.util.UUID getUuid()

Returns the identifier of the characteristic.

getProperties

@GattCharacteristic.Properties
int getProperties()

Returns the properties of this characteristic.

getPermissions

@GattCharacteristic.Permissions
int getPermissions()

Returns the permissions of this characteristic.

getService

GattService getService()

Returns the service that owns this characteristic.

getDescriptors

java.util.List<java.util.UUID> getDescriptors()

Returns the descriptors of the characteristic.

getDescriptorPermissions

@GattCharacteristic.Permissions
int getDescriptorPermissions(java.util.UUID descriptor)

Returns the permissions associated with a given descriptor.

Parameters:

descriptor - The descriptor identifier.

Returns:

The permissions of the descriptor if it can be found; 0 otherwise.

enableNotification

rx.Observable<java.util.UUID> enableNotification(java.util.UUID descriptor,
                                                 OperationTimeout timeout)

Enable notification events for a given descriptor.

Parameters:

descriptor - The descriptor to enable notifications for.

timeout - The timeout to apply to the operation.

Returns:

The operation, waiting to be subscribed to.

disableNotification

rx.Observable<java.util.UUID> disableNotification(java.util.UUID descriptor,
                                                  OperationTimeout timeout)

Disable notification events for a given descriptor.

Parameters:

descriptor - The descriptor to enable notifications for.

timeout - The timeout to apply to the operation.

Returns:

The operation, waiting to be subscribed to.

write

rx.Observable<java.lang.Void> write(GattPeripheral.WriteType writeType,
                                    byte[] payload,
                                    OperationTimeout timeout)

Writes a given payload on the characteristic.

Important: it appears on some devices that writes are asynchronous on multiple levels. Although the stack may report the write was successful, it doesn't mean the write has actually completed. If you're going to disconnect after a write operation, it's a good idea to add a delay of a few seconds.

The value of writeType is supposed to be automatically inferred during service discovery, but some devices do not consistently populate the value (Verizon Note 4). As such, this value must be provided for every write command call.

Parameters:

writeType - The type of write to perform.

payload - The payload to write. Must be 20 bytes or less.

timeout - The timeout to wrap the operation within.

Returns:

An observable that will emit a single null value, then complete upon success.