#![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 = 0x0406;
pub const REVISION: u16 = 7;
pub const PICS: &str = "OCC";
pub mod feature {
pub const OTHER: u32 = 1 << 0;
pub const PASSIVE_INFRARED: u32 = 1 << 1;
pub const ULTRASONIC: u32 = 1 << 2;
pub const PHYSICAL_CONTACT: u32 = 1 << 3;
pub const ACTIVE_INFRARED: u32 = 1 << 4;
pub const RADAR: u32 = 1 << 5;
pub const RF_SENSING: u32 = 1 << 6;
pub const VISION: u32 = 1 << 7;
pub const OCCUPANCY_EVENT: u32 = 1 << 9;
}
pub const FEATURES: &[Feature] = &[
Feature {
bit: 0,
code: "OTHER",
name: "Other",
conform: Conform::OPTIONAL,
},
Feature {
bit: 1,
code: "PIR",
name: "PassiveInfrared",
conform: Conform::OPTIONAL,
},
Feature {
bit: 2,
code: "US",
name: "Ultrasonic",
conform: Conform::OPTIONAL,
},
Feature {
bit: 3,
code: "PHY",
name: "PhysicalContact",
conform: Conform::OPTIONAL,
},
Feature {
bit: 4,
code: "AIR",
name: "ActiveInfrared",
conform: Conform::OPTIONAL,
},
Feature {
bit: 5,
code: "RAD",
name: "Radar",
conform: Conform::OPTIONAL,
},
Feature {
bit: 6,
code: "RFS",
name: "RFSensing",
conform: Conform::OPTIONAL,
},
Feature {
bit: 7,
code: "VIS",
name: "Vision",
conform: Conform::OPTIONAL,
},
Feature {
bit: 9,
code: "OCCEVENT",
name: "OccupancyEvent",
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Described,
when: Condition::Named("comparison"),
}],
},
},
];
pub mod attribute {
use crate::im::AttributeId;
pub const OCCUPANCY: AttributeId = 0x00;
pub const OCCUPANCY_SENSOR_TYPE: AttributeId = 0x01;
pub const OCCUPANCY_SENSOR_TYPE_BITMAP: AttributeId = 0x02;
pub const HOLD_TIME: AttributeId = 0x03;
pub const HOLD_TIME_LIMITS: AttributeId = 0x04;
pub const PIR_OCCUPIED_TO_UNOCCUPIED_DELAY: AttributeId = 0x10;
pub const PIR_UNOCCUPIED_TO_OCCUPIED_DELAY: AttributeId = 0x11;
pub const PIR_UNOCCUPIED_TO_OCCUPIED_THRESHOLD: AttributeId = 0x12;
pub const ULTRASONIC_OCCUPIED_TO_UNOCCUPIED_DELAY: AttributeId = 0x20;
pub const ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_DELAY: AttributeId = 0x21;
pub const ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_THRESHOLD: AttributeId = 0x22;
pub const PHYSICAL_CONTACT_OCCUPIED_TO_UNOCCUPIED_DELAY: AttributeId = 0x30;
pub const PHYSICAL_CONTACT_UNOCCUPIED_TO_OCCUPIED_DELAY: AttributeId = 0x31;
pub const PHYSICAL_CONTACT_UNOCCUPIED_TO_OCCUPIED_THRESHOLD: AttributeId = 0x32;
}
pub mod event {
use crate::im::EventId;
pub const OCCUPANCY_CHANGED: EventId = 0x00;
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum OccupancySensorTypeEnum {
PIR = 0,
Ultrasonic = 1,
PIRAndUltrasonic = 2,
PhysicalContact = 3,
}
impl OccupancySensorTypeEnum {
#[must_use]
pub const fn from_value(value: u8) -> Option<Self> {
match value {
0 => Some(Self::PIR),
1 => Some(Self::Ultrasonic),
2 => Some(Self::PIRAndUltrasonic),
3 => Some(Self::PhysicalContact),
_ => None,
}
}
#[must_use]
pub const fn value(self) -> u8 {
self as u8
}
}
impl ToTlv for OccupancySensorTypeEnum {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.value().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for OccupancySensorTypeEnum {
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 OccupancyBitmap: u8 {
const OCCUPIED = 1 << 0;
}
}
impl ToTlv for OccupancyBitmap {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.bits().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for OccupancyBitmap {
fn from_tlv(reader: &mut TlvReader<'a>, element: &Element<'a>) -> Result<Self> {
let bits = <u8 as FromTlv<'a>>::from_tlv(reader, element)?;
Self::from_bits(bits).ok_or(crate::Error::new(crate::ErrorCode::TlvOutOfRange))
}
}
bitflags::bitflags! {
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct OccupancySensorTypeBitmap: u8 {
const PIR = 1 << 0;
const ULTRASONIC = 1 << 1;
const PHYSICAL_CONTACT = 1 << 2;
}
}
impl ToTlv for OccupancySensorTypeBitmap {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.bits().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for OccupancySensorTypeBitmap {
fn from_tlv(reader: &mut TlvReader<'a>, element: &Element<'a>) -> Result<Self> {
let bits = <u8 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 HoldTimeLimitsStruct {
pub hold_time_min: u16,
pub hold_time_max: u16,
pub hold_time_default: u16,
}
impl ToTlv for HoldTimeLimitsStruct {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.hold_time_min.to_tlv(w, Tag::Context(0))?;
self.hold_time_max.to_tlv(w, Tag::Context(1))?;
self.hold_time_default.to_tlv(w, Tag::Context(2))?;
w.end_container()
}
}
impl<'a> FromTlv<'a> for HoldTimeLimitsStruct {
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 hold_time_min = None;
let mut hold_time_max = None;
let mut hold_time_default = 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) => hold_time_min = Some(<u16>::from_tlv(reader, &field)?),
Some(1) => hold_time_max = Some(<u16>::from_tlv(reader, &field)?),
Some(2) => hold_time_default = Some(<u16>::from_tlv(reader, &field)?),
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
hold_time_min: hold_time_min.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
hold_time_max: hold_time_max.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
hold_time_default: hold_time_default
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
})
}
}
pub const ATTRIBUTES: &[Attribute] = &[
Attribute {
id: 0x0000,
name: "Occupancy",
kind: "OccupancyBitmap",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::empty(),
reporting: Reporting::OnChange,
conform: Conform::MANDATORY,
},
Attribute {
id: 0x0001,
name: "OccupancySensorType",
kind: "OccupancySensorTypeEnum",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::Always,
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0002,
name: "OccupancySensorTypeBitmap",
kind: "OccupancySensorTypeBitmap",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::Always,
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0003,
name: "HoldTime",
kind: "uint16",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform::OPTIONAL,
},
Attribute {
id: 0x0004,
name: "HoldTimeLimits",
kind: "HoldTimeLimitsStruct",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::FIXED,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[Clause {
verdict: Conformance::Mandatory,
when: Condition::Attribute(0x0003),
}],
},
},
Attribute {
id: 0x0010,
name: "PIROccupiedToUnoccupiedDelay",
kind: "uint16",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[
Condition::Attribute(0x0003),
Condition::Any(&[
Condition::Feature(1),
Condition::All(&[
Condition::Not(&Condition::Feature(1)),
Condition::Not(&Condition::Feature(2)),
Condition::Not(&Condition::Feature(3)),
]),
]),
]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0011,
name: "PIRUnoccupiedToOccupiedDelay",
kind: "uint16",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::All(&[
Condition::All(&[
Condition::Attribute(0x0003),
Condition::Any(&[
Condition::Feature(1),
Condition::All(&[
Condition::Not(&Condition::Feature(1)),
Condition::Not(&Condition::Feature(2)),
Condition::Not(&Condition::Feature(3)),
]),
]),
]),
Condition::Attribute(0x0012),
]),
},
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[
Condition::Attribute(0x0003),
Condition::Any(&[
Condition::Feature(1),
Condition::All(&[
Condition::Not(&Condition::Feature(1)),
Condition::Not(&Condition::Feature(2)),
Condition::Not(&Condition::Feature(3)),
]),
]),
]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0012,
name: "PIRUnoccupiedToOccupiedThreshold",
kind: "uint8",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::All(&[
Condition::All(&[
Condition::Attribute(0x0003),
Condition::Any(&[
Condition::Feature(1),
Condition::All(&[
Condition::Not(&Condition::Feature(1)),
Condition::Not(&Condition::Feature(2)),
Condition::Not(&Condition::Feature(3)),
]),
]),
]),
Condition::Attribute(0x0011),
]),
},
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[
Condition::Attribute(0x0003),
Condition::Any(&[
Condition::Feature(1),
Condition::All(&[
Condition::Not(&Condition::Feature(1)),
Condition::Not(&Condition::Feature(2)),
Condition::Not(&Condition::Feature(3)),
]),
]),
]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0020,
name: "UltrasonicOccupiedToUnoccupiedDelay",
kind: "uint16",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[Condition::Attribute(0x0003), Condition::Feature(2)]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0021,
name: "UltrasonicUnoccupiedToOccupiedDelay",
kind: "uint16",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::All(&[
Condition::Attribute(0x0003),
Condition::Feature(2),
Condition::Attribute(0x0022),
]),
},
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[Condition::Attribute(0x0003), Condition::Feature(2)]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0022,
name: "UltrasonicUnoccupiedToOccupiedThreshold",
kind: "uint8",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::All(&[
Condition::Attribute(0x0003),
Condition::Feature(2),
Condition::Attribute(0x0021),
]),
},
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[Condition::Attribute(0x0003), Condition::Feature(2)]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0030,
name: "PhysicalContactOccupiedToUnoccupiedDelay",
kind: "uint16",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[Condition::Attribute(0x0003), Condition::Feature(3)]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0031,
name: "PhysicalContactUnoccupiedToOccupiedDelay",
kind: "uint16",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::All(&[
Condition::Attribute(0x0003),
Condition::Feature(3),
Condition::Attribute(0x0032),
]),
},
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[Condition::Attribute(0x0003), Condition::Feature(3)]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
Attribute {
id: 0x0032,
name: "PhysicalContactUnoccupiedToOccupiedThreshold",
kind: "uint8",
access: Access::read_write_with(Privilege::View, Privilege::Manage),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::All(&[
Condition::Attribute(0x0003),
Condition::Feature(3),
Condition::Attribute(0x0031),
]),
},
Clause {
verdict: Conformance::Optional,
when: Condition::All(&[Condition::Attribute(0x0003), Condition::Feature(3)]),
},
Clause {
verdict: Conformance::Deprecated,
when: Condition::Always,
},
],
},
},
];
pub const COMMANDS: &[Command] = &[];
pub const EVENTS: &[Event] = &[Event {
id: 0x00,
name: "OccupancyChanged",
priority: EventPriority::Info,
access: Access::read_only(Privilege::View),
conform: Conform {
clauses: &[
Clause {
verdict: Conformance::Mandatory,
when: Condition::Feature(9),
},
Clause {
verdict: Conformance::Optional,
when: Condition::Always,
},
],
},
}];
pub const CLUSTER: Cluster = Cluster {
id: ID,
name: "Occupancy Sensing",
revision: REVISION,
pics: "OCC",
derived_from: None,
features: FEATURES,
attributes: ATTRIBUTES,
commands: COMMANDS,
events: EVENTS,
};