Beacon

java.lang.Object
- com.sensoro.beacon.kit.Beacon

All Implemented Interfaces:

java.lang.Cloneable
```
public class Beacon
extends java.lang.Object
implements java.lang.Cloneable
```
The class of the beacon.The class can show all informantion of the beacon.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Beacon.MovingState

static class Beacon.Proximity
The proximity enum of the beacon.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Beacon.MovingState`
`static class`	`Beacon.Proximity` The proximity enum of the beacon.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONNECTED` The connected status.
`static <any>`	`CREATOR`
`static int`	`DISCONNECTED` The disconnected status.
`static java.lang.String`	`FV_10`
`static java.lang.String`	`FV_20`
`static java.lang.String`	`FV_21`
`static java.lang.String`	`FV_22`
`static java.lang.String`	`FV_23`
`static java.lang.String`	`FV_30`
`static java.lang.String`	`FV_31`
`static java.lang.String`	`FV_33`
`static java.lang.String`	`FV_40`
`static java.lang.String`	`FV_41`
`static java.lang.String`	`FV_42`
`static java.lang.String`	`FV_43`
`static java.lang.String`	`FV_44`
`static java.lang.String`	`HW_A0`
`static java.lang.String`	`HW_B0`
`static java.lang.String`	`HW_C0`
`static java.lang.String`	`HW_C1`
`static java.lang.String`	`HW_C8`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Beacon`	`clone()`
`int`	`describeContents()`
`boolean`	`equals(java.lang.Object that)`
`int`	`getAccelerometerCount()` Get the trigger count of the acceleration sensor of beacon.
`double`	`getAccuracy()` Get the accuracy to the beacon.The accuracy is effected by the environment.
`AdvertisingInterval`	`getAdvertisingInterval()` Get the advertising interval of the beacon
`BaseSettings`	`getBaseSettings()` Get the base settings `BaseSettings` of the beacon.
`int`	`getBatteryLevel()` Get the rest percent of the battery level.
`TLM`	`getEddystoneTLM()`
`EddystoneTLMInterval`	`getEddystoneTLMInterval()`
`java.lang.String`	`getEddystoneUID()`
`java.lang.String`	`getEddystoneURL()`
`java.lang.String`	`getFirmwareVersion()` Get the firmware version of the beacon.
`java.lang.String`	`getHardwareModelName()` Get the hardware model of the beacon
`java.lang.Double`	`getLight()` Get the illumination intensity of the beacon.
`java.lang.String`	`getMacAddress()` Get the mac address of the beacon.
`java.lang.Integer`	`getMajor()` Get the major of the beacon.
`int`	`getMeasuredPower()` Get the measured power(mrssi) of the beacon.
`java.lang.Integer`	`getMinor()` Get the minor of the beacon.
`Beacon.MovingState`	`getMovingState()` Get the moving state of the beacon.
`Beacon.Proximity`	`getProximity()` Get the proximity of the beacon.
`java.lang.String`	`getProximityUUID()` Get the UUID of the beacon.
`int`	`getRssi()` Get the rssi of the beacon.
`java.lang.Integer`	`getSecondMajor()`
`java.lang.Integer`	`getSecondMinor()`
`java.lang.String`	`getSecondProximityUUID()`
`SecureBroadcastInterval`	`getSecureBroadcastInterval()` Get the rotation time of secure broadcast of beacon.
`SensorSettings`	`getSensorSettings()` Get the sensor settings of the beacon.
`java.lang.String`	`getSerialNumber()` Get the SN of the beacon.
`java.lang.Integer`	`getTemperature()` Get the environment temperature of the beacon.
`TransmitPower`	`getTransmitPower()` Get the transmit power of the beacon.
`int`	`hashCode()`
`boolean`	`isAliBeaconEnabled()` Whether the beacon has enabled AliBeacon function or not.
`boolean`	`isBackgroundEnhancementEnabled()` Whether the beacon has enabled background enhancement function or not.
`boolean`	`isEddystoneEIDEnable()`
`boolean`	`isEddystoneEnabled()`
`boolean`	`isEddystoneOnly()`
`boolean`	`isEddystoneTLMEnabled()`
`boolean`	`isEddystoneUIDEnabled()`
`boolean`	`isEddystoneURLEnabled()`
`boolean`	`isEnergySavingEnabled()` Whether the beacon has enabled energy saving function or not.
`boolean`	`isIBeaconEnabled()` Whether the beacon has enabled iBeacon function or not.
`boolean`	`isPasswordEnabled()` Whether the beacon has enabled password function or not.
`boolean`	`isSecondIBeaconEnabled()`
`boolean`	`isSecretEnabled()` Whether the beacon has enabled secret function or not.
`boolean`	`isShakingEnabled()`
`java.lang.String`	`toString()`
`void`	`writeToParcel(Parcel out, int flags)`

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

- Field Detail
  - CONNECTED
```
public static final int CONNECTED
```
    The connected status.
    
    See Also:
    
    Constant Field Values
  - DISCONNECTED
```
public static final int DISCONNECTED
```
    The disconnected status.
    
    See Also:
    
    Constant Field Values
  - FV_10
```
public static final java.lang.String FV_10
```
    See Also:
    
    Constant Field Values
  - FV_20
```
public static final java.lang.String FV_20
```
    See Also:
    
    Constant Field Values
  - FV_21
```
public static final java.lang.String FV_21
```
    See Also:
    
    Constant Field Values
  - FV_22
```
public static final java.lang.String FV_22
```
    See Also:
    
    Constant Field Values
  - FV_23
```
public static final java.lang.String FV_23
```
    See Also:
    
    Constant Field Values
  - FV_30
```
public static final java.lang.String FV_30
```
    See Also:
    
    Constant Field Values
  - FV_31
```
public static final java.lang.String FV_31
```
    See Also:
    
    Constant Field Values
  - FV_33
```
public static final java.lang.String FV_33
```
    See Also:
    
    Constant Field Values
  - FV_40
```
public static final java.lang.String FV_40
```
    See Also:
    
    Constant Field Values
  - FV_41
```
public static final java.lang.String FV_41
```
    See Also:
    
    Constant Field Values
  - FV_42
```
public static final java.lang.String FV_42
```
    See Also:
    
    Constant Field Values
  - FV_43
```
public static final java.lang.String FV_43
```
    See Also:
    
    Constant Field Values
  - FV_44
```
public static final java.lang.String FV_44
```
    See Also:
    
    Constant Field Values
  - HW_A0
```
public static final java.lang.String HW_A0
```
    See Also:
    
    Constant Field Values
  - HW_B0
```
public static final java.lang.String HW_B0
```
    See Also:
    
    Constant Field Values
  - HW_C0
```
public static final java.lang.String HW_C0
```
    See Also:
    
    Constant Field Values
  - HW_C1
```
public static final java.lang.String HW_C1
```
    See Also:
    
    Constant Field Values
  - HW_C8
```
public static final java.lang.String HW_C8
```
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final <any> CREATOR
```
- Method Detail
  - describeContents
```
public int describeContents()
```
  - writeToParcel
```
public void writeToParcel(Parcel out,
                          int flags)
```
  - clone
```
public Beacon clone()
             throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - getSerialNumber
```
public java.lang.String getSerialNumber()
```
    Get the SN of the beacon.
    
    Returns:
    
    SN.
  - getMovingState
```
public Beacon.MovingState getMovingState()
```
    Get the moving state of the beacon.
    
    Returns:
    
    The value of movingState. Beacon.MovingState
  - getBatteryLevel
```
public int getBatteryLevel()
```
    Get the rest percent of the battery level.
    
    Returns:
    
    The left battery.90 means 90%. If 0xff(255), it means unknow.
  - getHardwareModelName
```
public java.lang.String getHardwareModelName()
```
    Get the hardware model of the beacon
    
    Returns:
    
    Hardware mode(only support A0 beacon and B0 beacon in current)
  - getFirmwareVersion
```
public java.lang.String getFirmwareVersion()
```
    Get the firmware version of the beacon.
    
    Returns:
    
    Firmware version.
  - getTemperature
```
public java.lang.Integer getTemperature()
```
    Get the environment temperature of the beacon.
    
    Returns:
    
    The value of temperature(unit:centigrade)
    Null means the beacon has no temperature sensor or the temperature sensor is disabled.
  - getLight
```
public java.lang.Double getLight()
```
    Get the illumination intensity of the beacon.
    
    Returns:
    
    The illumination intensity of the beacon (unit:lux)
    Null means that the beacon has no light sensor or the light sensor is disabled.
  - getAccelerometerCount
```
public int getAccelerometerCount()
```
    Get the trigger count of the acceleration sensor of beacon.
    
    Returns:
    
    The trigger count of acceleration sensor
    Integer.MAX_VALUE means the beacon has no accelerator sensor or the accelerator sensor is disabled.
  - getAccuracy
```
public double getAccuracy()
```
    Get the accuracy to the beacon.The accuracy is effected by the environment.
    
    Returns:
    
    The accuracy to the beacon.(unit:m)
  - getProximity
```
public Beacon.Proximity getProximity()
```
    Get the proximity of the beacon.
    
    Returns:
    
    The proximity level of the beacon Beacon.Proximity.
  - getRssi
```
public int getRssi()
```
    Get the rssi of the beacon.
    
    Returns:
    
    the value of rssi of beacon
  - getMeasuredPower
```
public int getMeasuredPower()
```
    Get the measured power(mrssi) of the beacon.
    
    Returns:
    
    The value of measured power(mrssi) of the beacon.(unit:dbm)
  - getMajor
```
public java.lang.Integer getMajor()
```
    Get the major of the beacon.
    
    Returns:
    
    The major of the beacon.
    Null means that the iBeacon function is disabled.
  - getSecondMajor
```
public java.lang.Integer getSecondMajor()
```
  - getMinor
```
public java.lang.Integer getMinor()
```
    Get the minor of the beacon.
    
    Returns:
    
    The minor of the beacon.
    Null means that the iBeacon function is disabled.
  - getSecondMinor
```
public java.lang.Integer getSecondMinor()
```
  - getMacAddress
```
public java.lang.String getMacAddress()
```
    Get the mac address of the beacon.
    
    Returns:
    
    The mac address of the beacon.
  - getProximityUUID
```
public java.lang.String getProximityUUID()
```
    Get the UUID of the beacon.
    
    Returns:
    
    The UUID of the beacon.
  - getSecondProximityUUID
```
public java.lang.String getSecondProximityUUID()
```
  - getBaseSettings
```
public BaseSettings getBaseSettings()
```
    Get the base settings BaseSettings of the beacon.
    
    Returns:
    
    The base settings of the beacon.If the beacon has not been connected,return the default invalid value.
  - getSecureBroadcastInterval
```
public SecureBroadcastInterval getSecureBroadcastInterval()
```
    Get the rotation time of secure broadcast of beacon.
    
    Returns:
    
    The rotation time of secure broadcast of beacon.If the beacon has not been connected,return the default invalid value.
  - getAdvertisingInterval
```
public AdvertisingInterval getAdvertisingInterval()
```
    Get the advertising interval of the beacon
    
    Returns:
    
    value of advertising interval
    AdvertisingInterval
  - getTransmitPower
```
public TransmitPower getTransmitPower()
```
    Get the transmit power of the beacon.
    
    Returns:
    
    value of transmit power
    TransmitPower
  - isIBeaconEnabled
```
public boolean isIBeaconEnabled()
```
    Whether the beacon has enabled iBeacon function or not.
    
    Returns:
    
    true or false
  - isSecondIBeaconEnabled
```
public boolean isSecondIBeaconEnabled()
```
  - isAliBeaconEnabled
```
public boolean isAliBeaconEnabled()
```
    Whether the beacon has enabled AliBeacon function or not.
    
    Returns:
    
    true or false
  - isBackgroundEnhancementEnabled
```
public boolean isBackgroundEnhancementEnabled()
```
    Whether the beacon has enabled background enhancement function or not.
    
    Returns:
    
    true or false
  - isSecretEnabled
```
public boolean isSecretEnabled()
```
    Whether the beacon has enabled secret function or not.
    
    Returns:
    
    true or false
  - isPasswordEnabled
```
public boolean isPasswordEnabled()
```
    Whether the beacon has enabled password function or not.
    
    Returns:
    
    true or false
  - isEnergySavingEnabled
```
public boolean isEnergySavingEnabled()
```
    Whether the beacon has enabled energy saving function or not.
    
    Returns:
    
    true or false
  - getSensorSettings
```
public SensorSettings getSensorSettings()
```
    Get the sensor settings of the beacon.
    
    Returns:
    
    If the beacon has not bean connected,return the default invalid value.
  - isEddystoneEnabled
```
public boolean isEddystoneEnabled()
```
  - isEddystoneUIDEnabled
```
public boolean isEddystoneUIDEnabled()
```
  - isEddystoneURLEnabled
```
public boolean isEddystoneURLEnabled()
```
  - isEddystoneTLMEnabled
```
public boolean isEddystoneTLMEnabled()
```
  - getEddystoneUID
```
public java.lang.String getEddystoneUID()
```
  - getEddystoneURL
```
public java.lang.String getEddystoneURL()
```
  - getEddystoneTLM
```
public TLM getEddystoneTLM()
```
  - getEddystoneTLMInterval
```
public EddystoneTLMInterval getEddystoneTLMInterval()
```
  - isEddystoneEIDEnable
```
public boolean isEddystoneEIDEnable()
```
  - isEddystoneOnly
```
public boolean isEddystoneOnly()
```
  - isShakingEnabled
```
public boolean isShakingEnabled()
```
  - equals
```
public boolean equals(java.lang.Object that)
```
    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

Class Beacon

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECTED

DISCONNECTED

FV_10

FV_20

FV_21

FV_22

FV_23

FV_30

FV_31

FV_33

FV_40

FV_41

FV_42

FV_43

FV_44

HW_A0

HW_B0

HW_C0

HW_C1

HW_C8

CREATOR

Method Detail

describeContents

writeToParcel

clone

getSerialNumber

getMovingState

getBatteryLevel

getHardwareModelName

getFirmwareVersion

getTemperature

getLight

getAccelerometerCount

getAccuracy

getProximity

getRssi

getMeasuredPower

getMajor

getSecondMajor

getMinor

getSecondMinor

getMacAddress

getProximityUUID

getSecondProximityUUID

getBaseSettings

getSecureBroadcastInterval

getAdvertisingInterval

getTransmitPower

isIBeaconEnabled

isSecondIBeaconEnabled

isAliBeaconEnabled

isBackgroundEnhancementEnabled

isSecretEnabled

isPasswordEnabled

isEnergySavingEnabled

getSensorSettings

isEddystoneEnabled

isEddystoneUIDEnabled

isEddystoneURLEnabled

isEddystoneTLMEnabled

getEddystoneUID

getEddystoneURL

getEddystoneTLM

getEddystoneTLMInterval

isEddystoneEIDEnable

isEddystoneOnly

isShakingEnabled

equals

hashCode

toString