ColorControlTrait.EnhancedStepHueCommand.Request
class ColorControlTrait.EnhancedStepHueCommand.Request
The request payload for the EnhancedStepHue command.
Summary
Public constructors |
|---|
Request(Creates a request payload for the EnhancedStepHue command. |
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 enhanced hue. |
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 enhanced hue. |
Public constructors
Request
Request(
stepMode: ColorControlTrait.StepModeEnum = StepModeEnum.Up,
stepSize: UShort,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)
Creates a request payload for the EnhancedStepHue command.
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 enhanced hue. 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 enhanced hue.