ColorControlTrait.StepSaturationCommand.Request
class ColorControlTrait.StepSaturationCommand.Request : ClusterStruct
The request payload for the StepSaturation command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the StepSaturation 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 |
|
|---|---|
ColorControlTrait.OptionsBitmap |
Determines which bits in the |
ColorControlTrait.OptionsBitmap |
If the corresponding bit in |
ColorControlTrait.StepModeEnum |
The direction in which to move the saturation. |
UByte |
The amount of units to move the device's |
UByte |
The time (in 0.1 seconds) taken to move the device to the new saturation. |
Public constructors
Request
Request(
stepMode: ColorControlTrait.StepModeEnum = StepModeEnum.Up,
stepSize: UByte,
transitionTime: UByte,
optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)
Creates a request payload for the StepSaturation 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
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 saturation. This must be one of the values in ColorControlTrait.SaturationStepMode.
transitionTime
val transitionTime: UByte
The time (in 0.1 seconds) taken to move the device to the new saturation.