Interface StepRequest

Input to the LevelControl step command

See

MatterSpecification.v13.Cluster § 1.6.7.3

interface StepRequest {
    optionsMask: TypeFromPartialBitSchema<{
        coupleColorTempToLevel: BitFlag;
        executeIfOff: BitFlag;
    }>;
    optionsOverride: TypeFromPartialBitSchema<{
        coupleColorTempToLevel: BitFlag;
        executeIfOff: BitFlag;
    }>;
    stepMode: LevelControl.StepMode;
    stepSize: number;
    transitionTime: null | number;
}

Hierarchy (view full)

Properties

optionsMask optionsOverride stepMode stepSize transitionTime

Properties

optionsMask

optionsMask: TypeFromPartialBitSchema<{
    coupleColorTempToLevel: BitFlag;
    executeIfOff: BitFlag;
}>

Type declaration

  • coupleColorTempToLevel: BitFlag

    Dependency on Color Control cluster

    This bit indicates if this cluster has a dependency with the Color Control cluster.

    See

    MatterSpecification.v13.Cluster § 1.6.5.1.2

  • executeIfOff: BitFlag

    Dependency on On/Off cluster

    This bit indicates if this cluster has a dependency with the On/Off cluster.

    See

    MatterSpecification.v13.Cluster § 1.6.5.1.1

optionsOverride

optionsOverride: TypeFromPartialBitSchema<{
    coupleColorTempToLevel: BitFlag;
    executeIfOff: BitFlag;
}>

Type declaration

  • coupleColorTempToLevel: BitFlag

    Dependency on Color Control cluster

    This bit indicates if this cluster has a dependency with the Color Control cluster.

    See

    MatterSpecification.v13.Cluster § 1.6.5.1.2

  • executeIfOff: BitFlag

    Dependency on On/Off cluster

    This bit indicates if this cluster has a dependency with the On/Off cluster.

    See

    MatterSpecification.v13.Cluster § 1.6.5.1.1

stepMode

stepMode: LevelControl.StepMode

This field shall be one of the non-reserved values in StepModeEnum.

See

MatterSpecification.v13.Cluster § 1.6.7.3.1

stepSize

stepSize: number

This field shall indicate the change to CurrentLevel.

See

MatterSpecification.v13.Cluster § 1.6.7.3.2

transitionTime

transitionTime: null | number

This field shall indicate the time that shall be taken to perform the step, in tenths of a second. A step is a change in the CurrentLevel of StepSize units. The actual time taken SHOULD be as close to this as the device is able. If the TransitionTime field is equal to null, the device SHOULD move as fast as it is able.

If the device is not able to move at a variable rate, the TransitionTime field may be disregarded.

See

MatterSpecification.v13.Cluster § 1.6.7.3.3

Settings

Member Visibility

On This Page

Properties