Interface StepColorTemperatureRequest

Input to the ColorControl stepColorTemperature command

See

MatterSpecification.v13.Cluster § 3.2.11.22

interface StepColorTemperatureRequest {
    colorTemperatureMaximumMireds: number;
    colorTemperatureMinimumMireds: number;
    optionsMask: TypeFromPartialBitSchema<{
        executeIfOff: BitFlag;
    }>;
    optionsOverride: TypeFromPartialBitSchema<{
        executeIfOff: BitFlag;
    }>;
    stepMode: ColorControl.StepMode;
    stepSize: number;
    transitionTime: number;
}

Hierarchy (view full)

Properties

colorTemperatureMaximumMireds colorTemperatureMinimumMireds optionsMask optionsOverride stepMode stepSize transitionTime

Properties

colorTemperatureMaximumMireds

colorTemperatureMaximumMireds: number

The ColorTemperatureMaximumMireds field specifies an upper bound on the ColorTemperatureMireds attribute (≡ a lower bound on the color temperature in kelvins) for the current step operation

ColorTemperatureMireds ≤ ColorTemperatureMaximumMireds field ≤ ColorTempPhysicalMaxMireds

As such if the step operation takes the ColorTemperatureMireds attribute towards the value of the ColorTemperatureMaximumMireds field it shall be clipped so that the above invariant is satisfied. If the ColorTemperatureMaximum Mireds field is set to 0, ColorTempPhysicalMaxMireds shall be used as the upper bound for the ColorTemperatureMireds attribute.

See

MatterSpecification.v13.Cluster § 3.2.11.22.5

colorTemperatureMinimumMireds

colorTemperatureMinimumMireds: number

The ColorTemperatureMinimumMireds field specifies a lower bound on the ColorTemperatureMireds attribute (≡ an upper bound on the color temperature in kelvins) for the current step operation

ColorTempPhysicalMinMireds <= ColorTemperatureMinimumMireds field <= ColorTemperatureMireds

As such if the step operation takes the ColorTemperatureMireds attribute towards the value of the Color Temperature Minimum Mireds field it shall be clipped so that the above invariant is satisfied. If the ColorTemperatureMinimumMireds field is set to 0, ColorTempPhysicalMinMireds shall be used as the lower bound for the ColorTemperatureMireds attribute.

See

MatterSpecification.v13.Cluster § 3.2.11.22.4

optionsMask

optionsMask: TypeFromPartialBitSchema<{
    executeIfOff: BitFlag;
}>

optionsOverride

optionsOverride: TypeFromPartialBitSchema<{
    executeIfOff: BitFlag;
}>

stepMode

stepMode: ColorControl.StepMode

This field is identical to the StepMode field of the StepHue command of the Color Control cluster (see sub-clause StepHue Command).

See

MatterSpecification.v13.Cluster § 3.2.11.22.1

stepSize

stepSize: number

The StepSize field specifies the change to be added to (or subtracted from) the current value of the device’s color temperature.

See

MatterSpecification.v13.Cluster § 3.2.11.22.2

transitionTime

transitionTime: number

The TransitionTime field specifies, in units of 1/10ths of a second, the time that shall be taken to perform the step. A step is a change to the device’s color temperature of a magnitude corresponding to the StepSize field.

See

MatterSpecification.v13.Cluster § 3.2.11.22.3

Settings

Member Visibility

On This Page

Properties