Variable TlvActionConst

Type declaration

• actionId: FieldType<number>

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

  See

  MatterSpecification.v13.Core § 9.14.4.6.1

• endpointListId: FieldType<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: FieldType<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: FieldType<Actions.ActionState>

  This field shall indicate the current state of this action.

  See

  MatterSpecification.v13.Core § 9.14.4.6.6

• 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;
  }>>

  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.

  See

  MatterSpecification.v13.Core § 9.14.4.6.5

• type: FieldType<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