Package io.github.zeroone3010.yahueapi

Class State

java.lang.Object

io.github.zeroone3010.yahueapi.State

public final class State
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	State.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static State	COLOR_LOOP_EFFECT	A state that turns on the EffectType.COLOR_LOOP effect.
static State	LONG_ALERT	A state that causes light(s) to blink for 15 seconds.
static State	NO_ALERT	A state that stops lights from blinking.
static State	NO_EFFECTS	A state that stops effects.
static State	SHORT_ALERT	A state that causes a short blink to occur.

Method Summary

Modifier and Type	Method	Description
static StateBuilderSteps.InitialStep	builder()
boolean	equals(Object o)
AlertType	getAlert()	The latest alert command issued.
Integer	getBri()
Integer	getCt()
EffectType	getEffect()	The latest effect command issued.
Integer	getHue()
Boolean	getOn()
Integer	getSat()
String	getScene()	The id of the scene that this state will activate.
Integer	getTransitiontime()
List<Float>	getXy()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SHORT_ALERT

public static final State SHORT_ALERT

A state that causes a short blink to occur.

LONG_ALERT

public static final State LONG_ALERT

A state that causes light(s) to blink for 15 seconds.

NO_ALERT

public static final State NO_ALERT

A state that stops lights from blinking.

COLOR_LOOP_EFFECT

public static final State COLOR_LOOP_EFFECT

A state that turns on the EffectType.COLOR_LOOP effect.

NO_EFFECTS

public static final State NO_EFFECTS

A state that stops effects.

Method Details

getOn

public Boolean getOn()

getBri

public Integer getBri()

getXy

public List<Float> getXy()

getHue

public Integer getHue()

getSat

public Integer getSat()

getCt

public Integer getCt()

getTransitiontime

public Integer getTransitiontime()

getScene

public String getScene()

The id of the scene that this state will activate. Note that the API does not populate this value when you get the state of a light or a room. This means that unless you created this State object manually, this value will always be null.

Returns:

Id of a scene, or null if this object was received from an actual Light object.

Since:

1.3.0

getAlert

public AlertType getAlert()

The latest alert command issued. Does not automatically reset to AlertType.NONE when the alert ends.

Returns:

Latest alert command issued.

Since:

2.1.0

getEffect

public EffectType getEffect()

The latest effect command issued. Does not automatically reset to EffectType.NONE when the effect ends.

Returns:

Latest effect command issued.

Since:

2.3.0

builder

public static StateBuilderSteps.InitialStep builder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object