com.swirl

Class BeaconAdvertisement

java.lang.Object

com.swirl.BeaconAdvertisement

public class BeaconAdvertisement
extends java.lang.Object

A BeaconAdvertisement is an object which represents a Bluetooth Beacon advertisement in a normalized way for consumption by the rest of the library. Beacon protocols broadcast beacon identity information and optionally other attributes, like telemetry (temperature, time, battery, etc).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEACON_TYPE_EID
static java.lang.String	BEACON_TYPE_IBEACON
static java.lang.String	BEACON_TYPE_UID
static java.lang.String	BEACON_TYPE_UNSPECIFIED
int	dbm1 A dB at 1m as reported by the beacon device (if reported).
long	detected A millisecond timestamp based on System.currentTimeMillis().
java.lang.String	device The Beacon mac address as reported by the operation system.
static android.os.ParcelUuid	EDDYSTONE_UUID A Bluetooth standard UUID representing a TI Firmware upgrade service
java.lang.String	extra Any associated telemetry or out-of-band data send in other packets.
java.lang.String	identifier A String which represents a normalized protocol specific representation of beacon identity.
static int	PROTOCOL_EDDYSTONE_EID
static int	PROTOCOL_EDDYSTONE_UID
static int	PROTOCOL_EDDYSTONE_URL
static int	PROTOCOL_GENERIC
static int	PROTOCOL_IBEACON
static int	PROTOCOL_KONTAKT
static int	PROTOCOL_SECURECAST
static int	PROTOCOL_SWIRL
static int	PROTOCOL_UNKNOWN
int	rssi An RSSI value as reported by the operating system.
static android.os.ParcelUuid	SECURECAST_UUID A Bluetooth standard UUID representing the SecureCast Service.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static BeaconAdvertisement	fromBytes(byte[] scanRecord, int rssi, long timestamp, java.lang.String device) Construct a BeaconAdvertisement from an array of bytes.
static BeaconAdvertisement	fromScanRecord(android.bluetooth.le.ScanRecord scanRecord, int rssi, long timestamp, java.lang.String device) Constructs a BeaconAdvertisement from a scanRecord
int	getDbm1()
static java.lang.String	getGoogleBeaconId(java.lang.String identifier) Returns the google proximity beacon API compatible formatted identifier
static java.lang.String	getGoogleBeaconType(java.lang.String identifier) Returns the google proximity beacon API compatible formatted type identifier
java.lang.String	getNamespaceString() Returns the namespace string for eddystone-uid protocols
int	getProtocol() Returns the identifier for the protocol
static int	getProtocol(java.lang.String identifier) Returns the identifier for the protocol given an identifier
java.lang.String	getProtocolString() Returns the protocol of the advertisement
static java.lang.String	getProtocolString(int id) Returns the protocol description given the id
int	hashCode()
boolean	isConnectable() Returns the connectability state of the device NOTE: unfortunately due to a current android limitation, always returns *true*
static java.lang.String[]	parseIdentifier(java.lang.String identifier) Returns a parsed urn identifier
java.lang.String	toString()
java.lang.String	uniquePrefix()
static java.lang.String	uniquePrefix(java.lang.String identifier)

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_UNKNOWN

public static final int PROTOCOL_UNKNOWN

See Also:

Constant Field Values

PROTOCOL_IBEACON

public static final int PROTOCOL_IBEACON

See Also:

Constant Field Values

PROTOCOL_EDDYSTONE_URL

public static final int PROTOCOL_EDDYSTONE_URL

See Also:

Constant Field Values

PROTOCOL_EDDYSTONE_UID

public static final int PROTOCOL_EDDYSTONE_UID

See Also:

Constant Field Values

PROTOCOL_EDDYSTONE_EID

public static final int PROTOCOL_EDDYSTONE_EID

See Also:

Constant Field Values

PROTOCOL_SECURECAST

public static final int PROTOCOL_SECURECAST

See Also:

Constant Field Values

PROTOCOL_SWIRL

public static final int PROTOCOL_SWIRL

See Also:

Constant Field Values

PROTOCOL_KONTAKT

public static final int PROTOCOL_KONTAKT

See Also:

Constant Field Values

PROTOCOL_GENERIC

public static final int PROTOCOL_GENERIC

See Also:

Constant Field Values

SECURECAST_UUID

public static final android.os.ParcelUuid SECURECAST_UUID

A Bluetooth standard UUID representing the SecureCast Service.

EDDYSTONE_UUID

public static final android.os.ParcelUuid EDDYSTONE_UUID

A Bluetooth standard UUID representing a TI Firmware upgrade service

identifier

public java.lang.String identifier

A String which represents a normalized protocol specific representation of beacon identity.

detected

public long detected

A millisecond timestamp based on System.currentTimeMillis().

rssi

public int rssi

An RSSI value as reported by the operating system.

dbm1

public int dbm1

A dB at 1m as reported by the beacon device (if reported).

device

public java.lang.String device

The Beacon mac address as reported by the operation system.

extra

public java.lang.String extra

Any associated telemetry or out-of-band data send in other packets. For Eddystone, this would be TLM packet data.

BEACON_TYPE_UID

public static final java.lang.String BEACON_TYPE_UID

See Also:

Constant Field Values

BEACON_TYPE_EID

public static final java.lang.String BEACON_TYPE_EID

See Also:

Constant Field Values

BEACON_TYPE_IBEACON

public static final java.lang.String BEACON_TYPE_IBEACON

See Also:

Constant Field Values

BEACON_TYPE_UNSPECIFIED

public static final java.lang.String BEACON_TYPE_UNSPECIFIED

See Also:

Constant Field Values

Method Detail

getDbm1

public int getDbm1()

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

getProtocolString

public static java.lang.String getProtocolString(int id)

Returns the protocol description given the id

Returns:

protocol description

getProtocol

public static int getProtocol(java.lang.String identifier)

Returns the identifier for the protocol given an identifier

Returns:

protocol description

parseIdentifier

public static java.lang.String[] parseIdentifier(java.lang.String identifier)

Returns a parsed urn identifier

Parameters:

identifier -

Returns:

arrays of parts with part[0] being the protocol

getNamespaceString

public java.lang.String getNamespaceString()

Returns the namespace string for eddystone-uid protocols

Returns:

hex-string of the uid or eddystone namespace

getProtocolString

public java.lang.String getProtocolString()

Returns the protocol of the advertisement

Returns:

protocol description

getProtocol

public int getProtocol()

Returns the identifier for the protocol

Returns:

protocol description

isConnectable

public boolean isConnectable()

Returns the connectability state of the device NOTE: unfortunately due to a current android limitation, always returns *true*

Returns:

true if connectable

uniquePrefix

public java.lang.String uniquePrefix()

uniquePrefix

public static java.lang.String uniquePrefix(java.lang.String identifier)

getGoogleBeaconType

public static java.lang.String getGoogleBeaconType(java.lang.String identifier)

Returns the google proximity beacon API compatible formatted type identifier

Parameters:

identifier -

Returns:

proximity api type

getGoogleBeaconId

public static java.lang.String getGoogleBeaconId(java.lang.String identifier)

Returns the google proximity beacon API compatible formatted identifier

Parameters:

identifier -

Returns:

base64 string compatible with proximity API

fromScanRecord

public static BeaconAdvertisement fromScanRecord(android.bluetooth.le.ScanRecord scanRecord,
                                                 int rssi,
                                                 long timestamp,
                                                 java.lang.String device)

Constructs a BeaconAdvertisement from a scanRecord

Parameters:

scanRecord - The scanRecord

rssi - The RSSI value

timestamp - The milliseconds since epoch

device - The mac-addressof the broadcasting device

Returns:

a BeaconAdvertisement

fromBytes

public static BeaconAdvertisement fromBytes(byte[] scanRecord,
                                            int rssi,
                                            long timestamp,
                                            java.lang.String device)

Construct a BeaconAdvertisement from an array of bytes.

Parameters:

scanRecord - The array of bytes containing advertisement data.

rssi - The RSSI value.

timestamp - The number of milliseconds since epoch start.

device - The mac-address of the bluetooth device (if available).

Returns:

a BeaconAdvertisement