Package wtf.choco.dyson4j.setting

Class FanState<T extends MqttStateValueProvider>

java.lang.Object

wtf.choco.dyson4j.setting.FanState<T>

Type Parameters:

T - the state value type

public final class FanState<T extends MqttStateValueProvider>
extends Object

Represents a state that a Dyson fan possesses.

Field Summary

Fields

Modifier and Type	Field	Description
static final FanState<AirQualityTarget>	AIR_QUALITY_TARGET	The target air quality the fan will attempt to achieve with its filter.
static final FanState<FocusMode>	FOCUS_MODE	The type of air distribution focus.
static final FanState<HeatMode>	HEAT_MODE	Heater mode.
static final FanState<TemperatureLimit>	MAXIMUM_TEMPERATURE	The maximum temperature (in Kelvin) that the fan will attempt to achieve in heat mode.
static final FanState<FanMode>	MODE	The mode of the fan.
static final FanState<AirQualityMonitor>	MONITOR_AIR_QUALITY	Whether or not the fan will passively monitor air quality.
static final FanState<NightMode>	NIGHT_MODE	Night mode (not to be confused with MODE).
static final FanState<FanOscillation>	OSCILLATION	Whether or not the fan is oscillating.
static final FanState<ResetFilterState>	RESET_FILTER_STATE	Whether or not the fan requires a filter change.
static final FanState<SleepTimer>	SLEEP_TIMER	The sleep timer (in minutes).
static final FanState<FanSpeed>	SPEED	The speed of the fan.

Method Summary

Modifier and Type	Method	Description
static <T extends MqttStateValueProvider> @Nullable FanState<T>	getById(@NotNull String id)	Get a FanState by its internal MQTT id.
@NotNull String	getId()	Get the unique id of this fan state (used in MQTT communications).
@NotNull String	getName()	Get the friendly name of this fan state, useful for display.
@NotNull Class<T>	getValueType()	Get the Class of the value required by this state.

Methods inherited from class java.lang.Object

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

Field Details

MODE

public static final FanState<FanMode> MODE

The mode of the fan.

See Also:

• FanMode

SPEED

public static final FanState<FanSpeed> SPEED

The speed of the fan.

See Also:

• FanSpeed

OSCILLATION

public static final FanState<FanOscillation> OSCILLATION

Whether or not the fan is oscillating.

See Also:

• FanOscillation

SLEEP_TIMER

public static final FanState<SleepTimer> SLEEP_TIMER

The sleep timer (in minutes).

See Also:

• SleepTimer

MONITOR_AIR_QUALITY

public static final FanState<AirQualityMonitor> MONITOR_AIR_QUALITY

Whether or not the fan will passively monitor air quality.

See Also:

• AirQualityMonitor

RESET_FILTER_STATE

public static final FanState<ResetFilterState> RESET_FILTER_STATE

Whether or not the fan requires a filter change.

If this state is set to ResetFilterState.RESET, the fan will reset the lifetime of its filter as though it has been changed.

See Also:

• ResetFilterState

AIR_QUALITY_TARGET

public static final FanState<AirQualityTarget> AIR_QUALITY_TARGET

The target air quality the fan will attempt to achieve with its filter.

See Also:

• AirQualityTarget

NIGHT_MODE

public static final FanState<NightMode> NIGHT_MODE

Night mode (not to be confused with MODE).

See Also:

• NightMode

HEAT_MODE

public static final FanState<HeatMode> HEAT_MODE

Heater mode.

See Also:

• HeatMode

FOCUS_MODE

public static final FanState<FocusMode> FOCUS_MODE

The type of air distribution focus.

See Also:

• FocusMode

MAXIMUM_TEMPERATURE

public static final FanState<TemperatureLimit> MAXIMUM_TEMPERATURE

The maximum temperature (in Kelvin) that the fan will attempt to achieve in heat mode.

See Also:

• TemperatureLimit

Method Details

getId

@NotNull
public @NotNull String getId()

Get the unique id of this fan state (used in MQTT communications).

Returns:

the unique id

getName

@NotNull
public @NotNull String getName()

Get the friendly name of this fan state, useful for display.

Returns:

the name

getValueType

@NotNull
public @NotNull Class<T> getValueType()

Get the Class of the value required by this state.

Returns:

the value class

getById

@Nullable
public static <T extends MqttStateValueProvider>
@Nullable FanState<T> getById(@NotNull
 @NotNull String id)

Get a FanState by its internal MQTT id.

Type Parameters:

T - a generic MqttStateValueProvider type

Parameters:

id - the internal MQTT id of the fan state

Returns:

the fan state, or null if none exists with the given id