class

Matter::Cluster::IdentifyCluster

Inherits Matter::Cluster::Base < Reference < Object

Identify Cluster Implementation (0x0003)

Provides an interface for a device to identify itself to a user (e.g., by flashing a light, sounding a beep, displaying a message).

Commonly required on many device types for commissioning and user interaction.

Matter Spec: Application 1.2

Constants

ATTR_IDENTIFY_TIME = 0_u32

Attributes (using ATTR_ prefix for consistency)

ATTR_IDENTIFY_TYPE = 1_u32
CLUSTER_ID = 3_u32
CLUSTER_REVISION = 65533_u32

Global attributes (required on all clusters)

CMD_IDENTIFY = 0_u32

Commands

CMD_TRIGGER_EFFECT = 64_u32
FEATURE_MAP = 65532_u32
Log = ::Log.for("matter.cluster.identify")

Constructors

new(endpoint_id : DataType::EndpointNumber, identify_type : IdentifyType = IdentifyType::None)
Source

Class methods

cluster_id

Identify Cluster Implementation (0x0003)

Provides an interface for a device to identify itself to a user (e.g., by flashing a light, sounding a beep, displaying a message).

Commonly required on many device types for commissioning and user interaction.

Matter Spec: Application 1.2

Source

Instance methods

attributes

Get all attribute metadata

Source
commands

Get all command metadata

Source
identify_time

Attribute storage

Source
identify_time=(identify_time : UInt16)

Attribute storage

Source
identify_type
Source
identify_type=(identify_type : IdentifyType)
Source
identifying?

Check if device is currently identifying

Source
name

Get cluster name

Source
on_identify_started

Set callback for when identify starts

Source
on_identify_stopped

Set callback for when identify stops

Source
on_trigger_effect

Set callback for trigger effect

Source
read_attribute(attribute_id : UInt32, fabric_index : UInt8 | Nil = nil) : InteractionModel::Status | Bytes

Read an attribute value The fabric_index parameter is optional and used for fabric-scoped attributes like CurrentFabricIndex in OperationalCredentialsCluster

Source
tick

Helper: Decrement identify time (call this periodically, e.g., every second)

Source
write_attribute(attribute_id : UInt32, value : Bytes) : InteractionModel::Status

Write an attribute value

Source

Nested types