Package org.openhab.core.util

Enum Class LightModel.LedOperatingMode

java.lang.Object

java.lang.Enum<LightModel.LedOperatingMode>

org.openhab.core.util.LightModel.LedOperatingMode

All Implemented Interfaces:

Serializable, Comparable<LightModel.LedOperatingMode>, Constable

Enclosing class:

LightModel

public static enum LightModel.LedOperatingMode
extends Enum<LightModel.LedOperatingMode>

Enum for the LED operating mode

Some brands of light are not able to use the RGB leds and the white led(s) at the same time. So they must be switched between WHITE_ONLY and RGB_ONLY mode. Whereas others lights can use any combination of RGB and White leds at the same time they must be switched COMBINED mode. If the mode is changed at runtime then the color and/or color temperature are updated to be consistent with the new mode, while keeping the brightness the same. If the light does not support color then the mode is forced to WHITE_ONLY.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMBINED	operating with RGB and white LEDs together
RGB_ONLY	operating with RGB LEDs only
WHITE_ONLY	operating with white LED(s) only

Method Summary

Modifier and Type	Method	Description
static LightModel.LedOperatingMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LightModel.LedOperatingMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RGB_ONLY

public static final LightModel.LedOperatingMode RGB_ONLY

operating with RGB LEDs only

COMBINED

public static final LightModel.LedOperatingMode COMBINED

operating with RGB and white LEDs together

WHITE_ONLY

public static final LightModel.LedOperatingMode WHITE_ONLY

operating with white LED(s) only

Method Details

values

public static LightModel.LedOperatingMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LightModel.LedOperatingMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null