ColorControlTrait.MoveColorTemperatureCommand.Request

class ColorControlTrait.MoveColorTemperatureCommand.Request

The request payload for the MoveColorTemperature command.

Summary

Public constructors
Request(
    moveMode: ColorControlTrait.HueMoveMode,
    rate: UShort,
    colorTemperatureMinimumMireds: UShort,
    colorTemperatureMaximumMireds: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the MoveColorTemperature command.

Public properties
UShort

The upper bound of the colorTemperatureMireds attribute for the command.
UShort

The lower bound of the colorTemperatureMireds attribute for the command.
ColorControlTrait.HueMoveMode

The direction in which to move the color temperature.
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.
UShort

The rate (in steps per seconds) used to change the device's colorTemperatureMireds.

Public constructors

Request

Request(
    moveMode: ColorControlTrait.HueMoveMode = HueMoveMode.Stop,
    rate: UShort,
    colorTemperatureMinimumMireds: UShort,
    colorTemperatureMaximumMireds: UShort,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the MoveColorTemperature command.

Public properties

colorTemperatureMaximumMireds

val colorTemperatureMaximumMireds: UShort

The upper bound of the colorTemperatureMireds attribute for the command. This value must be between the colorTemperatureMireds and colorTempPhysicalMaxMireds attributes. If this value is set to 0, colorTempPhysicalMaxMireds is used as the upper bound.

colorTemperatureMinimumMireds

val colorTemperatureMinimumMireds: UShort

The lower bound of the colorTemperatureMireds attribute for the command. This value must be between the colorTempPhysicalMinMireds and colorTemperatureMireds attributes. If this value is set to 0, colorTempPhysicalMinMireds is used as the lower bound.

moveMode

val moveMode: ColorControlTrait.HueMoveMode

The direction in which to move the color temperature. This must be one of the values in HueMoveMode.

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.

rate

val rate: UShort

The rate (in steps per seconds) used to change the device's colorTemperatureMireds.