com.radiusnetworks.proximity

Class ProximityKitBeacon

java.lang.Object

org.altbeacon.beacon.Beacon

com.radiusnetworks.proximity.ProximityKitBeacon

All Implemented Interfaces:

Parcelable, Serializable

public class ProximityKitBeacon
extends Beacon

Since:

0.1.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.altbeacon.beacon.Beacon

Beacon.Builder

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator, Parcelable.Creator

Field Summary

Fields inherited from class org.altbeacon.beacon.Beacon

beaconDataFactory, CREATOR, mBeaconTypeCode, mBluetoothAddress, mBluetoothName, mDataFields, mDistance, mExtraDataFields, mIdentifiers, mManufacturer, mMultiFrameBeacon, mParserIdentifier, mRssi, mServiceUuid, mTxPower, sDistanceCalculator, sHardwareEqualityEnforced

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
ProximityKitBeacon(Beacon beacon, KitBeacon kitBeacon) Create a new Proximity Kit beacon Not for public use.

Method Summary

Modifier and Type	Method and Description
Map	getAttributes() Meta data attributes defined for the beacon on the Proximity Kit server.
Integer	getBatteryLevel() Advertised remaining battery level, as a percentage, for the beacon.
String	getName() Name of the beacon as configured on the Proximity Kit server

Methods inherited from class org.altbeacon.beacon.Beacon

calculateDistance, describeContents, equals, getBeaconTypeCode, getBluetoothAddress, getBluetoothName, getDataFields, getDistance, getDistanceCalculator, getExtraDataFields, getHardwareEqualityEnforced, getId1, getId2, getId3, getIdentifier, getIdentifiers, getManufacturer, getMeasurementCount, getPacketCount, getParserIdentifier, getRssi, getRunningAverageRssi, getRunningAverageRssi, getServiceUuid, getTxPower, hashCode, isExtraBeaconData, isMultiFrameBeacon, requestData, setDistanceCalculator, setExtraDataFields, setHardwareEqualityEnforced, setPacketCount, setRssi, setRssiMeasurementCount, setRunningAverageRssi, toString, writeToParcel

Methods inherited from class java.lang.Object

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

Constructor Detail

ProximityKitBeacon

public ProximityKitBeacon(Beacon beacon,
                          KitBeacon kitBeacon)

Create a new Proximity Kit beacon

Not for public use.

Method Detail

getName

public String getName()

Name of the beacon as configured on the Proximity Kit server

Returns:

the configured name for the beacon or null

getAttributes

public Map getAttributes()

Meta data attributes defined for the beacon on the Proximity Kit server.

Returns:

Map of key-value attributes; if no meta data attributes are defined the map will be empty.

getBatteryLevel

public Integer getBatteryLevel()

Advertised remaining battery level, as a percentage, for the beacon.

Only some beacon advertisements support providing battery information. Additionally, not all physical beacon hardware is battery operated or runs firmware which supports providing the battery level.

Battery level reporting is currently supported by AltBeacon advertisements. The battery level is advertised in a single byte of the standard payload. As this is part of the standard advertisement payload, non-battery powered hardware advertises zero for this byte. Accordingly, a zero value in the payload is interpreted as the beacon hardware not being battery powered (instead of meaning less than one percent of battery remaining).

Returns:

the percentage of battery remaining, from 1 - 100, for this beacon or null if the level cannot be determined