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.
//
// Boolean State — cluster 0x0045.
//
// 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.

//! Boolean State (cluster `0x0045`, revision 3).
//!
//! 2 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 = 0x0045;

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

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

/// 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 {
    /// Supports reporting change events
    ///
    /// Code `CHGEVENT`, bit 0.
    pub const CHANGE_EVENT: u32 = 1 << 0;
}

/// Every feature bit, with its conformance.
pub const FEATURES: &[Feature] = &[Feature {
    bit: 0,
    code: "CHGEVENT",
    name: "ChangeEvent",
    conform: Conform {
        clauses: &[Clause {
            verdict: Conformance::Described,
            when: Condition::Named("comparison"),
        }],
    },
}];

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

    /// `StateValue`.
    pub const STATE_VALUE: AttributeId = 0x00;
}

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

    /// `StateChange`.
    pub const STATE_CHANGE: EventId = 0x00;
}

/// Every attribute the specification defines, with its conformance.
pub const ATTRIBUTES: &[Attribute] = &[Attribute {
    id: 0x0000,
    name: "StateValue",
    kind: "bool",
    access: Access::read_only(Privilege::View),
    qualities: AttributeQualities::empty(),
    reporting: Reporting::OnChange,
    conform: Conform::MANDATORY,
}];

/// Every command, with its conformance.
pub const COMMANDS: &[Command] = &[];

/// Every event, with its conformance.
pub const EVENTS: &[Event] = &[Event {
    id: 0x00,
    name: "StateChange",
    priority: EventPriority::Info,
    access: Access::read_only(Privilege::View),
    conform: Conform {
        clauses: &[
            Clause {
                verdict: Conformance::Mandatory,
                when: Condition::Feature(0),
            },
            Clause {
                verdict: Conformance::Optional,
                when: Condition::Always,
            },
        ],
    },
}];

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