com.estimote.coresdk.recognition.packets

Class Eddystone

java.lang.Object

com.estimote.coresdk.recognition.packets.Packet

com.estimote.coresdk.recognition.packets.Eddystone

All Implemented Interfaces:

android.os.Parcelable

public class Eddystone
extends Packet

Immutable representation of Eddystone-UID and Eddystone-URL beacons.

Eddystone beacon can either transmit Eddystone-UID or Eddystone-URL packet. Never both.

Periodically beacon sends telemetry information. Available in telemetry field along with time it was seen telemetryLastSeenMillis.

Author:

wiktor@estimote.com (Wiktor Gworek)

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
int	calibratedTxPower Signal strength emitted by the beacon in dBm at 0 meters distance.
static android.os.Parcelable.Creator<Eddystone>	CREATOR
EddystoneEID	eid Eddystone EID information after resolving in google cloud.
java.lang.String	instance Eddystone-UID instance.
MacAddress	macAddress MAC address of the beacon.
java.lang.String	namespace Eddystone-UID namespace.
int	rssi Received Signal Strength Indication at the moment of scanning.
EddystoneTelemetry	telemetry Telemetry information for this beacon.
java.lang.Long	telemetryLastSeenMillis Time in milliseconds when last telemetry was seen for this beacon.
java.lang.String	url Eddystone-URL url.

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
Eddystone(MacAddress macAddress, int calibratedTxPower, int rssi, java.lang.String namespace, java.lang.String instance, java.lang.String url, java.lang.Long telemetryLastSeenMillis, EddystoneTelemetry telemetry, EddystoneEID eid)
Eddystone(android.os.Parcel in)

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()
boolean	isEid() Returns true if Eddystone was encoded as EID
boolean	isUid() Returns true if Eddystone is setup as Eddystone-UID
boolean	isUrl() Returns true if Eddystone is setup as Eddystone-URL
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, toString, wait, wait, wait

Field Detail

macAddress

public final MacAddress macAddress

MAC address of the beacon.

calibratedTxPower

public final int calibratedTxPower

Signal strength emitted by the beacon in dBm at 0 meters distance.

rssi

public final int rssi

Received Signal Strength Indication at the moment of scanning.

namespace

public final java.lang.String namespace

Eddystone-UID namespace. 10-byte identifier encoded as hex. Null when Eddystone is setup as Eddystone-URL.

instance

public final java.lang.String instance

Eddystone-UID instance. 6-byte identifier encoded as hex. Null when Eddystone is setup as Eddystone-URL.

url

public final java.lang.String url

Eddystone-URL url. Null when Eddystone is setup as Eddystone-UID.

telemetryLastSeenMillis

public final java.lang.Long telemetryLastSeenMillis

Time in milliseconds when last telemetry was seen for this beacon. Null if wasn't seen recently.

telemetry

public final EddystoneTelemetry telemetry

Telemetry information for this beacon. Null if telemetry is not yet known.

eid

public final EddystoneEID eid

Eddystone EID information after resolving in google cloud.

CREATOR

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

Constructor Detail

Eddystone

public Eddystone(MacAddress macAddress,
                 int calibratedTxPower,
                 int rssi,
                 java.lang.String namespace,
                 java.lang.String instance,
                 java.lang.String url,
                 java.lang.Long telemetryLastSeenMillis,
                 EddystoneTelemetry telemetry,
                 EddystoneEID eid)

Eddystone

public Eddystone(android.os.Parcel in)

Method Detail

isUid

public boolean isUid()

Returns true if Eddystone is setup as Eddystone-UID

isUrl

public boolean isUrl()

Returns true if Eddystone is setup as Eddystone-URL

isEid

public boolean isEid()

Returns true if Eddystone was encoded as EID

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