ColorControlTrait.ColorLoopSetCommand.Request

class ColorControlTrait.ColorLoopSetCommand.Request

The request payload for the ColorLoopSet command.

Summary

Public constructors
`Request( updateFlags: ColorControlTrait.UpdateFlagsBitmap, action: ColorControlTrait.ColorLoopActionEnum, direction: ColorControlTrait.ColorLoopDirectionEnum, time: UShort, startHue: UShort, optionsMask: ColorControlTrait.OptionsBitmap, optionsOverride: ColorControlTrait.OptionsBitmap )` Creates a request payload for the ColorLoopSet command.

Public properties
`ColorControlTrait.ColorLoopActionEnum`	`action` The action to take if ColorControlTrait.ColorLoopUpdateFlags.updateAction is set in `updateFlags`.
`ColorControlTrait.ColorLoopDirectionEnum`	`direction` The direction of the color loop if ColorControlTrait.ColorLoopUpdateFlags.updateDirection is set in `updateFlags`.
`ColorControlTrait.OptionsBitmap`	`optionsMask` Determines which bits in the `options` attribute should be overridden by `optionsOverride`.
`ColorControlTrait.OptionsBitmap`	`optionsOverride` If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `options` attribute.
`UShort`	`startHue` The starting hue to use if ColorControlTrait.ColorLoopUpdateFlags.updateStartHue is set in `updateFlags`.
`UShort`	`time` The number of seconds over which to perform the full color loop if ColorControlTrait.ColorLoopUpdateFlags.updateTime is set in `updateFlags`.
`ColorControlTrait.UpdateFlagsBitmap`	`updateFlags` The attributes to update before the color loop starts.

Public constructors

Request

Request(
    updateFlags: ColorControlTrait.UpdateFlagsBitmap = UpdateFlagsBitmap(),
    action: ColorControlTrait.ColorLoopActionEnum = ColorLoopActionEnum.Deactivate,
    direction: ColorControlTrait.ColorLoopDirectionEnum = ColorLoopDirectionEnum.Decrement,
    time: UShort,
    startHue: UShort,
    optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the ColorLoopSet command.

Public properties

action

val action: ColorControlTrait.ColorLoopActionEnum

The action to take if ColorControlTrait.ColorLoopUpdateFlags.updateAction is set in updateFlags. Must be a value from the ColorControlTrait.ColorLoopAction enum.

direction

val direction: ColorControlTrait.ColorLoopDirectionEnum

The direction of the color loop if ColorControlTrait.ColorLoopUpdateFlags.updateDirection is set in updateFlags. Must be a value from the ColorControlTrait.ColorLoopDirection enum.

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.

startHue

val startHue: UShort

The starting hue to use if ColorControlTrait.ColorLoopUpdateFlags.updateStartHue is set in updateFlags.

time

val time: UShort

The number of seconds over which to perform the full color loop if ColorControlTrait.ColorLoopUpdateFlags.updateTime is set in updateFlags.

updateFlags

val updateFlags: ColorControlTrait.UpdateFlagsBitmap

The attributes to update before the color loop starts. See ColorControlTrait.ColorLoopUpdateFlags for the list of flags to use.