ColorControlTrait.EnhancedMoveToHueCommand.Request
class ColorControlTrait.EnhancedMoveToHueCommand.Request
The request payload for the EnhancedMoveToHue command.
Summary
Public constructors |
|---|
Request(Creates a request payload for the EnhancedMoveToHue command. |
Public properties |
|
|---|---|
ColorControlTrait.DirectionEnum |
The direction in which to move the enhanced hue. |
UShort |
The enhanced hue to be moved to. |
ColorControlTrait.OptionsBitmap |
Determines which bits in the |
ColorControlTrait.OptionsBitmap |
If the corresponding bit in |
UShort |
The time (in 0.1 seconds) taken to move the device to the new hue. |
Public constructors
Request
Request(
enhancedHue: UShort,
direction: ColorControlTrait.DirectionEnum = DirectionEnum.Shortest,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)
Creates a request payload for the EnhancedMoveToHue command.
Public properties
direction
val direction: ColorControlTrait.DirectionEnum
The direction in which to move the enhanced hue. This must be one of the values in ColorControlTrait.HueDirection.
enhancedHue
val enhancedHue: UShort
The enhanced hue to be moved to. The valid range of values is 0 to 65534.
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.
transitionTime
val transitionTime: UShort
The time (in 0.1 seconds) taken to move the device to the new hue.