ColorControlTrait.ColorLoopSetCommand.Request
class ColorControlTrait.ColorLoopSetCommand.Request
The request payload for the ColorLoopSet command.
Summary
Public constructors |
|---|
Request(Creates a request payload for the ColorLoopSet command. |
Public properties |
|
|---|---|
ColorControlTrait.ColorLoopAction |
The action to take if |
ColorControlTrait.ColorLoopDirection |
The direction of the color loop if |
UByte |
Determines which bits in the |
UByte |
If the corresponding bit in |
UShort |
The starting hue to use if |
UShort |
The number of seconds over which to perform the full color loop if |
ColorControlTrait.ColorLoopUpdateFlags |
The attributes to update before the color loop starts. |
Public constructors
Request
Request(
updateFlags: ColorControlTrait.ColorLoopUpdateFlags = ColorLoopUpdateFlags(),
action: ColorControlTrait.ColorLoopAction = ColorLoopAction.Deactivate,
direction: ColorControlTrait.ColorLoopDirection = ColorLoopDirection.DecrementHue,
time: UShort,
startHue: UShort,
optionsMask: UByte,
optionsOverride: UByte
)
Creates a request payload for the ColorLoopSet command.
Public properties
action
val action: ColorControlTrait.ColorLoopAction
The action to take if updateAction is set in updateFlags. Must be a value from the ColorLoopAction enum.
direction
val direction: ColorControlTrait.ColorLoopDirection
The direction of the color loop if updateDirection is set in updateFlags. Must be a value from the ColorLoopDirection enum.
optionsMask
val optionsMask: UByte
Determines which bits in the options attribute should be overridden by optionsOverride.
optionsOverride
val optionsOverride: UByte
If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.
time
val time: UShort
The number of seconds over which to perform the full color loop if updateTime is set in updateFlags.
updateFlags
val updateFlags: ColorControlTrait.ColorLoopUpdateFlags
The attributes to update before the color loop starts. See ColorLoopUpdateFlags for the list of flags to use.