ColorControlTrait.MoveToSaturationCommand.Request

class ColorControlTrait.MoveToSaturationCommand.Request

The request payload for the MoveToSaturation command.

Summary

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

Creates a request payload for the MoveToSaturation 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.
UByte

The saturation to be moved to.
UShort

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

Public constructors

Request

Request(
    saturation: UByte,
    transitionTime: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the MoveToSaturation 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.

saturation

val saturation: UByte

The saturation to be moved to. The valid range of values is 0 to 254.

transitionTime

val transitionTime: UShort

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