com.kontakt.sdk.android.ble.connection

Class KontaktDeviceConnection

java.lang.Object

com.kontakt.sdk.android.ble.connection.KontaktDeviceConnection

All Implemented Interfaces:

IKontaktDeviceConnection

public class KontaktDeviceConnection
extends java.lang.Object
implements IKontaktDeviceConnection

KontaktDeviceConnection connection allows to establish connection with beacon.
Since firmware in version 4.0 device does not to have setup password, but below it still needs set password

All operation with device should be as quick as possible. You should not open connection and wait long time before taking any action. After doing job connection should be closed immediately

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KontaktDeviceConnection.State State enum describes all possible state that BeaconConnection may be in.

Nested classes/interfaces inherited from interface com.kontakt.sdk.android.ble.connection.IKontaktDeviceConnection

IKontaktDeviceConnection.ConnectionListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_AUTHENTICATION Error code informing that unexpected error has occured while attempting beacon authentication.
static int	ERROR_BATCH_WRITE_INSTANCE_ID Error code informing that Batch write operation failed during InstanceId write
static int	ERROR_BATCH_WRITE_INTERVAL Error code informing that Batch write operation failed during Interval write.
static int	ERROR_BATCH_WRITE_MAJOR Error code informing that Batch write operation failed during Major write.
static int	ERROR_BATCH_WRITE_MINOR Error code informing that Batch write operation failed during Minor write.
static int	ERROR_BATCH_WRITE_NAME Error code informing that Batch write operation failed during Name write
static int	ERROR_BATCH_WRITE_NAMESPACE Error code informing that Batch write operation failed during Namespace write
static int	ERROR_BATCH_WRITE_PASSWORD Error code informing that Batch write failed during Password write
static int	ERROR_BATCH_WRITE_PROFILE Error code informing that Batch write operation failed during Profile write
static int	ERROR_BATCH_WRITE_PROXIMITY_UUID Error code informing that Batch write operation failed during Proximity UUID write.
static int	ERROR_BATCH_WRITE_TX_POWER Error code informing that Batch write operation failed during Transmission Power write.
static int	ERROR_BATCH_WRITE_URL Error code informing that Batch write operation failed during Url write
static int	ERROR_OVERWRITE_REQUEST Error code informing that error has occured during characteristic overwrite process.
static int	ERROR_SERVICES_DISCOVERY Error code informing that Beacon services discovery has failed.
static int	FAILURE_UNKNOWN_BEACON Failure code informing that BLE device was not recognised as kontakt.io Beacon.
static int	FAILURE_WRONG_PASSWORD Failure code informing that beacon was not authenticated because of wrong password.

Constructor Summary

Constructors

Modifier	Constructor and Description
	KontaktDeviceConnection(android.content.Context context, RemoteBluetoothDevice bluetoothDevice, IKontaktDeviceConnection.ConnectionListener connectionListener)
protected	KontaktDeviceConnection(android.content.Context context, RemoteBluetoothDevice bluetoothDevice, IKontaktDeviceConnection.ConnectionListener connectionListener, KontaktDeviceServiceStore serviceStore)

Method Summary

Modifier and Type	Method and Description
void	acceptProfile(IPreset profile, WriteBatchListener<IPreset> writeBatchListener) Accepts predefined profile (Preset) and changes parameters for Beacon.
void	applyConfig(IConfig config, WriteBatchListener<IConfig> writeBatchListener) Applies pending configuration (Config) for Beacon.
void	applySecureConfig(java.lang.String secureConfig, WriteListener writeListener) Method for writing secure config.
void	close()
boolean	connect()
void	enableDfuMode(java.lang.String masterPassword, WriteListener writeListener) Enables dfu mode.
void	enableNonConnectableMode(java.lang.String masterPassword, WriteListener writeListener) Changes Beacon mode to non-connectable.
RemoteBluetoothDevice	getDevice()
static int	getGattError(int errorCode) Method for getting gatt erorr status code from received errorCode
boolean	isAuthenticated()
boolean	isClosed()
boolean	isConnected()
static boolean	isGattError(int errorCode) Metohd for checking is error code indicating GATT error
protected void	overwrite(android.bluetooth.BluetoothGattCharacteristic characteristic, byte[] newValue, WriteListener listener)
void	overwriteAdvertisingInterval(long millis, WriteListener writeListener) Changes Beacon advertising interval.
void	overwriteInstanceId(java.lang.String instanceId, WriteListener writeListener) Overwrite instance id.
void	overwriteMajor(int value, WriteListener writeListener) Changes Beacon major value.
void	overwriteMinor(int value, WriteListener writeListener) Writes minor value.
void	overwriteModelName(java.lang.String newModelName, WriteListener writeListener) Changes Beacon model name.
void	overwriteNamespaceId(java.lang.String namespaceId, WriteListener writeListener) Overwrites namespace id.
void	overwritePassword(java.lang.String newPassword, WriteListener writeListener) Changes beacon password.
void	overwritePowerLevel(int powerLevel, WriteListener writeListener) Changes Beacon power level.
void	overwriteProximityUUID(java.util.UUID proximity, WriteListener writeListener) Changes Beacon Proximity UUID value.
void	overwriteUrl(java.lang.String newUrl, WriteListener writeListener) Overwrites url.
void	resetDevice(WriteListener writeListener) Resets device so that connection is established once again.
void	restoreDefaultSettings(java.lang.String masterPassword, WriteListener writeListener) Restores default Beacon settings.
void	switchToDeviceProfile(DeviceProfile deviceProfile, WriteListener writeListener) Switch to device profile.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_SERVICES_DISCOVERY

public static final int ERROR_SERVICES_DISCOVERY

Error code informing that Beacon services discovery has failed.

See Also:

Constant Field Values

ERROR_OVERWRITE_REQUEST

public static final int ERROR_OVERWRITE_REQUEST

Error code informing that error has occured during characteristic overwrite process.

See Also:

Constant Field Values

ERROR_AUTHENTICATION

public static final int ERROR_AUTHENTICATION

Error code informing that unexpected error has occured while attempting beacon authentication.

See Also:

Constant Field Values

FAILURE_UNKNOWN_BEACON

public static final int FAILURE_UNKNOWN_BEACON

Failure code informing that BLE device was not recognised as kontakt.io Beacon.

See Also:

Constant Field Values

FAILURE_WRONG_PASSWORD

public static final int FAILURE_WRONG_PASSWORD

Failure code informing that beacon was not authenticated because of wrong password. When authentication failure occurs, beacon change its state to Non-connectable mode lasting about 20 minutes.

See Also:

Constant Field Values

ERROR_BATCH_WRITE_PROXIMITY_UUID

public static final int ERROR_BATCH_WRITE_PROXIMITY_UUID

Error code informing that Batch write operation failed during Proximity UUID write.

See Also:

Constant Field Values

ERROR_BATCH_WRITE_TX_POWER

public static final int ERROR_BATCH_WRITE_TX_POWER

Error code informing that Batch write operation failed during Transmission Power write.

See Also:

Constant Field Values

ERROR_BATCH_WRITE_MAJOR

public static final int ERROR_BATCH_WRITE_MAJOR

Error code informing that Batch write operation failed during Major write.

See Also:

Constant Field Values

ERROR_BATCH_WRITE_MINOR

public static final int ERROR_BATCH_WRITE_MINOR

Error code informing that Batch write operation failed during Minor write.

See Also:

Constant Field Values

ERROR_BATCH_WRITE_INTERVAL

public static final int ERROR_BATCH_WRITE_INTERVAL

Error code informing that Batch write operation failed during Interval write.

See Also:

Constant Field Values

ERROR_BATCH_WRITE_PROFILE

public static final int ERROR_BATCH_WRITE_PROFILE

Error code informing that Batch write operation failed during Profile write

See Also:

Constant Field Values

ERROR_BATCH_WRITE_NAMESPACE

public static final int ERROR_BATCH_WRITE_NAMESPACE

Error code informing that Batch write operation failed during Namespace write

See Also:

Constant Field Values

ERROR_BATCH_WRITE_INSTANCE_ID

public static final int ERROR_BATCH_WRITE_INSTANCE_ID

Error code informing that Batch write operation failed during InstanceId write

See Also:

Constant Field Values

ERROR_BATCH_WRITE_URL

public static final int ERROR_BATCH_WRITE_URL

Error code informing that Batch write operation failed during Url write

See Also:

Constant Field Values

ERROR_BATCH_WRITE_NAME

public static final int ERROR_BATCH_WRITE_NAME

Error code informing that Batch write operation failed during Name write

See Also:

Constant Field Values

ERROR_BATCH_WRITE_PASSWORD

public static final int ERROR_BATCH_WRITE_PASSWORD

Error code informing that Batch write failed during Password write

See Also:

Constant Field Values

Constructor Detail

KontaktDeviceConnection

public KontaktDeviceConnection(android.content.Context context,
                               RemoteBluetoothDevice bluetoothDevice,
                               IKontaktDeviceConnection.ConnectionListener connectionListener)

KontaktDeviceConnection

protected KontaktDeviceConnection(android.content.Context context,
                                  RemoteBluetoothDevice bluetoothDevice,
                                  IKontaktDeviceConnection.ConnectionListener connectionListener,
                                  KontaktDeviceServiceStore serviceStore)

Method Detail

isGattError

public static boolean isGattError(int errorCode)

Metohd for checking is error code indicating GATT error

Parameters:

errorCode - received from IKontaktDeviceConnection.ConnectionListener.onErrorOccured(int)

Returns:

true if errorCode is gatt error

getGattError

public static int getGattError(int errorCode)

Method for getting gatt erorr status code from received errorCode

throws IllegalAccessException if errorCode is not gatt error code

Parameters:

errorCode -

Returns:

Gatt status code, e.g 133

getDevice

public RemoteBluetoothDevice getDevice()

Specified by:

getDevice in interface IKontaktDeviceConnection

connect

public boolean connect()

Specified by:

connect in interface IKontaktDeviceConnection

isConnected

public boolean isConnected()

Specified by:

isConnected in interface IKontaktDeviceConnection

isAuthenticated

public boolean isAuthenticated()

Specified by:

isAuthenticated in interface IKontaktDeviceConnection

close

public void close()

Specified by:

close in interface IKontaktDeviceConnection

isClosed

public boolean isClosed()

Specified by:

isClosed in interface IKontaktDeviceConnection

applyConfig

public void applyConfig(IConfig config,
                        WriteBatchListener<IConfig> writeBatchListener)

Applies pending configuration (Config) for Beacon.

It is possible to encounter problems during batch (the Config in this case) write operation which result in launching error handle callback method. Once the write batch operation failes, the Write Batch Processor will attempt performing rollback write batch operation aiming at restoring original Beacon configuration. The rollback operation however may not succeed as well leaving Beacon device changed partially. Therefore it is strongly advisable to write batches in relatively close distance to Beacon device. Thus, the risk of leaving Beacon in unspecified state may be avoided.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

applyConfig in interface IKontaktDeviceConnection

Parameters:

config - the config

writeBatchListener - the write batch listener

acceptProfile

public void acceptProfile(IPreset profile,
                          WriteBatchListener<IPreset> writeBatchListener)

Accepts predefined profile (Preset) and changes parameters for Beacon.

It is possible to encounter problems during batch (the Preset in this case) write operation which result in launching error handle callback method. Once the write batch operation failes, the Write Batch Processor will attempt performing rollback write batch operation aiming at restoring original Beacon configuration. The rollback operation however may not succeed as well leaving Beacon device changed partially. Therefore it is strongly advisable to write batches in relatively close distance to Beacon device. Thus, the risk of leaving Beacon in unspecified state may be avoided.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

acceptProfile in interface IKontaktDeviceConnection

Parameters:

profile - the profile

writeBatchListener - the write batch listener

overwriteMinor

public void overwriteMinor(int value,
                           WriteListener writeListener)

Writes minor value. The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwriteMinor in interface IKontaktDeviceConnection

Parameters:

value - the value

writeListener - the write listener

enableNonConnectableMode

public void enableNonConnectableMode(java.lang.String masterPassword,
                                     WriteListener writeListener)

Changes Beacon mode to non-connectable. During the non-connectable mode no connection can be established with the Beacon for about 20 minutes.

The non-connectable mode is also enabled when authentication failure occured because of providing wrong password.

Beacon Master Password can be obtained via REST Client. The result callback is invoked by WriteListener.

For more information concerning Beacon master password, see BeaconCredentials model (DeviceCredentials)

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

enableNonConnectableMode in interface IKontaktDeviceConnection

Parameters:

masterPassword - the beacon master password

writeListener - the write listener

overwriteMajor

public void overwriteMajor(int value,
                           WriteListener writeListener)

Changes Beacon major value. The result callback is invoked by WriteListener.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwriteMajor in interface IKontaktDeviceConnection

Parameters:

value - new value

writeListener - the write listener

overwriteProximityUUID

public void overwriteProximityUUID(java.util.UUID proximity,
                                   WriteListener writeListener)

Changes Beacon Proximity UUID value. The result callback is invoked by WriteListener.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwriteProximityUUID in interface IKontaktDeviceConnection

Parameters:

proximity - the proximity UUID

writeListener - the write listener

overwritePassword

public void overwritePassword(java.lang.String newPassword,
                              WriteListener writeListener)

Changes beacon password. The password must be 4-byte long. For more information see kontakt.io Datasheet - version 2.0. The result callback is invoked by WriteListener.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwritePassword in interface IKontaktDeviceConnection

Parameters:

newPassword - the new password

writeListener - the write listener

See Also:

kontakt.io Beacon Datasheet - version 2.0

overwriteModelName

public void overwriteModelName(java.lang.String newModelName,
                               WriteListener writeListener)

Changes Beacon model name. The name should be no longer than sequence of 15 bytes (15 ASCII characters). For more information see kontakt.io Datasheet - version 2.0. The result callback is invoked by WriteListener.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwriteModelName in interface IKontaktDeviceConnection

Parameters:

newModelName - the new model name

writeListener - the write listener

See Also:

kontakt.io Beacon Datasheet - version 2.0

overwriteAdvertisingInterval

public void overwriteAdvertisingInterval(long millis,
                                         WriteListener writeListener)

Changes Beacon advertising interval. The interval value is accepted in milliseconds and must be within [20 - 10240] ms range.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwriteAdvertisingInterval in interface IKontaktDeviceConnection

Parameters:

millis - the interval millis

writeListener - the write listener

overwritePowerLevel

public void overwritePowerLevel(int powerLevel,
                                WriteListener writeListener)

Changes Beacon power level. The Power level is described by 8 levels where 0 is the lowest (default) and 7 is the highest. For more information see kontakt.io Datasheet - version 2.0.

The result callback is invoked by WriteListener.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwritePowerLevel in interface IKontaktDeviceConnection

Parameters:

powerLevel - the power level

writeListener - the write listener

See Also:

kontakt.io Beacon Datasheet - version 2.0.

switchToDeviceProfile

public void switchToDeviceProfile(DeviceProfile deviceProfile,
                                  WriteListener writeListener)

Switch to device profile.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

switchToDeviceProfile in interface IKontaktDeviceConnection

Parameters:

deviceProfile - the device profile

writeListener - the write listener

resetDevice

public void resetDevice(WriteListener writeListener)

Resets device so that connection is established once again.

For more information see kontakt.io Datasheet - version 2.0.

The result callback is invoked by WriteListener.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

resetDevice in interface IKontaktDeviceConnection

Parameters:

writeListener - the write listener

See Also:

kontakt.io Beacon Datasheet - version 2.0.

enableDfuMode

public void enableDfuMode(java.lang.String masterPassword,
                          WriteListener writeListener)

Enables dfu mode. The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

enableDfuMode in interface IKontaktDeviceConnection

Parameters:

masterPassword - the master password

writeListener - the write listener

overwriteUrl

public void overwriteUrl(java.lang.String newUrl,
                         WriteListener writeListener)

Overwrites url. The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwriteUrl in interface IKontaktDeviceConnection

Parameters:

newUrl - the new url

writeListener - the write listener

overwriteNamespaceId

public void overwriteNamespaceId(java.lang.String namespaceId,
                                 WriteListener writeListener)

Overwrites namespace id. The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwriteNamespaceId in interface IKontaktDeviceConnection

Parameters:

namespaceId - the namespace id

writeListener - the write listener

overwriteInstanceId

public void overwriteInstanceId(java.lang.String instanceId,
                                WriteListener writeListener)

Overwrite instance id. The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

overwriteInstanceId in interface IKontaktDeviceConnection

Parameters:

instanceId - the instance id

writeListener - the write listener

restoreDefaultSettings

public void restoreDefaultSettings(java.lang.String masterPassword,
                                   WriteListener writeListener)

Restores default Beacon settings. As an argument, 6-byte long Beacon master password must be provided. The master password can be obtained via API Client.

The method is synchronized.

Throws IllegalOperationException if provided RemoteBluetoothDevice is in version 4.0 or higher

Specified by:

restoreDefaultSettings in interface IKontaktDeviceConnection

Parameters:

masterPassword - the master password

writeListener - the write listener

See Also:

kontakt.io Beacon Datasheet - version 2.0.

applySecureConfig

public void applySecureConfig(java.lang.String secureConfig,
                              WriteListener writeListener)

Method for writing secure config. Accessible for device with firmware 4.0 and above

Throws IllegalOperationException if provided device is below 4.0 firmware version

*

Specified by:

applySecureConfig in interface IKontaktDeviceConnection

Parameters:

secureConfig -

writeListener -

overwrite

protected void overwrite(android.bluetooth.BluetoothGattCharacteristic characteristic,
                         byte[] newValue,
                         WriteListener listener)