Expand description
Basic Information cluster 0x0028 (Core §11.1) — who this node is.
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.
It lives on endpoint 0 and there is exactly one per node.
§Almost all of it is F — fixed, and therefore const
Sixteen of the nineteen attributes carry the F quality: their values are decided when
the product is built and never change. So Product is a const record the application
points at, held in flash, and only the three mutable attributes — NodeLabel,
Location, LocalConfigDisabled — cost RAM.
Location is the interesting one of the three. §11.10.7.4 says SetRegulatoryConfig’s
CountryCode “SHALL be used to set the Location attribute reflected by the Basic
Information Cluster” — so the General Commissioning cluster writes an attribute of this
one, which is why Location is a separate shareable cell rather than a field.
§Revision 6
| Revision | Change |
|---|---|
| 1 | Initial revision |
| 2 | Added ProductAppearance |
| 3 | Added SpecificationVersion and MaxPathsPerInvoke |
| 4 | UniqueID conformance became mandatory |
| 5 | Added ConfigurationVersion as provisional |
| 6 | Extended CapabilityMinimaStruct; ConfigurationVersion no longer provisional |
Structs§
- Attributes
- The attribute list for one node, derived from its
Product. - Basic
Information - The Basic Information cluster on endpoint 0.
- Capability
Minima CapabilityMinimaStruct(§11.1.4.4) — “the minimum guaranteed value for some system-wide resource capabilities”.- Location
Location(§11.1.5.7) — the node’s ISO 3166-1 alpha-2 region code.- Product
- The
F-quality attributes — everything a product knows about itself at build time. - Product
Appearance ProductAppearanceStruct(§11.1.4.3) — “a description of the product’s appearance”.
Enums§
- Product
Finish ProductFinishEnum(§11.1.4.1).
Constants§
- CAPABILITY_
MINIMA CapabilityMinima—CapabilityMinimaStruct,F,RV, mandatory.- CONFIGURATION_
VERSION ConfigurationVersion—uint32min 1,N, fallback 1,RV, mandatory from revision 6.- DATA_
MODEL_ REVISION - The Data Model revision this crate implements — §7.1.1’s revision 21, “Added Revision conformance”.
- DATA_
MODEL_ REVISION_ ID DataModelRevision—uint16,F,RV, mandatory.- HARDWARE_
VERSION HardwareVersion—uint16,F,RV, mandatory.- HARDWARE_
VERSION_ STRING HardwareVersionString—string1 to 64,F,RV, mandatory.- ID
0x0028(§11.1.3).- LEAVE
Leave(§11.1.6.3) — INFO,V, optional.- LOCAL_
CONFIG_ DISABLED LocalConfigDisabled—bool,N, fallback false,RW VM, optional.- LOCATION
Location—stringexactly 2,N, fallback"XX",RW VA, mandatory.- MANUFACTURING_
DATE ManufacturingDate—string8 to 16,F,RV, optional.- MAX_
ATTRIBUTES - Every attribute §11.1.5 defines, at revision 6.
- MAX_
PATHS_ PER_ INVOKE MaxPathsPerInvoke—uint16min 1,F,RV, mandatory from revision 3.- NODE_
LABEL NodeLabel—stringmax 32,N, fallback"",RW VM, mandatory.- PART_
NUMBER PartNumber—stringmax 32,F,RV, optional.- PRODUCT_
APPEARANCE ProductAppearance—ProductAppearanceStruct,F,RV, optional from revision 2.- PRODUCT_
ID ProductID—uint16,F,RV, mandatory.- PRODUCT_
LABEL ProductLabel—stringmax 64,F,RV, optional.- PRODUCT_
NAME ProductName—stringmax 32,F,RV, mandatory.- PRODUCT_
URL ProductURL—stringmax 256,F,RV, optional.- REACHABLE
Reachable—bool, fallback true,RV, optional.- REACHABLE_
CHANGED ReachableChanged(§11.1.6.4) — INFO,V, conformanceReachable.- REVISION
- The highest revision in §11.1.1’s table.
- SERIAL_
NUMBER SerialNumber—stringmax 32,F,RV, optional.- SHUT_
DOWN ShutDown(§11.1.6.2) — CRITICAL,V, optional.- SOFTWARE_
VERSION SoftwareVersion—uint32,F,RV, mandatory.- SOFTWARE_
VERSION_ STRING SoftwareVersionString—string1 to 64,F,RV, mandatory.- SPECIFICATION_
VERSION SpecificationVersion(§11.1.5.22) for Matter 1.6.- SPECIFICATION_
VERSION_ ID SpecificationVersion—uint32,F,RV, mandatory from revision 3.- START_
UP StartUp(§11.1.6.1) — CRITICAL,V, mandatory.- UNIQUE_
ID UniqueID—stringmax 32,F,RV, mandatory from revision 4.- VENDOR_
ID VendorID—vendor-id,F,RV, mandatory.- VENDOR_
NAME VendorName—stringmax 32,F,RV, mandatory.