class Matter::Cluster::IdentifyCluster

Overview

Identify Cluster Implementation (0x0003) Provides a way to identify devices (e.g., by flashing a light or making a sound)

Defined in:

matter/cluster/identify_cluster.cr

Constant Summary

CLUSTER_ID = 3_u32
CLUSTER_REVISION = 65533_u32

Global attributes

CMD_IDENTIFY = 0_u32

Command IDs

CMD_IDENTIFY_QUERY = 64_u32
CMD_IDENTIFY_QUERY_RESPONSE = 0_u32

Response IDs

CMD_TRIGGER_EFFECT = 1_u32
FEATURE_MAP = 65532_u32
IDENTIFY_TIME = 0_u32

Attribute IDs

IDENTIFY_TYPE = 1_u32

Constructors

Instance Method Summary

Instance methods inherited from class Matter::Cluster::Base

attributes : Array(AttributeMetadata) attributes, cluster_id : DataType::ClusterId cluster_id, cluster_id=(cluster_id : DataType::ClusterId) cluster_id=, commands : Array(CommandMetadata) commands, data_version : UInt32 data_version, data_version=(data_version : UInt32) data_version=, endpoint_id : DataType::EndpointNumber endpoint_id, endpoint_id=(endpoint_id : DataType::EndpointNumber) endpoint_id=, events : Array(EventMetadata) events, get_attribute_metadata(attribute_id : UInt32) : AttributeMetadata | Nil get_attribute_metadata, get_command_metadata(command_id : UInt32) : CommandMetadata | Nil get_command_metadata, invoke_command(command_id : UInt32, fields : Bytes = Bytes.new(0)) : InteractionModel::Status | Bytes invoke_command, name : String name, read_attribute(attribute_id : UInt32) : InteractionModel::Status | Bytes read_attribute, write_attribute(attribute_id : UInt32, value : Bytes) : InteractionModel::Status write_attribute

Constructor methods inherited from class Matter::Cluster::Base

new(endpoint_id : DataType::EndpointNumber, cluster_id : DataType::ClusterId) new

Constructor Detail

def self.new(endpoint_id : DataType::EndpointNumber, identify_time : UInt16 = 0_u16, identify_type : Definitions::Identify::Type = Definitions::Identify::Type::None) #

[View source]

Instance Method Detail

def attributes : Array(AttributeMetadata) #
Description copied from class Matter::Cluster::Base

Get all attribute metadata


[View source]
def commands : Array(CommandMetadata) #
Description copied from class Matter::Cluster::Base

Get all command metadata


[View source]
def identify_time : UInt16 #

[View source]
def identify_time=(identify_time : UInt16) #

[View source]
def identify_type : Definitions::Identify::Type #

[View source]
def identify_type=(identify_type : Definitions::Identify::Type) #

[View source]
def name : String #
Description copied from class Matter::Cluster::Base

Get cluster name


[View source]
def on_identify : Proc(UInt16, Nil) | Nil #

Callback for when identify is triggered


[View source]
def on_identify=(on_identify : Proc(UInt16, Nil) | Nil) #

Callback for when identify is triggered


[View source]
def read_attribute(attribute_id : UInt32) : InteractionModel::Status | Bytes #
Description copied from class Matter::Cluster::Base

Read an attribute value


[View source]
def start_identify(duration : UInt16) #

Helper method to start identifying


[View source]
def stop_identify #

Helper method to stop identifying


[View source]
def write_attribute(attribute_id : UInt32, value : Bytes) : InteractionModel::Status #
Description copied from class Matter::Cluster::Base

Write an attribute value


[View source]