ColorControlTrait.StepSaturationCommand.Request

class ColorControlTrait.StepSaturationCommand.Request

The request payload for the StepSaturation command.

Summary

Public constructors
Request(
    stepMode: ColorControlTrait.SaturationStepMode,
    stepSize: UByte,
    transitionTime: UByte,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the StepSaturation 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.
ColorControlTrait.SaturationStepMode

The direction in which to move the saturation.
UByte

The amount of units to move the device's currentSaturation to.
UByte

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

Public constructors

Request

Request(
    stepMode: ColorControlTrait.SaturationStepMode = SaturationStepMode.Up,
    stepSize: UByte,
    transitionTime: UByte,
    optionsMask: UByte,
    optionsOverride: UByte
)

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

stepMode

val stepMode: ColorControlTrait.SaturationStepMode

The direction in which to move the saturation. This must be one of the values in SaturationStepMode.

stepSize

val stepSize: UByte

The amount of units to move the device's currentSaturation to.

transitionTime

val transitionTime: UByte

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