matter-kit 0.3.0

Matter (CSA smart-home standard) protocol implementation in Rust: no_std, no-alloc, executor-agnostic
Documentation
// Generated by `cargo xtask` from the CSA data model 1.6. Do not edit.
//
// Administrator Commissioning โ€” cluster 0x003C.
//
// 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.

//! Administrator Commissioning (cluster `0x003C`, revision 1).
//!
//! 6 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 = 0x003C;

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

/// 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 supports Basic Commissioning Method.
    ///
    /// Code `BC`, bit 0.
    pub const BASIC: u32 = 1 << 0;
}

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

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

    /// `WindowStatus`.
    pub const WINDOW_STATUS: AttributeId = 0x00;
    /// `AdminFabricIndex`.
    pub const ADMIN_FABRIC_INDEX: AttributeId = 0x01;
    /// `AdminVendorId`.
    pub const ADMIN_VENDOR_ID: AttributeId = 0x02;
}

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

    /// `OpenCommissioningWindow`.
    pub const OPEN_COMMISSIONING_WINDOW: CommandId = 0x00;
    /// `OpenBasicCommissioningWindow`.
    pub const OPEN_BASIC_COMMISSIONING_WINDOW: CommandId = 0x01;
    /// `RevokeCommissioning`.
    pub const REVOKE_COMMISSIONING: CommandId = 0x02;
}

/// `CommissioningWindowStatusEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum CommissioningWindowStatusEnum {
    /// Commissioning window not open
    WindowNotOpen = 0,
    /// An Enhanced Commissioning Method window is open
    EnhancedWindowOpen = 1,
    /// A Basic Commissioning Method window is open
    BasicWindowOpen = 2,
}

impl CommissioningWindowStatusEnum {
    /// 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::WindowNotOpen),
            1 => Some(Self::EnhancedWindowOpen),
            2 => Some(Self::BasicWindowOpen),
            _ => None,
        }
    }

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

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

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

/// `StatusCodeEnum`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum StatusCodeEnum {
    /// Could not be completed because another commissioning is in progress
    Busy = 2,
    /// Provided PAKE parameters were incorrectly formatted or otherwise invalid
    PAKEParameterError = 3,
    /// No commissioning window was currently open
    WindowNotOpen = 4,
}

impl StatusCodeEnum {
    /// 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 {
            2 => Some(Self::Busy),
            3 => Some(Self::PAKEParameterError),
            4 => Some(Self::WindowNotOpen),
            _ => None,
        }
    }

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

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

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

/// The fields of `OpenCommissioningWindow` (command `0x00`).
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct OpenCommissioningWindowFields<'a> {
    /// `CommissioningTimeout`, field 0.
    pub commissioning_timeout: u16,
    /// `PAKEPasscodeVerifier`, field 1.
    pub pake_passcode_verifier: &'a [u8],
    /// `Discriminator`, field 2.
    pub discriminator: u16,
    /// `Iterations`, field 3.
    pub iterations: u32,
    /// `Salt`, field 4.
    pub salt: &'a [u8],
}

impl<'a> ToTlv for OpenCommissioningWindowFields<'a> {
    fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
        w.start_structure(tag)?;
        self.commissioning_timeout.to_tlv(w, Tag::Context(0))?;
        self.pake_passcode_verifier.to_tlv(w, Tag::Context(1))?;
        self.discriminator.to_tlv(w, Tag::Context(2))?;
        self.iterations.to_tlv(w, Tag::Context(3))?;
        self.salt.to_tlv(w, Tag::Context(4))?;
        w.end_container()
    }
}

impl<'a> FromTlv<'a> for OpenCommissioningWindowFields<'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 commissioning_timeout = None;
        let mut pake_passcode_verifier = None;
        let mut discriminator = None;
        let mut iterations = None;
        let mut salt = 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) => commissioning_timeout = Some(<u16>::from_tlv(reader, &field)?),
                Some(1) => pake_passcode_verifier = Some(<&'a [u8]>::from_tlv(reader, &field)?),
                Some(2) => discriminator = Some(<u16>::from_tlv(reader, &field)?),
                Some(3) => iterations = Some(<u32>::from_tlv(reader, &field)?),
                Some(4) => salt = Some(<&'a [u8]>::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 {
            commissioning_timeout: commissioning_timeout
                .ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            pake_passcode_verifier: pake_passcode_verifier
                .ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            discriminator: discriminator.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            iterations: iterations.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
            salt: salt.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
        })
    }
}

/// The fields of `OpenBasicCommissioningWindow` (command `0x01`).
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct OpenBasicCommissioningWindowFields {
    /// `CommissioningTimeout`, field 0.
    pub commissioning_timeout: u16,
}

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

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

/// Every attribute the specification defines, with its conformance.
pub const ATTRIBUTES: &[Attribute] = &[
    Attribute {
        id: 0x0000,
        name: "WindowStatus",
        kind: "CommissioningWindowStatusEnum",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::empty(),
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0001,
        name: "AdminFabricIndex",
        kind: "fabric-idx",
        access: Access::read_only(Privilege::View),
        qualities: AttributeQualities::NULLABLE,
        reporting: Reporting::OnChange,
        conform: Conform::MANDATORY,
    },
    Attribute {
        id: 0x0002,
        name: "AdminVendorId",
        kind: "vendor-id",
        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: "OpenCommissioningWindow",
        to_server: true,
        response: None,
        access: Access::invoke(Privilege::Administer).with_qualities(AccessQualities::TIMED),
        conform: Conform::MANDATORY,
    },
    Command {
        id: 0x01,
        name: "OpenBasicCommissioningWindow",
        to_server: true,
        response: None,
        access: Access::invoke(Privilege::Administer).with_qualities(AccessQualities::TIMED),
        conform: Conform {
            clauses: &[Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            }],
        },
    },
    Command {
        id: 0x02,
        name: "RevokeCommissioning",
        to_server: true,
        response: None,
        access: Access::invoke(Privilege::Administer).with_qualities(AccessQualities::TIMED),
        conform: Conform::MANDATORY,
    },
];

/// 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: "Administrator Commissioning",
    revision: REVISION,
    pics: "CADMIN",
    derived_from: None,
    features: FEATURES,
    attributes: ATTRIBUTES,
    commands: COMMANDS,
    events: EVENTS,
};