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 classState.Builder -
Field Summary
Fields Modifier and Type Field Description static StateCOLOR_LOOP_EFFECTA state that turns on theEffectType.COLOR_LOOPeffect.static StateLONG_ALERTA state that causes light(s) to blink for 15 seconds.static StateNO_ALERTA state that stops lights from blinking.static StateNO_EFFECTSA state that stops effects.static StateSHORT_ALERTA state that causes a short blink to occur. -
Method Summary
Modifier and Type Method Description static StateBuilderSteps.InitialStepbuilder()booleanequals(Object o)AlertTypegetAlert()The latest alert command issued.IntegergetBri()IntegergetCt()EffectTypegetEffect()The latest effect command issued.IntegergetHue()BooleangetOn()IntegergetSat()StringgetScene()The id of the scene that this state will activate.IntegergetTransitiontime()List<Float>getXy()inthashCode()StringtoString()
-
Field Details
-
SHORT_ALERT
A state that causes a short blink to occur. -
LONG_ALERT
A state that causes light(s) to blink for 15 seconds. -
NO_ALERT
A state that stops lights from blinking. -
COLOR_LOOP_EFFECT
A state that turns on theEffectType.COLOR_LOOPeffect. -
NO_EFFECTS
A state that stops effects.
-
-
Method Details
-
getOn
-
getBri
-
getXy
-
getHue
-
getSat
-
getCt
-
getTransitiontime
-
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 benull.- Returns:
- Id of a scene, or
nullif this object was received from an actualLightobject. - Since:
- 1.3.0
-
getAlert
The latest alert command issued. Does not automatically reset toAlertType.NONEwhen the alert ends.- Returns:
- Latest alert command issued.
- Since:
- 2.1.0
-
getEffect
The latest effect command issued. Does not automatically reset toEffectType.NONEwhen the effect ends.- Returns:
- Latest effect command issued.
- Since:
- 2.3.0
-
builder
-
equals
-
hashCode
public int hashCode() -
toString
-