Interface StepHueRequest

Input to the ColorControl stepHue command

See

MatterSpecification.v13.Cluster § 3.2.11.6

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

Hierarchy (view full)

Properties

optionsMask optionsOverride stepMode stepSize transitionTime

Properties

optionsMask

optionsMask: TypeFromPartialBitSchema<{
    executeIfOff: BitFlag;
}>

optionsOverride

optionsOverride: TypeFromPartialBitSchema<{
    executeIfOff: BitFlag;
}>

stepMode

stepMode: ColorControl.StepMode

The StepMode field shall be one of the non-reserved values in Values of the StepMode Field.

Table 20. Values of the StepMode Field

See

MatterSpecification.v13.Cluster § 3.2.11.6.1

stepSize

stepSize: number

The change to be added to (or subtracted from) the current value of the device’s hue.

See

MatterSpecification.v13.Cluster § 3.2.11.6.2

transitionTime

transitionTime: number

The TransitionTime field specifies, in 1/10ths of a second, the time that shall be taken to perform the step. A step is a change in the device’s hue of ‘Step size’ units.

NOTE

Here the TransitionTime data field is of data type uint8, where uint16 is more common for TransitionTime data fields in other clusters / commands.

See

MatterSpecification.v13.Cluster § 3.2.11.6.3

Settings

Member Visibility

On This Page

Properties