com.reveldigital.player.api

Interface Beacon

public interface Beacon

The Interface Beacon.

Beacon associated with a beacon event such as when a user enters or exits the beacon activation area.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBluetoothName() Get the Bluetooth device name.
int	getDeviceId() Gets the beacon device id
double	getDistance() Get an estimate of how far the beacon is away in meters.
long	getDwell() Gets the dwell time (in milliseconds)
int	getId() Gets the beacon ping unique id
java.lang.String	getId1() Get the 1st beacon identifier
java.lang.String	getId2() Get the 2nd beacon identifier
java.lang.String	getId3() Get the 3rd beacon identifier
double	getLatitude() Gets the location latitude for this beacon
double	getLongitude() Gets the location longitude for this beacon
java.lang.String	getMacAddress() Gets the beacon MAC address
int	getManufacturer() A two byte code indicating the beacon manufacturer.
int	getPingType() Gets the type of beacon event.
int	getRssi() Get the measured signal strength of the Bluetooth packet.
java.util.Date	getTimestamp() Gets the timestamp for the beacon event
int	getTxPower() The calibrated measured Tx power of the Beacon in RSSI This value is baked into an Beacon when it is manufactured, and it is transmitted with each packet to aid in the mDistance estimate
BeaconUser	getUser() Gets the user profile associated with this beacon event

Method Detail

getId

int getId()

Gets the beacon ping unique id

Returns:

id

getDeviceId

int getDeviceId()

Gets the beacon device id

Returns:

device id

getTimestamp

java.util.Date getTimestamp()

Gets the timestamp for the beacon event

Returns:

timestamp

getPingType

int getPingType()

Gets the type of beacon event.

Mask this value with the following values to determine the event type:

16 for ENTER event 32 for EXIT event

Eg: if (getPingType() & 32) == 32) { Log.d("EXIT event"); }

Returns:

ping type

getDwell

long getDwell()

Gets the dwell time (in milliseconds)

Returns:

dwell time

getRssi

int getRssi()

Get the measured signal strength of the Bluetooth packet.

Returns:

RSSI

getTxPower

int getTxPower()

The calibrated measured Tx power of the Beacon in RSSI This value is baked into an Beacon when it is manufactured, and it is transmitted with each packet to aid in the mDistance estimate

Returns:

Tx power

getDistance

double getDistance()

Get an estimate of how far the beacon is away in meters.

Returns:

distance from beacon in meters

getId1

java.lang.String getId1()

Get the 1st beacon identifier

Returns:

1st beacon identifier

getId2

java.lang.String getId2()

Get the 2nd beacon identifier

Returns:

2nd beacon identifier

getId3

java.lang.String getId3()

Get the 3rd beacon identifier

Returns:

3rd beacon identifier

getLatitude

double getLatitude()

Gets the location latitude for this beacon

Returns:

latitude

getLongitude

double getLongitude()

Gets the location longitude for this beacon

Returns:

longitude

getMacAddress

java.lang.String getMacAddress()

Gets the beacon MAC address

Returns:

MAC address or null if not available

getManufacturer

int getManufacturer()

A two byte code indicating the beacon manufacturer.

Returns:

beacon manufacturer code

getBluetoothName

java.lang.String getBluetoothName()

Get the Bluetooth device name.

Returns:

Bluetooth device name

getUser

BeaconUser getUser()

Gets the user profile associated with this beacon event

Returns:

user profile