ColorControlTrait.StepColorCommand.Request

class ColorControlTrait.StepColorCommand.Request

The request payload for the StepColor command.

Summary

Public constructors
Request(
    stepX: Short,
    stepY: Short,
    transitionTime: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the StepColor command.

Public properties
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.
Short

The change to be added to the device's currentX attribute.
Short

The change to be added to the device's currentY attribute.
UShort

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

Public constructors

Request

Request(
    stepX: Short = 0,
    stepY: Short = 0,
    transitionTime: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the StepColor command.

Public properties

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.

stepX

val stepX: Short

The change to be added to the device's currentX attribute.

stepY

val stepY: Short

The change to be added to the device's currentY attribute.

transitionTime

val transitionTime: UShort

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