matc/clusters/codec/
thread_border_router_management.rs

1//! Matter TLV encoders and decoders for Thread Border Router Management Cluster
2//! Cluster ID: 0x0452
3//!
4//! This file is automatically generated from ThreadBorderRouterManagement.xml
5
6#![allow(clippy::too_many_arguments)]
7
8use crate::tlv;
9use anyhow;
10use serde_json;
11
12
13// Import serialization helpers for octet strings
14use crate::clusters::helpers::{serialize_opt_bytes_as_hex};
15
16// Command encoders
17
18/// Encode SetActiveDatasetRequest command (0x03)
19pub fn encode_set_active_dataset_request(active_dataset: Vec<u8>, breadcrumb: u64) -> anyhow::Result<Vec<u8>> {
20    let tlv = tlv::TlvItemEnc {
21        tag: 0,
22        value: tlv::TlvItemValueEnc::StructInvisible(vec![
23        (0, tlv::TlvItemValueEnc::OctetString(active_dataset)).into(),
24        (1, tlv::TlvItemValueEnc::UInt64(breadcrumb)).into(),
25        ]),
26    };
27    Ok(tlv.encode()?)
28}
29
30/// Encode SetPendingDatasetRequest command (0x04)
31pub fn encode_set_pending_dataset_request(pending_dataset: Vec<u8>) -> anyhow::Result<Vec<u8>> {
32    let tlv = tlv::TlvItemEnc {
33        tag: 0,
34        value: tlv::TlvItemValueEnc::StructInvisible(vec![
35        (0, tlv::TlvItemValueEnc::OctetString(pending_dataset)).into(),
36        ]),
37    };
38    Ok(tlv.encode()?)
39}
40
41// Attribute decoders
42
43/// Decode BorderRouterName attribute (0x0000)
44pub fn decode_border_router_name(inp: &tlv::TlvItemValue) -> anyhow::Result<String> {
45    if let tlv::TlvItemValue::String(v) = inp {
46        Ok(v.clone())
47    } else {
48        Err(anyhow::anyhow!("Expected String"))
49    }
50}
51
52/// Decode BorderAgentID attribute (0x0001)
53pub fn decode_border_agent_id(inp: &tlv::TlvItemValue) -> anyhow::Result<Vec<u8>> {
54    if let tlv::TlvItemValue::OctetString(v) = inp {
55        Ok(v.clone())
56    } else {
57        Err(anyhow::anyhow!("Expected OctetString"))
58    }
59}
60
61/// Decode ThreadVersion attribute (0x0002)
62pub fn decode_thread_version(inp: &tlv::TlvItemValue) -> anyhow::Result<u16> {
63    if let tlv::TlvItemValue::Int(v) = inp {
64        Ok(*v as u16)
65    } else {
66        Err(anyhow::anyhow!("Expected UInt16"))
67    }
68}
69
70/// Decode InterfaceEnabled attribute (0x0003)
71pub fn decode_interface_enabled(inp: &tlv::TlvItemValue) -> anyhow::Result<bool> {
72    if let tlv::TlvItemValue::Bool(v) = inp {
73        Ok(*v)
74    } else {
75        Err(anyhow::anyhow!("Expected Bool"))
76    }
77}
78
79/// Decode ActiveDatasetTimestamp attribute (0x0004)
80pub fn decode_active_dataset_timestamp(inp: &tlv::TlvItemValue) -> anyhow::Result<Option<u64>> {
81    if let tlv::TlvItemValue::Int(v) = inp {
82        Ok(Some(*v))
83    } else {
84        Ok(None)
85    }
86}
87
88/// Decode PendingDatasetTimestamp attribute (0x0005)
89pub fn decode_pending_dataset_timestamp(inp: &tlv::TlvItemValue) -> anyhow::Result<Option<u64>> {
90    if let tlv::TlvItemValue::Int(v) = inp {
91        Ok(Some(*v))
92    } else {
93        Ok(None)
94    }
95}
96
97
98// JSON dispatcher function
99
100/// Decode attribute value and return as JSON string
101///
102/// # Parameters
103/// * `cluster_id` - The cluster identifier
104/// * `attribute_id` - The attribute identifier
105/// * `tlv_value` - The TLV value to decode
106///
107/// # Returns
108/// JSON string representation of the decoded value or error
109pub fn decode_attribute_json(cluster_id: u32, attribute_id: u32, tlv_value: &crate::tlv::TlvItemValue) -> String {
110    // Verify this is the correct cluster
111    if cluster_id != 0x0452 {
112        return format!("{{\"error\": \"Invalid cluster ID. Expected 0x0452, got {}\"}}", cluster_id);
113    }
114
115    match attribute_id {
116        0x0000 => {
117            match decode_border_router_name(tlv_value) {
118                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
119                Err(e) => format!("{{\"error\": \"{}\"}}", e),
120            }
121        }
122        0x0001 => {
123            match decode_border_agent_id(tlv_value) {
124                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
125                Err(e) => format!("{{\"error\": \"{}\"}}", e),
126            }
127        }
128        0x0002 => {
129            match decode_thread_version(tlv_value) {
130                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
131                Err(e) => format!("{{\"error\": \"{}\"}}", e),
132            }
133        }
134        0x0003 => {
135            match decode_interface_enabled(tlv_value) {
136                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
137                Err(e) => format!("{{\"error\": \"{}\"}}", e),
138            }
139        }
140        0x0004 => {
141            match decode_active_dataset_timestamp(tlv_value) {
142                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
143                Err(e) => format!("{{\"error\": \"{}\"}}", e),
144            }
145        }
146        0x0005 => {
147            match decode_pending_dataset_timestamp(tlv_value) {
148                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
149                Err(e) => format!("{{\"error\": \"{}\"}}", e),
150            }
151        }
152        _ => format!("{{\"error\": \"Unknown attribute ID: {}\"}}", attribute_id),
153    }
154}
155
156/// Get list of all attributes supported by this cluster
157///
158/// # Returns
159/// Vector of tuples containing (attribute_id, attribute_name)
160pub fn get_attribute_list() -> Vec<(u32, &'static str)> {
161    vec![
162        (0x0000, "BorderRouterName"),
163        (0x0001, "BorderAgentID"),
164        (0x0002, "ThreadVersion"),
165        (0x0003, "InterfaceEnabled"),
166        (0x0004, "ActiveDatasetTimestamp"),
167        (0x0005, "PendingDatasetTimestamp"),
168    ]
169}
170
171// Command listing
172
173pub fn get_command_list() -> Vec<(u32, &'static str)> {
174    vec![
175        (0x00, "GetActiveDatasetRequest"),
176        (0x01, "GetPendingDatasetRequest"),
177        (0x03, "SetActiveDatasetRequest"),
178        (0x04, "SetPendingDatasetRequest"),
179    ]
180}
181
182pub fn get_command_name(cmd_id: u32) -> Option<&'static str> {
183    match cmd_id {
184        0x00 => Some("GetActiveDatasetRequest"),
185        0x01 => Some("GetPendingDatasetRequest"),
186        0x03 => Some("SetActiveDatasetRequest"),
187        0x04 => Some("SetPendingDatasetRequest"),
188        _ => None,
189    }
190}
191
192pub fn get_command_schema(cmd_id: u32) -> Option<Vec<crate::clusters::codec::CommandField>> {
193    match cmd_id {
194        0x00 => Some(vec![]),
195        0x01 => Some(vec![]),
196        0x03 => Some(vec![
197            crate::clusters::codec::CommandField { tag: 0, name: "active_dataset", kind: crate::clusters::codec::FieldKind::OctetString, optional: false, nullable: false },
198            crate::clusters::codec::CommandField { tag: 1, name: "breadcrumb", kind: crate::clusters::codec::FieldKind::U64, optional: true, nullable: false },
199        ]),
200        0x04 => Some(vec![
201            crate::clusters::codec::CommandField { tag: 0, name: "pending_dataset", kind: crate::clusters::codec::FieldKind::OctetString, optional: false, nullable: false },
202        ]),
203        _ => None,
204    }
205}
206
207pub fn encode_command_json(cmd_id: u32, args: &serde_json::Value) -> anyhow::Result<Vec<u8>> {
208    match cmd_id {
209        0x00 => Ok(vec![]),
210        0x01 => Ok(vec![]),
211        0x03 => {
212        let active_dataset = crate::clusters::codec::json_util::get_octstr(args, "active_dataset")?;
213        let breadcrumb = crate::clusters::codec::json_util::get_u64(args, "breadcrumb")?;
214        encode_set_active_dataset_request(active_dataset, breadcrumb)
215        }
216        0x04 => {
217        let pending_dataset = crate::clusters::codec::json_util::get_octstr(args, "pending_dataset")?;
218        encode_set_pending_dataset_request(pending_dataset)
219        }
220        _ => Err(anyhow::anyhow!("unknown command ID: 0x{:02X}", cmd_id)),
221    }
222}
223
224#[derive(Debug, serde::Serialize)]
225pub struct DatasetResponse {
226    #[serde(serialize_with = "serialize_opt_bytes_as_hex")]
227    pub dataset: Option<Vec<u8>>,
228}
229
230// Command response decoders
231
232/// Decode DatasetResponse command response (02)
233pub fn decode_dataset_response(inp: &tlv::TlvItemValue) -> anyhow::Result<DatasetResponse> {
234    if let tlv::TlvItemValue::List(_fields) = inp {
235        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
236        Ok(DatasetResponse {
237                dataset: item.get_octet_string_owned(&[0]),
238        })
239    } else {
240        Err(anyhow::anyhow!("Expected struct fields"))
241    }
242}
243
244// Typed facade (invokes + reads)
245
246/// Invoke `GetActiveDatasetRequest` command on cluster `Thread Border Router Management`.
247pub async fn get_active_dataset_request(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<DatasetResponse> {
248    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_CMD_ID_GETACTIVEDATASETREQUEST, &[]).await?;
249    decode_dataset_response(&tlv)
250}
251
252/// Invoke `GetPendingDatasetRequest` command on cluster `Thread Border Router Management`.
253pub async fn get_pending_dataset_request(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<DatasetResponse> {
254    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_CMD_ID_GETPENDINGDATASETREQUEST, &[]).await?;
255    decode_dataset_response(&tlv)
256}
257
258/// Invoke `SetActiveDatasetRequest` command on cluster `Thread Border Router Management`.
259pub async fn set_active_dataset_request(conn: &crate::controller::Connection, endpoint: u16, active_dataset: Vec<u8>, breadcrumb: u64) -> anyhow::Result<()> {
260    conn.invoke_request(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_CMD_ID_SETACTIVEDATASETREQUEST, &encode_set_active_dataset_request(active_dataset, breadcrumb)?).await?;
261    Ok(())
262}
263
264/// Invoke `SetPendingDatasetRequest` command on cluster `Thread Border Router Management`.
265pub async fn set_pending_dataset_request(conn: &crate::controller::Connection, endpoint: u16, pending_dataset: Vec<u8>) -> anyhow::Result<()> {
266    conn.invoke_request(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_CMD_ID_SETPENDINGDATASETREQUEST, &encode_set_pending_dataset_request(pending_dataset)?).await?;
267    Ok(())
268}
269
270/// Read `BorderRouterName` attribute from cluster `Thread Border Router Management`.
271pub async fn read_border_router_name(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<String> {
272    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_ATTR_ID_BORDERROUTERNAME).await?;
273    decode_border_router_name(&tlv)
274}
275
276/// Read `BorderAgentID` attribute from cluster `Thread Border Router Management`.
277pub async fn read_border_agent_id(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Vec<u8>> {
278    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_ATTR_ID_BORDERAGENTID).await?;
279    decode_border_agent_id(&tlv)
280}
281
282/// Read `ThreadVersion` attribute from cluster `Thread Border Router Management`.
283pub async fn read_thread_version(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<u16> {
284    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_ATTR_ID_THREADVERSION).await?;
285    decode_thread_version(&tlv)
286}
287
288/// Read `InterfaceEnabled` attribute from cluster `Thread Border Router Management`.
289pub async fn read_interface_enabled(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<bool> {
290    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_ATTR_ID_INTERFACEENABLED).await?;
291    decode_interface_enabled(&tlv)
292}
293
294/// Read `ActiveDatasetTimestamp` attribute from cluster `Thread Border Router Management`.
295pub async fn read_active_dataset_timestamp(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Option<u64>> {
296    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_ATTR_ID_ACTIVEDATASETTIMESTAMP).await?;
297    decode_active_dataset_timestamp(&tlv)
298}
299
300/// Read `PendingDatasetTimestamp` attribute from cluster `Thread Border Router Management`.
301pub async fn read_pending_dataset_timestamp(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Option<u64>> {
302    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_THREAD_BORDER_ROUTER_MANAGEMENT, crate::clusters::defs::CLUSTER_THREAD_BORDER_ROUTER_MANAGEMENT_ATTR_ID_PENDINGDATASETTIMESTAMP).await?;
303    decode_pending_dataset_timestamp(&tlv)
304}
305
matc/clusters/codec/thread_border_router_management.rs

matc/clusters/codec/
thread_border_router_management.rs
