struct Matter::Cluster::Definitions::BasicInformation::Configuration

Included Modules

Defined in:

matter/cluster/definitions/basic_information.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(data : Slice(UInt8)) #

[View source]

Instance Method Detail

def capability_minima : CapabilityMinima #

This attribute shall provide the minimum guaranteed value for some system-wide resource capabilities that are not otherwise cluster-specific and do not appear elsewhere. This attribute may be used by clients to optimize communication with Nodes by allowing them to use more than the strict minimum values required by this specification, wherever available.

The values supported by the server in reality may be larger than the values provided in this attribute, such as if a server is not resource-constrained at all. However, clients SHOULD only rely on the amounts provided in this attribute.

Note that since the fixed values within this attribute may change over time, both increasing and decreasing, as software versions change for a given Node, clients SHOULD take care not to assume forever unchanging values and SHOULD NOT cache this value permanently at Commissioning time.


[View source]
def capability_minima=(capability_minima : CapabilityMinima) #

This attribute shall provide the minimum guaranteed value for some system-wide resource capabilities that are not otherwise cluster-specific and do not appear elsewhere. This attribute may be used by clients to optimize communication with Nodes by allowing them to use more than the strict minimum values required by this specification, wherever available.

The values supported by the server in reality may be larger than the values provided in this attribute, such as if a server is not resource-constrained at all. However, clients SHOULD only rely on the amounts provided in this attribute.

Note that since the fixed values within this attribute may change over time, both increasing and decreasing, as software versions change for a given Node, clients SHOULD take care not to assume forever unchanging values and SHOULD NOT cache this value permanently at Commissioning time.


[View source]
def data_model_revision : UInt16 #

This attribute shall be set to the revision number of the Data Model against which the Node is certified.


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

This attribute shall be set to the revision number of the Data Model against which the Node is certified.


[View source]
def hardware_version : UInt16 #

This attribute shall specify the version number of the hardware of the Node. The meaning of its value, and the versioning scheme, are vendor defined.


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

This attribute shall specify the version number of the hardware of the Node. The meaning of its value, and the versioning scheme, are vendor defined.


[View source]
def hardware_version_string : String #

This attribute shall specify the version number of the hardware of the Node. The meaning of its value, and the versioning scheme, are vendor defined. The HardwareVersionString attribute shall be used to provide a more user-friendly value than that represented by the HardwareVersion attribute.


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

This attribute shall specify the version number of the hardware of the Node. The meaning of its value, and the versioning scheme, are vendor defined. The HardwareVersionString attribute shall be used to provide a more user-friendly value than that represented by the HardwareVersion attribute.


[View source]
def local_config_disabled : Bool | Nil #

This attribute shall allow a local Node configuration to be disabled. When this attribute is set to True the Node shall disable the ability to configure the Node through an on-Node user interface. The value of the LocalConfigDisabled attribute shall NOT in any way modify, disable, or otherwise affect the user’s ability to trigger a factory reset on the Node.


[View source]
def local_config_disabled=(local_config_disabled : Bool | Nil) #

This attribute shall allow a local Node configuration to be disabled. When this attribute is set to True the Node shall disable the ability to configure the Node through an on-Node user interface. The value of the LocalConfigDisabled attribute shall NOT in any way modify, disable, or otherwise affect the user’s ability to trigger a factory reset on the Node.


[View source]
def location : String #

This attribute shall be an ISO 3166-1 alpha-2 code to represent the country, dependent territory, or special area of geographic interest in which the Node is located at the time of the attribute being set. This attribute shall be set during initial commissioning (unless already set) and may be updated by further reconfigurations. This attribute may affect some regulatory aspects of the Node’s operation, such as radio transmission power levels in given spectrum allocation bands if technologies where this is applicable are used. The Location’s region code shall be interpreted in a case-insensitive manner. If the Node cannot understand the location code with which it was configured, or the location code has not yet been configured, it shall configure itself in a region- agnostic manner as determined by the vendor, avoiding region-specific assumptions as much as is practical. The special value XX shall indicate that region-agnostic mode is used.


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

This attribute shall be an ISO 3166-1 alpha-2 code to represent the country, dependent territory, or special area of geographic interest in which the Node is located at the time of the attribute being set. This attribute shall be set during initial commissioning (unless already set) and may be updated by further reconfigurations. This attribute may affect some regulatory aspects of the Node’s operation, such as radio transmission power levels in given spectrum allocation bands if technologies where this is applicable are used. The Location’s region code shall be interpreted in a case-insensitive manner. If the Node cannot understand the location code with which it was configured, or the location code has not yet been configured, it shall configure itself in a region- agnostic manner as determined by the vendor, avoiding region-specific assumptions as much as is practical. The special value XX shall indicate that region-agnostic mode is used.


[View source]
def manufacturing_date : String | Nil #

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

[View source]
def node_label : String #

This attribute shall represent a user defined name for the Node. This attribute SHOULD be set during initial commissioning and may be updated by further reconfigurations.


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

This attribute shall represent a user defined name for the Node. This attribute SHOULD be set during initial commissioning and may be updated by further reconfigurations.


[View source]
def part_number : String | Nil #

This attribute shall specify a human-readable (displayable) vendor assigned part number for the Node whose meaning and numbering scheme is vendor defined.

Multiple products (and hence PartNumbers) can share a ProductID. For instance, there may be different packaging (with different PartNumbers) for different regions; also different colors of a product might share the ProductID but may have a different PartNumber.


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

This attribute shall specify a human-readable (displayable) vendor assigned part number for the Node whose meaning and numbering scheme is vendor defined.

Multiple products (and hence PartNumbers) can share a ProductID. For instance, there may be different packaging (with different PartNumbers) for different regions; also different colors of a product might share the ProductID but may have a different PartNumber.


[View source]
def product_appearance : ProductAppearance | Nil #

[View source]
def product_appearance=(product_appearance : ProductAppearance | Nil) #

[View source]
def product_id : UInt16 #

This attribute shall specify the Product ID assigned by the vendor that is unique to the specific product of the Node.


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

This attribute shall specify the Product ID assigned by the vendor that is unique to the specific product of the Node.


[View source]
def product_label : String | Nil #

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

[View source]
def product_name : String #

This attribute shall specify a human readable (displayable) name of the model for the Node such as the model number (or other identifier) assigned by the vendor.


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

This attribute shall specify a human readable (displayable) name of the model for the Node such as the model number (or other identifier) assigned by the vendor.


[View source]
def product_url : String | Nil #

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

[View source]
def reachable : Bool | Nil #

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

[View source]
def serial_number : String | Nil #

This attributes shall specify a human readable (displayable) serial number.


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

This attributes shall specify a human readable (displayable) serial number.


[View source]
def software_version : UInt32 #

This attribute shall contain the current version number for the software running on this Node. The version number can be compared using a total ordering to determine if a version is logically newer than another one. A larger value of SoftwareVersion is newer than a lower value, from the perspective of software updates (see Section 11.19.3.3, “Availability of Software Images”). Nodes may query this field to determine the currently running version of software on another given Node.


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

This attribute shall contain the current version number for the software running on this Node. The version number can be compared using a total ordering to determine if a version is logically newer than another one. A larger value of SoftwareVersion is newer than a lower value, from the perspective of software updates (see Section 11.19.3.3, “Availability of Software Images”). Nodes may query this field to determine the currently running version of software on another given Node.


[View source]
def software_version_string : String #

This attribute shall contain a current human-readable representation for the software running on the Node. This version information may be conveyed to users. The maximum length of the SoftwareVersionString attribute is 64 bytes of UTF-8 characters. The contents SHOULD only use simple 7-bit ASCII alphanumeric and punctuation characters, so as to simplify the conveyance of the value to a variety of cultures.

Examples of version strings include "1.0", "1.2.3456", "1.2-2", "1.0b123", "1.2_3".


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

This attribute shall contain a current human-readable representation for the software running on the Node. This version information may be conveyed to users. The maximum length of the SoftwareVersionString attribute is 64 bytes of UTF-8 characters. The contents SHOULD only use simple 7-bit ASCII alphanumeric and punctuation characters, so as to simplify the conveyance of the value to a variety of cultures.

Examples of version strings include "1.0", "1.2.3456", "1.2-2", "1.0b123", "1.2_3".


[View source]
def unique_id : String | Nil #

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

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

This attribute shall specify the Vendor ID.


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

This attribute shall specify the Vendor ID.


[View source]
def vendor_name : String #

This attribute shall specify a human readable (displayable) name of the vendor for the Node.


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

This attribute shall specify a human readable (displayable) name of the vendor for the Node.


[View source]