ColorControlTrait.EnhancedMoveToHueCommand.Request

class ColorControlTrait.EnhancedMoveToHueCommand.Request

The request payload for the EnhancedMoveToHue command.

Summary

Public constructors
Request(
    enhancedHue: UShort,
    direction: ColorControlTrait.HueDirection,
    transitionTime: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the EnhancedMoveToHue command.

Public properties
ColorControlTrait.HueDirection

The direction in which to move the enhanced hue.
UShort

The enhanced hue to be moved to.
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 time (in 0.1 seconds) taken to move the device to the new hue.

Public constructors

Request

Request(
    enhancedHue: UShort,
    direction: ColorControlTrait.HueDirection = HueDirection.ShortestDistance,
    transitionTime: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the EnhancedMoveToHue command.

Public properties

direction

val direction: ColorControlTrait.HueDirection

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

enhancedHue

val enhancedHue: UShort

The enhanced hue to be moved to. The valid range of values is 0 to 65534.

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.

transitionTime

val transitionTime: UShort

The time (in 0.1 seconds) taken to move the device to the new hue.