Interface MoveRequest

Input to the LevelControl move command

See

MatterSpecification.v13.Cluster § 1.6.7.2

interface MoveRequest {
    moveMode: LevelControl.MoveMode;
    optionsMask: TypeFromPartialBitSchema<{
        coupleColorTempToLevel: BitFlag;
        executeIfOff: BitFlag;
    }>;
    optionsOverride: TypeFromPartialBitSchema<{
        coupleColorTempToLevel: BitFlag;
        executeIfOff: BitFlag;
    }>;
    rate: null | number;
}

Hierarchy (view full)

Properties

moveMode optionsMask optionsOverride rate

Properties

moveMode

moveMode: LevelControl.MoveMode

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

See

MatterSpecification.v13.Cluster § 1.6.7.2.1

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

rate

rate: null | number

This field shall indicate the rate of movement in units per second. The actual rate of movement SHOULD be as close to this rate as the device is able. If the Rate field is equal to null, then the value in DefaultMoveRate attribute shall be used. However, if the Rate field is equal to null and the DefaultMoveRate attribute is not supported, or if the Rate field is equal to null and the value of the DefaultMoveRate attribute is equal to null, then the device SHOULD move as fast as it is able. If the device is not able to move at a variable rate, this field may be disregarded.

See

MatterSpecification.v13.Cluster § 1.6.7.2.2

Settings

Member Visibility

On This Page

Properties