class Matter::Cluster::BasicInformationCluster

Overview

Basic Information Cluster Implementation (0x0028) Provides attributes about the device hardware, software, and configuration

Defined in:

matter/cluster/basic_information_cluster.cr

Constant Summary

CAPABILITY_MINIMA = 19_u32
CLUSTER_ID = 40_u32
CLUSTER_REVISION = 65533_u32

Global attributes

DATA_MODEL_REVISION = 0_u32

Attribute IDs

FEATURE_MAP = 65532_u32
HARDWARE_VERSION = 7_u32
HARDWARE_VERSION_STRING = 8_u32
LOCAL_CONFIG_DISABLED = 16_u32
LOCATION = 6_u32
MANUFACTURING_DATE = 11_u32
NODE_LABEL = 5_u32
PART_NUMBER = 12_u32
PRODUCT_APPEARANCE = 20_u32
PRODUCT_ID = 4_u32
PRODUCT_LABEL = 14_u32
PRODUCT_NAME = 3_u32
PRODUCT_URL = 13_u32
REACHABLE = 17_u32
SERIAL_NUMBER = 15_u32
SOFTWARE_VERSION = 9_u32
SOFTWARE_VERSION_STRING = 10_u32
UNIQUE_ID = 18_u32
VENDOR_ID = 2_u32
VENDOR_NAME = 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, data_model_revision : UInt16 = 1_u16, vendor_name : String = "Test Vendor", vendor_id : UInt16 = 65521_u16, product_name : String = "Test Product", product_id : UInt16 = 32768_u16, node_label : String = "", location : String = "XX", hardware_version : UInt16 = 0_u16, hardware_version_string : String = "v1.0", software_version : UInt32 = 1_u32, software_version_string : String = "1.0.0", serial_number : String | Nil = nil, reachable : Bool = true) #

[View source]

Instance Method Detail

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

Get all attribute metadata


[View source]
def data_model_revision : UInt16 #

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

[View source]
def hardware_version : UInt16 #

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

[View source]
def hardware_version_string : String #

[View source]
def hardware_version_string=(hardware_version_string : String) #

[View source]
def location : String #

[View source]
def location=(location : String) #

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

Get cluster name


[View source]
def node_label : String #

[View source]
def node_label=(node_label : String) #

[View source]
def product_id : UInt16 #

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

[View source]
def product_name : String #

[View source]
def product_name=(product_name : String) #

[View source]
def reachable : Bool #

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

[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 serial_number : String | Nil #

[View source]
def serial_number=(serial_number : String | Nil) #

[View source]
def software_version : UInt32 #

[View source]
def software_version=(software_version : UInt32) #

[View source]
def software_version_string : String #

[View source]
def software_version_string=(software_version_string : String) #

[View source]
def vendor_id : DataType::VendorId #

[View source]
def vendor_id=(vendor_id : DataType::VendorId) #

[View source]
def vendor_name : String #

[View source]
def vendor_name=(vendor_name : String) #

[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]