com.kontakt.sdk.android.ble.device

Class BeaconDevice

java.lang.Object

com.kontakt.sdk.android.ble.device.BeaconDevice

All Implemented Interfaces:

IBeaconDevice, RemoteBluetoothDevice, java.lang.Comparable<IBeaconDevice>

public class BeaconDevice
extends java.lang.Object
implements IBeaconDevice

Class representing a real Beacon device. Please, note that in the SDK there is also another Beacon class (Beacon) which represents a JSON model for a Beacon and is accessible while interacting with the REST Client.

Nested Class Summary

Nested classes/interfaces inherited from interface com.kontakt.sdk.android.common.profile.RemoteBluetoothDevice

RemoteBluetoothDevice.Characteristics

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR The Parcelable CREATOR constant.

Constructor Summary

Constructors

Constructor and Description
BeaconDevice(IBeaconAdvertisingPacket advertisingPacket) Instantiates a new Beacon.

Method Summary

Modifier and Type	Method and Description
int	compareTo(IBeaconDevice another)
int	describeContents()
boolean	equals(java.lang.Object o)
java.lang.String	getAddress() Gets MAC address of beacon.
int	getBatteryPower() Returns percentage battery power.
double	getDistance() Gets accuracy.
java.lang.String	getFirmwareVersion() Gets firmware version.
int	getMajor() Gets major value.
int	getMinor() Gets minor value.
java.lang.String	getName() Gets beacon name.
byte[]	getPassword() Gets password.
DeviceProfile	getProfile()
Proximity	getProximity() Gets one of three values: IMMEDIATE, NEAR, FAR.
java.util.UUID	getProximityUUID() Gets Proximity UUID.
double	getRssi() Gets rssi.
long	getTimestamp() Gets timestamp - time when beacon device was discovered
int	getTxPower() Gets measured power.
java.lang.String	getUniqueId() Gets beacon unique id.
int	hashCode()
boolean	isShuffled() Checks is device shuffled
static BeaconDevice	of(IBeaconDevice beaconDevice, ResolvedId resolvedId) Creates BeaconDevice from BeaconDevice and ResolvedId
void	setPassword(byte[] password) Sets authorization password.
void	writeToParcel(Parcel output, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final <any> CREATOR

The Parcelable CREATOR constant.

Constructor Detail

BeaconDevice

public BeaconDevice(IBeaconAdvertisingPacket advertisingPacket)

Instantiates a new Beacon.

Parameters:

advertisingPacket - the advertising package

Method Detail

of

public static BeaconDevice of(IBeaconDevice beaconDevice,
                              ResolvedId resolvedId)

Creates BeaconDevice from BeaconDevice and ResolvedId

Should be used when resolving shuffled beacons manually

Parameters:

beaconDevice - source beacon device

resolvedId - target resolved values

Returns:

new beacon device

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel output,
                          int flags)

compareTo

public int compareTo(IBeaconDevice another)

Specified by:

compareTo in interface java.lang.Comparable<IBeaconDevice>

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

getTimestamp

public long getTimestamp()

Gets timestamp - time when beacon device was discovered

Specified by:

getTimestamp in interface RemoteBluetoothDevice

Returns:

the timestamp

getProximityUUID

public java.util.UUID getProximityUUID()

Gets Proximity UUID.

Specified by:

getProximityUUID in interface IBeaconDevice

Returns:

the proximity UUID

getProximity

public Proximity getProximity()

Gets one of three values: IMMEDIATE, NEAR, FAR.

Specified by:

getProximity in interface RemoteBluetoothDevice

Returns:

the proximity

getBatteryPower

public int getBatteryPower()

Returns percentage battery power.

Specified by:

getBatteryPower in interface RemoteBluetoothDevice

Returns:

the battery power

getMajor

public int getMajor()

Gets major value.

Specified by:

getMajor in interface IBeaconDevice

Returns:

the major

getUniqueId

public java.lang.String getUniqueId()

Gets beacon unique id.

Specified by:

getUniqueId in interface RemoteBluetoothDevice

Returns:

the beacon unique id

getMinor

public int getMinor()

Gets minor value.

Specified by:

getMinor in interface IBeaconDevice

Returns:

the minor

getTxPower

public int getTxPower()

Gets measured power.

Specified by:

getTxPower in interface RemoteBluetoothDevice

Returns:

the measured power

getProfile

public DeviceProfile getProfile()

Specified by:

getProfile in interface RemoteBluetoothDevice

getDistance

public double getDistance()

Gets accuracy. The accuracy is calculated according to algorithm described in the Stack Overflow answer.

Specified by:

getDistance in interface RemoteBluetoothDevice

Returns:

the accuracy [m]

See Also:

Stack Overflow answer

getAddress

public java.lang.String getAddress()

Gets MAC address of beacon.

Specified by:

getAddress in interface RemoteBluetoothDevice

Returns:

the mac address

setPassword

public void setPassword(byte[] password)

Sets authorization password.

Specified by:

setPassword in interface RemoteBluetoothDevice

Parameters:

password - the password

getPassword

public byte[] getPassword()

Gets password.

Specified by:

getPassword in interface RemoteBluetoothDevice

Returns:

the byte [ ]

getRssi

public double getRssi()

Gets rssi.

Specified by:

getRssi in interface RemoteBluetoothDevice

Returns:

the rssi

getName

public java.lang.String getName()

Gets beacon name.

Specified by:

getName in interface RemoteBluetoothDevice

Returns:

the name

getFirmwareVersion

public java.lang.String getFirmwareVersion()

Gets firmware version.

Specified by:

getFirmwareVersion in interface RemoteBluetoothDevice

Returns:

the firmware version

isShuffled

public boolean isShuffled()

Checks is device shuffled

Specified by:

isShuffled in interface RemoteBluetoothDevice

Returns:

true or false