#![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,
};
pub const ID: ClusterId = 0x0046;
pub const REVISION: u16 = 3;
pub const PICS: &str = "ICDM";
pub mod feature {
pub const CHECK_IN_PROTOCOL_SUPPORT: u32 = 1 << 0;
pub const USER_ACTIVE_MODE_TRIGGER: u32 = 1 << 1;
pub const LONG_IDLE_TIME_SUPPORT: u32 = 1 << 2;
pub const DYNAMIC_SIT_LIT_SUPPORT: u32 = 1 << 3;
}
pub const FEATURES: &[Feature] = &[
Feature {
bit: 0,
code: "CIP",
name: "CheckInProtocolSupport",
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(2),
},
Clause {
verdict: Conformance::Optional,
when: Condition::Always,
},
],
},
},
Feature {
bit: 1,
code: "UAT",
name: "UserActiveModeTrigger",
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(2),
},
Clause {
verdict: Conformance::Optional,
when: Condition::Always,
},
],
},
},
Feature {
bit: 2,
code: "LITS",
name: "LongIdleTimeSupport",
conform: Conform::OPTIONAL,
},
Feature {
bit: 3,
code: "DSLS",
name: "DynamicSitLitSupport",
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Optional,
when: Condition::Feature(2),
}],
},
},
];
pub mod attribute {
use crate::im::AttributeId;
pub const IDLE_MODE_DURATION: AttributeId = 0x00;
pub const ACTIVE_MODE_DURATION: AttributeId = 0x01;
pub const ACTIVE_MODE_THRESHOLD: AttributeId = 0x02;
pub const REGISTERED_CLIENTS: AttributeId = 0x03;
pub const ICD_COUNTER: AttributeId = 0x04;
pub const CLIENTS_SUPPORTED_PER_FABRIC: AttributeId = 0x05;
pub const USER_ACTIVE_MODE_TRIGGER_HINT: AttributeId = 0x06;
pub const USER_ACTIVE_MODE_TRIGGER_INSTRUCTION: AttributeId = 0x07;
pub const OPERATING_MODE: AttributeId = 0x08;
pub const MAXIMUM_CHECK_IN_BACKOFF: AttributeId = 0x09;
}
pub mod command {
use crate::im::CommandId;
pub const REGISTER_CLIENT: CommandId = 0x00;
pub const REGISTER_CLIENT_RESPONSE: CommandId = 0x01;
pub const UNREGISTER_CLIENT: CommandId = 0x02;
pub const STAY_ACTIVE_REQUEST: CommandId = 0x03;
pub const STAY_ACTIVE_RESPONSE: CommandId = 0x04;
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum ClientTypeEnum {
Permanent = 0,
Ephemeral = 1,
}
impl ClientTypeEnum {
#[must_use]
pub const fn from_value(value: u8) -> Option<Self> {
match value {
0 => Some(Self::Permanent),
1 => Some(Self::Ephemeral),
_ => None,
}
}
#[must_use]
pub const fn value(self) -> u8 {
self as u8
}
}
impl ToTlv for ClientTypeEnum {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.value().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for ClientTypeEnum {
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))
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum OperatingModeEnum {
SIT = 0,
LIT = 1,
}
impl OperatingModeEnum {
#[must_use]
pub const fn from_value(value: u8) -> Option<Self> {
match value {
0 => Some(Self::SIT),
1 => Some(Self::LIT),
_ => None,
}
}
#[must_use]
pub const fn value(self) -> u8 {
self as u8
}
}
impl ToTlv for OperatingModeEnum {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.value().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for OperatingModeEnum {
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))
}
}
bitflags::bitflags! {
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct UserActiveModeTriggerBitmap: u32 {
const POWER_CYCLE = 1 << 0;
const SETTINGS_MENU = 1 << 1;
const CUSTOM_INSTRUCTION = 1 << 2;
const DEVICE_MANUAL = 1 << 3;
const ACTUATE_SENSOR = 1 << 4;
const ACTUATE_SENSOR_SECONDS = 1 << 5;
const ACTUATE_SENSOR_TIMES = 1 << 6;
const ACTUATE_SENSOR_LIGHTS_BLINK = 1 << 7;
const RESET_BUTTON = 1 << 8;
const RESET_BUTTON_LIGHTS_BLINK = 1 << 9;
const RESET_BUTTON_SECONDS = 1 << 10;
const RESET_BUTTON_TIMES = 1 << 11;
const SETUP_BUTTON = 1 << 12;
const SETUP_BUTTON_SECONDS = 1 << 13;
const SETUP_BUTTON_LIGHTS_BLINK = 1 << 14;
const SETUP_BUTTON_TIMES = 1 << 15;
const APP_DEFINED_BUTTON = 1 << 16;
}
}
impl ToTlv for UserActiveModeTriggerBitmap {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.bits().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for UserActiveModeTriggerBitmap {
fn from_tlv(reader: &mut TlvReader<'a>, element: &Element<'a>) -> Result<Self> {
let bits = <u32 as FromTlv<'a>>::from_tlv(reader, element)?;
Self::from_bits(bits).ok_or(crate::Error::new(crate::ErrorCode::TlvOutOfRange))
}
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct MonitoringRegistrationStruct {
pub check_in_node_id: crate::msg::NodeId,
pub monitored_subject: u64,
pub client_type: ClientTypeEnum,
pub fabric_index: crate::msg::FabricIndex,
}
impl ToTlv for MonitoringRegistrationStruct {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.check_in_node_id.to_tlv(w, Tag::Context(1))?;
self.monitored_subject.to_tlv(w, Tag::Context(2))?;
self.client_type.to_tlv(w, Tag::Context(4))?;
self.fabric_index.to_tlv(w, Tag::Context(254))?;
w.end_container()
}
}
impl<'a> FromTlv<'a> for MonitoringRegistrationStruct {
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 check_in_node_id = None;
let mut monitored_subject = None;
let mut client_type = 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) => check_in_node_id = Some(<crate::msg::NodeId>::from_tlv(reader, &field)?),
Some(2) => monitored_subject = Some(<u64>::from_tlv(reader, &field)?),
Some(4) => client_type = Some(<ClientTypeEnum>::from_tlv(reader, &field)?),
Some(254) => {
fabric_index = Some(<crate::msg::FabricIndex>::from_tlv(reader, &field)?)
}
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
check_in_node_id: check_in_node_id
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
monitored_subject: monitored_subject
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
client_type: client_type.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
fabric_index: fabric_index.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
})
}
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RegisterClientFields<'a> {
pub check_in_node_id: crate::msg::NodeId,
pub monitored_subject: u64,
pub key: &'a [u8],
pub verification_key: Option<&'a [u8]>,
pub client_type: ClientTypeEnum,
}
impl<'a> ToTlv for RegisterClientFields<'a> {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.check_in_node_id.to_tlv(w, Tag::Context(0))?;
self.monitored_subject.to_tlv(w, Tag::Context(1))?;
self.key.to_tlv(w, Tag::Context(2))?;
if let Some(value) = &self.verification_key {
value.to_tlv(w, Tag::Context(3))?;
}
self.client_type.to_tlv(w, Tag::Context(4))?;
w.end_container()
}
}
impl<'a> FromTlv<'a> for RegisterClientFields<'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 check_in_node_id = None;
let mut monitored_subject = None;
let mut key = None;
let mut verification_key = None;
let mut client_type = 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) => check_in_node_id = Some(<crate::msg::NodeId>::from_tlv(reader, &field)?),
Some(1) => monitored_subject = Some(<u64>::from_tlv(reader, &field)?),
Some(2) => key = Some(<&'a [u8]>::from_tlv(reader, &field)?),
Some(3) => verification_key = Some(<&'a [u8]>::from_tlv(reader, &field)?),
Some(4) => client_type = Some(<ClientTypeEnum>::from_tlv(reader, &field)?),
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
check_in_node_id: check_in_node_id
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
monitored_subject: monitored_subject
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
key: key.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
verification_key,
client_type: client_type.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
})
}
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RegisterClientResponseFields {
pub icd_counter: u32,
}
impl ToTlv for RegisterClientResponseFields {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.icd_counter.to_tlv(w, Tag::Context(0))?;
w.end_container()
}
}
impl<'a> FromTlv<'a> for RegisterClientResponseFields {
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 icd_counter = 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) => icd_counter = Some(<u32>::from_tlv(reader, &field)?),
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
icd_counter: icd_counter.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
})
}
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct UnregisterClientFields<'a> {
pub check_in_node_id: crate::msg::NodeId,
pub verification_key: Option<&'a [u8]>,
}
impl<'a> ToTlv for UnregisterClientFields<'a> {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.check_in_node_id.to_tlv(w, Tag::Context(0))?;
if let Some(value) = &self.verification_key {
value.to_tlv(w, Tag::Context(1))?;
}
w.end_container()
}
}
impl<'a> FromTlv<'a> for UnregisterClientFields<'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 check_in_node_id = None;
let mut verification_key = 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) => check_in_node_id = Some(<crate::msg::NodeId>::from_tlv(reader, &field)?),
Some(1) => verification_key = Some(<&'a [u8]>::from_tlv(reader, &field)?),
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
check_in_node_id: check_in_node_id
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
verification_key,
})
}
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct StayActiveRequestFields {
pub stay_active_duration: u32,
}
impl ToTlv for StayActiveRequestFields {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.stay_active_duration.to_tlv(w, Tag::Context(0))?;
w.end_container()
}
}
impl<'a> FromTlv<'a> for StayActiveRequestFields {
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 stay_active_duration = 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) => stay_active_duration = Some(<u32>::from_tlv(reader, &field)?),
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
stay_active_duration: stay_active_duration
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
})
}
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct StayActiveResponseFields {
pub promised_active_duration: u32,
}
impl ToTlv for StayActiveResponseFields {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.promised_active_duration.to_tlv(w, Tag::Context(0))?;
w.end_container()
}
}
impl<'a> FromTlv<'a> for StayActiveResponseFields {
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 promised_active_duration = 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) => promised_active_duration = Some(<u32>::from_tlv(reader, &field)?),
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
promised_active_duration: promised_active_duration
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
})
}
}
pub const ATTRIBUTES: &[Attribute] = &[
Attribute {
id: 0x0000,
name: "IdleModeDuration",
kind: "uint32",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform::MANDATORY,
},
Attribute {
id: 0x0001,
name: "ActiveModeDuration",
kind: "uint32",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform::MANDATORY,
},
Attribute {
id: 0x0002,
name: "ActiveModeThreshold",
kind: "uint16",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform::MANDATORY,
},
Attribute {
id: 0x0003,
name: "RegisteredClients",
kind: "list[MonitoringRegistrationStruct]",
access: Access::read_only(Privilege::Administer)
.with_qualities(AccessQualities::FABRIC_SCOPED),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(0),
}],
},
},
Attribute {
id: 0x0004,
name: "ICDCounter",
kind: "uint32",
access: Access::read_only(Privilege::Administer),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::ChangesOmitted,
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(0),
}],
},
},
Attribute {
id: 0x0005,
name: "ClientsSupportedPerFabric",
kind: "uint16",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(0),
}],
},
},
Attribute {
id: 0x0006,
name: "UserActiveModeTriggerHint",
kind: "UserActiveModeTriggerBitmap",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(1),
}],
},
},
Attribute {
id: 0x0007,
name: "UserActiveModeTriggerInstruction",
kind: "string",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform::DESCRIBED,
},
Attribute {
id: 0x0008,
name: "OperatingMode",
kind: "OperatingModeEnum",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::empty(),
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(2),
}],
},
},
Attribute {
id: 0x0009,
name: "MaximumCheckInBackoff",
kind: "uint32",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(0),
}],
},
},
];
pub const COMMANDS: &[Command] = &[
Command {
id: 0x00,
name: "RegisterClient",
to_server: true,
response: Some(0x01),
access: Access::invoke(Privilege::Manage).with_qualities(AccessQualities::FABRIC_SCOPED),
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(0),
}],
},
},
Command {
id: 0x01,
name: "RegisterClientResponse",
to_server: false,
response: None,
access: Access::invoke(Privilege::Operate),
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(0),
}],
},
},
Command {
id: 0x02,
name: "UnregisterClient",
to_server: true,
response: None,
access: Access::invoke(Privilege::Manage).with_qualities(AccessQualities::FABRIC_SCOPED),
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(0),
}],
},
},
Command {
id: 0x03,
name: "StayActiveRequest",
to_server: true,
response: Some(0x04),
access: Access::invoke(Privilege::Operate),
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(2),
},
Clause {
verdict: Conformance::Optional,
when: Condition::Always,
},
],
},
},
Command {
id: 0x04,
name: "StayActiveResponse",
to_server: false,
response: None,
access: Access::invoke(Privilege::Operate),
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(2),
},
Clause {
verdict: Conformance::Optional,
when: Condition::Always,
},
],
},
},
];
pub const EVENTS: &[Event] = &[];
pub const CLUSTER: Cluster = Cluster {
id: ID,
name: "ICD Management",
revision: REVISION,
pics: "ICDM",
derived_from: None,
features: FEATURES,
attributes: ATTRIBUTES,
commands: COMMANDS,
events: EVENTS,
};