ColorControlTrait.StepColorTemperatureCommand.Request

class ColorControlTrait.StepColorTemperatureCommand.Request


The request payload for the StepColorTemperature command.

Summary

Public constructors

Request(
    stepMode: ColorControlTrait.StepModeEnum,
    stepSize: UShort,
    transitionTime: UShort,
    colorTemperatureMinimumMireds: UShort,
    colorTemperatureMaximumMireds: UShort,
    optionsMask: ColorControlTrait.OptionsBitmap,
    optionsOverride: ColorControlTrait.OptionsBitmap
)

Creates a request payload for the StepColorTemperature 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.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 color temperature.

UShort

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

UShort

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

Public constructors

Request

Request(
    stepMode: ColorControlTrait.StepModeEnum = StepModeEnum.Up,
    stepSize: UShort,
    transitionTime: UShort,
    colorTemperatureMinimumMireds: UShort,
    colorTemperatureMaximumMireds: UShort,
    optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the StepColorTemperature command.

Public properties

colorTemperatureMaximumMireds

val colorTemperatureMaximumMiredsUShort

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 colorTemperatureMinimumMiredsUShort

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.

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 color temperature. This must be one of the values in ColorControlTrait.HueStepMode.

stepSize

val stepSizeUShort

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

transitionTime

val transitionTimeUShort

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