ColorSettingState

Description

The state of a color setting.

Fields

Key Type Description
device Device

The device reporting the ColorSetting state.

Required

state FieldPath

The specific state data to check.

Required

is Dynamic

Checks if the state data is equal to a value.

Optional

To use this field, all the following fields CANNOT be used: isNot, greaterThanOrEqualTo, greaterThan, lessThanOrEqualTo, lessThan

isNot Dynamic

Checks if the state data is not equal to a value.

Optional

To use this field, all the following fields CANNOT be used: is, greaterThanOrEqualTo, greaterThan, lessThanOrEqualTo, lessThan

greaterThan Dynamic

Checks if the state data is greater than (>) a value.

Optional

To use this field, all the following fields CANNOT be used: isNot, is, greaterThanOrEqualTo

greaterThanOrEqualTo Dynamic

Checks if the state data is greater than or equal to (>=) a value.

Optional

To use this field, all the following fields CANNOT be used: isNot, is, greaterThan

lessThan Dynamic

Checks if the state data is less than (<) a value.

Optional

To use this field, all the following fields CANNOT be used: isNot, is, lessThanOrEqualTo

lessThanOrEqualTo Dynamic

Checks if the state data is less than or equal to (<=) a value.

Optional

To use this field, all the following fields CANNOT be used: isNot, is, lessThan

for Duration

Checks if the state has already remained for a certain duration. Only applicable for Starters, cannot be used with Conditions.

Optional

suppressFor Duration

Suppress the triggering of the starter for a specified time period.

Optional

ColorSetting State Data

Key Type Description
color Color

Optional

spectrumHsv SpectrumHSV

Optional

hue Number

Optional

saturation Number

Optional

value Number

Optional

spectrumRgb ColorHex

Optional

temperatureK ColorTemperature

Optional

Examples

starters:
- type: device.state.ColorSetting
  device: My Device - Room Name
  state: color.colorTemperature
  is: 2000K

condition:
  type: device.state.ColorSetting
  device: My Device - Room Name
  state: color.colorTemperature
  is: 2000K