ColorControlTrait.EnhancedMoveHueCommand.Request

class ColorControlTrait.EnhancedMoveHueCommand.Request


The request payload for the EnhancedMoveHue command.

Summary

Public constructors

Request(
    moveMode: ColorControlTrait.HueMoveMode,
    rate: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the EnhancedMoveHue command.

Public properties

ColorControlTrait.HueMoveMode

The direction in which to move the enhanced hue.

UByte

Determines which bits in the options attribute should be overridden by optionsOverride.

UByte

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.

UShort

The rate (in steps per seconds) used to change the device's enhancedCurrentHue.

Public constructors

Request

Request(
    moveMode: ColorControlTrait.HueMoveMode = HueMoveMode.Stop,
    rate: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the EnhancedMoveHue command.

Public properties

moveMode

val moveModeColorControlTrait.HueMoveMode

The direction in which to move the enhanced hue. This must be one of the values in HueMoveMode.

optionsMask

val optionsMaskUByte

Determines which bits in the options attribute should be overridden by optionsOverride.

optionsOverride

val optionsOverrideUByte

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.

rate

val rateUShort

The rate (in steps per seconds) used to change the device's enhancedCurrentHue.