com.iotize.android.communication.protocol.ble

Class BLEProtocol

java.lang.Object

BluetoothProtocol

com.iotize.android.communication.protocol.ble.BLEProtocol

public class BLEProtocol
extends BluetoothProtocol

TODO - A thread safe implementation Optimisation: - Replace waits by callbacks ? Should use lastError ?

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BLEProtocol.StepCode

Field Summary

Fields

Modifier and Type	Field and Description
BLEConfig	bleConfig
java.util.List<android.bluetooth.BluetoothGatt>	bluetoothGattList
static long	CONNECT_DELAY_MILLISECONDS
static long	RX_TX_DELAY_MILLISECONDS

Constructor Summary

Constructors

Constructor and Description
BLEProtocol(android.content.Context context, android.bluetooth.BluetoothDevice mDevice)

Method Summary

Modifier and Type	Method and Description
void	_connect()
void	_disconnect()
void	connectToGatt()
long	discoverServices()
void	enableCharacteristicNotification(java.util.UUID svcUuid, java.util.UUID charUuid, byte[] enableType)
static BLEProtocol	fromAddress(android.content.Context context, java.lang.String address) Instantiate a BLE protocol object from the bluetooth address.
static BLEProtocol	fromDevice(android.content.Context context, android.bluetooth.BluetoothDevice bluetoothDevice) Instantiate a BLE protocol object from the bluetooth address.
android.bluetooth.BluetoothDevice	getBluetoothDevice()
android.bluetooth.BluetoothGattCharacteristic	getCharacteristic(android.bluetooth.BluetoothGatt gatt, java.util.UUID svcUuid, java.util.UUID charUuid)
int	getConnectionPriority()
HostProtocol	getType()
boolean	hasIotizeBufferService()
byte[]	read()
byte[]	send(byte[] message)
void	sendWithIndication(byte[] data) BLE indications need to be acknowledged by the client whereas notifications do not
void	sendWithNotification(byte[] data)
void	setCharacteristicNotification(java.util.UUID svcUuid, java.util.UUID charUuid, boolean enabled, byte[] enableType)
BLEProtocol	setConnectionEventListener(OnConnectionStepProgress connectionEventListener)
void	setConnectionPriority(int connectionPriority)
java.lang.String	toString()
void	write(byte[] data)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RX_TX_DELAY_MILLISECONDS

public static final long RX_TX_DELAY_MILLISECONDS

See Also:

Constant Field Values

CONNECT_DELAY_MILLISECONDS

public static final long CONNECT_DELAY_MILLISECONDS

See Also:

Constant Field Values

bleConfig

@NonNull
public BLEConfig bleConfig

bluetoothGattList

@NonNull
public final java.util.List<android.bluetooth.BluetoothGatt> bluetoothGattList

Constructor Detail

BLEProtocol

public BLEProtocol(@NonNull
                   android.content.Context context,
                   @NonNull
                   android.bluetooth.BluetoothDevice mDevice)

Method Detail

setConnectionEventListener

public BLEProtocol setConnectionEventListener(OnConnectionStepProgress connectionEventListener)

setConnectionPriority

public void setConnectionPriority(int connectionPriority)

getConnectionPriority

public int getConnectionPriority()

fromAddress

public static BLEProtocol fromAddress(@NonNull
                                      android.content.Context context,
                                      @NonNull
                                      java.lang.String address)
                               throws AdapterNotAvailableException

Instantiate a BLE protocol object from the bluetooth address.

Parameters:

context - Android context

address - the bluetooth address of the device

Returns:

the BLE protocol object

Throws:

AdapterNotAvailableException - if Bluetooth adapter is not available

fromDevice

public static BLEProtocol fromDevice(@NonNull
                                     android.content.Context context,
                                     android.bluetooth.BluetoothDevice bluetoothDevice)
                              throws AdapterNotAvailableException

Instantiate a BLE protocol object from the bluetooth address.

Parameters:

context - Android context

bluetoothDevice - the android bluetooth device to connect to

Returns:

the BLE protocol object

Throws:

AdapterNotAvailableException - if Bluetooth adapter is not available

_connect

public void _connect()
              throws java.lang.Exception

Throws:

java.lang.Exception

_disconnect

public void _disconnect()
                 throws java.lang.Exception

Throws:

java.lang.Exception

write

public void write(byte[] data)
           throws java.lang.Exception

Throws:

java.lang.Exception

connectToGatt

public void connectToGatt()
                   throws AdapterNotAvailableException

Throws:

AdapterNotAvailableException

send

public byte[] send(byte[] message)
            throws java.lang.Exception

Throws:

java.lang.Exception

read

public byte[] read()
            throws java.lang.Exception

Throws:

java.lang.Exception

sendWithIndication

public void sendWithIndication(byte[] data)
                        throws CannotWriteCharacteristicException,
                               WritePacketIsTooBigException

BLE indications need to be acknowledged by the client whereas notifications do not

Parameters:

data - data bytes to send

Throws:

CannotWriteCharacteristicException - write characteristic fail

WritePacketIsTooBigException - when data packet is too big

sendWithNotification

public void sendWithNotification(@NonNull
                                 byte[] data)
                          throws CannotWriteCharacteristicException,
                                 WritePacketIsTooBigException

Throws:

CannotWriteCharacteristicException

WritePacketIsTooBigException

getType

public HostProtocol getType()

getCharacteristic

public android.bluetooth.BluetoothGattCharacteristic getCharacteristic(android.bluetooth.BluetoothGatt gatt,
                                                                       java.util.UUID svcUuid,
                                                                       java.util.UUID charUuid)
                                                                throws ServiceNotAvailableException,
                                                                       CharacteristicNotAvailableException

Throws:

ServiceNotAvailableException

CharacteristicNotAvailableException

hasIotizeBufferService

public boolean hasIotizeBufferService()

enableCharacteristicNotification

public void enableCharacteristicNotification(java.util.UUID svcUuid,
                                             java.util.UUID charUuid,
                                             byte[] enableType)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

setCharacteristicNotification

public void setCharacteristicNotification(java.util.UUID svcUuid,
                                          java.util.UUID charUuid,
                                          boolean enabled,
                                          byte[] enableType)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

discoverServices

public long discoverServices()
                      throws java.lang.Exception

Throws:

java.lang.Exception

getBluetoothDevice

public android.bluetooth.BluetoothDevice getBluetoothDevice()

toString

public java.lang.String toString()