Interface MoveColorTemperatureRequest

Input to the ColorControl moveColorTemperature command

See

MatterSpecification.v13.Cluster § 3.2.11.21

interface MoveColorTemperatureRequest {
    colorTemperatureMaximumMireds: number;
    colorTemperatureMinimumMireds: number;
    moveMode: ColorControl.MoveMode;
    optionsMask: TypeFromPartialBitSchema<{
        executeIfOff: BitFlag;
    }>;
    optionsOverride: TypeFromPartialBitSchema<{
        executeIfOff: BitFlag;
    }>;
    rate: number;
}

Hierarchy (view full)

Properties

colorTemperatureMaximumMireds colorTemperatureMinimumMireds moveMode optionsMask optionsOverride rate

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 move operation

ColorTemperatureMireds <= ColorTemperatureMaximumMireds field <= ColorTempPhysicalMaxMireds

As such if the move 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 ColorTemperatureMaximumMireds field is set to 0, ColorTempPhysicalMaxMireds shall be used as the upper bound for the ColorTemperatureMireds attribute.

See

MatterSpecification.v13.Cluster § 3.2.11.21.4

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 move operation

ColorTempPhysicalMinMireds <= ColorTemperatureMinimumMireds field <= ColorTemperatureMireds

As such if the move operation takes the ColorTemperatureMireds attribute towards the value of the ColorTemperatureMinimumMireds 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.21.3

moveMode

moveMode: ColorControl.MoveMode

This field is identical to the MoveMode field of the MoveHue command of the Color Control cluster (see sub-clause MoveHue Command). If the MoveMode field is equal to 0 (Stop), the Rate field shall be ignored.

See

MatterSpecification.v13.Cluster § 3.2.11.21.1

optionsMask

optionsMask: TypeFromPartialBitSchema<{
    executeIfOff: BitFlag;
}>

optionsOverride

optionsOverride: TypeFromPartialBitSchema<{
    executeIfOff: BitFlag;
}>

rate

rate: number

The Rate field specifies the rate of movement in steps per second. A step is a change in the color temperature of a device by one unit. If the MoveMode field is set to 1 (up) or 3 (down) and the Rate field has a value of zero, the command has no effect and a response command shall be sent in response, with the status code set to INVALID_COMMAND. If the MoveMode field is set to 0 (stop) the Rate field shall be ignored.

See

MatterSpecification.v13.Cluster § 3.2.11.21.2

Settings

Member Visibility

On This Page

Properties