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
// Generated by `cargo xtask` from the CSA data model 1.6. Do not edit.
//
// OTA Software Update Requestor โ€” cluster 0x002A.
//
// 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.

//! OTA Software Update Requestor (cluster `0x002A`, revision 1).
//!
//! 8 identifiers, 0 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 = 0x002A;

/// 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 = "OTAR";

/// This cluster defines no features, so its `FeatureMap` is always zero.
pub const FEATURES: &[Feature] = &[];

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

    /// `DefaultOTAProviders`.
    pub const DEFAULT_OTA_PROVIDERS: AttributeId = 0x00;
    /// `UpdatePossible`.
    pub const UPDATE_POSSIBLE: AttributeId = 0x01;
    /// `UpdateState`.
    pub const UPDATE_STATE: AttributeId = 0x02;
    /// `UpdateStateProgress`.
    pub const UPDATE_STATE_PROGRESS: AttributeId = 0x03;
}

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

    /// `AnnounceOTAProvider`.
    pub const ANNOUNCE_OTA_PROVIDER: CommandId = 0x00;
}

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

    /// `StateTransition`.
    pub const STATE_TRANSITION: EventId = 0x00;
    /// `VersionApplied`.
    pub const VERSION_APPLIED: EventId = 0x01;
    /// `DownloadError`.
    pub const DOWNLOAD_ERROR: EventId = 0x02;
}

/// `AnnouncementReasonEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum AnnouncementReasonEnum {
    /// An OTA Provider is announcing its presence.
    SimpleAnnouncement = 0,
    /// An OTA Provider is announcing, either to a single Node or to a group of Nodes, that a new Software Image MAY be available.
    UpdateAvailable = 1,
    /// An OTA Provider is announcing, either to a single Node or to a group of Nodes, that a new Software Image MAY be available, which contains an update that needs to be applied urgently.
    UrgentUpdateAvailable = 2,
}

impl AnnouncementReasonEnum {
    /// 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::SimpleAnnouncement),
            1 => Some(Self::UpdateAvailable),
            2 => Some(Self::UrgentUpdateAvailable),
            _ => None,
        }
    }

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

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

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

/// `ChangeReasonEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum ChangeReasonEnum {
    /// The reason for a state change is unknown.
    Unknown = 0,
    /// The reason for a state change is the success of a prior operation.
    Success = 1,
    /// The reason for a state change is the failure of a prior operation.
    Failure = 2,
    /// The reason for a state change is a time-out.
    TimeOut = 3,
    /// The reason for a state change is a request by the OTA Provider to wait.
    DelayByProvider = 4,
}

impl ChangeReasonEnum {
    /// 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::Success),
            2 => Some(Self::Failure),
            3 => Some(Self::TimeOut),
            4 => Some(Self::DelayByProvider),
            _ => None,
        }
    }

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

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

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

/// `UpdateStateEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum UpdateStateEnum {
    /// Current state is not yet determined.
    Unknown = 0,
    /// Indicate a Node not yet in the process of software update.
    Idle = 1,
    /// Indicate a Node in the process of querying an OTA Provider.
    Querying = 2,
    /// Indicate a Node waiting after a Busy response.
    DelayedOnQuery = 3,
    /// Indicate a Node currently in the process of downloading a software update.
    Downloading = 4,
    /// Indicate a Node currently in the process of verifying and applying a software update.
    Applying = 5,
    /// Indicate a Node waiting caused by AwaitNextAction response.
    DelayedOnApply = 6,
    /// Indicate a Node in the process of recovering to a previous version.
    RollingBack = 7,
    /// Indicate a Node is capable of user consent.
    DelayedOnUserConsent = 8,
}

impl UpdateStateEnum {
    /// 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::Idle),
            2 => Some(Self::Querying),
            3 => Some(Self::DelayedOnQuery),
            4 => Some(Self::Downloading),
            5 => Some(Self::Applying),
            6 => Some(Self::DelayedOnApply),
            7 => Some(Self::RollingBack),
            8 => Some(Self::DelayedOnUserConsent),
            _ => None,
        }
    }

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

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

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

/// `ProviderLocation`, fabric-scoped โ€” ยง7.19.1.9's `FabricIndex` is field 254.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct ProviderLocation {
    /// `ProviderNodeID`, field 1.
    pub provider_node_id: crate::msg::NodeId,
    /// `Endpoint`, field 2.
    pub endpoint: u16,
    /// `FabricIndex`, field 254.
    pub fabric_index: crate::msg::FabricIndex,
}

impl ToTlv for ProviderLocation {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.provider_node_id.to_tlv(w, Tag::Context(1))?;
        self.endpoint.to_tlv(w, Tag::Context(2))?;
        self.fabric_index.to_tlv(w, Tag::Context(254))?;
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for ProviderLocation {
    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 provider_node_id = None;
        let mut endpoint = None;
        let mut fabric_index = 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(1) => provider_node_id = Some(<crate::msg::NodeId>::from_tlv(reader, &field)?),
                Some(2) => endpoint = Some(<u16>::from_tlv(reader, &field)?),
                Some(254) => {
                    fabric_index = Some(<crate::msg::FabricIndex>::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 {
            provider_node_id: provider_node_id
                .ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            endpoint: endpoint.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            fabric_index: fabric_index.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
        })
    }
}

/// The fields of `AnnounceOTAProvider` (command `0x00`).
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct AnnounceOTAProviderFields<'a> {
    /// `ProviderNodeID`, field 0.
    pub provider_node_id: crate::msg::NodeId,
    /// `VendorID`, field 1.
    pub vendor_id: crate::msg::VendorId,
    /// `AnnouncementReason`, field 2.
    pub announcement_reason: AnnouncementReasonEnum,
    /// `MetadataForNode`, field 3.
    pub metadata_for_node: Option<&'a [u8]>,
    /// `Endpoint`, field 4.
    pub endpoint: u16,
}

impl<'a> ToTlv for AnnounceOTAProviderFields<'a> {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.provider_node_id.to_tlv(w, Tag::Context(0))?;
        self.vendor_id.to_tlv(w, Tag::Context(1))?;
        self.announcement_reason.to_tlv(w, Tag::Context(2))?;
        if let Some(value) = &self.metadata_for_node {
            value.to_tlv(w, Tag::Context(3))?;
        }
        self.endpoint.to_tlv(w, Tag::Context(4))?;
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for AnnounceOTAProviderFields<'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 provider_node_id = None;
        let mut vendor_id = None;
        let mut announcement_reason = None;
        let mut metadata_for_node = None;
        let mut endpoint = 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) => provider_node_id = Some(<crate::msg::NodeId>::from_tlv(reader, &field)?),
                Some(1) => vendor_id = Some(<crate::msg::VendorId>::from_tlv(reader, &field)?),
                Some(2) => {
                    announcement_reason = Some(<AnnouncementReasonEnum>::from_tlv(reader, &field)?)
                }
                Some(3) => metadata_for_node = Some(<&'a [u8]>::from_tlv(reader, &field)?),
                Some(4) => endpoint = Some(<u16>::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 {
            provider_node_id: provider_node_id
                .ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            vendor_id: vendor_id.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            announcement_reason: announcement_reason
                .ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            metadata_for_node,
            endpoint: endpoint.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
        })
    }
}

/// Every attribute the specification defines, with its conformance.
pub const ATTRIBUTES: &[Attribute] = &[
    Attribute {
        id: 0x0000,
        name: "DefaultOTAProviders",
        kind: "list[ProviderLocation]",
        access: Access::read_write_with(Privilege::View, Privilege::Administer)
            .with_qualities(AccessQualities::FABRIC_SCOPED),
        qualities: AttributeQualities::NON_VOLATILE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0001,
        name: "UpdatePossible",
        kind: "bool",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0002,
        name: "UpdateState",
        kind: "UpdateStateEnum",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0003,
        name: "UpdateStateProgress",
        kind: "uint8",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
];

/// Every command, with its conformance.
pub const COMMANDS: &[Command] = &[Command {
    id: 0x00,
    name: "AnnounceOTAProvider",
    to_server: true,
    response: None,
    access: Access::invoke(Privilege::Administer),
    conform: Conform::OPTIONAL,
}];

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

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