#![allow(clippy::too_many_arguments)]
use crate::tlv;
use anyhow;
use serde_json;
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[repr(u8)]
pub enum AnnouncementReason {
Simpleannouncement = 0,
Updateavailable = 1,
Urgentupdateavailable = 2,
}
impl AnnouncementReason {
pub fn from_u8(value: u8) -> Option<Self> {
match value {
0 => Some(AnnouncementReason::Simpleannouncement),
1 => Some(AnnouncementReason::Updateavailable),
2 => Some(AnnouncementReason::Urgentupdateavailable),
_ => None,
}
}
pub fn to_u8(self) -> u8 {
self as u8
}
}
impl From<AnnouncementReason> for u8 {
fn from(val: AnnouncementReason) -> Self {
val as u8
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[repr(u8)]
pub enum ChangeReason {
Unknown = 0,
Success = 1,
Failure = 2,
Timeout = 3,
Delaybyprovider = 4,
}
impl ChangeReason {
pub fn from_u8(value: u8) -> Option<Self> {
match value {
0 => Some(ChangeReason::Unknown),
1 => Some(ChangeReason::Success),
2 => Some(ChangeReason::Failure),
3 => Some(ChangeReason::Timeout),
4 => Some(ChangeReason::Delaybyprovider),
_ => None,
}
}
pub fn to_u8(self) -> u8 {
self as u8
}
}
impl From<ChangeReason> for u8 {
fn from(val: ChangeReason) -> Self {
val as u8
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[repr(u8)]
pub enum UpdateState {
Unknown = 0,
Idle = 1,
Querying = 2,
Delayedonquery = 3,
Downloading = 4,
Applying = 5,
Delayedonapply = 6,
Rollingback = 7,
Delayedonuserconsent = 8,
}
impl UpdateState {
pub fn from_u8(value: u8) -> Option<Self> {
match value {
0 => Some(UpdateState::Unknown),
1 => Some(UpdateState::Idle),
2 => Some(UpdateState::Querying),
3 => Some(UpdateState::Delayedonquery),
4 => Some(UpdateState::Downloading),
5 => Some(UpdateState::Applying),
6 => Some(UpdateState::Delayedonapply),
7 => Some(UpdateState::Rollingback),
8 => Some(UpdateState::Delayedonuserconsent),
_ => None,
}
}
pub fn to_u8(self) -> u8 {
self as u8
}
}
impl From<UpdateState> for u8 {
fn from(val: UpdateState) -> Self {
val as u8
}
}
#[derive(Debug, serde::Serialize)]
pub struct ProviderLocation {
pub provider_node_id: Option<u64>,
pub endpoint: Option<u16>,
}
pub fn encode_announce_ota_provider(provider_node_id: u64, vendor_id: u16, announcement_reason: AnnouncementReason, metadata_for_node: Option<Vec<u8>>, endpoint: u16) -> anyhow::Result<Vec<u8>> {
let mut tlv_fields: Vec<tlv::TlvItemEnc> = Vec::new();
tlv_fields.push((0, tlv::TlvItemValueEnc::UInt64(provider_node_id)).into());
tlv_fields.push((1, tlv::TlvItemValueEnc::UInt16(vendor_id)).into());
tlv_fields.push((2, tlv::TlvItemValueEnc::UInt8(announcement_reason.to_u8())).into());
if let Some(x) = metadata_for_node { tlv_fields.push((3, tlv::TlvItemValueEnc::OctetString(x)).into()); }
tlv_fields.push((4, tlv::TlvItemValueEnc::UInt16(endpoint)).into());
let tlv = tlv::TlvItemEnc {
tag: 0,
value: tlv::TlvItemValueEnc::StructInvisible(tlv_fields),
};
Ok(tlv.encode()?)
}
pub fn decode_default_ota_providers(inp: &tlv::TlvItemValue) -> anyhow::Result<Vec<ProviderLocation>> {
let mut res = Vec::new();
if let tlv::TlvItemValue::List(v) = inp {
for item in v {
res.push(ProviderLocation {
provider_node_id: item.get_int(&[1]),
endpoint: item.get_int(&[2]).map(|v| v as u16),
});
}
}
Ok(res)
}
pub fn decode_update_possible(inp: &tlv::TlvItemValue) -> anyhow::Result<bool> {
if let tlv::TlvItemValue::Bool(v) = inp {
Ok(*v)
} else {
Err(anyhow::anyhow!("Expected Bool"))
}
}
pub fn decode_update_state(inp: &tlv::TlvItemValue) -> anyhow::Result<UpdateState> {
if let tlv::TlvItemValue::Int(v) = inp {
UpdateState::from_u8(*v as u8).ok_or_else(|| anyhow::anyhow!("Invalid enum value"))
} else {
Err(anyhow::anyhow!("Expected Integer"))
}
}
pub fn decode_update_state_progress(inp: &tlv::TlvItemValue) -> anyhow::Result<Option<u8>> {
if let tlv::TlvItemValue::Int(v) = inp {
Ok(Some(*v as u8))
} else {
Ok(None)
}
}
pub fn decode_attribute_json(cluster_id: u32, attribute_id: u32, tlv_value: &crate::tlv::TlvItemValue) -> String {
if cluster_id != 0x002A {
return format!("{{\"error\": \"Invalid cluster ID. Expected 0x002A, got {}\"}}", cluster_id);
}
match attribute_id {
0x0000 => {
match decode_default_ota_providers(tlv_value) {
Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
Err(e) => format!("{{\"error\": \"{}\"}}", e),
}
}
0x0001 => {
match decode_update_possible(tlv_value) {
Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
Err(e) => format!("{{\"error\": \"{}\"}}", e),
}
}
0x0002 => {
match decode_update_state(tlv_value) {
Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
Err(e) => format!("{{\"error\": \"{}\"}}", e),
}
}
0x0003 => {
match decode_update_state_progress(tlv_value) {
Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
Err(e) => format!("{{\"error\": \"{}\"}}", e),
}
}
_ => format!("{{\"error\": \"Unknown attribute ID: {}\"}}", attribute_id),
}
}
pub fn get_attribute_list() -> Vec<(u32, &'static str)> {
vec![
(0x0000, "DefaultOTAProviders"),
(0x0001, "UpdatePossible"),
(0x0002, "UpdateState"),
(0x0003, "UpdateStateProgress"),
]
}
pub fn get_command_list() -> Vec<(u32, &'static str)> {
vec![
(0x00, "AnnounceOTAProvider"),
]
}
pub fn get_command_name(cmd_id: u32) -> Option<&'static str> {
match cmd_id {
0x00 => Some("AnnounceOTAProvider"),
_ => None,
}
}
pub fn get_command_schema(cmd_id: u32) -> Option<Vec<crate::clusters::codec::CommandField>> {
match cmd_id {
0x00 => Some(vec![
crate::clusters::codec::CommandField { tag: 0, name: "provider_node_id", kind: crate::clusters::codec::FieldKind::U64, optional: false, nullable: false },
crate::clusters::codec::CommandField { tag: 1, name: "vendor_id", kind: crate::clusters::codec::FieldKind::U16, optional: false, nullable: false },
crate::clusters::codec::CommandField { tag: 2, name: "announcement_reason", kind: crate::clusters::codec::FieldKind::Enum { name: "AnnouncementReason", variants: &[(0, "Simpleannouncement"), (1, "Updateavailable"), (2, "Urgentupdateavailable")] }, optional: false, nullable: false },
crate::clusters::codec::CommandField { tag: 3, name: "metadata_for_node", kind: crate::clusters::codec::FieldKind::OctetString, optional: true, nullable: false },
crate::clusters::codec::CommandField { tag: 4, name: "endpoint", kind: crate::clusters::codec::FieldKind::U16, optional: false, nullable: false },
]),
_ => None,
}
}
pub fn encode_command_json(cmd_id: u32, args: &serde_json::Value) -> anyhow::Result<Vec<u8>> {
match cmd_id {
0x00 => {
let provider_node_id = crate::clusters::codec::json_util::get_u64(args, "provider_node_id")?;
let vendor_id = crate::clusters::codec::json_util::get_u16(args, "vendor_id")?;
let announcement_reason = {
let n = crate::clusters::codec::json_util::get_u64(args, "announcement_reason")?;
AnnouncementReason::from_u8(n as u8).ok_or_else(|| anyhow::anyhow!("invalid AnnouncementReason: {}", n))?
};
let metadata_for_node = crate::clusters::codec::json_util::get_opt_octstr(args, "metadata_for_node")?;
let endpoint = crate::clusters::codec::json_util::get_u16(args, "endpoint")?;
encode_announce_ota_provider(provider_node_id, vendor_id, announcement_reason, metadata_for_node, endpoint)
}
_ => Err(anyhow::anyhow!("unknown command ID: 0x{:02X}", cmd_id)),
}
}
pub async fn announce_ota_provider(conn: &crate::controller::Connection, endpoint: u16, provider_node_id: u64, vendor_id: u16, announcement_reason: AnnouncementReason, metadata_for_node: Option<Vec<u8>>, endpoint_: u16) -> anyhow::Result<()> {
conn.invoke_request(endpoint, crate::clusters::defs::CLUSTER_ID_OTA_SOFTWARE_UPDATE_REQUESTOR, crate::clusters::defs::CLUSTER_OTA_SOFTWARE_UPDATE_REQUESTOR_CMD_ID_ANNOUNCEOTAPROVIDER, &encode_announce_ota_provider(provider_node_id, vendor_id, announcement_reason, metadata_for_node, endpoint_)?).await?;
Ok(())
}
pub async fn read_default_ota_providers(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Vec<ProviderLocation>> {
let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OTA_SOFTWARE_UPDATE_REQUESTOR, crate::clusters::defs::CLUSTER_OTA_SOFTWARE_UPDATE_REQUESTOR_ATTR_ID_DEFAULTOTAPROVIDERS).await?;
decode_default_ota_providers(&tlv)
}
pub async fn read_update_possible(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<bool> {
let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OTA_SOFTWARE_UPDATE_REQUESTOR, crate::clusters::defs::CLUSTER_OTA_SOFTWARE_UPDATE_REQUESTOR_ATTR_ID_UPDATEPOSSIBLE).await?;
decode_update_possible(&tlv)
}
pub async fn read_update_state(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<UpdateState> {
let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OTA_SOFTWARE_UPDATE_REQUESTOR, crate::clusters::defs::CLUSTER_OTA_SOFTWARE_UPDATE_REQUESTOR_ATTR_ID_UPDATESTATE).await?;
decode_update_state(&tlv)
}
pub async fn read_update_state_progress(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Option<u8>> {
let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OTA_SOFTWARE_UPDATE_REQUESTOR, crate::clusters::defs::CLUSTER_OTA_SOFTWARE_UPDATE_REQUESTOR_ATTR_ID_UPDATESTATEPROGRESS).await?;
decode_update_state_progress(&tlv)
}
#[derive(Debug, serde::Serialize)]
pub struct StateTransitionEvent {
pub previous_state: Option<UpdateState>,
pub new_state: Option<UpdateState>,
pub reason: Option<ChangeReason>,
pub target_software_version: Option<u32>,
}
#[derive(Debug, serde::Serialize)]
pub struct VersionAppliedEvent {
pub software_version: Option<u32>,
pub product_id: Option<u16>,
}
#[derive(Debug, serde::Serialize)]
pub struct DownloadErrorEvent {
pub software_version: Option<u32>,
pub bytes_downloaded: Option<u64>,
pub progress_percent: Option<u8>,
pub platform_code: Option<i64>,
}
pub fn decode_state_transition_event(inp: &tlv::TlvItemValue) -> anyhow::Result<StateTransitionEvent> {
if let tlv::TlvItemValue::List(_fields) = inp {
let item = tlv::TlvItem { tag: 0, value: inp.clone() };
Ok(StateTransitionEvent {
previous_state: item.get_int(&[0]).and_then(|v| UpdateState::from_u8(v as u8)),
new_state: item.get_int(&[1]).and_then(|v| UpdateState::from_u8(v as u8)),
reason: item.get_int(&[2]).and_then(|v| ChangeReason::from_u8(v as u8)),
target_software_version: item.get_int(&[3]).map(|v| v as u32),
})
} else {
Err(anyhow::anyhow!("Expected struct fields"))
}
}
pub fn decode_version_applied_event(inp: &tlv::TlvItemValue) -> anyhow::Result<VersionAppliedEvent> {
if let tlv::TlvItemValue::List(_fields) = inp {
let item = tlv::TlvItem { tag: 0, value: inp.clone() };
Ok(VersionAppliedEvent {
software_version: item.get_int(&[0]).map(|v| v as u32),
product_id: item.get_int(&[1]).map(|v| v as u16),
})
} else {
Err(anyhow::anyhow!("Expected struct fields"))
}
}
pub fn decode_download_error_event(inp: &tlv::TlvItemValue) -> anyhow::Result<DownloadErrorEvent> {
if let tlv::TlvItemValue::List(_fields) = inp {
let item = tlv::TlvItem { tag: 0, value: inp.clone() };
Ok(DownloadErrorEvent {
software_version: item.get_int(&[0]).map(|v| v as u32),
bytes_downloaded: item.get_int(&[1]),
progress_percent: item.get_int(&[2]).map(|v| v as u8),
platform_code: item.get_int(&[3]).map(|v| v as i64),
})
} else {
Err(anyhow::anyhow!("Expected struct fields"))
}
}