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
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
// Generated by `cargo xtask` from the CSA data model 1.6. Do not edit.
//
// Fan Control — cluster 0x0202.
//
// 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.

//! Fan Control (cluster `0x0202`, revision 6).
//!
//! 13 identifiers, 6 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 = 0x0202;

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

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

/// 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 {
    /// 0-SpeedMax Fan Speeds
    ///
    /// Code `SPD`, bit 0.
    pub const MULTI_SPEED: u32 = 1 << 0;
    /// Automatic mode supported for fan speed
    ///
    /// Code `AUT`, bit 1.
    pub const AUTO: u32 = 1 << 1;
    /// Rocking movement supported
    ///
    /// Code `RCK`, bit 2.
    pub const ROCKING: u32 = 1 << 2;
    /// Wind emulation supported
    ///
    /// Code `WND`, bit 3.
    pub const WIND: u32 = 1 << 3;
    /// Step command supported
    ///
    /// Code `STEP`, bit 4.
    pub const STEP: u32 = 1 << 4;
    /// Airflow Direction attribute is supported
    ///
    /// Code `DIR`, bit 5.
    pub const AIRFLOW_DIRECTION: u32 = 1 << 5;
}

/// Every feature bit, with its conformance.
pub const FEATURES: &[Feature] = &[
    Feature {
        bit: 0,
        code: "SPD",
        name: "MultiSpeed",
        conform: Conform::OPTIONAL,
    },
    Feature {
        bit: 1,
        code: "AUT",
        name: "Auto",
        conform: Conform::OPTIONAL,
    },
    Feature {
        bit: 2,
        code: "RCK",
        name: "Rocking",
        conform: Conform::OPTIONAL,
    },
    Feature {
        bit: 3,
        code: "WND",
        name: "Wind",
        conform: Conform::OPTIONAL,
    },
    Feature {
        bit: 4,
        code: "STEP",
        name: "Step",
        conform: Conform::OPTIONAL,
    },
    Feature {
        bit: 5,
        code: "DIR",
        name: "AirflowDirection",
        conform: Conform::OPTIONAL,
    },
];

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

    /// `FanMode`.
    pub const FAN_MODE: AttributeId = 0x00;
    /// `FanModeSequence`.
    pub const FAN_MODE_SEQUENCE: AttributeId = 0x01;
    /// `PercentSetting`.
    pub const PERCENT_SETTING: AttributeId = 0x02;
    /// `PercentCurrent`.
    pub const PERCENT_CURRENT: AttributeId = 0x03;
    /// `SpeedMax`.
    pub const SPEED_MAX: AttributeId = 0x04;
    /// `SpeedSetting`.
    pub const SPEED_SETTING: AttributeId = 0x05;
    /// `SpeedCurrent`.
    pub const SPEED_CURRENT: AttributeId = 0x06;
    /// `RockSupport`.
    pub const ROCK_SUPPORT: AttributeId = 0x07;
    /// `RockSetting`.
    pub const ROCK_SETTING: AttributeId = 0x08;
    /// `WindSupport`.
    pub const WIND_SUPPORT: AttributeId = 0x09;
    /// `WindSetting`.
    pub const WIND_SETTING: AttributeId = 0x0A;
    /// `AirflowDirection`.
    pub const AIRFLOW_DIRECTION: AttributeId = 0x0B;
}

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

    /// `Step`.
    pub const STEP: CommandId = 0x00;
}

/// `AirflowDirectionEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum AirflowDirectionEnum {
    /// Airflow is in the forward direction
    Forward = 0,
    /// Airflow is in the reverse direction
    Reverse = 1,
}

impl AirflowDirectionEnum {
    /// 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::Forward),
            1 => Some(Self::Reverse),
            _ => None,
        }
    }

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

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

impl<'a> FromTlv<'a> for AirflowDirectionEnum {
    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))
    }
}

/// `FanModeEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum FanModeEnum {
    /// Fan is off
    Off = 0,
    /// Fan using low speed
    Low = 1,
    /// Fan using medium speed
    Medium = 2,
    /// Fan using high speed
    High = 3,
    /// `On`.
    On = 4,
    /// Fan is using auto mode
    Auto = 5,
    /// Fan is using smart mode
    Smart = 6,
}

impl FanModeEnum {
    /// 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::Off),
            1 => Some(Self::Low),
            2 => Some(Self::Medium),
            3 => Some(Self::High),
            4 => Some(Self::On),
            5 => Some(Self::Auto),
            6 => Some(Self::Smart),
            _ => None,
        }
    }

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

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

impl<'a> FromTlv<'a> for FanModeEnum {
    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))
    }
}

/// `FanModeSequenceEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum FanModeSequenceEnum {
    /// Fan is capable of off, low, medium and high modes
    OffLowMedHigh = 0,
    /// Fan is capable of off, low and high modes
    OffLowHigh = 1,
    /// Fan is capable of off, low, medium, high and auto modes
    OffLowMedHighAuto = 2,
    /// Fan is capable of off, low, high and auto modes
    OffLowHighAuto = 3,
    /// Fan is capable of off, high and auto modes
    OffHighAuto = 4,
    /// Fan is capable of off and high modes
    OffHigh = 5,
}

impl FanModeSequenceEnum {
    /// 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::OffLowMedHigh),
            1 => Some(Self::OffLowHigh),
            2 => Some(Self::OffLowMedHighAuto),
            3 => Some(Self::OffLowHighAuto),
            4 => Some(Self::OffHighAuto),
            5 => Some(Self::OffHigh),
            _ => None,
        }
    }

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

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

impl<'a> FromTlv<'a> for FanModeSequenceEnum {
    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))
    }
}

/// `StepDirectionEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum StepDirectionEnum {
    /// Step moves in increasing direction
    Increase = 0,
    /// Step moves in decreasing direction
    Decrease = 1,
}

impl StepDirectionEnum {
    /// 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::Increase),
            1 => Some(Self::Decrease),
            _ => None,
        }
    }

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

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

impl<'a> FromTlv<'a> for StepDirectionEnum {
    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))
    }
}

bitflags::bitflags! {
    /// `RockBitmap`.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
    pub struct RockBitmap: u8 {
        /// Indicate rock left to right
        const ROCK_LEFT_RIGHT = 1 << 0;
        /// Indicate rock up and down
        const ROCK_UP_DOWN = 1 << 1;
        /// Indicate rock around
        const ROCK_ROUND = 1 << 2;
    }
}

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

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

bitflags::bitflags! {
    /// `WindBitmap`.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
    pub struct WindBitmap: u8 {
        /// Indicate sleep wind
        const SLEEP_WIND = 1 << 0;
        /// Indicate natural wind
        const NATURAL_WIND = 1 << 1;
    }
}

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

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

/// The fields of `Step` (command `0x00`).
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct StepFields {
    /// `Direction`, field 0.
    pub direction: StepDirectionEnum,
    /// `Wrap`, field 1.
    pub wrap: Option<bool>,
    /// `LowestOff`, field 2.
    pub lowest_off: Option<bool>,
}

impl ToTlv for StepFields {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.direction.to_tlv(w, Tag::Context(0))?;
        if let Some(value) = &self.wrap {
            value.to_tlv(w, Tag::Context(1))?;
        }
        if let Some(value) = &self.lowest_off {
            value.to_tlv(w, Tag::Context(2))?;
        }
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for StepFields {
    fn from_tlv(reader: &mut TlvReader<'a>, element: &Element<'a>) -> Result<Self> {
        if element.value.container() != Some(ContainerKind::Structure) {
            return Err(crate::Error::new(crate::ErrorCode::TlvWrongType));
        }
        let mut direction = None;
        let mut wrap = None;
        let mut lowest_off = None;
        loop {
            let Some(field) = reader.next_element()? else {
                return Err(crate::Error::new(crate::ErrorCode::TlvTruncated));
            };
            if field.value == Value::EndOfContainer {
                break;
            }
            match field.tag.context() {
                Some(0) => direction = Some(<StepDirectionEnum>::from_tlv(reader, &field)?),
                Some(1) => wrap = Some(<bool>::from_tlv(reader, &field)?),
                Some(2) => lowest_off = Some(<bool>::from_tlv(reader, &field)?),
                // A field this revision does not define. §7.19.2: a receiver
                // ignores what it does not know rather than refusing the whole
                // structure, which is what lets a newer peer talk to an older one.
                _ => reader.skip_value(&field)?,
            }
        }
        Ok(Self {
            direction: direction.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            wrap,
            lowest_off,
        })
    }
}

/// Every attribute the specification defines, with its conformance.
pub const ATTRIBUTES: &[Attribute] = &[
    Attribute {
        id: 0x0000,
        name: "FanMode",
        kind: "FanModeEnum",
        access: Access::read_write_with(Privilege::View, Privilege::Operate),
        qualities: AttributeQualities::NON_VOLATILE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0001,
        name: "FanModeSequence",
        kind: "FanModeSequenceEnum",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::FIXED,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0002,
        name: "PercentSetting",
        kind: "percent",
        access: Access::read_write_with(Privilege::View, Privilege::Operate),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0003,
        name: "PercentCurrent",
        kind: "percent",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0004,
        name: "SpeedMax",
        kind: "uint8",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::FIXED,
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Attribute {
        id: 0x0005,
        name: "SpeedSetting",
        kind: "uint8",
        access: Access::read_write_with(Privilege::View, Privilege::Operate),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Attribute {
        id: 0x0006,
        name: "SpeedCurrent",
        kind: "uint8",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Attribute {
        id: 0x0007,
        name: "RockSupport",
        kind: "RockBitmap",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::FIXED,
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(2),
            }],
        },
    },
    Attribute {
        id: 0x0008,
        name: "RockSetting",
        kind: "RockBitmap",
        access: Access::read_write_with(Privilege::View, Privilege::Operate),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(2),
            }],
        },
    },
    Attribute {
        id: 0x0009,
        name: "WindSupport",
        kind: "WindBitmap",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::FIXED,
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(3),
            }],
        },
    },
    Attribute {
        id: 0x000A,
        name: "WindSetting",
        kind: "WindBitmap",
        access: Access::read_write_with(Privilege::View, Privilege::Operate),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(3),
            }],
        },
    },
    Attribute {
        id: 0x000B,
        name: "AirflowDirection",
        kind: "AirflowDirectionEnum",
        access: Access::read_write_with(Privilege::View, Privilege::Operate),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(5),
            }],
        },
    },
];

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

/// Every event, with its conformance.
pub const EVENTS: &[Event] = &[];

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