ColorControlTrait.StepHueCommand.Request

class ColorControlTrait.StepHueCommand.Request


The request payload for the StepHue command.

Summary

Public constructors

Request(
    stepMode: ColorControlTrait.StepModeEnum,
    stepSize: UByte,
    transitionTime: UByte,
    optionsMask: ColorControlTrait.OptionsBitmap,
    optionsOverride: ColorControlTrait.OptionsBitmap
)

Creates a request payload for the StepHue command.

Public properties

ColorControlTrait.OptionsBitmap

Determines which bits in the options attribute should be overridden by optionsOverride.

ColorControlTrait.OptionsBitmap

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.

ColorControlTrait.StepModeEnum

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.StepModeEnum = StepModeEnum.Up,
    stepSize: UByte,
    transitionTime: UByte,
    optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the StepHue command.

Public properties

optionsMask

val optionsMaskColorControlTrait.OptionsBitmap

Determines which bits in the options attribute should be overridden by optionsOverride.

optionsOverride

val optionsOverrideColorControlTrait.OptionsBitmap

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.

stepMode

val stepModeColorControlTrait.StepModeEnum

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

stepSize

val stepSizeUByte

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

transitionTime

val transitionTimeUByte

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