com.estimote.coresdk.recognition.packets

Class Nearable

java.lang.Object

com.estimote.coresdk.recognition.packets.Packet

com.estimote.coresdk.recognition.packets.Nearable

All Implemented Interfaces:

android.os.Parcelable

public class Nearable
extends Packet

Immutable representation of a nearable.

Two Nearables are considered equal if their identifiers are equal.

You can find nearby Nearables using BeaconManager.startNearableDiscovery() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Nearable.BatteryLevel
static class	Nearable.FirmwareState Type of firmware that Nearable is running.
static class	Nearable.Orientation Possible physical orientations of nearable in space.

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
Nearable.BatteryLevel	batteryLevel Device's battery level.
BeaconRegion	beaconRegion iBeacon region (Location UUID, major, minor) broadcasted by the sticker as every third Bluetooth packet.
java.lang.String	bootloaderVersion Version of bootloader firmware.
Color	color Nearable color - not final, because this info is resolved from cloud
static android.os.Parcelable.Creator<Nearable>	CREATOR
long	currentMotionStateDuration Time since last change of motion state (isMoving value changed) returned in seconds.
Nearable.FirmwareState	firmwareState Type of firmware running on Nearable.
java.lang.String	firmwareVersion Version of firmware.
java.lang.String	hardwareVersion Revision of hardware.
java.lang.String	identifier Unique nearable identifier.
boolean	isMoving Whether Nearable is moving.
long	lastMotionStateDuration Time of nearable's previous motion state returned in seconds.
Nearable.Orientation	orientation Physical orientation of nearable in space.
BroadcastingPower	power Signal strength emitted by the nearable at 0 meters distance.
int	rssi Received Signal Strength Indication at the moment of scanning.
double	temperature Ambient temperature value (in Celsius).
NearableType	type Nearable type - not final, because this info is resolved from cloud
double	xAcceleration X-Axis acceleration value (in milli g, where g is 9,81 m/s^2).
double	yAcceleration Y-Axis acceleration value (in milli g, where g is 9,81 m/s^2).
double	zAcceleration Z-Axis acceleration value (in milli g, where g is 9,81 m/s^2).

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

Modifier	Constructor and Description
protected	Nearable(android.os.Parcel in)
	Nearable(java.lang.String identifier, BeaconRegion beaconRegion, Nearable.FirmwareState firmwareState, java.lang.String hardwareVersion, java.lang.String firmwareVersion, java.lang.String bootloaderVersion, double temperature, int rssi, boolean isMoving, double xAcceleration, double yAcceleration, double zAcceleration, long currentMotionStateDuration, long lastMotionStateDuration, Nearable.BatteryLevel batteryLevel, BroadcastingPower power)

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	isMotionBroken() Checks if given nearable has broken motion sensor
boolean	isTemperatureBroken() Checks if given nearable has broken temperature sensor
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

identifier

public final java.lang.String identifier

Unique nearable identifier.

hardwareVersion

public final java.lang.String hardwareVersion

Revision of hardware.

firmwareVersion

public final java.lang.String firmwareVersion

Version of firmware.

bootloaderVersion

public final java.lang.String bootloaderVersion

Version of bootloader firmware.

firmwareState

public final Nearable.FirmwareState firmwareState

Type of firmware running on Nearable.

temperature

public final double temperature

Ambient temperature value (in Celsius).

rssi

public final int rssi

Received Signal Strength Indication at the moment of scanning.

isMoving

public final boolean isMoving

Whether Nearable is moving.

xAcceleration

public final double xAcceleration

X-Axis acceleration value (in milli g, where g is 9,81 m/s^2).

yAcceleration

public final double yAcceleration

Y-Axis acceleration value (in milli g, where g is 9,81 m/s^2).

zAcceleration

public final double zAcceleration

Z-Axis acceleration value (in milli g, where g is 9,81 m/s^2).

orientation

public final Nearable.Orientation orientation

Physical orientation of nearable in space.

currentMotionStateDuration

public final long currentMotionStateDuration

Time since last change of motion state (isMoving value changed) returned in seconds.

lastMotionStateDuration

public final long lastMotionStateDuration

Time of nearable's previous motion state returned in seconds.

batteryLevel

public final Nearable.BatteryLevel batteryLevel

Device's battery level.

power

public final BroadcastingPower power

Signal strength emitted by the nearable at 0 meters distance.

beaconRegion

public final BeaconRegion beaconRegion

iBeacon region (Location UUID, major, minor) broadcasted by the sticker as every third Bluetooth packet.

type

public NearableType type

Nearable type - not final, because this info is resolved from cloud

color

public Color color

Nearable color - not final, because this info is resolved from cloud

CREATOR

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

Constructor Detail

Nearable

public Nearable(java.lang.String identifier,
                BeaconRegion beaconRegion,
                Nearable.FirmwareState firmwareState,
                java.lang.String hardwareVersion,
                java.lang.String firmwareVersion,
                java.lang.String bootloaderVersion,
                double temperature,
                int rssi,
                boolean isMoving,
                double xAcceleration,
                double yAcceleration,
                double zAcceleration,
                long currentMotionStateDuration,
                long lastMotionStateDuration,
                Nearable.BatteryLevel batteryLevel,
                BroadcastingPower power)

Nearable

protected Nearable(android.os.Parcel in)

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

toString

public java.lang.String toString()

Overrides:

toString 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

isTemperatureBroken

public boolean isTemperatureBroken()

Checks if given nearable has broken temperature sensor

Returns:

if temperature sensor is broken

isMotionBroken

public boolean isMotionBroken()

Checks if given nearable has broken motion sensor

Returns:

if motion sensor is broken