Expand description
§matter-controller
A Matter controller on rs-matter.
- Onboarding: QR codes and manual pairing codes (
Onboarding). - Commissioning over IP: the device is found by DNS-SD among
commissionable nodes, or reached at an address given, then taken through
PASE, the fail-safe, CSR, AddNOC, CASE and
CommissioningCompleteby rs-matter’s commissioner. - A fabric with a pluggable CA (
CertificateAuthority);FileCafor a standalone controller. - Multi-admin:
Controller::open_commissioning_windowlets a second ecosystem (Apple Home, Google Home, Home Assistant) commission the node too. - The interaction model: read, write and invoke on any cluster, in JSON
converted by
matter_modelfrom the CSA’s published data model, and a subscription to every node that is re-established when it lapses, with attribute changes and events delivered asEvents. - A node store (
NodeStore) written when the network changes.
rs-matter’s futures are not Send, so the controller runs on a thread of
its own; Controller is the Send + Clone handle to it.
Part of matter-bridge, maintained by Pulzar. See the user guide, the library guide and the API documentation.
License: MIT.
Re-exports§
pub use ca::install_intermediate;pub use ca::intermediate_csr;pub use ca::intermediate_path;pub use ca::CertificateAuthority;pub use ca::FileCa;pub use ca::IntermediateCa;pub use ca::Issued;pub use ca::NodeIdRange;pub use onboarding::Discriminator;pub use onboarding::Onboarding;pub use ota::OtaImage;pub use store::BasicInfo;pub use store::DeviceType;pub use store::Endpoint;pub use store::Node;pub use store::NodeStore;
Modules§
- ca
- The fabric’s certificate authority.
- network
- Operational network credentials for devices being commissioned.
- onboarding
- Onboarding payloads: the QR code (
MT:...) and the manual pairing code a device carries, parsed with rs-matter’s parsers. - ota
- The OTA provider: the controller offers the nodes it commissioned the Matter OTA image files in a directory, and serves them over BDX.
- store
- The node store: every commissioned node, what its interview found, and the name a person gave it.
- x509
- X.509 DER certificates in the Matter certificate profile, as a CA built on common PKI tooling issues them, converted to the Matter TLV encoding that Matter nodes exchange (Matter Core spec, “Certificate Encoding”).
Structs§
- Attribute
Path - A path to one attribute or a wildcard over several.
- Attribute
Value - An attribute’s value, or why it has none.
- Commission
Request - What to commission.
- Commissionable
- A node advertising itself as commissionable.
- Commissioning
Window - A commissioning window opened on a node, for another administrator.
- Config
- How the controller runs.
- Controller
- The handle to a running controller. Cheap to clone; the controller stops when the last handle is dropped.
- Controller
Info - The controller’s identity on its fabric.
- Event
Value - An event a node emitted.
- Networks
- Operational networks for devices being commissioned over Bluetooth.
- WiFi
- A Wi-Fi network.
Enums§
- CaChoice
- Where a controller’s fabric certificates come from.
- Commission
Step - A commissioning step, as it happens.
- Error
- What can go wrong.
- Event
- What the controller tells its users, as it happens.
- OtaStep
- A step of a software update, as the controller (its OTA provider) sees it. The node’s own OTA Requestor events tell the download’s progress.
Functions§
- decode_
report_ data - Decode one
ReportDatamessage payload fromnodethe way the controller does: for tests, recorded sessions and fuzzing.