com.aylanetworks.aylasdk.setup.ble

Class AylaBaseGattCharacteristic

java.lang.Object

com.aylanetworks.aylasdk.setup.ble.AylaBaseGattCharacteristic

Direct Known Subclasses:

AylaConnectCharacteristic, AylaConnectStatusCharacteristic, AylaDSNCharacteristic, AylaScanCharacteristic, AylaScanResultCharacteristic, AylaSetupTokenGattCharacteristic

public class AylaBaseGattCharacteristic
extends java.lang.Object

Base class of a structured Ayla GATT characteristic.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AylaBaseGattCharacteristic.OnCharacteristicChangedListener

Constructor Summary

Constructors

Constructor and Description
AylaBaseGattCharacteristic(android.bluetooth.BluetoothGattCharacteristic owner)

Method Summary

Modifier and Type	Method and Description
AylaAPIRequest	enableCharacteristicNotification(android.bluetooth.BluetoothGatt gatt, boolean enable, com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener, ErrorListener errorListener) Enable or disable notification on a characteristic.
AylaBaseGattCharacteristic.OnCharacteristicChangedListener	getCharacteristicChangedListener()
int	getIntValue() Return the stored value of this characteristic.
java.lang.String	getName()
android.bluetooth.BluetoothGattCharacteristic	getOwner() Get the owner characteristic hosted by this characteristic.
java.lang.String	getStringValue() Return the stored value of this characteristic.
protected android.os.Handler	getUiHandler() Returns the UI handler to post read/write result on the main thread.
java.util.UUID	getUUID()
byte[]	getValue() Return the stored value of this characteristic.
void	onCharacteristicChanged(android.bluetooth.BluetoothGatt gatt, android.bluetooth.BluetoothGattCharacteristic characteristic) Callback triggered as a result of a remote characteristic notification.
boolean	onCharacteristicRead(android.bluetooth.BluetoothGatt gatt, android.bluetooth.BluetoothGattCharacteristic characteristic, int status) Callback method to receive the result of a characteristic read operation.
boolean	onCharacteristicWrite(android.bluetooth.BluetoothGatt gatt, android.bluetooth.BluetoothGattCharacteristic characteristic, int status) Callback indicating the result of a characteristic write operation.
void	onDescriptorRead(android.bluetooth.BluetoothGatt gatt, android.bluetooth.BluetoothGattDescriptor descriptor, int status) Callback reporting the result of a descriptor read operation.
void	onDescriptorWrite(android.bluetooth.BluetoothGatt gatt, android.bluetooth.BluetoothGattDescriptor descriptor, int status) Callback indicating the result of a descriptor write operation.
AylaAPIRequest	readCharacteristic(android.bluetooth.BluetoothGatt gatt, com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener, ErrorListener errorListener) readCharacteristic
AylaAPIRequest	readDescriptor(android.bluetooth.BluetoothGatt gatt, android.bluetooth.BluetoothGattDescriptor descriptor, com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener, ErrorListener errorListener) readDescriptor
boolean	setIntValue(int value) Updates the locally stored value of this characteristic.
void	setOnCharacteristicChangedListener(AylaBaseGattCharacteristic.OnCharacteristicChangedListener listener)
boolean	setStringValue(java.lang.String value) Updates the locally stored value of this characteristic.
boolean	setValue(byte[] value) Updates the locally stored value of this characteristic.
protected boolean	shouldHandleRead() Called after data for a characteristic has been read or has changed, in onCharacteristicRead(BluetoothGatt, BluetoothGattCharacteristic, int) and in onCharacteristicChanged(BluetoothGatt, BluetoothGattCharacteristic) respectively.
protected boolean	shouldHandleWrite() Called before data for a characteristic is about to be written.
AylaAPIRequest	writeCharacteristic(android.bluetooth.BluetoothGatt gatt, com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener, ErrorListener errorListener) writeCharacteristic
AylaAPIRequest	writeDescriptor(android.bluetooth.BluetoothGatt gatt, android.bluetooth.BluetoothGattDescriptor descriptor, com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener, ErrorListener errorListener) writeDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

AylaBaseGattCharacteristic

public AylaBaseGattCharacteristic(@NonNull
                                  android.bluetooth.BluetoothGattCharacteristic owner)

Method Detail

setOnCharacteristicChangedListener

public void setOnCharacteristicChangedListener(AylaBaseGattCharacteristic.OnCharacteristicChangedListener listener)

getCharacteristicChangedListener

public AylaBaseGattCharacteristic.OnCharacteristicChangedListener getCharacteristicChangedListener()

getOwner

public final android.bluetooth.BluetoothGattCharacteristic getOwner()

Get the owner characteristic hosted by this characteristic.

Returns:

null if the owner doesn't exist.

getUUID

public final java.util.UUID getUUID()

getName

public java.lang.String getName()

setValue

public boolean setValue(byte[] value)

Updates the locally stored value of this characteristic.

getValue

public byte[] getValue()

Return the stored value of this characteristic.

setIntValue

public boolean setIntValue(int value)

Updates the locally stored value of this characteristic.

getIntValue

public int getIntValue()

Return the stored value of this characteristic.

setStringValue

public boolean setStringValue(java.lang.String value)

Updates the locally stored value of this characteristic.

getStringValue

public java.lang.String getStringValue()

Return the stored value of this characteristic.

shouldHandleRead

protected boolean shouldHandleRead()

Called after data for a characteristic has been read or has changed, in onCharacteristicRead(BluetoothGatt, BluetoothGattCharacteristic, int) and in onCharacteristicChanged(BluetoothGatt, BluetoothGattCharacteristic) respectively.

Returns:

true to notify listeners that data has been read, or false to prevent notification. Subclasses should override this method to keep the structured characteristic members, if any, updated. For characteristics that don't contain structured members, no overriding is needed.

shouldHandleWrite

protected boolean shouldHandleWrite()

Called before data for a characteristic is about to be written. For subclasses that needs to assemble the structured characteristic members, if any, and update the result in the owner characteristic's local value via a call to setValue(byte[]), should override this method and return true to allow the writing to remote GATT server happening.

Returns:

true to allow performing the write, or false to skip writing to the characteristic.

getUiHandler

protected android.os.Handler getUiHandler()

Returns the UI handler to post read/write result on the main thread.

readCharacteristic

public AylaAPIRequest readCharacteristic(@NonNull
                                         android.bluetooth.BluetoothGatt gatt,
                                         @NonNull
                                         com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener,
                                         @NonNull
                                         ErrorListener errorListener)

readCharacteristic

writeCharacteristic

public AylaAPIRequest writeCharacteristic(@NonNull
                                          android.bluetooth.BluetoothGatt gatt,
                                          @NonNull
                                          com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener,
                                          @NonNull
                                          ErrorListener errorListener)

writeCharacteristic

enableCharacteristicNotification

public AylaAPIRequest enableCharacteristicNotification(@NonNull
                                                       android.bluetooth.BluetoothGatt gatt,
                                                       boolean enable,
                                                       @NonNull
                                                       com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener,
                                                       @NonNull
                                                       ErrorListener errorListener)

Enable or disable notification on a characteristic.

Parameters:

enable - true to enable notification, false to disable notification.

successListener - the listener in response to the notification set result.

errorListener - errorListener

readDescriptor

public AylaAPIRequest readDescriptor(@NonNull
                                     android.bluetooth.BluetoothGatt gatt,
                                     @NonNull
                                     android.bluetooth.BluetoothGattDescriptor descriptor,
                                     @NonNull
                                     com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener,
                                     @NonNull
                                     ErrorListener errorListener)

readDescriptor

writeDescriptor

public AylaAPIRequest writeDescriptor(@NonNull
                                      android.bluetooth.BluetoothGatt gatt,
                                      @NonNull
                                      android.bluetooth.BluetoothGattDescriptor descriptor,
                                      @NonNull
                                      com.android.volley.Response.Listener<AylaBaseGattCharacteristic> successListener,
                                      @NonNull
                                      ErrorListener errorListener)

writeDescriptor

onCharacteristicRead

public boolean onCharacteristicRead(android.bluetooth.BluetoothGatt gatt,
                                    android.bluetooth.BluetoothGattCharacteristic characteristic,
                                    int status)

Callback method to receive the result of a characteristic read operation.

Parameters:

gatt - GATT client invoked BluetoothGatt.readCharacteristic(android.bluetooth.BluetoothGattCharacteristic)

characteristic - Characteristic that was read from the associated remote device.

status - BluetoothGatt.GATT_SUCCESS if the read operation was completed successfully.

Returns:

true if the read was successful, otherwise return false.

onCharacteristicWrite

public boolean onCharacteristicWrite(android.bluetooth.BluetoothGatt gatt,
                                     android.bluetooth.BluetoothGattCharacteristic characteristic,
                                     int status)

Callback indicating the result of a characteristic write operation.

If this callback is invoked while a reliable write transaction is in progress, the value of the characteristic represents the value reported by the remote device. An application should compare this value to the desired value to be written. If the values don't match, the application must abort the reliable write transaction.

Parameters:

gatt - GATT client invoked BluetoothGatt.writeCharacteristic(android.bluetooth.BluetoothGattCharacteristic)

characteristic - Characteristic that was written to the associated remote device.

status - The result of the write operation BluetoothGatt.GATT_SUCCESS if the operation succeeds.

Returns:

true if the write was successful, otherwise return false.

onDescriptorRead

public void onDescriptorRead(android.bluetooth.BluetoothGatt gatt,
                             android.bluetooth.BluetoothGattDescriptor descriptor,
                             int status)

Callback reporting the result of a descriptor read operation.

Parameters:

gatt - GATT client invoked BluetoothGatt.readDescriptor(android.bluetooth.BluetoothGattDescriptor)

descriptor - Descriptor that was read from the associated remote device.

status - BluetoothGatt.GATT_SUCCESS if the read operation was completed successfully

onDescriptorWrite

public void onDescriptorWrite(android.bluetooth.BluetoothGatt gatt,
                              android.bluetooth.BluetoothGattDescriptor descriptor,
                              int status)

Callback indicating the result of a descriptor write operation. Subclasses should override this method to do the specific operation.

Parameters:

gatt - GATT client invoked BluetoothGatt.writeDescriptor(android.bluetooth.BluetoothGattDescriptor)

descriptor - Descriptor that was writte to the associated remote device.

status - The result of the write operation BluetoothGatt.GATT_SUCCESS if the operation succeeds.

onCharacteristicChanged

public void onCharacteristicChanged(android.bluetooth.BluetoothGatt gatt,
                                    android.bluetooth.BluetoothGattCharacteristic characteristic)

Callback triggered as a result of a remote characteristic notification.

Parameters:

gatt - GATT client the characteristic is associated with

characteristic - Characteristic that has been updated as a result of a remote notification event.