nl.q42.jue

Class StateUpdate

Object

StateUpdate

public class StateUpdate
extends Object

Collection of updates to the state of a light.

Constructor Summary

Constructors

Constructor and Description
StateUpdate()

Method Summary

Methods

Modifier and Type	Method and Description
StateUpdate	setAlert(State.AlertMode mode) Set the alert mode.
StateUpdate	setBrightness(int brightness) Set brightness of light.
StateUpdate	setColorTemperature(int colorTemperature) Switch to CT color mode and set color temperature in mired.
StateUpdate	setEffect(State.Effect effect) Set the current effect.
StateUpdate	setHue(int hue) Switch to HS color mode and set hue.
StateUpdate	setOn(boolean on) Turn light on or off.
StateUpdate	setSat(int saturation) Switch to HS color mode and set saturation.
StateUpdate	setTransitionTime(int timeMillis) Set the transition time from the current state to the new state.
StateUpdate	setXY(float[] xy) Switch to XY color mode and set CIE color space coordinates.
StateUpdate	setXY(float x, float y) Switch to XY color mode and set CIE color space coordinates.
StateUpdate	turnOff() Turn light off.
StateUpdate	turnOn() Turn light on.

Methods inherited from class Object

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

Constructor Detail

StateUpdate

public StateUpdate()

Method Detail

turnOn

public StateUpdate turnOn()

Turn light on.

Returns:

this object for chaining calls

turnOff

public StateUpdate turnOff()

Turn light off.

Returns:

this object for chaining calls

setOn

public StateUpdate setOn(boolean on)

Turn light on or off.

Parameters:

on - on if true, off otherwise

Returns:

this object for chaining calls

setBrightness

public StateUpdate setBrightness(int brightness)

Set brightness of light. Brightness 0 is not the same as off.

Parameters:

brightness - brightness [1..255]

Returns:

this object for chaining calls

setHue

public StateUpdate setHue(int hue)

Switch to HS color mode and set hue.

Parameters:

hue - hue [0..65535]

Returns:

this object for chaining calls

setSat

public StateUpdate setSat(int saturation)

Switch to HS color mode and set saturation.

Parameters:

saturation - saturation [0..255]

Returns:

this object for chaining calls

setXY

public StateUpdate setXY(float x,
                float y)

Switch to XY color mode and set CIE color space coordinates.

Parameters:

x - x coordinate [0..1]

y - y coordinate [0..1]

Returns:

this object for chaining calls

setXY

public StateUpdate setXY(float[] xy)

Switch to XY color mode and set CIE color space coordinates.

Parameters:

xy - x and y coordinates [0..1, 0..1]

Returns:

this object for chaining calls

setColorTemperature

public StateUpdate setColorTemperature(int colorTemperature)

Switch to CT color mode and set color temperature in mired.

Parameters:

colorTemperature - color temperature [153..500]

Returns:

this object for chaining calls

setAlert

public StateUpdate setAlert(State.AlertMode mode)

Set the alert mode.

Parameters:

mode - alert mode

Returns:

this object for chaining calls

See Also:

State.AlertMode

setEffect

public StateUpdate setEffect(State.Effect effect)

Set the current effect.

Parameters:

effect - effect

Returns:

this object for chaining calls

See Also:

State.Effect

setTransitionTime

public StateUpdate setTransitionTime(int timeMillis)

Set the transition time from the current state to the new state. Time is accurate to 100 milliseconds.

Parameters:

timeMillis - time in milliseconds [0..6553600]

Returns:

this object for chaining calls