ColorControlTrait.MoveToColorTemperatureCommand.Request

class ColorControlTrait.MoveToColorTemperatureCommand.Request


The request payload for the MoveToColorTemperature command.

Summary

Public constructors

Request(
    colorTemperatureMireds: UShort,
    transitionTime: UShort,
    optionsMask: ColorControlTrait.OptionsBitmap,
    optionsOverride: ColorControlTrait.OptionsBitmap
)

Creates a request payload for the MoveToColorTemperature command.

Public properties

UShort

The color temperature, in mireds, to move the device to.

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.

UShort

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

Public constructors

Request

Request(
    colorTemperatureMireds: UShort,
    transitionTime: UShort,
    optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the MoveToColorTemperature command.

Public properties

colorTemperatureMireds

val colorTemperatureMiredsUShort

The color temperature, in mireds, to move the device to.

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.

transitionTime

val transitionTimeUShort

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