org.eclipse.kura.bluetooth

Interface BluetoothGatt

@ProviderType
public interface BluetoothGatt

The BluetoothGatt service is the main communication interface with the Bluettoth LE device. The service will provide information about available services and mechanisms for reading and writing to available characteristics.

Method Summary

Modifier and Type	Method and Description
boolean	checkConnection() Check if the device is connected.
boolean	connect() Connect to devices GATT server.
boolean	connect(java.lang.String adapterName) Connect to devices GATT server with a given adapter.
void	disconnect() Disconnect from devices GATT server.
java.util.List<BluetoothGattCharacteristic>	getCharacteristics(java.lang.String startHandle, java.lang.String endHandle) Get a list of GATT characteristics based on start and end handles.
BluetoothGattSecurityLevel	getSecurityLevel() Get security level.
BluetoothGattService	getService(java.util.UUID uuid) Return a GATT service based on a UUID.
java.util.List<BluetoothGattService>	getServices() Get a list of GATT services offered by the device.
java.lang.String	readCharacteristicValue(java.lang.String handle) Read characteristic value from handle.
java.lang.String	readCharacteristicValueByUuid(java.util.UUID uuid) Read value from characteristic by UUID.
void	setBluetoothLeNotificationListener(BluetoothLeNotificationListener listener) Sets the listener by which asynchronous actions of the GATT server will be communicated.
void	setSecurityLevel(BluetoothGattSecurityLevel level) Set security level.
void	writeCharacteristicValue(java.lang.String handle, java.lang.String value) Write value to characteristic.

Method Detail

connect

boolean connect()
         throws KuraException

Connect to devices GATT server.

Returns:

If connection was successful

Throws:

KuraException

connect

boolean connect(java.lang.String adapterName)
         throws KuraException

Connect to devices GATT server with a given adapter.

Parameters:

adapterName - the name of the bluetooth adapter

Returns:

If connection was successful

Throws:

KuraException

Since:

1.0.8

disconnect

void disconnect()

Disconnect from devices GATT server.

checkConnection

boolean checkConnection()
                 throws KuraException

Check if the device is connected.

Returns:

If connection was successful

Throws:

KuraException

setBluetoothLeNotificationListener

void setBluetoothLeNotificationListener(BluetoothLeNotificationListener listener)

Sets the listener by which asynchronous actions of the GATT server will be communicated.

Parameters:

listener - BluetoothLeListener

getService

BluetoothGattService getService(java.util.UUID uuid)

Return a GATT service based on a UUID.

Parameters:

uuid - UUID of service

Returns:

BluetoothGattService

getServices

java.util.List<BluetoothGattService> getServices()

Get a list of GATT services offered by the device.

Returns:

List of services

getCharacteristics

java.util.List<BluetoothGattCharacteristic> getCharacteristics(java.lang.String startHandle,
                                                               java.lang.String endHandle)

Get a list of GATT characteristics based on start and end handles. Handle boundaries can be obtained from the getServices method.

Parameters:

startHandle - Start handle

endHandle - End handle

Returns:

List of GATT characteristics

readCharacteristicValue

java.lang.String readCharacteristicValue(java.lang.String handle)
                                  throws KuraException

Read characteristic value from handle.

Parameters:

handle - Characteristic handle

Returns:

Characteristic value

Throws:

KuraException

readCharacteristicValueByUuid

java.lang.String readCharacteristicValueByUuid(java.util.UUID uuid)
                                        throws KuraException

Read value from characteristic by UUID.

Parameters:

uuid - UUID of Characteristic

Returns:

Characteristic value

Throws:

KuraException

writeCharacteristicValue

void writeCharacteristicValue(java.lang.String handle,
                              java.lang.String value)

Write value to characteristic.

Parameters:

handle - Handle of Characteristic

value - Value to write to Characteristic

getSecurityLevel

BluetoothGattSecurityLevel getSecurityLevel()
                                     throws KuraException

Get security level.

Throws:

KuraException

Since:

1.2

setSecurityLevel

void setSecurityLevel(BluetoothGattSecurityLevel level)

Set security level.

Parameters:

level - Security Level

Since:

1.2