Interface Action

This data type holds the details of a single action, and contains the data fields below.

See

MatterSpecification.v13.Core § 9.14.4.6

interface Action {
    actionId: number;
    endpointListId: number;
    name: string;
    state: Actions.ActionState;
    supportedCommands: TypeFromPartialBitSchema<{
        disableAction: BitFlag;
        disableActionWithDuration: BitFlag;
        enableAction: BitFlag;
        enableActionWithDuration: BitFlag;
        instantAction: BitFlag;
        instantActionWithTransition: BitFlag;
        pauseAction: BitFlag;
        pauseActionWithDuration: BitFlag;
        resumeAction: BitFlag;
        startAction: BitFlag;
        startActionWithDuration: BitFlag;
        stopAction: BitFlag;
    }>;
    type: Actions.ActionType;
}

Hierarchy (view full)

Properties

actionId endpointListId name state supportedCommands type

Properties

actionId

actionId: number = ...

This field shall provide an unique identifier used to identify an action.

See

MatterSpecification.v13.Core § 9.14.4.6.1

endpointListId

endpointListId: number = ...

This field shall provide a reference to the associated endpoint list, which specifies the endpoints on this Node which will be impacted by this ActionID.

See

MatterSpecification.v13.Core § 9.14.4.6.4

name

name: string = ...

This field shall indicate the name (as assigned by the user or automatically by the server) associated with this action. This can be used for identifying the action to the user by the client. Example: "my colorful scene".

See

MatterSpecification.v13.Core § 9.14.4.6.2

state

state: Actions.ActionState = ...

This field shall indicate the current state of this action.

See

MatterSpecification.v13.Core § 9.14.4.6.6

supportedCommands

supportedCommands: TypeFromPartialBitSchema<{
    disableAction: BitFlag;
    disableActionWithDuration: BitFlag;
    enableAction: BitFlag;
    enableActionWithDuration: BitFlag;
    instantAction: BitFlag;
    instantActionWithTransition: BitFlag;
    pauseAction: BitFlag;
    pauseActionWithDuration: BitFlag;
    resumeAction: BitFlag;
    startAction: BitFlag;
    startActionWithDuration: BitFlag;
    stopAction: BitFlag;
}> = ...

This field is a bitmap which shall be used to indicate which of the cluster’s commands are supported for this particular action, with a bit set to 1 for each supported command according to the table below. Other bits shall be set to 0.

Type declaration

  • disableAction: BitFlag

    Indicate support for DisableAction command

  • disableActionWithDuration: BitFlag

    Indicate support for DisableActionWithDuration command

  • enableAction: BitFlag

    Indicate support for EnableAction command

  • enableActionWithDuration: BitFlag

    Indicate support for EnableActionWithDuration command

  • instantAction: BitFlag

    Indicate support for InstantAction command

  • instantActionWithTransition: BitFlag

    Indicate support for InstantActionWithTransition command

  • pauseAction: BitFlag

    Indicate support for PauseAction command

  • pauseActionWithDuration: BitFlag

    Indicate support for PauseActionWithDuration command

  • resumeAction: BitFlag

    Indicate support for ResumeAction command

  • startAction: BitFlag

    Indicate support for StartAction command

  • startActionWithDuration: BitFlag

    Indicate support for StartActionWithDuration command

  • stopAction: BitFlag

    Indicate support for StopAction command

See

MatterSpecification.v13.Core § 9.14.4.6.5

type

type: Actions.ActionType = ...

This field shall indicate the type of action. The value of Type of an action, along with its SupportedCommands can be used by the client in its UX or logic to determine how to present or use such action. See ActionTypeEnum for details and examples.

See

MatterSpecification.v13.Core § 9.14.4.6.3

Settings

Member Visibility

On This Page

Properties