class Matter::Cluster::ScenesCluster

Overview

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

Defined in:

matter/cluster/scenes_cluster.cr

Constant Summary

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 = 65532_u32
LAST_CONFIGURED_BY = 5_u32
NAME_SUPPORT = 4_u32
SCENE_COUNT = 0_u32

Attribute IDs

SCENE_VALID = 3_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, name_support : Bool = true, max_scenes : UInt8 = 16_u8) #

[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 current_group : UInt16 #

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

[View source]
def current_scene : UInt8 #

[View source]
def current_scene=(current_scene : UInt8) #

[View source]
def has_scene?(group_id : UInt16, scene_id : UInt8) : Bool #

[View source]
def invalidate_current_scene #

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

Get cluster name


[View source]
def name_support : Bool #

[View source]
def name_support=(name_support : Bool) #

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

Callback for when scene is recalled


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

Callback for when scene is recalled


[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 scene_count : Int32 #

[View source]
def scene_valid : Bool #

[View source]
def scene_valid=(scene_valid : Bool) #

[View source]
def scenes : Hash(Tuple(UInt16, UInt8), SceneData) #

Scene storage: {group_id, scene_id} => SceneData


[View source]
def scenes=(scenes : Hash(Tuple(UInt16, UInt8), SceneData)) #

Scene storage: {group_id, scene_id} => SceneData


[View source]