Matter Specification - Basic Information Cluster

Matter :: Basic Information Cluster

---

This cluster provides attributes and events for determining basic information about Nodes, which supports both Commissioning and operational determination of Node characteristics, such as Vendor ID, Product ID and serial number, which apply to the whole Node.

---

1. Classification

Hierarchy	Role	Context	PICS Code
Base	Utility	Node	BINFO

2. Identifier

Identifier	Name
0x0028	Basic Information

3. Data Types

3.1. CapabilityMinimaStruct

This structure provides constant values related to overall global capabilities of this Node, that are not cluster-specific

ID	Name	Type	Constraint	Quality	Default	Conformance
0	CaseSessionsPerFabric	uint16	min 3		3	M

This field SHALL indicate the actual minimum number of concurrent CASE sessions that are supported per fabric. This value SHALL NOT be smaller than the required minimum indicated in Section 4.13.2.8, “Minimal Number of CASE Sessions”

ID	Name	Type	Constraint	Quality	Default	Conformance
1	SubscriptionsPerFabric	uint16	min 3		3	M

This field SHALL indicate the actual minimum number of concurrent subscriptions supported per fabric. This value SHALL NOT be smaller than the required minimum indicated in Section 8.5.1, “Subscribe Transaction”.

4. Attributes

4.1. Data Mode Revision

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0000	DataModelRevision	uint16	all	F	MS	R V	M

The DataModelRevision attribute SHALL be set to the revision number of the Data Model against which the Node is certified.

 

4.2. Vendor Name

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0001	VendorName	string	max 32	F	MS	R V	M

The VendorName attribute SHALL specify a human readable (displayable) name of the vendor for the Node.

 

4.3. Vendor ID

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0002	VendorID	vendor-id	all	F	MS	R V	M

The VendorID attribute SHALL specify the Vendor ID.

 

4.4. Product Name

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0003	ProductName	string	max 32	F	MS	R V	M

The ProductName 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.

 

4.5. Product ID

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0004	ProductID	uint16	all	F	MS	R V	M

The ProductID attribute SHALL specify the Product ID assigned by the vendor that is unique to the specific product of the Node.

 

4.6. Node Label

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0005	NodeLabel	string	max 32	N	""	RW VM	M

The NodeLabel 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.

 

4.7. Location

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0006	Location	string	2	N	"XX"	RW VA	M

The Location 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.

 

4.8. Hardware Version

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0007	HardwareVersion	uint16	all	F	0	R V	M

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

 

4.9. Hardware Version String

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0008	HardwareVersionString	string	1 to 64	F	MS	R V	M

The HardwareVersionString 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.

 

4.10. Software Version

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0009	SoftwareVersion	uint32	desc	F	0	R V	M

This field 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.

 

4.11. Software Version String

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x000A	SoftwareVersionString	string	1 to 64	F	MS	R V	M

This field 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".

 

4.12. Manufacturing Date

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x000B	ManufacturingDate	string	8 to 16	F	MS	R V	O

The ManufacturingDate attribute SHALL specify the date that the Node was manufactured. The first 8 characters SHALL specify the date of manufacture of the Node in international date notation according to ISO 8601, i.e., YYYYMMDD, e.g., 20060814. The final 8 characters MAY include country, factory, line, shift or other related information at the option of the vendor. The format of this information is vendor defined

 

4.13. Part Number

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x000C	PartNumber	string	max 32	F	MS	R V	O

The PartNumber 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.

 

4.14. Product URL

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x000D	ProductURL	string	max 256	F	MS	R V	O

The ProductURL attribute SHALL specify a link to a product specific web page. The syntax of the ProductURL attribute SHALL follow the syntax as specified in RFC 3986 [https://tools.ietf.org/html/rfc3986]. The specified URL SHOULD resolve to a maintained web page available for the lifetime of the product. The maximum length of the ProductUrl attribute is 256 ASCII characters.

 

4.15. Product Label

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x000E	ProductLabel	string	max 64	F	MS	R V	O

The ProductLabel attribute SHALL specify a vendor specific human readable (displayable) product label. The ProductLabel attribute MAY be used to provide a more user-friendly value than that represented by the ProductName attribute. The ProductLabel attribute SHOULD NOT include the name of the vendor as defined within the VendorName attribute.

 

4.16. Serial Number

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x000F	SerialNumber	string	max 32	F	MS	R V	O

The SerialNumber attributes SHALL specify a human readable (displayable) serial number.

 

4.17. Local Config Disabled

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0010	LocalConfigDisabled	bool	all	N	False	RW VM	O

The LocalConfigDisabled 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 onNode 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.

 

4.18. Reachable

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0011	Reachable	bool	all		True	R V	O

The Reachable attribute (when used) SHALL indicate whether the Node can be reached. For a native Node this is implicitly True (and its use is optional).

Its main use case is in the derived Bridged Device Basic Information cluster where it is used to indicate whether the bridged device is reachable by the bridge over the non-native network

 

4.19. Unique ID

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0012	UniqueID	string	max 32	F	MS	R V	O

This attribute (when used) SHALL indicate a unique identifier for the device, which is constructed in a manufacturer specific manner.

It MAY be constructed using a permanent device identifier (such as device MAC address) as basis.

In order to prevent tracking,

• it SHOULD NOT be identical to (or easily derived from) such permanent device identifier
• it SHOULD be updated when the device is factory reset
• it SHALL not be identical to the SerialNumber attribute
• it SHALL not be printed on the product or delivered with the product

The value does not need to be human readable.

 

4.20. CapabilityMinima

ID	Name	Type	Constraint	Quality	Default	Access	Conformance
0x0013	CapabilityMinima	CapabilityMinimaStruct	all	F	MS	R V	M

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.

5. Events

5.1. Start Up

ID	Name	Priority	Access	Conformance
0x00	StartUp	CRITICAL	V	M

The StartUp event SHALL be generated by a Node as soon as reasonable after completing a boot or reboot process. The StartUp event SHOULD be the first Data Model event recorded by the Node after it completes a boot or reboot process.

The data of this event SHALL contain the following information:

ID	Name	Type	Constraint	Quality	Default	Conformance
0	SoftwareVersion	uint32				M

The SoftwareVersion field SHALL be set to the same value as the one available in the Software Version attribute of the Basic Information Cluster.

 

5.2. Shut Down

ID	Name	Priority	Access	Conformance
0x01	ShutDown	CRITICAL	V	O

The ShutDown event SHOULD be generated by a Node prior to any orderly shutdown sequence on a best-effort basis. When a ShutDown event is generated, it SHOULD be the last Data Model event recorded by the Node. This event SHOULD be delivered urgently to current subscribers on a best-effort basis. Any subsequent incoming interactions to the Node MAY be dropped until the completion of a future boot or reboot process.

 

5.3. Leave

ID	Name	Priority	Access	Conformance
0x02	Leave	INFO	V	O

The Leave event SHOULD be generated by a Node prior to permanently leaving a given Fabric, such as when the RemoveFabric command is invoked for a given fabric, or triggered by factory reset or some other manufacturer specific action to disable or reset the operational data in the Node. When a Leave event is generated, it SHOULD be assumed that the fabric recorded in the event is no longer usable, and subsequent interactions targeting that fabric will most likely fail.

Upon receipt of Leave Event on a subscription, the receiving Node MAY update other nodes in the fabric by removing related bindings, access control list entries and other data referencing the leaving Node.

The data of this event SHALL contain the following information:

ID	Name	Type	Constraint	Quality	Default	Conformance
0	FabricIndex	fabric-idx	1 to 254			M

The FabricIndex field SHALL contain the local Fabric Index of the fabric which the node is about to leave.

 

5.4. Reachable Changed

ID	Name	Priority	Access	Conformance
0x03	ReachableChanged	INFO	V	desc

This event SHALL be supported if and only if the Reachable attribute is supported.

This event (when supported) SHALL be generated when there is a change in the Reachable attribute.

Its main use case is in the derived Bridged Device Basic Information cluster.

The data of this event SHALL contain the following information:

ID	Name	Type	Quality	Constraint	Conformance
0	ReachableNewValue	bool			M

The ReachableNewValue field SHALL indicate the value of the Reachable attribute after it was changed.