com.swirl

Class Beacon

java.lang.Object

com.swirl.SObject

com.swirl.Signal

com.swirl.Beacon

Direct Known Subclasses:

Config.Beacon

public class Beacon
extends Signal

A Beacon object defines a type of Signal that is based on the device's proximity to a Bluetooth beacon, as opposed to a geographic location or wifi network. A beacon aggregates a set of BeaconAdvertisements from a specific beacon device and matches that device with logical location, placement, and custom attributes specified through the platform. When the beacon device comes in range, the BeaconManager will change the state of the beacon and will generate appropriate events and post them to the EventBus.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENTERED_RSSI This value is for an RSSI that forces a placement/zone entry.
static double	INVALID_RANGE This value for a range indicates that there is not enough information to return a value
static int	INVALID_RSSI This value for an RSSI indicates that there is not enough information to return a value
static int	STATE_INSIDE This value indicates that there are valid advertisements to compute a range and the BeaconManager has determined that the beacon is within the specified range.
static int	STATE_OUTSIDE This value indicates that there are valid advertisements to compute a range and the BeaconManager has determined that the beacon is outside of the specified range.
static int	STATE_UNKNOWN This value indicates that there are not enough recent advertisements to compute a state.

Fields inherited from class com.swirl.Signal

location, TYPE_BEACON, TYPE_GEOFENCE, TYPE_WIFI

Fields inherited from class com.swirl.SObject

properties

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddress()
java.util.List<BeaconAdvertisement>	getAdvertisements() Get the list of current BeaconAdvertisements associated to this beacon.
int	getdBm1() Returns the 1m measured power.
java.lang.String	getExtra() Searches the recent BeaconAdvertisements associated with this beacon to find any TLM or out-of-band data packets and returns that information as a base-64 encoded string.
BeaconAdvertisement	getLast() Get the last BeaconAdvertisement received.
long	getLastDetected() Get the detected timestamp from the last BeaconAdvertisement or return 0
java.lang.String	getManufacturer() Return the registered manufacturer
java.lang.String	getModel() Returns the Beacon mdoel string
java.lang.String	getName()
SObject	getPartner() Return the partner for this beacon
Peripheral	getPeripheral() Get the peripheral associated with this beacon (if in configuration mode)
int	getPower() Get the transmit power as specified in the platform database (as opposed to read directly from the beacon).
int	getProtocol() Return the protocol of the underlying advertisements
java.lang.String	getProtocolString() Return the protocol description of the underlying advertisements
double	getRange() Compute a range in meters based on the current RSSI estimate.
int	getRssi() Computes a RSSI value based on the current working set of BeaconAdvertisements associated with this beacon.
java.lang.String	getSerial() If resolved, returns the beacon serial number, otherwise an empty string.
int	getState() Return the current state of the beacon with respect to its threshold.
int	getThreshold() Get the RSSI threshold value.
int	getType() Inherited from Signal, for beacons this always returns the same value.
boolean	isConnectable()
boolean	isOverlapping() Determine if this beacon is part of an overlapping placement or not.
void	setRssiParams(org.json.JSONObject params) Set a custom RSSI params to control RSSI smoothing opt_sample_age - optimal seconds to average over max_sample_age - maximum seconds to average over if less than min samples min_samples - minimum number of samples to require
java.lang.String	toString()

Methods inherited from class com.swirl.Signal

getAttachments, getAttributes, getError, getLabels, getLocation, getURN, setError

Methods inherited from class com.swirl.SObject

equals, getArray, getArray, getDouble, getIdentifier, getInt, getObject, getObject, getString, getString, hashCode, setProperties

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_RSSI

public static final int INVALID_RSSI

This value for an RSSI indicates that there is not enough information to return a value

See Also:

Constant Field Values

ENTERED_RSSI

public static final int ENTERED_RSSI

This value is for an RSSI that forces a placement/zone entry. For beacons/signals that only generate and enter/exit event.

See Also:

Constant Field Values

INVALID_RANGE

public static final double INVALID_RANGE

This value for a range indicates that there is not enough information to return a value

See Also:

Constant Field Values

STATE_UNKNOWN

public static final int STATE_UNKNOWN

This value indicates that there are not enough recent advertisements to compute a state. Possibly this is a newly detected beacon, or an older beacon that has since timed out.

See Also:

Constant Field Values

STATE_OUTSIDE

public static final int STATE_OUTSIDE

This value indicates that there are valid advertisements to compute a range and the BeaconManager has determined that the beacon is outside of the specified range.

See Also:

Constant Field Values

STATE_INSIDE

public static final int STATE_INSIDE

This value indicates that there are valid advertisements to compute a range and the BeaconManager has determined that the beacon is within the specified range.

See Also:

Constant Field Values

Method Detail

getAdvertisements

public java.util.List<BeaconAdvertisement> getAdvertisements()

Get the list of current BeaconAdvertisements associated to this beacon.

Returns:

returns a list of all current BeaconAdvertisements

getType

public int getType()

Inherited from Signal, for beacons this always returns the same value.

Specified by:

getType in class Signal

Returns:

Signal.TYPE_BEACON

getName

public java.lang.String getName()

Overrides:

getName in class SObject

getAddress

public java.lang.String getAddress()

getPartner

public SObject getPartner()

Return the partner for this beacon

Returns:

Partner

getManufacturer

public java.lang.String getManufacturer()

Return the registered manufacturer

Returns:

manufacturer string

getModel

public java.lang.String getModel()

Returns the Beacon mdoel string

Returns:

model

getSerial

public java.lang.String getSerial()

If resolved, returns the beacon serial number, otherwise an empty string.

Returns:

serial number string or empty

getProtocol

public int getProtocol()

Return the protocol of the underlying advertisements

Returns:

protocol id

getProtocolString

public java.lang.String getProtocolString()

Return the protocol description of the underlying advertisements

Returns:

protocol string

isConnectable

public boolean isConnectable()

getPeripheral

public Peripheral getPeripheral()

Get the peripheral associated with this beacon (if in configuration mode)

Returns:

associated peripheral or null if not found or not connectable

getPower

public int getPower()

Get the transmit power as specified in the platform database (as opposed to read directly from the beacon).

Returns:

The transmit power (if not specified, defaults to 0)

getThreshold

public int getThreshold()

Get the RSSI threshold value. This value is computed from the pathloss threshold sent by the server.

Returns:

The RSSI threshold value.

isOverlapping

public boolean isOverlapping()

Determine if this beacon is part of an overlapping placement or not.

Returns:

true if in an overlapping placement, false otherwise

getdBm1

public int getdBm1()

Returns the 1m measured power. This value can be broadcast as part of the BeaconAdvertisement for some beacon protocols. For others this value is estimated from the transmit power.

Returns:

expected RSSI at 1m

getExtra

public java.lang.String getExtra()

Searches the recent BeaconAdvertisements associated with this beacon to find any TLM or out-of-band data packets and returns that information as a base-64 encoded string.

Returns:

base-64 encoded data or null

setRssiParams

public void setRssiParams(org.json.JSONObject params)

Set a custom RSSI params to control RSSI smoothing opt_sample_age - optimal seconds to average over max_sample_age - maximum seconds to average over if less than min samples min_samples - minimum number of samples to require

getRssi

public int getRssi()

Computes a RSSI value based on the current working set of BeaconAdvertisements associated with this beacon. The algorithm computes an average by scanning backwards over the last 20 seconds of advertisements. If it cannot find enough samples, it will look back another 10 seconds. If it can find at least 2 samples, then it will return the average.

Returns:

average RSSI over the last 20-30 seconds

getRange

public double getRange()

Compute a range in meters based on the current RSSI estimate.

Specified by:

getRange in class Signal

Returns:

current distance to the beacon

getState

public int getState()

Return the current state of the beacon with respect to its threshold.

Returns:

STATE_INSIDE if within the beacon range, STATE_OUTSIDE if outside, STATE_UNKNOWN otherwise.

getLast

public BeaconAdvertisement getLast()

Get the last BeaconAdvertisement received.

Returns:

the last beacon advertisement or null.

getLastDetected

public long getLastDetected()

Get the detected timestamp from the last BeaconAdvertisement or return 0

Specified by:

getLastDetected in class Signal

Returns:

the detected timestamp from the last BeaconAdvertisement or 0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object