class

Matter::Cluster::ScenesCluster

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

Scenes Cluster Implementation (0x0005) Provides scene storage and recall functionality

Features:

  • SceneNames (SN): Store names for scenes

Specification: Matter 1.4 § 1.4

Constants

CLUSTER_ID = 5_u32
CLUSTER_REVISION = 65533_u32

Global attributes

CMD_ADD_SCENE = 0_u32

Command IDs

CMD_ADD_SCENE_RESPONSE = 0_u32

Response IDs

CMD_COPY_SCENE = 64_u32
CMD_COPY_SCENE_RESPONSE = 64_u32
CMD_GET_SCENE_MEMBERSHIP = 6_u32
CMD_GET_SCENE_MEMBERSHIP_RESPONSE = 6_u32
CMD_RECALL_SCENE = 5_u32
CMD_REMOVE_ALL_SCENES = 3_u32
CMD_REMOVE_ALL_SCENES_RESPONSE = 3_u32
CMD_REMOVE_SCENE = 2_u32
CMD_REMOVE_SCENE_RESPONSE = 2_u32
CMD_STORE_SCENE = 4_u32
CMD_STORE_SCENE_RESPONSE = 4_u32
CMD_VIEW_SCENE = 1_u32
CMD_VIEW_SCENE_RESPONSE = 1_u32
CURRENT_GROUP = 2_u32
CURRENT_SCENE = 1_u32
FEATURE_MAP_ATTR = 65532_u32
LAST_CONFIGURED_BY = 5_u32
NAME_SUPPORT = 4_u32
SCENE_COUNT = 0_u32

Attribute IDs

SCENE_VALID = 3_u32

Constructors

new(endpoint_id : DataType::EndpointNumber, feature_map : Feature = Feature::SceneNames, max_scenes : UInt8 = 16_u8)
Source

Class methods

cluster_id

Scenes Cluster Implementation (0x0005) Provides scene storage and recall functionality

Features:

  • SceneNames (SN): Store names for scenes

Specification: Matter 1.4 § 1.4

Source

Instance methods

attributes

Get all attribute metadata

Source
commands

Get all command metadata

Source
current_group
Source
current_group=(current_group : UInt16)
Source
current_scene
Source
current_scene=(current_scene : UInt8)
Source
feature_map

Feature map

Source
feature_map=(feature_map : Feature)

Feature map

Source
has_scene?(group_id : UInt16, scene_id : UInt8) : Bool
Source
invalidate_current_scene
Source
name

Get cluster name

Source
on_recall_scene

Callback for when scene is recalled

Source
on_recall_scene=(on_recall_scene : Proc(UInt16, UInt8, Nil) | Nil)

Callback for when scene is recalled

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
scene_count
Source
scene_valid=(scene_valid : Bool)
Source
scene_valid?
Source
scenes

Scene storage: {group_id, scene_id} => SceneData

Source
scenes=(scenes : Hash(Tuple(UInt16, UInt8), SceneData))

Scene storage: {group_id, scene_id} => SceneData

Source

Nested types