ColorControlTrait.MoveToColorCommand.Request

class ColorControlTrait.MoveToColorCommand.Request

The request payload for the MoveToColor command.

Summary

Public constructors
Request(
    colorX: UShort,
    colorY: UShort,
    transitionTime: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the MoveToColor command.

Public properties
UShort

The normalized chromaticity value x, as defined in the CIE xyY Color Space, to move the device's color to.
UShort

The normalized chromaticity value y, as defined in the CIE xyY Color Space, to move the device's color 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 color.

Public constructors

Request

Request(
    colorX: UShort,
    colorY: UShort,
    transitionTime: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the MoveToColor command.

Public properties

colorX

val colorX: UShort

The normalized chromaticity value x, as defined in the CIE xyY Color Space, to move the device's color to.

colorY

val colorY: UShort

The normalized chromaticity value y, as defined in the CIE xyY Color Space, to move the device's color to.

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 color.