com.kontakt.sdk.android.ble.connection

Interface KontaktDeviceConnection

All Known Subinterfaces:

KontaktGatewayConnection

public interface KontaktDeviceConnection

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	Interface and Description
static interface	KontaktDeviceConnection.ConnectionListener

Method Summary

Modifier and Type	Method and Description
void	applySecureConfig(Config config, AuthToken token, WriteListener writeListener) Method for writing secure config offline.
void	applySecureConfig(java.lang.String encryptedConfig, WriteListener writeListener) Method for writing secure config.
void	authorize(AuthToken token, AuthorizationCallback callback) Authorizes with beacon.
void	close() Closes Beacon connection releases provided resources.
boolean	connect() Initializes connection to device provided in the KontaktDeviceConnection constructor.
boolean	connect(RemoteBluetoothDevice remoteBluetoothDevice) Initializes connection to given device.
void	executeSecureCommand(java.lang.String secureCommand, WriteListener writeListener) Executes Secure Command.
RemoteBluetoothDevice	getDevice() Gets beacon that the connection is established with.
boolean	isAuthenticated() Returns true if Beacon was successfully authenticated.
boolean	isClosed() Returns true if connection is closed.
boolean	isConnected() Returns true if Connection with Beacon is established.
void	readAll(AuthToken token, ReadListener<Config> listener) Operation that returns beacon's current configuration wrapped in a Config object.
void	readLightSensor(ReadListener<java.lang.Integer> listener) Operation that returns current light sensor reading on a device.
void	readTime(ReadListener<Time> listener) Operation that returns current UTC time on a device.
void	syncTime(WriteListener writeListener) Operation that synchronizes current UTC time with the beacon.
void	updateFirmware(Firmware firmware, byte[] fileBytes, KontaktCloud kontaktCloud, FirmwareUpdateListener firmwareUpdateListener) Method for initializing firmware update for Kontakt.io devices with secure profile (for now: Beacon PRO only).
void	updateFirmware(Firmware firmware, KontaktCloud kontaktCloud, FirmwareUpdateListener firmwareUpdateListener) Method for initializing firmware update for Kontakt.io devices with secure profile (for now: Beacon PRO only)

Method Detail

authorize

void authorize(AuthToken token,
               AuthorizationCallback callback)

Authorizes with beacon. Authorization is required before certain operations conducted on beacons with firmware 4.0 or higher and beacons pro.
These operations are:
- readTime(ReadListener)
- readLightSensor(ReadListener)

Parameters:

token - AuthToken instance required for authorization.

callback - Authorization result callback.

applySecureConfig

void applySecureConfig(java.lang.String encryptedConfig,
                       WriteListener writeListener)

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

Throws IllegalOperationException if provided device's firmware does not support this operation *

applySecureConfig

void applySecureConfig(Config config,
                       AuthToken token,
                       WriteListener writeListener)

Method for writing secure config offline. Accessible for devices with firmware 4.0 or higher and Beacon Pro
WARNING: This is an advanced feature that should not be used in normal situations. By applying offline secure configs you accept the fact that the beacon might be desynchronized with Kontakt Cloud.

Throws IllegalOperationException if provided device's firmware does not support this operation

Parameters:

config - Config that is about to be applied.

token - AuthToken token.

writeListener - Operation listener

executeSecureCommand

void executeSecureCommand(java.lang.String secureCommand,
                          WriteListener writeListener)

Executes Secure Command.

Parameters:

secureCommand - String representing secure command.

writeListener - Execution listener.

readAll

void readAll(AuthToken token,
             ReadListener<Config> listener)

Operation that returns beacon's current configuration wrapped in a Config object.
Successful read all operation is equal to successful authorization operation authorize(AuthToken, AuthorizationCallback).

Only available for beacons with firmware 4.0 or higher and beacons pro.

Parameters:

token - AuthToken instance.

listener - Read listener.

readTime

void readTime(ReadListener<Time> listener)

Operation that returns current UTC time on a device.
Only available for beacons pro.
Authorization is required before this operation. See authorize(AuthToken, AuthorizationCallback)

Parameters:

listener - Read listener

syncTime

void syncTime(WriteListener writeListener)

Operation that synchronizes current UTC time with the beacon.
Only available for beacons pro.
Authorization is required before this operation. See authorize(AuthToken, AuthorizationCallback)

Parameters:

writeListener - Write listener (extra will always be null in this case)

readLightSensor

void readLightSensor(ReadListener<java.lang.Integer> listener)

Operation that returns current light sensor reading on a device. Unit: 0 to 100 %
Only available for Beacons Pro with firmware 1.7 or higher.
Reading light sensor is based on characteristic notification so after using this method a sensor reading will be received continuously every 0.5 of a second. Authorization is required before this operation. See authorize(AuthToken, AuthorizationCallback)

Parameters:

listener - Read listener

updateFirmware

void updateFirmware(Firmware firmware,
                    KontaktCloud kontaktCloud,
                    FirmwareUpdateListener firmwareUpdateListener)

Method for initializing firmware update for Kontakt.io devices with secure profile (for now: Beacon PRO only)

Parameters:

firmware - Firmware instance.

kontaktCloud - KontaktCloud instance. This is required for Beacon authorization and downloading firmware file.

firmwareUpdateListener - FirmwareUpdateListener instance. Listener that will report firmware update progress and errors.

updateFirmware

void updateFirmware(Firmware firmware,
                    byte[] fileBytes,
                    KontaktCloud kontaktCloud,
                    FirmwareUpdateListener firmwareUpdateListener)

Method for initializing firmware update for Kontakt.io devices with secure profile (for now: Beacon PRO only). This method should be used only uf you have pre-loaded byte array of valid firmware file.

Parameters:

firmware - Firmware instance.

fileBytes - Firmware file bytes.

kontaktCloud - KontaktCloud instance. This is required for Beacon authorization.

firmwareUpdateListener - FirmwareUpdateListener instance. Listener that will report firmware update progress and errors.

getDevice

RemoteBluetoothDevice getDevice()

Gets beacon that the connection is established with.

Returns:

the iBeacon device.

connect

boolean connect()

Initializes connection to device provided in the KontaktDeviceConnection constructor.

Returns:

true, if the connection attempt was initiated successfully

connect

boolean connect(RemoteBluetoothDevice remoteBluetoothDevice)

Initializes connection to given device.

Parameters:

remoteBluetoothDevice - device to connect to.

Returns:

true, if the connection attempt was initiated successfully.

close

void close()

Closes Beacon connection releases provided resources. The method is synchronized.

isConnected

boolean isConnected()

Returns true if Connection with Beacon is established. The method is synchronized.

Returns:

the boolean flag indicating whether connection is established.

isAuthenticated

boolean isAuthenticated()

Returns true if Beacon was successfully authenticated. The method is synchronized.

Returns:

the boolean flag indicating whether beacon was authenticated.

isClosed

boolean isClosed()

Returns true if connection is closed.

Returns:

the boolean flag indicating whether connection is closed.