matter-kit 0.3.0

Matter (CSA smart-home standard) protocol implementation in Rust: no_std, no-alloc, executor-agnostic
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
// Generated by `cargo xtask` from the CSA data model 1.6. Do not edit.
//
// Wi-Fi Network Diagnostics — cluster 0x0036.
//
// Regenerate with `cargo xtask clusters --dm <checkout>/data_model/1.6`; `cargo xtask check`
// is the CI gate that keeps this file honest. The XML itself is not vendored here — it
// carries the CSA's own copyright notice and is not redistributable.

//! Wi-Fi Network Diagnostics (cluster `0x0036`, revision 1).
//!
//! 17 identifiers, 2 feature bits, and the specification's own conformance for
//! every element. `CLUSTER` is the whole table.

#![allow(unused_imports)]

use crate::dm::conformance::{Clause, Condition, Conform, Conformance};
use crate::dm::meta::{EventPriority, Reporting};
use crate::dm::spec::{Attribute, Cluster, Command, Event, Feature};
use crate::dm::{Access, AccessQualities, AttributeQualities, Privilege};
use crate::error::Result;
use crate::im::{AttributeId, ClusterId, CommandId, EventId};
use crate::tlv::{
    ContainerKind, Element, FromTlv, Nullable, Tag, TlvList, TlvReader, TlvWriter, ToTlv, Value,
};

/// The cluster id.
pub const ID: ClusterId = 0x0036;

/// The highest revision the specification's history defines — what `ClusterRevision`
/// must report (Core §7.13.1).
pub const REVISION: u16 = 1;

/// The PICS code, which a certification declaration names the cluster by.
pub const PICS: &str = "DGWIFI";

/// The `FeatureMap` bits (Core §7.13.2).
///
/// A feature has conformance of its own: a device may not claim one the
/// specification forbids it alongside another.
pub mod feature {
    /// Node makes available the counts for the number of received and transmitted packets on the Wi-Fi interface.
    ///
    /// Code `PKTCNT`, bit 0.
    pub const PACKET_COUNTS: u32 = 1 << 0;
    /// Node makes available the counts for the number of errors that have occurred during the reception and transmission of packets on the Wi-Fi interface.
    ///
    /// Code `ERRCNT`, bit 1.
    pub const ERROR_COUNTS: u32 = 1 << 1;
}

/// Every feature bit, with its conformance.
pub const FEATURES: &[Feature] = &[
    Feature {
        bit: 0,
        code: "PKTCNT",
        name: "PacketCounts",
        conform: Conform::OPTIONAL,
    },
    Feature {
        bit: 1,
        code: "ERRCNT",
        name: "ErrorCounts",
        conform: Conform::OPTIONAL,
    },
];

/// The attribute ids.
pub mod attribute {
    use crate::im::AttributeId;

    /// `BSSID`.
    pub const BSSID: AttributeId = 0x00;
    /// `SecurityType`.
    pub const SECURITY_TYPE: AttributeId = 0x01;
    /// `WiFiVersion`.
    pub const WI_FI_VERSION: AttributeId = 0x02;
    /// `ChannelNumber`.
    pub const CHANNEL_NUMBER: AttributeId = 0x03;
    /// `RSSI`.
    pub const RSSI: AttributeId = 0x04;
    /// `BeaconLostCount`.
    pub const BEACON_LOST_COUNT: AttributeId = 0x05;
    /// `BeaconRxCount`.
    pub const BEACON_RX_COUNT: AttributeId = 0x06;
    /// `PacketMulticastRxCount`.
    pub const PACKET_MULTICAST_RX_COUNT: AttributeId = 0x07;
    /// `PacketMulticastTxCount`.
    pub const PACKET_MULTICAST_TX_COUNT: AttributeId = 0x08;
    /// `PacketUnicastRxCount`.
    pub const PACKET_UNICAST_RX_COUNT: AttributeId = 0x09;
    /// `PacketUnicastTxCount`.
    pub const PACKET_UNICAST_TX_COUNT: AttributeId = 0x0A;
    /// `CurrentMaxRate`.
    pub const CURRENT_MAX_RATE: AttributeId = 0x0B;
    /// `OverrunCount`.
    pub const OVERRUN_COUNT: AttributeId = 0x0C;
}

/// The command ids.
pub mod command {
    use crate::im::CommandId;

    /// `ResetCounts`.
    pub const RESET_COUNTS: CommandId = 0x00;
}

/// The event ids.
pub mod event {
    use crate::im::EventId;

    /// `Disconnection`.
    pub const DISCONNECTION: EventId = 0x00;
    /// `AssociationFailure`.
    pub const ASSOCIATION_FAILURE: EventId = 0x01;
    /// `ConnectionStatus`.
    pub const CONNECTION_STATUS: EventId = 0x02;
}

/// `AssociationFailureCauseEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum AssociationFailureCauseEnum {
    /// The reason for the failure is unknown.
    Unknown = 0,
    /// An error occurred during association.
    AssociationFailed = 1,
    /// An error occurred during authentication.
    AuthenticationFailed = 2,
    /// The specified SSID could not be found.
    SsidNotFound = 3,
}

impl AssociationFailureCauseEnum {
    /// Reads a wire value, or `None` for one this revision does not define.
    #[must_use]
    pub const fn from_value(value: u8) -> Option<Self> {
        match value {
            0 => Some(Self::Unknown),
            1 => Some(Self::AssociationFailed),
            2 => Some(Self::AuthenticationFailed),
            3 => Some(Self::SsidNotFound),
            _ => None,
        }
    }

    /// Its wire value.
    #[must_use]
    pub const fn value(self) -> u8 {
        self as u8
    }
}

impl ToTlv for AssociationFailureCauseEnum {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        self.value().to_tlv(w, tag)
    }
}

impl<'a> FromTlv<'a> for AssociationFailureCauseEnum {
    fn from_tlv(reader: &mut TlvReader<'a>, element: &Element<'a>) -> Result<Self> {
        let value = <u8 as FromTlv<'a>>::from_tlv(reader, element)?;
        Self::from_value(value).ok_or(crate::Error::new(crate::ErrorCode::TlvOutOfRange))
    }
}

/// `ConnectionStatusEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum ConnectionStatusEnum {
    /// Indicate the node is connected
    Connected = 0,
    /// Indicate the node is not connected
    NotConnected = 1,
}

impl ConnectionStatusEnum {
    /// Reads a wire value, or `None` for one this revision does not define.
    #[must_use]
    pub const fn from_value(value: u8) -> Option<Self> {
        match value {
            0 => Some(Self::Connected),
            1 => Some(Self::NotConnected),
            _ => None,
        }
    }

    /// Its wire value.
    #[must_use]
    pub const fn value(self) -> u8 {
        self as u8
    }
}

impl ToTlv for ConnectionStatusEnum {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        self.value().to_tlv(w, tag)
    }
}

impl<'a> FromTlv<'a> for ConnectionStatusEnum {
    fn from_tlv(reader: &mut TlvReader<'a>, element: &Element<'a>) -> Result<Self> {
        let value = <u8 as FromTlv<'a>>::from_tlv(reader, element)?;
        Self::from_value(value).ok_or(crate::Error::new(crate::ErrorCode::TlvOutOfRange))
    }
}

/// `SecurityTypeEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum SecurityTypeEnum {
    /// Indicate the usage of an unspecified Wi-Fi security type
    Unspecified = 0,
    /// Indicate the usage of no Wi-Fi security
    None = 1,
    /// Indicate the usage of WEP Wi-Fi security
    WEP = 2,
    /// Indicate the usage of WPA Wi-Fi security
    WPA = 3,
    /// Indicate the usage of WPA2 Wi-Fi security
    WPA2 = 4,
    /// Indicate the usage of WPA3 Wi-Fi security
    WPA3 = 5,
}

impl SecurityTypeEnum {
    /// Reads a wire value, or `None` for one this revision does not define.
    #[must_use]
    pub const fn from_value(value: u8) -> Option<Self> {
        match value {
            0 => Some(Self::Unspecified),
            1 => Some(Self::None),
            2 => Some(Self::WEP),
            3 => Some(Self::WPA),
            4 => Some(Self::WPA2),
            5 => Some(Self::WPA3),
            _ => None,
        }
    }

    /// Its wire value.
    #[must_use]
    pub const fn value(self) -> u8 {
        self as u8
    }
}

impl ToTlv for SecurityTypeEnum {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        self.value().to_tlv(w, tag)
    }
}

impl<'a> FromTlv<'a> for SecurityTypeEnum {
    fn from_tlv(reader: &mut TlvReader<'a>, element: &Element<'a>) -> Result<Self> {
        let value = <u8 as FromTlv<'a>>::from_tlv(reader, element)?;
        Self::from_value(value).ok_or(crate::Error::new(crate::ErrorCode::TlvOutOfRange))
    }
}

/// `WiFiVersionEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum WiFiVersionEnum {
    /// Indicate the network interface is currently using IEEE 802.11a against the wireless access point.
    A = 0,
    /// Indicate the network interface is currently using IEEE 802.11b against the wireless access point.
    B = 1,
    /// Indicate the network interface is currently using IEEE 802.11g against the wireless access point.
    G = 2,
    /// Indicate the network interface is currently using IEEE 802.11n against the wireless access point.
    N = 3,
    /// Indicate the network interface is currently using IEEE 802.11ac against the wireless access point.
    Ac = 4,
    /// Indicate the network interface is currently using IEEE 802.11ax against the wireless access point.
    Ax = 5,
    /// Indicate the network interface is currently using IEEE 802.11ah against the wireless access point.
    Ah = 6,
}

impl WiFiVersionEnum {
    /// Reads a wire value, or `None` for one this revision does not define.
    #[must_use]
    pub const fn from_value(value: u8) -> Option<Self> {
        match value {
            0 => Some(Self::A),
            1 => Some(Self::B),
            2 => Some(Self::G),
            3 => Some(Self::N),
            4 => Some(Self::Ac),
            5 => Some(Self::Ax),
            6 => Some(Self::Ah),
            _ => None,
        }
    }

    /// Its wire value.
    #[must_use]
    pub const fn value(self) -> u8 {
        self as u8
    }
}

impl ToTlv for WiFiVersionEnum {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        self.value().to_tlv(w, tag)
    }
}

impl<'a> FromTlv<'a> for WiFiVersionEnum {
    fn from_tlv(reader: &mut TlvReader<'a>, element: &Element<'a>) -> Result<Self> {
        let value = <u8 as FromTlv<'a>>::from_tlv(reader, element)?;
        Self::from_value(value).ok_or(crate::Error::new(crate::ErrorCode::TlvOutOfRange))
    }
}

/// Every attribute the specification defines, with its conformance.
pub const ATTRIBUTES: &[Attribute] = &[
    Attribute {
        id: 0x0000,
        name: "BSSID",
        kind: "octstr",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0001,
        name: "SecurityType",
        kind: "SecurityTypeEnum",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0002,
        name: "WiFiVersion",
        kind: "WiFiVersionEnum",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0003,
        name: "ChannelNumber",
        kind: "uint16",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0004,
        name: "RSSI",
        kind: "int8",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0005,
        name: "BeaconLostCount",
        kind: "uint32",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(1),
            }],
        },
    },
    Attribute {
        id: 0x0006,
        name: "BeaconRxCount",
        kind: "uint32",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Attribute {
        id: 0x0007,
        name: "PacketMulticastRxCount",
        kind: "uint32",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Attribute {
        id: 0x0008,
        name: "PacketMulticastTxCount",
        kind: "uint32",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Attribute {
        id: 0x0009,
        name: "PacketUnicastRxCount",
        kind: "uint32",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Attribute {
        id: 0x000A,
        name: "PacketUnicastTxCount",
        kind: "uint32",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Attribute {
        id: 0x000B,
        name: "CurrentMaxRate",
        kind: "uint64",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform::OPTIONAL,
    },
    Attribute {
        id: 0x000C,
        name: "OverrunCount",
        kind: "uint64",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::ChangesOmitted,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(1),
            }],
        },
    },
];

/// Every command, with its conformance.
pub const COMMANDS: &[Command] = &[Command {
    id: 0x00,
    name: "ResetCounts",
    to_server: true,
    response: None,
    access: Access::invoke(Privilege::Operate),
    conform: Conform {
        clauses: &[Clause {
            verdict: Conformance::Mandatory,
            when: Condition::Feature(1),
        }],
    },
}];

/// Every event, with its conformance.
pub const EVENTS: &[Event] = &[
    Event {
        id: 0x00,
        name: "Disconnection",
        priority: EventPriority::Info,
        access: Access::read_only(Privilege::View),
        conform: Conform::OPTIONAL,
    },
    Event {
        id: 0x01,
        name: "AssociationFailure",
        priority: EventPriority::Info,
        access: Access::read_only(Privilege::View),
        conform: Conform::OPTIONAL,
    },
    Event {
        id: 0x02,
        name: "ConnectionStatus",
        priority: EventPriority::Info,
        access: Access::read_only(Privilege::View),
        conform: Conform::OPTIONAL,
    },
];

/// The whole cluster, as the specification defines it.
pub const CLUSTER: Cluster = Cluster {
    id: ID,
    name: "Wi-Fi Network Diagnostics",
    revision: REVISION,
    pics: "DGWIFI",
    derived_from: None,
    features: FEATURES,
    attributes: ATTRIBUTES,
    commands: COMMANDS,
    events: EVENTS,
};