com.kontakt.sdk.android.ble.spec

Class BluetoothDeviceCharacteristic

java.lang.Object

android.bluetooth.BluetoothGattCharacteristic

com.kontakt.sdk.android.ble.spec.BluetoothDeviceCharacteristic

public final class BluetoothDeviceCharacteristic
extends android.bluetooth.BluetoothGattCharacteristic

CharacteristicWrapper delegates methods to wrapped BluetoothGattCharacteristic (BluetoothGattCharacteristic). Please note that CharacteristicWrapper can wrap only characteristics identified by UUID ids described in kontakt.io iBeacon and Eddystone specification.

See Also:

kontakt.io Beacon Datasheet - version 2.0.

Field Summary

Fields inherited from class android.bluetooth.BluetoothGattCharacteristic

FORMAT_FLOAT, FORMAT_SFLOAT, FORMAT_SINT16, FORMAT_SINT32, FORMAT_SINT8, FORMAT_UINT16, FORMAT_UINT32, FORMAT_UINT8, mDescriptors, PERMISSION_READ, PERMISSION_READ_ENCRYPTED, PERMISSION_READ_ENCRYPTED_MITM, PERMISSION_WRITE, PERMISSION_WRITE_ENCRYPTED, PERMISSION_WRITE_ENCRYPTED_MITM, PERMISSION_WRITE_SIGNED, PERMISSION_WRITE_SIGNED_MITM, PROPERTY_BROADCAST, PROPERTY_EXTENDED_PROPS, PROPERTY_INDICATE, PROPERTY_NOTIFY, PROPERTY_READ, PROPERTY_SIGNED_WRITE, PROPERTY_WRITE, PROPERTY_WRITE_NO_RESPONSE, WRITE_TYPE_DEFAULT, WRITE_TYPE_NO_RESPONSE, WRITE_TYPE_SIGNED

Constructor Summary

Constructors

Constructor and Description
BluetoothDeviceCharacteristic(android.bluetooth.BluetoothGattCharacteristic characteristic) Instantiates a new CharacteristicWrapper.

Method Summary

Modifier and Type	Method and Description
boolean	addDescriptor(android.bluetooth.BluetoothGattDescriptor descriptor)
android.bluetooth.BluetoothGattDescriptor	getDescriptor(java.util.UUID uuid)
java.util.List<android.bluetooth.BluetoothGattDescriptor>	getDescriptors()
java.lang.Float	getFloatValue(int formatType, int offset)
java.lang.String	getHexStringValue() Gets hex string value.
java.util.UUID	getId() Gets id of the characteristic.
int	getInstanceId() Gets characteristic instance id.
int	getIntValue() Gets characteristic's value as Integer.
java.lang.Integer	getIntValue(int formatType, int offset)
KontaktDeviceCharacteristic	getKontaktDeviceCharacteristic()
long	getLongValue() Gets characteristic's valueas Lon.
java.lang.String	getName() Gets characteristic name.
int	getPermissions() Gets characteristic permissions.
int	getProperties() Gets characteristic properties.
android.bluetooth.BluetoothGattService	getService()
java.lang.String	getStringValue() Gets characteristic's value as String.
java.lang.String	getStringValue(int offset)
java.util.UUID	getUuid()
java.util.UUID	getUUIDValue() Gets characteristic's value as UUID.
byte[]	getValue() Gets characteristic's value as byte array.
int	getWriteType() Gets characteristic write type.
boolean	isNotifiable() Checks whether wrapped characteristic is notifiable.
boolean	isReadable() Checks whether wrapped characteristic is readable.
boolean	isWritable() Checks whether wrapped characteristic is writable.
boolean	setValue(byte[] value)
void	setValue(int value) Sets Integer as characteristic's value.
boolean	setValue(int value, int formatType, int offset)
boolean	setValue(int mantissa, int exponent, int formatType, int offset)
boolean	setValue(long value) Sets Long as characteristic's value.
boolean	setValue(java.lang.String value) Sets String as characteristic's value.
void	setWriteType(int writeType)

Methods inherited from class java.lang.Object

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

Constructor Detail

BluetoothDeviceCharacteristic

public BluetoothDeviceCharacteristic(android.bluetooth.BluetoothGattCharacteristic characteristic)

Instantiates a new CharacteristicWrapper.

Parameters:

characteristic - the characteristic

Method Detail

getUuid

public java.util.UUID getUuid()

Overrides:

getUuid in class android.bluetooth.BluetoothGattCharacteristic

addDescriptor

public boolean addDescriptor(android.bluetooth.BluetoothGattDescriptor descriptor)

Overrides:

addDescriptor in class android.bluetooth.BluetoothGattCharacteristic

getService

public android.bluetooth.BluetoothGattService getService()

Overrides:

getService in class android.bluetooth.BluetoothGattCharacteristic

setWriteType

public void setWriteType(int writeType)

Overrides:

setWriteType in class android.bluetooth.BluetoothGattCharacteristic

getDescriptors

public java.util.List<android.bluetooth.BluetoothGattDescriptor> getDescriptors()

Overrides:

getDescriptors in class android.bluetooth.BluetoothGattCharacteristic

getDescriptor

public android.bluetooth.BluetoothGattDescriptor getDescriptor(java.util.UUID uuid)

Overrides:

getDescriptor in class android.bluetooth.BluetoothGattCharacteristic

getIntValue

public java.lang.Integer getIntValue(int formatType,
                                     int offset)

Overrides:

getIntValue in class android.bluetooth.BluetoothGattCharacteristic

getFloatValue

public java.lang.Float getFloatValue(int formatType,
                                     int offset)

Overrides:

getFloatValue in class android.bluetooth.BluetoothGattCharacteristic

getStringValue

public java.lang.String getStringValue(int offset)

Overrides:

getStringValue in class android.bluetooth.BluetoothGattCharacteristic

setValue

public boolean setValue(int value,
                        int formatType,
                        int offset)

Overrides:

setValue in class android.bluetooth.BluetoothGattCharacteristic

setValue

public boolean setValue(int mantissa,
                        int exponent,
                        int formatType,
                        int offset)

Overrides:

setValue in class android.bluetooth.BluetoothGattCharacteristic

getId

public java.util.UUID getId()

Gets id of the characteristic. The Ids are described in kontakt.io Beacon specification - version 2.

Returns:

the id

See Also:

kontakt.io Beacon specification - version 2.

getName

public java.lang.String getName()

Gets characteristic name. The names are described in in kontakt.io Beacon specification - version 2.

Returns:

the name

See Also:

kontakt.io Beacon specification - version 2

isWritable

public boolean isWritable()

Checks whether wrapped characteristic is writable.

Returns:

the boolean value specifying whether wrapped characteristic is writable

isReadable

public boolean isReadable()

Checks whether wrapped characteristic is readable.

Returns:

the boolean value specifying whether wrapped characteristic is readable

isNotifiable

public boolean isNotifiable()

Checks whether wrapped characteristic is notifiable.

Returns:

the boolean value specifying whether wrapped characteristic is notifiable

setValue

public void setValue(int value)

Sets Integer as characteristic's value.

Parameters:

value - the int value

setValue

public boolean setValue(java.lang.String value)

Sets String as characteristic's value.

Overrides:

setValue in class android.bluetooth.BluetoothGattCharacteristic

Parameters:

value - the String value

setValue

public boolean setValue(long value)

Sets Long as characteristic's value.

Parameters:

value - the long value

Returns:

set value

setValue

public boolean setValue(byte[] value)

Overrides:

setValue in class android.bluetooth.BluetoothGattCharacteristic

getValue

public byte[] getValue()

Gets characteristic's value as byte array.

Overrides:

getValue in class android.bluetooth.BluetoothGattCharacteristic

Returns:

the byte array value

getStringValue

public java.lang.String getStringValue()

Gets characteristic's value as String.

Returns:

the byte array value converted to String. If the value is Null, then empty string is returned.

getHexStringValue

public java.lang.String getHexStringValue()

Gets hex string value.

Returns:

the hex string value

getUUIDValue

public java.util.UUID getUUIDValue()

Gets characteristic's value as UUID.

Returns:

the byte array value converted to UUID.

getIntValue

public int getIntValue()

Gets characteristic's value as Integer.

Returns:

the byte array value converted to Integer

getLongValue

public long getLongValue()

Gets characteristic's valueas Lon.

Returns:

the byte array value converted to long

getPermissions

public int getPermissions()

Gets characteristic permissions.

Overrides:

getPermissions in class android.bluetooth.BluetoothGattCharacteristic

Returns:

the permissions

getWriteType

public int getWriteType()

Gets characteristic write type.

Overrides:

getWriteType in class android.bluetooth.BluetoothGattCharacteristic

Returns:

the write type

getProperties

public int getProperties()

Gets characteristic properties.

Overrides:

getProperties in class android.bluetooth.BluetoothGattCharacteristic

Returns:

the properties

getInstanceId

public int getInstanceId()

Gets characteristic instance id.

Overrides:

getInstanceId in class android.bluetooth.BluetoothGattCharacteristic

Returns:

the instance id

getKontaktDeviceCharacteristic

public KontaktDeviceCharacteristic getKontaktDeviceCharacteristic()