com.estimote.mgmtsdk.connection.api

Class DeviceConnection

java.lang.Object

com.estimote.mgmtsdk.connection.api.DeviceConnection

public class DeviceConnection
extends java.lang.Object

Main entry point for configuring device. This class represents direct authenticated connection to one device. You can control reading / writing device settings, as well as updating its firmware. It can be obtained from DeviceConnectionProvider.

Author:

lukasz.pobereznik@estimote.com (Lukasz Pobereznik)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeviceConnection.CheckFirmwareCallback Callback to indicate whether device needs update.
static interface	DeviceConnection.FirmwareUpdateCallback Callback to indicate status of beacon's update.
static interface	DeviceConnection.SyncSettingsCallback Callback for synchronising device with cloud

Field Summary

Fields

Modifier and Type	Field and Description
Settings	settings

Constructor Summary

Constructors

Constructor and Description
DeviceConnection(DeviceSettingBuilder builder)

Method Summary

Modifier and Type	Method and Description
CallbackHandler	checkForFirmwareUpdate(DeviceConnection.CheckFirmwareCallback callback) Checks if there is new firmware available for connected device.
void	close() Closes connection to device.
void	connect(DeviceConnectionCallback callback) If no current connection is opened, it creates one and attaches callback.
void	destroy() Destroys this object callback from internal device connection object.
SettingsEditor	edit() Settings editor that allows to conveniently change more than one device setting.
boolean	isConnected() Check if device is connected.
CallbackHandler	readRssi(SettingCallback<java.lang.Integer> callback) Reads remote RSSI value from connection.
void	reconnect() Does reconnection using the same callback object as provided while first usage of connect(DeviceConnectionCallback)
CallbackHandler	syncSettings(DeviceConnection.SyncSettingsCallback callback) Allows to synchronise device settings with cloud.
CallbackHandler	updateDevice(DeviceConnection.FirmwareUpdateCallback callback) Updates device firmware.

Methods inherited from class java.lang.Object

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

Field Detail

settings

public final Settings settings

Constructor Detail

DeviceConnection

public DeviceConnection(DeviceSettingBuilder builder)

Method Detail

connect

public void connect(DeviceConnectionCallback callback)

If no current connection is opened, it creates one and attaches callback. If connection is already opened, only callback is being attached.

Parameters:

callback -

isConnected

public boolean isConnected()

Check if device is connected.

Returns:

true if device is connected, false if disconnected or destroy() was called.

reconnect

public void reconnect()

Does reconnection using the same callback object as provided while first usage of connect(DeviceConnectionCallback)

destroy

public void destroy()

Destroys this object callback from internal device connection object. This will not kill entire connection, but rather detach current object callbacks from it

close

public void close()

Closes connection to device. Connection can be reused after that, by calling reconnect() or connect(DeviceConnectionCallback). New connection must be obtained using DeviceConnectionProvider.

readRssi

public CallbackHandler readRssi(SettingCallback<java.lang.Integer> callback)

Reads remote RSSI value from connection.

Parameters:

callback - Callback that returns RSSI value.

Returns:

Handler that can be used to drop request.

updateDevice

public CallbackHandler updateDevice(DeviceConnection.FirmwareUpdateCallback callback)

Updates device firmware. First use checkForFirmwareUpdate(CheckFirmwareCallback) to check if firmware update is really needed.

Parameters:

callback - Callback to inform about firmware update progress.

checkForFirmwareUpdate

public CallbackHandler checkForFirmwareUpdate(DeviceConnection.CheckFirmwareCallback callback)

Checks if there is new firmware available for connected device. If the is then method updateDevice(FirmwareUpdateCallback) should be used to perform update.

syncSettings

public CallbackHandler syncSettings(DeviceConnection.SyncSettingsCallback callback)

Allows to synchronise device settings with cloud. All settings data will be copied from cloud and pushed to device's registers.

Parameters:

callback - Callback to be notified about the results

edit

public SettingsEditor edit()

Settings editor that allows to conveniently change more than one device setting.

Returns:

Settings editor object.