struct

Matter::Cluster::Definitions::Action::Base

Inherits TLV::Serializable < Struct < Value < Object

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

Constructors

new(any : TLV::Any)
Source

Class methods

from_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian)
Source
from_slice(bytes : Bytes)
Source
from_tlv(any : TLV::Any)
Source
from_tlv(data : Bytes)
Source

Instance methods

action_id

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

Source
action_id=(action_id : UInt16)

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

Source
endpoint_list_id

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.

Source
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.

Source
name

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".

Source
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".

Source
state

This field shall indicate the current state of this action.

Source
state=(state : State)

This field shall indicate the current state of this action.

Source
supported_commands

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.

Source
supported_commands=(supported_commands : UInt16)

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.

Source
to_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian) : Nil
Source
to_slice
Source
to_tlv(outer_tag : Nil | UInt8 | Tuple(UInt16, UInt16) | Tuple(UInt16, UInt16, UInt16) = nil) : TLV::Any
Source
type

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.

Source
type=(type : Type)

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.

Source