com.kontakt.sdk.android.ble.connection.eddystone

Class EddystoneBeaconConnection

java.lang.Object

com.kontakt.sdk.android.ble.connection.eddystone.EddystoneBeaconConnection

public class EddystoneBeaconConnection
extends java.lang.Object

Eddystone connection allows to establish connection with Eddystone device by authorizing with it with 4-byte long password and manipulating Eddystone parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EddystoneBeaconConnection.ConnectionListener Notifies whenever EddystoneBeaconConnection.State changes It is a part of EddystoneBeaconConnection instance construction.
static class	EddystoneBeaconConnection.State State enum describes all possible state that EddystoneBeaconConnection may be in.
static interface	EddystoneBeaconConnection.WriteListener WriteListener provides callbacks indicating whether Eddystone characteristics manipulation ended successfully or failed.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_AUTHENTICATION Error code informing that unexpected error has occured while attempting Eddystone authentication.
static int	ERROR_CHARACTERISTIC_READING Error code informing that error has occured during characteristic reading request.
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 Eddystone services discovery has failed.
static int	FAILURE_UNKNOWN_BEACON Failure code informing that BLE device was not recognised as kontakt.io Eddystone.
static int	FAILURE_WRONG_PASSWORD Failure code informing that beacon was not authenticated because of wrong password.

Constructor Summary

Constructors

Constructor and Description
EddystoneBeaconConnection(android.content.Context context, IEddystoneDevice eddystoneDevice, EddystoneBeaconConnection.ConnectionListener connectionListener) Creates new instance of Eddystone connection.

Method Summary

Modifier and Type	Method and Description
void	close() Closes Eddystone connection and releases provided resources.
boolean	connect() Connects to Eddystone device.
IEddystoneDevice	getEddystoneDevice() Gets Eddystone device that the connection is established with.
boolean	isAuthenticated() Returns true if Eddystone was successfully authenticated.
boolean	isConnected() Returns true if connection with Eddystone is established.
void	overwriteInstanceId(java.lang.String instanceId, EddystoneBeaconConnection.WriteListener writeListener) Overwrite instance id.
void	overwriteNamespaceId(java.lang.String namespaceId, EddystoneBeaconConnection.WriteListener writeListener) Overwrites namespace id.
void	overwritePassword(java.lang.String newPassword, EddystoneBeaconConnection.WriteListener writeListener) Overwrite password.
void	overwritePowerLevel(int powerLevel, EddystoneBeaconConnection.WriteListener writeListener) Overwrites power level.
void	overwriteUrl(java.lang.String newUrl, EddystoneBeaconConnection.WriteListener writeListener) Overwrites url.
void	resetDevice(EddystoneBeaconConnection.WriteListener writeListener) Resets eddystone device.
void	restoreDefaultSettings(java.lang.String masterPassword, EddystoneBeaconConnection.WriteListener writeListener) Restore default settings.

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 Eddystone 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 Eddystone authentication.

See Also:

Constant Field Values

ERROR_CHARACTERISTIC_READING

public static final int ERROR_CHARACTERISTIC_READING

Error code informing that error has occured during characteristic reading request.

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 Eddystone.

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

Constructor Detail

EddystoneBeaconConnection

public EddystoneBeaconConnection(android.content.Context context,
                                 IEddystoneDevice eddystoneDevice,
                                 EddystoneBeaconConnection.ConnectionListener connectionListener)

Creates new instance of Eddystone connection.

Parameters:

context - the context

eddystoneDevice - the eddystone device

connectionListener - the listener

Method Detail

getEddystoneDevice

public IEddystoneDevice getEddystoneDevice()

Gets Eddystone device that the connection is established with.

Returns:

the beacon

connect

public boolean connect()

Connects to Eddystone device. The method is synchronized.

Returns:

true, if the connection attempt was initiated successfully

isConnected

public boolean isConnected()

Returns true if connection with Eddystone is established. The method is synchronized.

Returns:

the boolean flag indicating whether connection is established.

isAuthenticated

public boolean isAuthenticated()

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

Returns:

the boolean flag indicating whether connection with Eddystone device is authenticated.

close

public void close()

Closes Eddystone connection and releases provided resources. The method is synchronized.

overwriteUrl

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

Overwrites url. The method is synchronized.

Parameters:

newUrl - the new url

writeListener - the write listener

overwritePowerLevel

public void overwritePowerLevel(int powerLevel,
                                EddystoneBeaconConnection.WriteListener writeListener)

Overwrites power level. The method is synchronized.

Parameters:

powerLevel - the power level

writeListener - the write listener

resetDevice

public void resetDevice(EddystoneBeaconConnection.WriteListener writeListener)

Resets eddystone device. The method is synchronized.

Parameters:

writeListener - the write listener

overwriteNamespaceId

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

Overwrites namespace id. The method is synchronized.

Parameters:

namespaceId - the namespace id

writeListener - the write listener

overwriteInstanceId

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

Overwrite instance id. The method is synchronized.

Parameters:

instanceId - the instance id

writeListener - the write listener

restoreDefaultSettings

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

Restore default settings. The method is synchronized.

Parameters:

masterPassword - the master password

writeListener - the write listener

overwritePassword

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

Overwrite password. The method is synchronized.

Parameters:

newPassword - the new password

writeListener - the write listener