com.dsi.ant.message

Class Rssi

java.lang.Object

com.dsi.ant.message.Rssi

public class Rssi
extends java.lang.Object

The container for the Received Signal Strength Indication information.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rssi.RssiMeasurementType The possible measurement types for RSSI data.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RSSI_VALUE Maximum RSSI value
static int	MIN_RSSI_VALUE Minimum RSSI value
static int	OFFSET_MEASUREMENT_TYPE The message content offset the the measurement type
static int	OFFSET_RSSI_VALUE The message content offset the the RSSI value
static int	OFFSET_THRESHOLD_CONFIG The message content offset the the RSSI value
static int	SIZE_MEASUREMENT_TYPE The number of bytes used for the measurement type
static int	SIZE_RSSI The number of bytes used for the RSSI information
static int	SIZE_RSSI_VALUE The number of bytes used for the RSSI value
static int	SIZE_THRESHOLD_CONFIG The number of bytes used for the threshold configuration
static int	THRESHOLD_CONFIG_OFF The threshold configuration value when off

Constructor Summary

Constructors

Constructor and Description
Rssi(byte[] messageContent, int startOffset) Constructs RSSI information from the message content.
Rssi(int measurementType, int rssiValue, int thresholdConfigDB) Constructs Rssi with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Rssi.RssiMeasurementType	getMeasurementType() Gets the measurement type received in the extended message.
int	getRawMeasurementType() Gets the raw value for the measurement type.
int	getRssiValue() Gets the Received Signal Strength Indicator value.
int	getThresholdConfigDB() Gets the threshold configuration value, the power level of the threshold bin configured through proximity search.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

MIN_RSSI_VALUE

public static final int MIN_RSSI_VALUE

Minimum RSSI value

Since:

4.9

See Also:

Constant Field Values

MAX_RSSI_VALUE

public static final int MAX_RSSI_VALUE

Maximum RSSI value

Since:

4.9

See Also:

Constant Field Values

SIZE_MEASUREMENT_TYPE

public static final int SIZE_MEASUREMENT_TYPE

The number of bytes used for the measurement type

Since:

4.0

See Also:

Constant Field Values

SIZE_RSSI_VALUE

public static final int SIZE_RSSI_VALUE

The number of bytes used for the RSSI value

Since:

4.0

See Also:

Constant Field Values

SIZE_THRESHOLD_CONFIG

public static final int SIZE_THRESHOLD_CONFIG

The number of bytes used for the threshold configuration

Since:

4.0

See Also:

Constant Field Values

SIZE_RSSI

public static final int SIZE_RSSI

The number of bytes used for the RSSI information

Since:

4.0

See Also:

Constant Field Values

OFFSET_MEASUREMENT_TYPE

public static final int OFFSET_MEASUREMENT_TYPE

The message content offset the the measurement type

Since:

4.0

See Also:

Constant Field Values

OFFSET_RSSI_VALUE

public static final int OFFSET_RSSI_VALUE

The message content offset the the RSSI value

Since:

4.0

See Also:

Constant Field Values

OFFSET_THRESHOLD_CONFIG

public static final int OFFSET_THRESHOLD_CONFIG

The message content offset the the RSSI value

Since:

4.0

See Also:

Constant Field Values

THRESHOLD_CONFIG_OFF

public static final int THRESHOLD_CONFIG_OFF

The threshold configuration value when off

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

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 Detail

getRawMeasurementType

public int getRawMeasurementType()

Gets the raw value for the measurement type. Applications should use getMeasurementType().

Returns:

The raw value for the measurement type received.

Since:

4.0

getMeasurementType

public Rssi.RssiMeasurementType 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()

Overrides:

hashCode in class java.lang.Object

Since:

4.1

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Since:

4.1

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

4.1