Skip to main content

Module basic_information

Module basic_information 

Source
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

RevisionChange
1Initial revision
2Added ProductAppearance
3Added SpecificationVersion and MaxPathsPerInvoke
4UniqueID conformance became mandatory
5Added ConfigurationVersion as provisional
6Extended CapabilityMinimaStruct; ConfigurationVersion no longer provisional

Structs§

Attributes
The attribute list for one node, derived from its Product.
BasicInformation
The Basic Information cluster on endpoint 0.
CapabilityMinima
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.
ProductAppearance
ProductAppearanceStruct (§11.1.4.3) — “a description of the product’s appearance”.

Enums§

ProductFinish
ProductFinishEnum (§11.1.4.1).

Constants§

CAPABILITY_MINIMA
CapabilityMinima — CapabilityMinimaStruct, F, RV, mandatory.
CONFIGURATION_VERSION
ConfigurationVersion — uint32 min 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 — string 1 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 — string exactly 2, N, fallback "XX", RW VA, mandatory.
MANUFACTURING_DATE
ManufacturingDate — string 8 to 16, F, RV, optional.
MAX_ATTRIBUTES
Every attribute §11.1.5 defines, at revision 6.
MAX_PATHS_PER_INVOKE
MaxPathsPerInvoke — uint16 min 1, F, RV, mandatory from revision 3.
NODE_LABEL
NodeLabel — string max 32, N, fallback "", RW VM, mandatory.
PART_NUMBER
PartNumber — string max 32, F, RV, optional.
PRODUCT_APPEARANCE
ProductAppearance — ProductAppearanceStruct, F, RV, optional from revision 2.
PRODUCT_ID
ProductID — uint16, F, RV, mandatory.
PRODUCT_LABEL
ProductLabel — string max 64, F, RV, optional.
PRODUCT_NAME
ProductName — string max 32, F, RV, mandatory.
PRODUCT_URL
ProductURL — string max 256, F, RV, optional.
REACHABLE
Reachable — bool, fallback true, RV, optional.
REACHABLE_CHANGED
ReachableChanged (§11.1.6.4) — INFO, V, conformance Reachable.
REVISION
The highest revision in §11.1.1’s table.
SERIAL_NUMBER
SerialNumber — string max 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 — string 1 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 — string max 32, F, RV, mandatory from revision 4.
VENDOR_ID
VendorID — vendor-id, F, RV, mandatory.
VENDOR_NAME
VendorName — string max 32, F, RV, mandatory.