ColorControlTrait.StepColorTemperatureCommand.Request
class ColorControlTrait.StepColorTemperatureCommand.Request : ClusterStruct
The request payload for the StepColorTemperature command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the StepColorTemperature command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
UShort |
The upper bound of the |
UShort |
The lower bound of the |
ColorControlTrait.OptionsBitmap |
Determines which bits in the |
ColorControlTrait.OptionsBitmap |
If the corresponding bit in |
ColorControlTrait.StepModeEnum |
The direction in which to move the color temperature. |
UShort |
The amount of units to move the device's |
UShort |
The time (in 0.1 seconds) taken to move the device to the new color temperature. |
Public constructors
Request
Request(
stepMode: ColorControlTrait.StepModeEnum = StepModeEnum.Up,
stepSize: UShort,
transitionTime: UShort,
colorTemperatureMinimumMireds: UShort,
colorTemperatureMaximumMireds: UShort,
optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)
Creates a request payload for the StepColorTemperature command.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
colorTemperatureMaximumMireds
val colorTemperatureMaximumMireds: UShort
The upper bound of the colorTemperatureMireds attribute for the command. This value must be between the colorTemperatureMireds and colorTempPhysicalMaxMireds attributes. If this value is set to 0, colorTempPhysicalMaxMireds is used as the upper bound.
colorTemperatureMinimumMireds
val colorTemperatureMinimumMireds: UShort
The lower bound of the colorTemperatureMireds attribute for the command. This value must be between the colorTempPhysicalMinMireds and colorTemperatureMireds attributes. If this value is set to 0, colorTempPhysicalMinMireds is used as the lower bound.
optionsMask
val optionsMask: ColorControlTrait.OptionsBitmap
Determines which bits in the options attribute should be overridden by optionsOverride.
optionsOverride
val optionsOverride: ColorControlTrait.OptionsBitmap
If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.
stepMode
val stepMode: ColorControlTrait.StepModeEnum
The direction in which to move the color temperature. This must be one of the values in ColorControlTrait.HueStepMode.
transitionTime
val transitionTime: UShort
The time (in 0.1 seconds) taken to move the device to the new color temperature.