ColorControlTrait.ColorMode
enum ColorControlTrait.ColorMode : Enum, ClusterEnum
The attributes that determine the current color of the device. Used for the colorMode attribute.
Summary
Enum Values |
|
|---|---|
ColorTemperature |
The current color is determined by the |
CurrentHueAndCurrentSaturation |
The current color is determined by the |
CurrentXAndCurrentY |
The current color is determined by the |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
ColorControlTrait.ColorMode |
Returns the enum constant of this type with the specified name. |
Array<ColorControlTrait.ColorMode> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
ColorTemperature
val ColorControlTrait.ColorMode.ColorTemperature: ColorControlTrait.ColorMode
The current color is determined by the colorTemperatureMireds attribute.
CurrentHueAndCurrentSaturation
val ColorControlTrait.ColorMode.CurrentHueAndCurrentSaturation: ColorControlTrait.ColorMode
The current color is determined by the currentHue and currentSaturation attributes.
CurrentXAndCurrentY
val ColorControlTrait.ColorMode.CurrentXAndCurrentY: ColorControlTrait.ColorMode
The current color is determined by the currentX and currentY attributes.
UnknownValue
val ColorControlTrait.ColorMode.UnknownValue: ColorControlTrait.ColorMode
The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.
Public functions
valueOf
fun valueOf(value: String): ColorControlTrait.ColorMode
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<ColorControlTrait.ColorMode>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.