Interface State

interface State {
    actionList: TypeFromFields<{
        actionId: FieldType<number>;
        endpointListId: FieldType<number>;
        name: FieldType<string>;
        state: FieldType<Actions.ActionState>;
        supportedCommands: FieldType<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: FieldType<Actions.ActionType>;
    }>[];
    endpointLists: TypeFromFields<{
        endpointListId: FieldType<number>;
        endpoints: FieldType<EndpointNumber[]>;
        name: FieldType<string>;
        type: FieldType<Actions.EndpointListType>;
    }>[];
    setupUrl?: string;
}

Hierarchy

  • StateType
    • State

Properties

actionList endpointLists setupUrl?

Properties

ReadonlyactionList

actionList: TypeFromFields<{
    actionId: FieldType<number>;
    endpointListId: FieldType<number>;
    name: FieldType<string>;
    state: FieldType<Actions.ActionState>;
    supportedCommands: FieldType<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: FieldType<Actions.ActionType>;
}>[]

The ActionList attribute holds the list of actions. Each entry shall have an unique ActionID, and its EndpointListID shall exist in the EndpointLists attribute.

See

MatterSpecification.v13.Core § 9.14.5.1

ReadonlyendpointLists

endpointLists: TypeFromFields<{
    endpointListId: FieldType<number>;
    endpoints: FieldType<EndpointNumber[]>;
    name: FieldType<string>;
    type: FieldType<Actions.EndpointListType>;
}>[]

The EndpointLists attribute holds the list of endpoint lists. Each entry shall have an unique EndpointListID.

See

MatterSpecification.v13.Core § 9.14.5.2

Optional ReadonlysetupUrl

setupUrl?: string

The SetupURL attribute (when provided) shall indicate a URL; its syntax shall follow the syntax as specified in RFC 3986, max. 512 ASCII characters. The location referenced by this URL shall provide additional information for the actions provided:

• When used without suffix, it shall provide information about the various actions which the cluster provides.

◦ Example: SetupURL could take the value of example://Actions or https://domain.example/
  Matter/bridgev1/Actions for this generic case (access generic info how to use actions provided by
  this cluster).

• When used with a suffix of "/?a=" and the decimal value of ActionID for one of the actions, it may provide information about that particular action. This could be a deeplink to manufacturer-app/website (associated somehow to the server node) with the information/edit-screen for this action so that the user can view and update details of the action, e.g. edit the scene, or change the wake-up experience time period.

◦ Example of SetupURL with suffix added: example://Actions/?a=12345 or
  https://domain.example/Matter/bridgev1/Actions/?a=12345 for linking to specific info/editing of
  the action with ActionID 0x3039.

See

MatterSpecification.v13.Core § 9.14.5.3

Settings

Member Visibility

On This Page

Properties