#![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 = 0x002A;
pub const REVISION: u16 = 1;
pub const PICS: &str = "OTAR";
pub const FEATURES: &[Feature] = &[];
pub mod attribute {
use crate::im::AttributeId;
pub const DEFAULT_OTA_PROVIDERS: AttributeId = 0x00;
pub const UPDATE_POSSIBLE: AttributeId = 0x01;
pub const UPDATE_STATE: AttributeId = 0x02;
pub const UPDATE_STATE_PROGRESS: AttributeId = 0x03;
}
pub mod command {
use crate::im::CommandId;
pub const ANNOUNCE_OTA_PROVIDER: CommandId = 0x00;
}
pub mod event {
use crate::im::EventId;
pub const STATE_TRANSITION: EventId = 0x00;
pub const VERSION_APPLIED: EventId = 0x01;
pub const DOWNLOAD_ERROR: EventId = 0x02;
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
pub enum AnnouncementReasonEnum {
SimpleAnnouncement = 0,
UpdateAvailable = 1,
UrgentUpdateAvailable = 2,
}
impl AnnouncementReasonEnum {
#[must_use]
pub const fn from_value(value: u8) -> Option<Self> {
match value {
0 => Some(Self::SimpleAnnouncement),
1 => Some(Self::UpdateAvailable),
2 => Some(Self::UrgentUpdateAvailable),
_ => None,
}
}
#[must_use]
pub const fn value(self) -> u8 {
self as u8
}
}
impl ToTlv for AnnouncementReasonEnum {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.value().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for AnnouncementReasonEnum {
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 ChangeReasonEnum {
Unknown = 0,
Success = 1,
Failure = 2,
TimeOut = 3,
DelayByProvider = 4,
}
impl ChangeReasonEnum {
#[must_use]
pub const fn from_value(value: u8) -> Option<Self> {
match value {
0 => Some(Self::Unknown),
1 => Some(Self::Success),
2 => Some(Self::Failure),
3 => Some(Self::TimeOut),
4 => Some(Self::DelayByProvider),
_ => None,
}
}
#[must_use]
pub const fn value(self) -> u8 {
self as u8
}
}
impl ToTlv for ChangeReasonEnum {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.value().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for ChangeReasonEnum {
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 UpdateStateEnum {
Unknown = 0,
Idle = 1,
Querying = 2,
DelayedOnQuery = 3,
Downloading = 4,
Applying = 5,
DelayedOnApply = 6,
RollingBack = 7,
DelayedOnUserConsent = 8,
}
impl UpdateStateEnum {
#[must_use]
pub const fn from_value(value: u8) -> Option<Self> {
match value {
0 => Some(Self::Unknown),
1 => Some(Self::Idle),
2 => Some(Self::Querying),
3 => Some(Self::DelayedOnQuery),
4 => Some(Self::Downloading),
5 => Some(Self::Applying),
6 => Some(Self::DelayedOnApply),
7 => Some(Self::RollingBack),
8 => Some(Self::DelayedOnUserConsent),
_ => None,
}
}
#[must_use]
pub const fn value(self) -> u8 {
self as u8
}
}
impl ToTlv for UpdateStateEnum {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
self.value().to_tlv(w, tag)
}
}
impl<'a> FromTlv<'a> for UpdateStateEnum {
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)]
pub struct ProviderLocation {
pub provider_node_id: crate::msg::NodeId,
pub endpoint: u16,
pub fabric_index: crate::msg::FabricIndex,
}
impl ToTlv for ProviderLocation {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.provider_node_id.to_tlv(w, Tag::Context(1))?;
self.endpoint.to_tlv(w, Tag::Context(2))?;
self.fabric_index.to_tlv(w, Tag::Context(254))?;
w.end_container()
}
}
impl<'a> FromTlv<'a> for ProviderLocation {
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 provider_node_id = None;
let mut endpoint = 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) => provider_node_id = Some(<crate::msg::NodeId>::from_tlv(reader, &field)?),
Some(2) => endpoint = Some(<u16>::from_tlv(reader, &field)?),
Some(254) => {
fabric_index = Some(<crate::msg::FabricIndex>::from_tlv(reader, &field)?)
}
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
provider_node_id: provider_node_id
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
endpoint: endpoint.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 AnnounceOTAProviderFields<'a> {
pub provider_node_id: crate::msg::NodeId,
pub vendor_id: crate::msg::VendorId,
pub announcement_reason: AnnouncementReasonEnum,
pub metadata_for_node: Option<&'a [u8]>,
pub endpoint: u16,
}
impl<'a> ToTlv for AnnounceOTAProviderFields<'a> {
fn to_tlv(&self, w: &mut TlvWriter<'_>, tag: Tag) -> Result<()> {
w.start_structure(tag)?;
self.provider_node_id.to_tlv(w, Tag::Context(0))?;
self.vendor_id.to_tlv(w, Tag::Context(1))?;
self.announcement_reason.to_tlv(w, Tag::Context(2))?;
if let Some(value) = &self.metadata_for_node {
value.to_tlv(w, Tag::Context(3))?;
}
self.endpoint.to_tlv(w, Tag::Context(4))?;
w.end_container()
}
}
impl<'a> FromTlv<'a> for AnnounceOTAProviderFields<'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 provider_node_id = None;
let mut vendor_id = None;
let mut announcement_reason = None;
let mut metadata_for_node = None;
let mut endpoint = 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) => provider_node_id = Some(<crate::msg::NodeId>::from_tlv(reader, &field)?),
Some(1) => vendor_id = Some(<crate::msg::VendorId>::from_tlv(reader, &field)?),
Some(2) => {
announcement_reason = Some(<AnnouncementReasonEnum>::from_tlv(reader, &field)?)
}
Some(3) => metadata_for_node = Some(<&'a [u8]>::from_tlv(reader, &field)?),
Some(4) => endpoint = Some(<u16>::from_tlv(reader, &field)?),
_ => reader.skip_value(&field)?,
}
}
Ok(Self {
provider_node_id: provider_node_id
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
vendor_id: vendor_id.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
announcement_reason: announcement_reason
.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
metadata_for_node,
endpoint: endpoint.ok_or(crate::Error::new(crate::ErrorCode::TlvNotFound))?,
})
}
}
pub const ATTRIBUTES: &[Attribute] = &[
Attribute {
id: 0x0000,
name: "DefaultOTAProviders",
kind: "list[ProviderLocation]",
access: Access::read_write_with(Privilege::View, Privilege::Administer)
.with_qualities(AccessQualities::FABRIC_SCOPED),
qualities: AttributeQualities::NON_VOLATILE,
reporting: Reporting::OnChange,
conform: Conform::MANDATORY,
},
Attribute {
id: 0x0001,
name: "UpdatePossible",
kind: "bool",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::empty(),
reporting: Reporting::OnChange,
conform: Conform::MANDATORY,
},
Attribute {
id: 0x0002,
name: "UpdateState",
kind: "UpdateStateEnum",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::empty(),
reporting: Reporting::OnChange,
conform: Conform::MANDATORY,
},
Attribute {
id: 0x0003,
name: "UpdateStateProgress",
kind: "uint8",
access: Access::read_only(Privilege::View),
qualities: AttributeQualities::NULLABLE,
reporting: Reporting::OnChange,
conform: Conform::MANDATORY,
},
];
pub const COMMANDS: &[Command] = &[Command {
id: 0x00,
name: "AnnounceOTAProvider",
to_server: true,
response: None,
access: Access::invoke(Privilege::Administer),
conform: Conform::OPTIONAL,
}];
pub const EVENTS: &[Event] = &[
Event {
id: 0x00,
name: "StateTransition",
priority: EventPriority::Info,
access: Access::read_only(Privilege::View),
conform: Conform::MANDATORY,
},
Event {
id: 0x01,
name: "VersionApplied",
priority: EventPriority::Critical,
access: Access::read_only(Privilege::View),
conform: Conform::MANDATORY,
},
Event {
id: 0x02,
name: "DownloadError",
priority: EventPriority::Info,
access: Access::read_only(Privilege::View),
conform: Conform::MANDATORY,
},
];
pub const CLUSTER: Cluster = Cluster {
id: ID,
name: "OTA Software Update Requestor",
revision: REVISION,
pics: "OTAR",
derived_from: None,
features: FEATURES,
attributes: ATTRIBUTES,
commands: COMMANDS,
events: EVENTS,
};