ColorControlTrait.StepHueCommand.Request

class ColorControlTrait.StepHueCommand.Request

The request payload for the StepHue command.

Summary

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

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

The direction in which to move the hue.
UByte

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

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

Public constructors

Request

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

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

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

stepSize

val stepSize: UByte

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

transitionTime

val transitionTime: UByte

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