Interface MoveHueRequest

Input to the ColorControl moveHue command

See

MatterSpecification.v13.Cluster § 3.2.11.5

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

The MoveMode field shall be one of the non-reserved values in Values of the MoveMode Field. If the MoveMode field is equal to 0 (Stop), the Rate field shall be ignored.

Table 18. Values of the MoveMode Field

See

MatterSpecification.v13.Cluster § 3.2.11.5.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 device’s hue of 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.5.2

Settings

Member Visibility

On This Page

Properties