Interface EnhancedMoveHueRequest

Input to the ColorControl enhancedMoveHue command

See

MatterSpecification.v13.Cluster § 3.2.11.16

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

Hierarchy (view full)

Properties

moveMode optionsMask optionsOverride rate

Properties

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.16.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 extended hue 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.16.2

Settings

Member Visibility

On This Page

Properties