ColorControlTrait.MoveToHueAndSaturationCommand.Request
class ColorControlTrait.MoveToHueAndSaturationCommand.Request : ClusterStruct
The request payload for the MoveToHueAndSaturation command.
Summary
Nested types |
|---|
@HomeExperimentalApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the MoveToHueAndSaturation command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
UByte |
The hue to be moved to. |
ColorControlTrait.OptionsBitmap |
Determines which bits in the |
ColorControlTrait.OptionsBitmap |
If the corresponding bit in |
UByte |
The saturation to be moved to. |
UShort |
The time (in 0.1 seconds) taken to move the device to the new hue and saturation. |
Public constructors
Request
Request(
hue: UByte,
saturation: UByte,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)
Creates a request payload for the MoveToHueAndSaturation command.
Public functions
getDescriptor
@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
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.
saturation
val saturation: UByte
The saturation to be moved to. The valid range of values is 0 to 254.
transitionTime
val transitionTime: UShort
The time (in 0.1 seconds) taken to move the device to the new hue and saturation.