Beacon

java.lang.Object
- com.oym.indoor.Beacon

All Implemented Interfaces:

java.lang.Comparable<Beacon>

Direct Known Subclasses:

Asset, ProxiBeacon
```
public class Beacon
extends java.lang.Object
implements java.lang.Comparable<Beacon>
```
This class includes all the information regarding the Beacon Items stored.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Beacon.BeaconStatus
Annotation defining the possible beacon status

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Beacon.BeaconStatus` Annotation defining the possible beacon status

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STATUS_LOST` Beacon is lost
`static int`	`STATUS_LOW_BATTERY` Beacon battery is low
`static int`	`STATUS_NEEDS_MAINTENANCE` Beacon needs maintenance
`static int`	`STATUS_NO_BATTERY` Beacon battery is empty
`static int`	`STATUS_OK` Beacon is working
`static int`	`STATUS_OUT_OF_ORDER` Beacon is out of order
`static java.lang.String`	`TYPE` String containing the Beacon type

Constructor Summary

Constructors
Constructor and Description
`Beacon(android.bluetooth.BluetoothDevice device, int rssi, byte[] scanRecord)` Deprecated. Use the `Beacon(BluetoothDevice, int, byte[], Building, Floor)` Constructor.
`Beacon(android.bluetooth.BluetoothDevice device, int rssi, byte[] scanRecord, Building building, Floor floor)` Beacon constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.String`	`bytesToHex(byte[] bytes, int start, int end)` This method converts an array of bytes to an hexadecimal string.
`int`	`compareTo(Beacon another)`
`double`	`computeAccuracy(double rssi)` This method computes an estimation of the accuracy according to the RSSI level received.
`static boolean`	`detect(byte[] scanRecord)` This method checks that the BLE broadcasted message corresponds to an Beacon or Eddystone Beacon.
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getBuilding()` Getter for the Beacon Building ID.
`java.lang.String`	`getFloor()` Getter for the Beacon Floor ID.
`int`	`getFloorNumber()` Getter for the Beacon Floor number.
`java.lang.String`	`getId()` Getter for the Beacon ID.
`java.lang.String`	`getIdentifier()` This method provides an identifier for the Beacon that can be used across the different platforms.
`double`	`getLatitude()` Getter for the Beacon latitude.
`double`	`getLongitude()` Getter for the Beacon longitude.
`int`	`getMajor()` Getter for the Beacon major.
`int`	`getMinor()` Getter for the Beacon minor.
`java.lang.String`	`getScanDate()` Getter for the Beacon scan date.
`int`	`getStatus()` Getter for the Beacon status.
`int`	`getTxPower()` Getter for the Beacon transmission power.
`java.lang.String`	`getType()` Deprecated.
`java.lang.String`	`getUuid()` Getter for the Beacon proximity UUID.
`double`	`getX()` Deprecated. Use `getLongitude()` instead.
`double`	`getY()` Deprecated. Use `getLatitude()` instead.
`int`	`hashCode()`
`void`	`setBuilding(java.lang.String building)` Setter for the Beacon Building ID.
`void`	`setFloor(java.lang.String floor)` Setter for the Beacon Floor ID.
`void`	`setFloorNumber(int floorNumber)` Setter for the Beacon Floor number.
`void`	`setId(java.lang.String id)` Setter for the Beacon ID.
`void`	`setLatitude(double lat)` Setter for the Beacon latitude.
`void`	`setLongitude(double lon)` Setter for the Beacon longitude.
`void`	`setMajor(int major)` Setter for the Beacon major.
`void`	`setMinor(int minor)` Setter for the Beacon minor.
`void`	`setScanDate(java.lang.String scanDate)` Setter for the Beacon scan date.
`void`	`setStatus(int status)` Setter for the Beacon status.
`void`	`setTxPower(int txPower)` Setter for the Beacon transmission power.
`void`	`setType(java.lang.String type)` Deprecated.
`void`	`setUuid(java.lang.String uuid)` Setter for the Beacon proximity UUID.
`void`	`setX(double x)` Deprecated. Use `setLongitude(double)` instead.
`void`	`setY(double y)` Deprecated. Use `setLatitude(double)` instead.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE
```
public static final java.lang.String TYPE
```
    String containing the Beacon type
    
    See Also:
    
    Constant Field Values
  - STATUS_OK
```
public static final int STATUS_OK
```
    Beacon is working
    
    See Also:
    
    Constant Field Values
  - STATUS_LOW_BATTERY
```
public static final int STATUS_LOW_BATTERY
```
    Beacon battery is low
    
    See Also:
    
    Constant Field Values
  - STATUS_LOST
```
public static final int STATUS_LOST
```
    Beacon is lost
    
    See Also:
    
    Constant Field Values
  - STATUS_NEEDS_MAINTENANCE
```
public static final int STATUS_NEEDS_MAINTENANCE
```
    Beacon needs maintenance
    
    See Also:
    
    Constant Field Values
  - STATUS_OUT_OF_ORDER
```
public static final int STATUS_OUT_OF_ORDER
```
    Beacon is out of order
    
    See Also:
    
    Constant Field Values
  - STATUS_NO_BATTERY
```
public static final int STATUS_NO_BATTERY
```
    Beacon battery is empty
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Beacon
```
public Beacon(android.bluetooth.BluetoothDevice device,
              int rssi,
              byte[] scanRecord,
              Building building,
              Floor floor)
```
    Beacon constructor.
    
    Parameters:
    
    device - BluetoothDevice object that identifies the remote device
    
    rssi - The RSSI value for the remote device as reported by the Bluetooth hardware
    
    scanRecord - The content of the advertisement record offered by the remote device
    
    building - Building object
    
    floor - Floor number
  - Beacon
```
public Beacon(android.bluetooth.BluetoothDevice device,
              int rssi,
              byte[] scanRecord)
```
    Deprecated. Use the Beacon(BluetoothDevice, int, byte[], Building, Floor) Constructor.
    
    Beacon partial constructor.
    
    Parameters:
    
    device - BluetoothDevice object that identifies the remote device
    
    rssi - The RSSI value for the remote device as reported by the Bluetooth hardware
    
    scanRecord - The content of the advertisement record offered by the remote device
- Method Detail
  - detect
```
public static boolean detect(byte[] scanRecord)
```
    This method checks that the BLE broadcasted message corresponds to an Beacon or Eddystone Beacon.
    
    Parameters:
    
    scanRecord - The content of the advertisement record offered by the remote device
    
    Returns:
    
    true if is an Beacon or Eddystone beacon, false otherwise
  - bytesToHex
```
public static java.lang.String bytesToHex(byte[] bytes,
                                          int start,
                                          int end)
```
    This method converts an array of bytes to an hexadecimal string.
    
    Parameters:
    
    bytes - Byte array to be decoded
    
    start - Initial position to be decoded
    
    end - Last position to be decoded
    
    Returns:
    
    The hexadecimal string representation of the selected bytes, 0 if error
  - compareTo
```
public int compareTo(Beacon another)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Beacon>
  - 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
  - computeAccuracy
```
public double computeAccuracy(double rssi)
```
    This method computes an estimation of the accuracy according to the RSSI level received.
    
    Parameters:
    
    rssi - The RSSI value for the remote device as reported by the Bluetooth hardware
    
    Returns:
    
    The estimated accuracy in meters
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    This method provides an identifier for the Beacon that can be used across the different platforms.
    
    Returns:
    
    A unique Beacon identifier
  - getId
```
public java.lang.String getId()
```
    Getter for the Beacon ID.
    
    Returns:
    
    The Beacon ID
  - getLatitude
```
public double getLatitude()
```
    Getter for the Beacon latitude.
    
    Returns:
    
    The Beacon latitude
  - setLatitude
```
public void setLatitude(double lat)
```
    Setter for the Beacon latitude.
    
    Parameters:
    
    lat - The Beacon latitude to be set
  - setId
```
public void setId(java.lang.String id)
```
    Setter for the Beacon ID.
    
    Parameters:
    
    id - The Beacon ID to be set
  - getLongitude
```
public double getLongitude()
```
    Getter for the Beacon longitude.
    
    Returns:
    
    The Beacon longitude
  - setLongitude
```
public void setLongitude(double lon)
```
    Setter for the Beacon longitude.
    
    Parameters:
    
    lon - The Beacon longitude to be set
  - getX
```
@Deprecated
public double getX()
```
    Deprecated. Use getLongitude() instead.
    
    Getter for the Beacon longitude.
    
    Returns:
    
    The Beacon longitude
  - setX
```
@Deprecated
public void setX(double x)
```
    Deprecated. Use setLongitude(double) instead.
    
    Setter for the Beacon longitude.
    
    Parameters:
    
    x - The Beacon longitude to be set
  - getY
```
@Deprecated
public double getY()
```
    Deprecated. Use getLatitude() instead.
    
    Getter for the Beacon latitude.
    
    Returns:
    
    The Beacon latitude
  - setY
```
@Deprecated
public void setY(double y)
```
    Deprecated. Use setLatitude(double) instead.
    
    Setter for the Beacon latitude.
    
    Parameters:
    
    y - The Beacon latitude to be set
  - getMajor
```
public int getMajor()
```
    Getter for the Beacon major.
    
    Returns:
    
    The Beacon major
  - setMajor
```
public void setMajor(int major)
```
    Setter for the Beacon major.
    
    Parameters:
    
    major - The Beacon major to be set
  - getMinor
```
public int getMinor()
```
    Getter for the Beacon minor.
    
    Returns:
    
    The Beacon minor
  - setMinor
```
public void setMinor(int minor)
```
    Setter for the Beacon minor.
    
    Parameters:
    
    minor - The Beacon minor
  - getTxPower
```
public int getTxPower()
```
    Getter for the Beacon transmission power.
    
    Returns:
    
    The Beacon transmission power
  - setTxPower
```
public void setTxPower(int txPower)
```
    Setter for the Beacon transmission power.
    
    Parameters:
    
    txPower - The Beacon transmission power to be set
  - getUuid
```
public java.lang.String getUuid()
```
    Getter for the Beacon proximity UUID.
    
    Returns:
    
    The Beacon proximity UUID
  - setUuid
```
public void setUuid(java.lang.String uuid)
```
    Setter for the Beacon proximity UUID.
    
    Parameters:
    
    uuid - The Beacon proximity UUID to be set
  - getBuilding
```
public java.lang.String getBuilding()
```
    Getter for the Beacon Building ID.
    
    Returns:
    
    The Beacon Building ID
  - setBuilding
```
public void setBuilding(java.lang.String building)
```
    Setter for the Beacon Building ID.
    
    Parameters:
    
    building - The Beacon Building ID to be set
  - getFloor
```
public java.lang.String getFloor()
```
    Getter for the Beacon Floor ID.
    
    Returns:
    
    The Beacon Floor ID
  - setFloor
```
public void setFloor(java.lang.String floor)
```
    Setter for the Beacon Floor ID.
    
    Parameters:
    
    floor - The Beacon Floor ID to be set
  - getFloorNumber
```
public int getFloorNumber()
```
    Getter for the Beacon Floor number.
    
    Returns:
    
    The Beacon Floor number
  - setFloorNumber
```
public void setFloorNumber(int floorNumber)
```
    Setter for the Beacon Floor number.
    
    Parameters:
    
    floorNumber - The Beacon Floor number to be set
  - getType
```
@Deprecated
public java.lang.String getType()
```
    Deprecated.
    
    Getter for the Beacon type.
    
    Returns:
    
    The Beacon type
  - setType
```
@Deprecated
public void setType(java.lang.String type)
```
    Deprecated.
    
    Setter for the Beacon type.
    
    Parameters:
    
    type - The Beacon type to be set
  - getScanDate
```
public java.lang.String getScanDate()
```
    Getter for the Beacon scan date.
    
    Returns:
    
    The Beacon scan date
  - setScanDate
```
public void setScanDate(java.lang.String scanDate)
```
    Setter for the Beacon scan date.
    
    Parameters:
    
    scanDate - The Beacon scan date to be set
  - getStatus
```
public int getStatus()
```
    Getter for the Beacon status.
    
    Returns:
    
    The Beacon status
  - setStatus
```
public void setStatus(int status)
```
    Setter for the Beacon status.
    
    Parameters:
    
    status - The Beacon status to be set

Class Beacon

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE

STATUS_OK

STATUS_LOW_BATTERY

STATUS_LOST

STATUS_NEEDS_MAINTENANCE

STATUS_OUT_OF_ORDER

STATUS_NO_BATTERY

Constructor Detail

Beacon

Beacon

Method Detail

detect

bytesToHex

compareTo

equals

hashCode

computeAccuracy

getIdentifier

getId

getLatitude

setLatitude

setId

getLongitude

setLongitude

getX

setX

getY

setY

getMajor

setMajor

getMinor

setMinor

getTxPower

setTxPower

getUuid

setUuid

getBuilding

setBuilding

getFloor

setFloor

getFloorNumber

setFloorNumber

getType

setType

getScanDate

setScanDate

getStatus

setStatus