matter-clusters 0.3.0

//! AdministratorCommissioning cluster (0x003C).
//! @generated by `cargo xtask codegen` — do not edit.

#![allow(
    clippy::all,
    clippy::pedantic,
    dead_code,
    unreachable_pub,
    unused_imports
)]

use crate::datatypes::SemanticTagStruct;
use crate::error::ClusterError;
use crate::types::Nullable;
use matter_codec::{ContainerKind, Element, Tag, TlvReader, TlvWriter, Value};

/// Cluster ID.
pub const CLUSTER_ID: u32 = 0x003C;
/// Cluster revision.
pub const CLUSTER_REVISION: u16 = 1;

/// Command IDs (requests and responses).
pub mod command_id {
    /// `OpenCommissioningWindow` (request).
    pub const OPEN_COMMISSIONING_WINDOW: u32 = 0x00;
    /// `OpenBasicCommissioningWindow` (request).
    pub const OPEN_BASIC_COMMISSIONING_WINDOW: u32 = 0x01;
    /// `RevokeCommissioning` (request).
    pub const REVOKE_COMMISSIONING: u32 = 0x02;
}

/// Attribute IDs (cluster-specific).
pub mod attribute_id {
    /// `WindowStatus`.
    pub const WINDOW_STATUS: u32 = 0x0000;
    /// `AdminFabricIndex`.
    pub const ADMIN_FABRIC_INDEX: u32 = 0x0001;
    /// `AdminVendorId`.
    pub const ADMIN_VENDOR_ID: u32 = 0x0002;
}

bitflags::bitflags! {
    /// `AdministratorCommissioning` feature bits (FeatureMap).
    #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
    pub struct Feature: u32 {
        /// Basic (BC).
        const BC = 1 << 0;
    }
}

/// `CommissioningWindowStatusEnum` (enum8).
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum CommissioningWindowStatusEnum {
    /// WindowNotOpen = 0.
    WindowNotOpen,
    /// EnhancedWindowOpen = 1.
    EnhancedWindowOpen,
    /// BasicWindowOpen = 2.
    BasicWindowOpen,
    /// A value not known to this codegen revision.
    Unknown(u8),
}

impl CommissioningWindowStatusEnum {
    /// Decode from its raw discriminant (unknown → `Unknown`).
    #[must_use]
    pub fn from_raw(v: u8) -> Self {
        match v {
            0 => Self::WindowNotOpen,
            1 => Self::EnhancedWindowOpen,
            2 => Self::BasicWindowOpen,
            other => Self::Unknown(other),
        }
    }
    /// The raw discriminant.
    #[must_use]
    pub fn to_raw(self) -> u8 {
        match self {
            Self::WindowNotOpen => 0,
            Self::EnhancedWindowOpen => 1,
            Self::BasicWindowOpen => 2,
            Self::Unknown(v) => v,
        }
    }
}

/// `StatusCodeEnum` (enum8).
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum StatusCodeEnum {
    /// Busy = 2.
    Busy,
    /// PakeParameterError = 3.
    PakeParameterError,
    /// WindowNotOpen = 4.
    WindowNotOpen,
    /// A value not known to this codegen revision.
    Unknown(u8),
}

impl StatusCodeEnum {
    /// Decode from its raw discriminant (unknown → `Unknown`).
    #[must_use]
    pub fn from_raw(v: u8) -> Self {
        match v {
            2 => Self::Busy,
            3 => Self::PakeParameterError,
            4 => Self::WindowNotOpen,
            other => Self::Unknown(other),
        }
    }
    /// The raw discriminant.
    #[must_use]
    pub fn to_raw(self) -> u8 {
        match self {
            Self::Busy => 2,
            Self::PakeParameterError => 3,
            Self::WindowNotOpen => 4,
            Self::Unknown(v) => v,
        }
    }
}

/// Decode the `WindowStatus` attribute value.
///
/// # Errors
/// Returns [`ClusterError`] on a type mismatch or out-of-range value.
pub fn decode_window_status(tlv: &[u8]) -> Result<CommissioningWindowStatusEnum, ClusterError> {
    let mut r = TlvReader::new(tlv);
    match r.next()? {
        Some(Element::Scalar {
            value: Value::Uint(v),
            ..
        }) => Ok(CommissioningWindowStatusEnum::from_raw(
            u8::try_from(v).map_err(|_| ClusterError::InvalidLength("WindowStatus"))?,
        )),
        _ => Err(ClusterError::UnexpectedType {
            context: "WindowStatus",
        }),
    }
}

/// Decode the `AdminFabricIndex` attribute value.
///
/// # Errors
/// Returns [`ClusterError`] on a type mismatch or out-of-range value.
pub fn decode_admin_fabric_index(tlv: &[u8]) -> Result<Nullable<u8>, ClusterError> {
    let mut r = TlvReader::new(tlv);
    match r.next()? {
        Some(Element::Scalar {
            value: Value::Null, ..
        }) => Ok(Nullable::Null),
        Some(Element::Scalar {
            value: Value::Uint(v),
            ..
        }) => {
            Ok(Nullable::Value(u8::try_from(v).map_err(|_| {
                ClusterError::InvalidLength("AdminFabricIndex")
            })?))
        }
        _ => Err(ClusterError::UnexpectedType {
            context: "AdminFabricIndex",
        }),
    }
}

/// Decode the `AdminVendorId` attribute value.
///
/// # Errors
/// Returns [`ClusterError`] on a type mismatch or out-of-range value.
pub fn decode_admin_vendor_id(tlv: &[u8]) -> Result<Nullable<u16>, ClusterError> {
    let mut r = TlvReader::new(tlv);
    match r.next()? {
        Some(Element::Scalar {
            value: Value::Null, ..
        }) => Ok(Nullable::Null),
        Some(Element::Scalar {
            value: Value::Uint(v),
            ..
        }) => {
            Ok(Nullable::Value(u16::try_from(v).map_err(|_| {
                ClusterError::InvalidLength("AdminVendorId")
            })?))
        }
        _ => Err(ClusterError::UnexpectedType {
            context: "AdminVendorId",
        }),
    }
}

/// Encode the `OpenCommissioningWindow` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_open_commissioning_window(
    commissioning_timeout: u16,
    pake_passcode_verifier: &Vec<u8>,
    discriminator: u16,
    iterations: u32,
    salt: &Vec<u8>,
) -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.put_uint(Tag::Context(0), u64::from(commissioning_timeout))
        .expect("infallible: vec writer");
    w.put_bytes(Tag::Context(1), &pake_passcode_verifier)
        .expect("infallible: vec writer");
    w.put_uint(Tag::Context(2), u64::from(discriminator))
        .expect("infallible: vec writer");
    w.put_uint(Tag::Context(3), u64::from(iterations))
        .expect("infallible: vec writer");
    w.put_bytes(Tag::Context(4), &salt)
        .expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}

/// Encode the `OpenBasicCommissioningWindow` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_open_basic_commissioning_window(commissioning_timeout: u16) -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.put_uint(Tag::Context(0), u64::from(commissioning_timeout))
        .expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}

/// Encode the `RevokeCommissioning` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_revoke_commissioning() -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}