struct
Matter::Cluster::Definitions::Action::Base
- Matter::Cluster::Definitions::Action::Base
- Struct
- Value
- Object
Overview
This data type holds the details of a single action, and contains the data fields below.
Included Modules
- TLV::Serializable
Defined in:
matter/cluster/definitions/action.crConstructors
Instance Method Summary
-
#action_id : UInt16
This field shall provide an unique identifier used to identify an action.
-
#action_id=(action_id : UInt16)
This field shall provide an unique identifier used to identify an action.
-
#endpoint_list_id : UInt16
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.
-
#endpoint_list_id=(endpoint_list_id : UInt16)
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.
-
#name : String
This field shall indicate the name (as assigned by the user or automatically by the server) associated with this action.
-
#name=(name : String)
This field shall indicate the name (as assigned by the user or automatically by the server) associated with this action.
-
#state : State
This field shall indicate the current state of this action.
-
#state=(state : State)
This field shall indicate the current state of this action.
-
#supported_commands : UInt16
This field is a bitmap which shall be used to indicate which of the cluster’s commands are sup
-
#supported_commands=(supported_commands : UInt16)
This field is a bitmap which shall be used to indicate which of the cluster’s commands are sup
-
#type : Type
This field shall indicate the type of action.
-
#type=(type : Type)
This field shall indicate the type of action.
Constructor Detail
Instance Method Detail
This field shall provide an unique identifier used to identify an action.
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.
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.
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".
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".
This field shall indicate the current state of this action.
This field is a bitmap which shall be used to indicate which of the cluster’s commands are sup
ported 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.
This field is a bitmap which shall be used to indicate which of the cluster’s commands are sup
ported 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.
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.
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.