Interface EnhancedStepHueRequest

Input to the ColorControl enhancedStepHue command

See

MatterSpecification.v13.Cluster § 3.2.11.17

interface EnhancedStepHueRequest {
    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

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.17.1

stepSize

stepSize: number

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

See

MatterSpecification.v13.Cluster § 3.2.11.17.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 enhanced hue of a magnitude corresponding to the StepSize field.

NOTE

Here TransitionTime data field is of data type uint16, while the TransitionTime data field of the StepHue command is of data type uint8.

See

MatterSpecification.v13.Cluster § 3.2.11.17.3

Settings

Member Visibility

On This Page

Properties