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
// Generated by `cargo xtask` from the CSA data model 1.6. Do not edit.
//
// Commodity Price โ€” cluster 0x0095.
//
// 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.

//! Commodity Price (cluster `0x0095`, revision 4).
//!
//! 9 identifiers, 1 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 = 0x0095;

/// The highest revision the specification's history defines โ€” what `ClusterRevision`
/// must report (Core ยง7.13.1).
pub const REVISION: u16 = 4;

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

/// 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 {
    /// Forecasts upcoming pricing
    ///
    /// Code `FORE`, bit 0.
    pub const FORECASTING: u32 = 1 << 0;
}

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

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

    /// `TariffUnit`.
    pub const TARIFF_UNIT: AttributeId = 0x00;
    /// `Currency`.
    pub const CURRENCY: AttributeId = 0x01;
    /// `CurrentPrice`.
    pub const CURRENT_PRICE: AttributeId = 0x02;
    /// `PriceForecast`.
    pub const PRICE_FORECAST: AttributeId = 0x03;
}

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

    /// `GetDetailedPriceRequest`.
    pub const GET_DETAILED_PRICE_REQUEST: CommandId = 0x00;
    /// `GetDetailedPriceResponse`.
    pub const GET_DETAILED_PRICE_RESPONSE: CommandId = 0x01;
    /// `GetDetailedForecastRequest`.
    pub const GET_DETAILED_FORECAST_REQUEST: CommandId = 0x02;
    /// `GetDetailedForecastResponse`.
    pub const GET_DETAILED_FORECAST_RESPONSE: CommandId = 0x03;
}

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

    /// `PriceChange`.
    pub const PRICE_CHANGE: EventId = 0x00;
}

bitflags::bitflags! {
    /// `CommodityPriceDetailBitmap`.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
    pub struct CommodityPriceDetailBitmap: u8 {
        /// A textual description of a price; e.g. the name of a rate plan.
        const DESCRIPTION = 1 << 0;
        /// A breakdown of the component parts of a price; e.g. generation, delivery, etc.
        const COMPONENTS = 1 << 1;
    }
}

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

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

/// `CommodityPriceComponentStruct`.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct CommodityPriceComponentStruct<'a> {
    /// `Price`, field 0.
    pub price: i64,
    /// `Source`, field 1.
    pub source: crate::clusters::generated::globals::TariffPriceTypeEnum,
    /// `Description`, field 2.
    pub description: Option<&'a str>,
    /// `TariffComponentID`, field 3.
    pub tariff_component_id: Option<u32>,
}

impl<'a> ToTlv for CommodityPriceComponentStruct<'a> {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.price.to_tlv(w, Tag::Context(0))?;
        self.source.to_tlv(w, Tag::Context(1))?;
        if let Some(value) = &self.description {
            value.to_tlv(w, Tag::Context(2))?;
        }
        if let Some(value) = &self.tariff_component_id {
            value.to_tlv(w, Tag::Context(3))?;
        }
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for CommodityPriceComponentStruct<'a> {
    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 price = None;
        let mut source = None;
        let mut description = None;
        let mut tariff_component_id = 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) => price = Some(<i64>::from_tlv(reader, &field)?),
                Some(1) => {
                    source = Some(
                        <crate::clusters::generated::globals::TariffPriceTypeEnum>::from_tlv(
                            reader, &field,
                        )?,
                    )
                }
                Some(2) => description = Some(<&'a str>::from_tlv(reader, &field)?),
                Some(3) => tariff_component_id = Some(<u32>::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 {
            price: price.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            source: source.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            description,
            tariff_component_id,
        })
    }
}

/// `CommodityPriceStruct`.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct CommodityPriceStruct<'a> {
    /// `PeriodStart`, field 0.
    pub period_start: u32,
    /// `PeriodEnd`, field 1.
    pub period_end: Nullable<u32>,
    /// `Price`, field 2.
    pub price: Option<i64>,
    /// `PriceLevel`, field 3.
    pub price_level: Option<i16>,
    /// `Description`, field 4.
    pub description: Option<&'a str>,
    /// `Components`, field 5.
    pub components: Option<TlvList<'a, CommodityPriceComponentStruct<'a>>>,
}

impl<'a> ToTlv for CommodityPriceStruct<'a> {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.period_start.to_tlv(w, Tag::Context(0))?;
        self.period_end.to_tlv(w, Tag::Context(1))?;
        if let Some(value) = &self.price {
            value.to_tlv(w, Tag::Context(2))?;
        }
        if let Some(value) = &self.price_level {
            value.to_tlv(w, Tag::Context(3))?;
        }
        if let Some(value) = &self.description {
            value.to_tlv(w, Tag::Context(4))?;
        }
        if let Some(value) = &self.components {
            value.to_tlv(w, Tag::Context(5))?;
        }
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for CommodityPriceStruct<'a> {
    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 period_start = None;
        let mut period_end = None;
        let mut price = None;
        let mut price_level = None;
        let mut description = None;
        let mut components = 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) => period_start = Some(<u32>::from_tlv(reader, &field)?),
                Some(1) => period_end = Some(<Nullable<u32>>::from_tlv(reader, &field)?),
                Some(2) => price = Some(<i64>::from_tlv(reader, &field)?),
                Some(3) => price_level = Some(<i16>::from_tlv(reader, &field)?),
                Some(4) => description = Some(<&'a str>::from_tlv(reader, &field)?),
                Some(5) => {
                    components = Some(<TlvList<'a, CommodityPriceComponentStruct<'a>>>::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 {
            period_start: period_start.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            period_end: period_end.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            price,
            price_level,
            description,
            components,
        })
    }
}

/// The fields of `GetDetailedPriceRequest` (command `0x00`).
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GetDetailedPriceRequestFields {
    /// `Details`, field 0.
    pub details: CommodityPriceDetailBitmap,
}

impl ToTlv for GetDetailedPriceRequestFields {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.details.to_tlv(w, Tag::Context(0))?;
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for GetDetailedPriceRequestFields {
    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 details = 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) => details = Some(<CommodityPriceDetailBitmap>::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 {
            details: details.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
        })
    }
}

/// The fields of `GetDetailedPriceResponse` (command `0x01`).
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GetDetailedPriceResponseFields<'a> {
    /// `CurrentPrice`, field 0.
    pub current_price: Nullable<CommodityPriceStruct<'a>>,
}

impl<'a> ToTlv for GetDetailedPriceResponseFields<'a> {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.current_price.to_tlv(w, Tag::Context(0))?;
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for GetDetailedPriceResponseFields<'a> {
    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 current_price = 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) => {
                    current_price = Some(<Nullable<CommodityPriceStruct<'a>>>::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 {
            current_price: current_price.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
        })
    }
}

/// The fields of `GetDetailedForecastRequest` (command `0x02`).
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GetDetailedForecastRequestFields {
    /// `Details`, field 0.
    pub details: CommodityPriceDetailBitmap,
}

impl ToTlv for GetDetailedForecastRequestFields {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.details.to_tlv(w, Tag::Context(0))?;
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for GetDetailedForecastRequestFields {
    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 details = 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) => details = Some(<CommodityPriceDetailBitmap>::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 {
            details: details.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
        })
    }
}

/// The fields of `GetDetailedForecastResponse` (command `0x03`).
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GetDetailedForecastResponseFields<'a> {
    /// `PriceForecast`, field 0.
    pub price_forecast: TlvList<'a, CommodityPriceStruct<'a>>,
}

impl<'a> ToTlv for GetDetailedForecastResponseFields<'a> {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.price_forecast.to_tlv(w, Tag::Context(0))?;
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for GetDetailedForecastResponseFields<'a> {
    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 price_forecast = 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) => {
                    price_forecast = Some(<TlvList<'a, CommodityPriceStruct<'a>>>::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 {
            price_forecast: price_forecast
                .ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
        })
    }
}

/// Every attribute the specification defines, with its conformance.
pub const ATTRIBUTES: &[Attribute] = &[
    Attribute {
        id: 0x0000,
        name: "TariffUnit",
        kind: "TariffUnitEnum",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0001,
        name: "Currency",
        kind: "CurrencyStruct",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0002,
        name: "CurrentPrice",
        kind: "CommodityPriceStruct",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0003,
        name: "PriceForecast",
        kind: "list[CommodityPriceStruct]",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
];

/// Every command, with its conformance.
pub const COMMANDS: &[Command] = &[
    Command {
        id: 0x00,
        name: "GetDetailedPriceRequest",
        to_server: true,
        response: Some(0x01),
        access: Access::invoke(Privilege::Operate),
        conform: Conform::OPTIONAL,
    },
    Command {
        id: 0x01,
        name: "GetDetailedPriceResponse",
        to_server: false,
        response: None,
        access: Access::invoke(Privilege::Operate),
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Command(0x00),
            }],
        },
    },
    Command {
        id: 0x02,
        name: "GetDetailedForecastRequest",
        to_server: true,
        response: Some(0x03),
        access: Access::invoke(Privilege::Operate).with_qualities(AccessQualities::LARGE),
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Optional,
                when: Condition::Feature(0),
            }],
        },
    },
    Command {
        id: 0x03,
        name: "GetDetailedForecastResponse",
        to_server: false,
        response: None,
        access: Access::invoke(Privilege::Operate).with_qualities(AccessQualities::LARGE),
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Command(0x02),
            }],
        },
    },
];

/// Every event, with its conformance.
pub const EVENTS: &[Event] = &[Event {
    id: 0x00,
    name: "PriceChange",
    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: "Commodity Price",
    revision: REVISION,
    pics: "SEPR",
    derived_from: None,
    features: FEATURES,
    attributes: ATTRIBUTES,
    commands: COMMANDS,
    events: EVENTS,
};