com.spacecode.sdk.device.module.data

Class ProbeSettings

java.lang.Object

com.spacecode.sdk.device.module.data.ProbeSettings

public class ProbeSettings
extends java.lang.Object

Describe the configuration of a temperature probe.

Field Summary

Fields

Modifier and Type	Field and Description
static double	ERROR_VALUE Default value provided in case of error when reading the probe value.
static int	MIN_MEASURE_DELAY Minimum value (in seconds) allowed for the delay between two measures.
static double	MIN_MEASURE_DELTA Minimum value (in °C) allowed for the delta (difference) between two measures.

Constructor Summary

Constructors

Constructor and Description
ProbeSettings(int delay, double delta, boolean enabled) Build a configuration for a ProbeModule module.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDelay()
double	getDelta()
boolean	isEnabled()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_VALUE

public static final double ERROR_VALUE

Default value provided in case of error when reading the probe value.

See Also:

Constant Field Values

MIN_MEASURE_DELTA

public static final double MIN_MEASURE_DELTA

Minimum value (in °C) allowed for the delta (difference) between two measures.

See Also:

Constant Field Values

MIN_MEASURE_DELAY

public static final int MIN_MEASURE_DELAY

Minimum value (in seconds) allowed for the delay between two measures.

See Also:

Constant Field Values

Constructor Detail

ProbeSettings

public ProbeSettings(int delay,
             double delta,
             boolean enabled)

Build a configuration for a ProbeModule module.

Parameters:

delay - Delay between two measures, in seconds. Minimum: ProbeModule.MIN_MEASURE_DELAY

delta - Delta (difference in °C) expected between two measures. Minimum: ProbeModule.MIN_MEASURE_DELTA

enabled - If set to true, the temperature probe is enabled and the remote device takes measures.

Method Detail

getDelay

public int getDelay()

Returns:

Delay between two measures, in seconds.

getDelta

public double getDelta()

Returns:

Delta (difference in °C) expected between two measures.

isEnabled

public boolean isEnabled()

Returns:

True if the probe is set as "enabled", false otherwise.