matter-controller 0.3.0

High-level Matter controller API: commission, read, write, invoke, subscribe.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

# matter-controller

The high-level Matter controller API — the single crate a consumer depends on
to commission and control Matter devices from pure Rust. It wraps every other
`matter-*` crate behind a small, async (Tokio) surface.

Part of [`matter-rust`](https://github.com/phunapps/matter-rust).

> Status: **0.3.0**. The v1.0 controller (M8) plus Matter-1.4 completeness work
> (M9): BLE→Wi-Fi/Thread commissioning, full interaction model, groups, OTA
> provider, ICD client, multi-admin/ACL — extensively validated against real
> silicon (ESP32-C6 over Wi-Fi and Thread).

## What it does

- **Fabric & identity** — `create_fabric` mints and persists the controller's
  stable operational identity once per fabric, through a pluggable
  `ControllerStore` (a default `FileStore` ships). Opt-in per-fabric ICAC for
  a 3-tier RCAC→ICAC→NOC chain.
- **Commissioning** — `commission("MT:…" | "<manual-code>", label)` brings a
  device onto the fabric over IP, verifying device attestation against an
  `AttestationTrust` (`example_device_roots()`, or production PAA/CD roots via
  `from_dirs`). `commission_ble` (feature `ble`) commissions a fresh device
  over BLE onto Wi-Fi or Thread. Both return a typed `NodeInfo`.
- **Node lifecycle** — `nodes() -> Vec<NodeInfo>` enumerates commissioned
  devices (node id, fabric id, vendor/product id, label) with no snapshot
  deserialization; `forget_node(node_id)` drops all local state for a device
  without needing it to cooperate (reclaim an unreachable/reset node).
- **Interaction** — `Node::read` / `write` / `invoke` over raw
  `matter_codec::Value` (plus `invoke_tlv` for pre-encoded
  `matter-clusters` command TLV), **wildcard + chunked reads**, events, and
  timed interactions.
- **Subscriptions** — `Node::subscribe` returns a `Subscription` stream of
  attribute/event reports that **transparently auto-resubscribes** across
  session loss or a device reboot (validated on hardware).
- **Groups** — provision group keys and `invoke_group` over IPv6 multicast.
- **OTA provider** — `serve_ota` announces + serves a `.ota` image over BDX to
  a commissioned requestor.
- **ICD client** — register as a check-in client and receive a Long-Idle-Time
  device's periodic Check-In.

The operational CASE session is established, cached, and reused transparently —
callers address a device by node id and never manage sessions.

## Quickstart

```rust
use std::sync::Arc;
use matter_controller::{AttestationTrust, FabricConfig, FileStore, MatterController, MatterTime, ReadPath};

let store = Arc::new(FileStore::new("controller-state.bin"));
let controller = MatterController::builder(store)
    .attestation_trust(AttestationTrust::example_device_roots())
    .build()
    .await?;

let _fabric = controller.create_fabric(FabricConfig {
    fabric_id: 1, rcac_id: 1, commissioner_node_id: 1,
    validity: (MatterTime::from_unix_secs(0), MatterTime::NO_EXPIRY),
}).await?;

let info = controller
    .commission("MT:Y.K90AFN00KA0648G00", Some("kitchen plug".into()))
    .await?;
let node = controller.node(info.node_id);

// Read all OnOff attributes; subscribe to changes.
let report = node.read(&[ReadPath::cluster(1, 0x0006)]).await?;
let mut sub = node.subscribe(&[ReadPath::cluster(1, 0x0006)], &[], 1, 30).await?;
while let Some(change) = sub.next().await { /* … */ }

// Enumerate and manage commissioned nodes.
for n in controller.nodes().await? {
    println!("node 0x{:016X} — {:?}", n.node_id, n.label);
}
```

See `examples/` (`controller_quickstart`, `list_nodes`, `e3_group_multicast`,
`serve_ota`, …) for end-to-end runs, and
[`docs/matter-js-migration-guide.md`](../../docs/matter-js-migration-guide.md)
if you're coming from matter.js.

## Known limitations

- **BLE commissioning on macOS hangs** in the BTP pump (CoreBluetooth). Drive
  live BLE commissioning from Linux; IP commissioning and everything else is
  unaffected on all platforms. Tracked with a diagnosis + instrumentation
  (`MATTER_BLE_PUMP_TRACE=1`).
- Thread network commissioning and BLE transport require the `ble` feature.

## License

Apache-2.0.