Package org.openhab.core.util

Enum Class LightModel.RgbDataType

java.lang.Object

java.lang.Enum<LightModel.RgbDataType>

org.openhab.core.util.LightModel.RgbDataType

All Implemented Interfaces:

Serializable, Comparable<LightModel.RgbDataType>, Constable

Enclosing class:

LightModel

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

Enum for the different types of RGB data

Different brands of light use different types of RGB data. Some only support plain RGB, some support RGB with a single white channel, and some support RGB with both cold and warm white channels. Also some lights use their RGBx values to represent only the hue and saturation (only the HS parts), and they have another separate control channel for the brightness (B part). Whereby others use the RGBx values to represent the hue, saturation and brightness all together (all the HSB parts).

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
DEFAULT	supports plain RGB with brightness (i.e. full HSBType)
RGB_C_W	supports 5-element RGB with cold and warm white channels
RGB_NO_BRIGHTNESS	supports plain RGB but ignores brightness (i.e. only HS parts of HSBType)
RGB_W	supports 4-element RGB with white channel

Method Summary

Modifier and Type	Method	Description
static LightModel.RgbDataType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LightModel.RgbDataType[]	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

DEFAULT

public static final LightModel.RgbDataType DEFAULT

supports plain RGB with brightness (i.e. full HSBType)

RGB_NO_BRIGHTNESS

public static final LightModel.RgbDataType RGB_NO_BRIGHTNESS

supports plain RGB but ignores brightness (i.e. only HS parts of HSBType)

RGB_W

public static final LightModel.RgbDataType RGB_W

supports 4-element RGB with white channel

RGB_C_W

public static final LightModel.RgbDataType RGB_C_W

supports 5-element RGB with cold and warm white channels

Method Details

values

public static LightModel.RgbDataType[] 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.RgbDataType 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