com.estimote.coresdk.recognition.packets

Class ConfigurableDevice

java.lang.Object

com.estimote.coresdk.recognition.packets.Packet

com.estimote.coresdk.recognition.packets.ConfigurableDevice

All Implemented Interfaces:

android.os.Parcelable

public class ConfigurableDevice
extends Packet

General object for all connectivity packets advertised by Estimote's devices. You need to obtain them in order to establish connection to your owned devices. The best way to do this is to enable BeaconManager.startConfigurableDevicesDiscovery(). Scanned objects will be passed to the listener interface - BeaconManager.ConfigurableDevicesListener.

Author:

Pawel Dylag (pawel.dylag@estimote.com)

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	appVersion String with encoded SemVer of device's firmware version (application)
java.lang.String	bootloaderVersion String with encoded SemVer of device's firmware versin (bootloader)
static android.os.Parcelable.Creator<ConfigurableDevice>	CREATOR
DeviceId	deviceId Id of device that is broadcasting this packet.
java.lang.Long	discoveryTime Exact time when this packet was scanned
boolean	isClose Near to connect field - is set to true if device is cloe to the user's phone.
boolean	isShaken This field will be set to true, if device is being shaken.
MacAddress	macAddress Mac address of device.
java.lang.Integer	rssi Received Signal Strength Indicator of given packet.
java.lang.Integer	txPower Transfer power of given packet.
DeviceType	type Configurable device object is a general concept for all connectivity packets that our device's advertise.

Fields inherited from class com.estimote.coresdk.recognition.packets.Packet

packetType

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
ConfigurableDevice(DeviceType type, DeviceId deviceId, MacAddress macAddress, java.lang.String appVersion, java.lang.String bootloaderVersion)
ConfigurableDevice(DeviceType type, DeviceId deviceId, MacAddress macAddress, java.lang.String appVersion, java.lang.String bootloaderVersion, boolean isShaken, boolean isClose, java.lang.Integer rssi, java.lang.Integer txPower, java.lang.Long discoveryTime)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object o)
java.lang.String	getUniqueKey() Returns unique key for this packet to identify it between other Packet objects.
int	hashCode()
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.estimote.coresdk.recognition.packets.Packet

getPacketType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

public final DeviceType type

Configurable device object is a general concept for all connectivity packets that our device's advertise. To verify the kind of a device (location beacon, proximity beacon, nearable, mirror, etc.) you can use this field with enum type

deviceId

public final DeviceId deviceId

Id of device that is broadcasting this packet.

macAddress

public final MacAddress macAddress

Mac address of device. Notice that Nearable devices are rotating their Mac addresses, so you better don't rely on them

appVersion

public final java.lang.String appVersion

String with encoded SemVer of device's firmware version (application)

bootloaderVersion

public final java.lang.String bootloaderVersion

String with encoded SemVer of device's firmware versin (bootloader)

isShaken

public final boolean isShaken

This field will be set to true, if device is being shaken. This option needs to be enabled on beacon (Shake to connect)

isClose

public final boolean isClose

Near to connect field - is set to true if device is cloe to the user's phone. This feature needs to be enabled prior tu use it

rssi

public final java.lang.Integer rssi

Received Signal Strength Indicator of given packet. This value may be affected by some of our smoothing algorithms

txPower

public final java.lang.Integer txPower

Transfer power of given packet. In decibels

discoveryTime

public final java.lang.Long discoveryTime

Exact time when this packet was scanned

CREATOR

public static final android.os.Parcelable.Creator<ConfigurableDevice> CREATOR

Constructor Detail

ConfigurableDevice

public ConfigurableDevice(DeviceType type,
                          DeviceId deviceId,
                          MacAddress macAddress,
                          java.lang.String appVersion,
                          java.lang.String bootloaderVersion,
                          boolean isShaken,
                          boolean isClose,
                          java.lang.Integer rssi,
                          java.lang.Integer txPower,
                          java.lang.Long discoveryTime)

ConfigurableDevice

public ConfigurableDevice(DeviceType type,
                          DeviceId deviceId,
                          MacAddress macAddress,
                          java.lang.String appVersion,
                          java.lang.String bootloaderVersion)

Method Detail

getUniqueKey

public java.lang.String getUniqueKey()

Description copied from class: Packet

Returns unique key for this packet to identify it between other Packet objects. Child classes should implement this method.

Specified by:

getUniqueKey in class Packet

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class Packet

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object