Package com.dsi.ant.message
Class Rssi
java.lang.Object
com.dsi.ant.message.Rssi
The container for the Received Signal Strength Indication information.
- Since:
- 4.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The possible measurement types for RSSI data. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Maximum RSSI valuestatic final int
Minimum RSSI valuestatic final int
The message content offset the the measurement typestatic final int
The message content offset the the RSSI valuestatic final int
The message content offset the the RSSI valuestatic final int
The number of bytes used for the measurement typestatic final int
The number of bytes used for the RSSI informationstatic final int
The number of bytes used for the RSSI valuestatic final int
The number of bytes used for the threshold configurationstatic final int
The threshold configuration value when off -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Gets the measurement type received in the extended message.int
Gets the raw value for the measurement type.int
Gets the Received Signal Strength Indicator value.int
Gets the threshold configuration value, the power level of the threshold bin configured through proximity search.int
hashCode()
toString()
-
Field Details
-
MIN_RSSI_VALUE
public static final int MIN_RSSI_VALUEMinimum RSSI value- Since:
- 4.9
- See Also:
-
MAX_RSSI_VALUE
public static final int MAX_RSSI_VALUEMaximum RSSI value- Since:
- 4.9
- See Also:
-
SIZE_MEASUREMENT_TYPE
public static final int SIZE_MEASUREMENT_TYPEThe number of bytes used for the measurement type- Since:
- 4.0
- See Also:
-
SIZE_RSSI_VALUE
public static final int SIZE_RSSI_VALUEThe number of bytes used for the RSSI value- Since:
- 4.0
- See Also:
-
SIZE_THRESHOLD_CONFIG
public static final int SIZE_THRESHOLD_CONFIGThe number of bytes used for the threshold configuration- Since:
- 4.0
- See Also:
-
SIZE_RSSI
public static final int SIZE_RSSIThe number of bytes used for the RSSI information- Since:
- 4.0
- See Also:
-
OFFSET_MEASUREMENT_TYPE
public static final int OFFSET_MEASUREMENT_TYPEThe message content offset the the measurement type- Since:
- 4.0
- See Also:
-
OFFSET_RSSI_VALUE
public static final int OFFSET_RSSI_VALUEThe message content offset the the RSSI value- Since:
- 4.0
- See Also:
-
OFFSET_THRESHOLD_CONFIG
public static final int OFFSET_THRESHOLD_CONFIGThe message content offset the the RSSI value- Since:
- 4.0
- See Also:
-
THRESHOLD_CONFIG_OFF
public static final int THRESHOLD_CONFIG_OFFThe threshold configuration value when off- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
Rssi
public Rssi(byte[] messageContent, int startOffset) Constructs RSSI information from the message content.- Parameters:
messageContent
- The byte array of the message content.startOffset
- The offset to RSSI information- Since:
- 4.0
-
Rssi
public Rssi(int measurementType, int rssiValue, int thresholdConfigDB) Constructs Rssi with the given values.- Parameters:
measurementType
- The received measurement type.rssiValue
- The received RSSI value.thresholdConfigDB
- The received threshold configuration value.- Since:
- 4.0
-
-
Method Details
-
getRawMeasurementType
public int getRawMeasurementType()Gets the raw value for the measurement type. Applications should usegetMeasurementType()
.- Returns:
- The raw value for the measurement type received.
- Since:
- 4.0
-
getMeasurementType
Gets the measurement type received in the extended message.- Returns:
- The measurement type received.
- Since:
- 4.0
-
getRssiValue
public int getRssiValue()Gets the Received Signal Strength Indicator value.- Returns:
- The value of RSSI in units returned by
getMeasurementType()
. - Since:
- 4.0
-
getThresholdConfigDB
public int getThresholdConfigDB()Gets the threshold configuration value, the power level of the threshold bin configured through proximity search.- Returns:
- The threshold configuration value in units returned by
getMeasurementType()
. - Since:
- 4.0
-
hashCode
public int hashCode() -
equals
-
toString
-