matc/clusters/codec/
web_rtc_provider.rs

1//! Matter TLV encoders and decoders for WebRTC Transport Provider Cluster
2//! Cluster IDs: 0x0553
3//!
4//! This file is automatically generated from WebRTC_Provider.xml
5
6#![allow(clippy::too_many_arguments)]
7
8use crate::tlv;
9use anyhow;
10use serde_json;
11
12
13// Command encoders
14
15/// Parameters for SolicitOffer command
16pub struct SolicitOfferParams {
17    pub stream_usage: u8,
18    pub originating_endpoint_id: u16,
19    pub video_stream_id: Option<u16>,
20    pub audio_stream_id: Option<u16>,
21    pub ice_transport_policy: Option<String>,
22    pub metadata_enabled: bool,
23    pub video_streams: Option<Vec<u16>>,
24    pub audio_streams: Option<Vec<u16>>,
25}
26
27/// Encode SolicitOffer command (0x00)
28pub fn encode_solicit_offer(params: SolicitOfferParams) -> anyhow::Result<Vec<u8>> {
29    let mut tlv_fields: Vec<tlv::TlvItemEnc> = Vec::new();
30    tlv_fields.push((0, tlv::TlvItemValueEnc::UInt8(params.stream_usage)).into());
31    tlv_fields.push((1, tlv::TlvItemValueEnc::UInt16(params.originating_endpoint_id)).into());
32    tlv_fields.push((2, tlv::TlvItemValueEnc::UInt16(params.video_stream_id.unwrap_or(0))).into());
33    tlv_fields.push((3, tlv::TlvItemValueEnc::UInt16(params.audio_stream_id.unwrap_or(0))).into());
34    if let Some(x) = params.ice_transport_policy { tlv_fields.push((5, tlv::TlvItemValueEnc::String(x)).into()); }
35    tlv_fields.push((6, tlv::TlvItemValueEnc::Bool(params.metadata_enabled)).into());
36    if let Some(video_streams) = params.video_streams {
37        tlv_fields.push((8, tlv::TlvItemValueEnc::StructAnon(video_streams.into_iter().map(|v| (0, tlv::TlvItemValueEnc::UInt16(v)).into()).collect())).into());
38    }
39    if let Some(audio_streams) = params.audio_streams {
40        tlv_fields.push((9, tlv::TlvItemValueEnc::StructAnon(audio_streams.into_iter().map(|v| (0, tlv::TlvItemValueEnc::UInt16(v)).into()).collect())).into());
41    }
42    let tlv = tlv::TlvItemEnc {
43        tag: 0,
44        value: tlv::TlvItemValueEnc::StructInvisible(tlv_fields),
45    };
46    Ok(tlv.encode()?)
47}
48
49/// Parameters for ProvideOffer command
50pub struct ProvideOfferParams {
51    pub web_rtc_session_id: Option<u8>,
52    pub sdp: String,
53    pub stream_usage: Option<u8>,
54    pub originating_endpoint_id: Option<u16>,
55    pub video_stream_id: Option<u16>,
56    pub audio_stream_id: Option<u16>,
57    pub ice_transport_policy: Option<String>,
58    pub metadata_enabled: bool,
59    pub video_streams: Option<Vec<u16>>,
60    pub audio_streams: Option<Vec<u16>>,
61}
62
63/// Encode ProvideOffer command (0x02)
64pub fn encode_provide_offer(params: ProvideOfferParams) -> anyhow::Result<Vec<u8>> {
65    let mut tlv_fields: Vec<tlv::TlvItemEnc> = Vec::new();
66    tlv_fields.push((0, tlv::TlvItemValueEnc::UInt8(params.web_rtc_session_id.unwrap_or(0))).into());
67    tlv_fields.push((1, tlv::TlvItemValueEnc::String(params.sdp)).into());
68    if let Some(x) = params.stream_usage { tlv_fields.push((2, tlv::TlvItemValueEnc::UInt8(x)).into()); }
69    if let Some(x) = params.originating_endpoint_id { tlv_fields.push((3, tlv::TlvItemValueEnc::UInt16(x)).into()); }
70    tlv_fields.push((4, tlv::TlvItemValueEnc::UInt16(params.video_stream_id.unwrap_or(0))).into());
71    tlv_fields.push((5, tlv::TlvItemValueEnc::UInt16(params.audio_stream_id.unwrap_or(0))).into());
72    if let Some(x) = params.ice_transport_policy { tlv_fields.push((7, tlv::TlvItemValueEnc::String(x)).into()); }
73    tlv_fields.push((8, tlv::TlvItemValueEnc::Bool(params.metadata_enabled)).into());
74    if let Some(video_streams) = params.video_streams {
75        tlv_fields.push((10, tlv::TlvItemValueEnc::StructAnon(video_streams.into_iter().map(|v| (0, tlv::TlvItemValueEnc::UInt16(v)).into()).collect())).into());
76    }
77    if let Some(audio_streams) = params.audio_streams {
78        tlv_fields.push((11, tlv::TlvItemValueEnc::StructAnon(audio_streams.into_iter().map(|v| (0, tlv::TlvItemValueEnc::UInt16(v)).into()).collect())).into());
79    }
80    let tlv = tlv::TlvItemEnc {
81        tag: 0,
82        value: tlv::TlvItemValueEnc::StructInvisible(tlv_fields),
83    };
84    Ok(tlv.encode()?)
85}
86
87/// Encode ProvideAnswer command (0x04)
88pub fn encode_provide_answer(web_rtc_session_id: u8, sdp: String) -> anyhow::Result<Vec<u8>> {
89    let tlv = tlv::TlvItemEnc {
90        tag: 0,
91        value: tlv::TlvItemValueEnc::StructInvisible(vec![
92        (0, tlv::TlvItemValueEnc::UInt8(web_rtc_session_id)).into(),
93        (1, tlv::TlvItemValueEnc::String(sdp)).into(),
94        ]),
95    };
96    Ok(tlv.encode()?)
97}
98
99/// Encode ProvideICECandidates command (0x05)
100pub fn encode_provide_ice_candidates(web_rtc_session_id: u8) -> anyhow::Result<Vec<u8>> {
101    let tlv = tlv::TlvItemEnc {
102        tag: 0,
103        value: tlv::TlvItemValueEnc::StructInvisible(vec![
104        (0, tlv::TlvItemValueEnc::UInt8(web_rtc_session_id)).into(),
105        ]),
106    };
107    Ok(tlv.encode()?)
108}
109
110/// Encode EndSession command (0x06)
111pub fn encode_end_session(web_rtc_session_id: u8, reason: u8) -> anyhow::Result<Vec<u8>> {
112    let tlv = tlv::TlvItemEnc {
113        tag: 0,
114        value: tlv::TlvItemValueEnc::StructInvisible(vec![
115        (0, tlv::TlvItemValueEnc::UInt8(web_rtc_session_id)).into(),
116        (1, tlv::TlvItemValueEnc::UInt8(reason)).into(),
117        ]),
118    };
119    Ok(tlv.encode()?)
120}
121
122// Attribute decoders
123
124/// Decode CurrentSessions attribute (0x0000)
125pub fn decode_current_sessions(inp: &tlv::TlvItemValue) -> anyhow::Result<Vec<u8>> {
126    let mut res = Vec::new();
127    if let tlv::TlvItemValue::List(v) = inp {
128        for item in v {
129            if let tlv::TlvItemValue::Int(i) = &item.value {
130                res.push(*i as u8);
131            }
132        }
133    }
134    Ok(res)
135}
136
137
138// JSON dispatcher function
139
140/// Decode attribute value and return as JSON string
141///
142/// # Parameters
143/// * `cluster_id` - The cluster identifier
144/// * `attribute_id` - The attribute identifier
145/// * `tlv_value` - The TLV value to decode
146///
147/// # Returns
148/// JSON string representation of the decoded value or error
149pub fn decode_attribute_json(cluster_id: u32, attribute_id: u32, tlv_value: &crate::tlv::TlvItemValue) -> String {
150    // Verify this is the correct cluster
151    if ![0x0553].contains(&cluster_id) {
152        return format!("{{\"error\": \"Invalid cluster ID. Expected [0x0553], got {}\"}}", cluster_id);
153    }
154
155    match attribute_id {
156        0x0000 => {
157            match decode_current_sessions(tlv_value) {
158                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
159                Err(e) => format!("{{\"error\": \"{}\"}}", e),
160            }
161        }
162        _ => format!("{{\"error\": \"Unknown attribute ID: {}\"}}", attribute_id),
163    }
164}
165
166/// Get list of all attributes supported by this cluster
167///
168/// # Returns
169/// Vector of tuples containing (attribute_id, attribute_name)
170pub fn get_attribute_list() -> Vec<(u32, &'static str)> {
171    vec![
172        (0x0000, "CurrentSessions"),
173    ]
174}
175
176// Command listing
177
178pub fn get_command_list() -> Vec<(u32, &'static str)> {
179    vec![
180        (0x00, "SolicitOffer"),
181        (0x02, "ProvideOffer"),
182        (0x04, "ProvideAnswer"),
183        (0x05, "ProvideICECandidates"),
184        (0x06, "EndSession"),
185    ]
186}
187
188pub fn get_command_name(cmd_id: u32) -> Option<&'static str> {
189    match cmd_id {
190        0x00 => Some("SolicitOffer"),
191        0x02 => Some("ProvideOffer"),
192        0x04 => Some("ProvideAnswer"),
193        0x05 => Some("ProvideICECandidates"),
194        0x06 => Some("EndSession"),
195        _ => None,
196    }
197}
198
199pub fn get_command_schema(cmd_id: u32) -> Option<Vec<crate::clusters::codec::CommandField>> {
200    match cmd_id {
201        0x00 => Some(vec![
202            crate::clusters::codec::CommandField { tag: 0, name: "stream_usage", kind: crate::clusters::codec::FieldKind::U8, optional: false, nullable: false },
203            crate::clusters::codec::CommandField { tag: 1, name: "originating_endpoint_id", kind: crate::clusters::codec::FieldKind::U16, optional: false, nullable: false },
204            crate::clusters::codec::CommandField { tag: 2, name: "video_stream_id", kind: crate::clusters::codec::FieldKind::U16, optional: true, nullable: true },
205            crate::clusters::codec::CommandField { tag: 3, name: "audio_stream_id", kind: crate::clusters::codec::FieldKind::U16, optional: true, nullable: true },
206            crate::clusters::codec::CommandField { tag: 5, name: "ice_transport_policy", kind: crate::clusters::codec::FieldKind::String, optional: true, nullable: false },
207            crate::clusters::codec::CommandField { tag: 6, name: "metadata_enabled", kind: crate::clusters::codec::FieldKind::Bool, optional: false, nullable: false },
208            crate::clusters::codec::CommandField { tag: 8, name: "video_streams", kind: crate::clusters::codec::FieldKind::List { entry_type: "uint16" }, optional: true, nullable: false },
209            crate::clusters::codec::CommandField { tag: 9, name: "audio_streams", kind: crate::clusters::codec::FieldKind::List { entry_type: "uint16" }, optional: true, nullable: false },
210        ]),
211        0x02 => Some(vec![
212            crate::clusters::codec::CommandField { tag: 0, name: "web_rtc_session_id", kind: crate::clusters::codec::FieldKind::U32, optional: false, nullable: true },
213            crate::clusters::codec::CommandField { tag: 1, name: "sdp", kind: crate::clusters::codec::FieldKind::String, optional: false, nullable: false },
214            crate::clusters::codec::CommandField { tag: 2, name: "stream_usage", kind: crate::clusters::codec::FieldKind::U8, optional: true, nullable: false },
215            crate::clusters::codec::CommandField { tag: 3, name: "originating_endpoint_id", kind: crate::clusters::codec::FieldKind::U16, optional: true, nullable: false },
216            crate::clusters::codec::CommandField { tag: 4, name: "video_stream_id", kind: crate::clusters::codec::FieldKind::U16, optional: true, nullable: true },
217            crate::clusters::codec::CommandField { tag: 5, name: "audio_stream_id", kind: crate::clusters::codec::FieldKind::U16, optional: true, nullable: true },
218            crate::clusters::codec::CommandField { tag: 7, name: "ice_transport_policy", kind: crate::clusters::codec::FieldKind::String, optional: true, nullable: false },
219            crate::clusters::codec::CommandField { tag: 8, name: "metadata_enabled", kind: crate::clusters::codec::FieldKind::Bool, optional: false, nullable: false },
220            crate::clusters::codec::CommandField { tag: 10, name: "video_streams", kind: crate::clusters::codec::FieldKind::List { entry_type: "uint16" }, optional: true, nullable: false },
221            crate::clusters::codec::CommandField { tag: 11, name: "audio_streams", kind: crate::clusters::codec::FieldKind::List { entry_type: "uint16" }, optional: true, nullable: false },
222        ]),
223        0x04 => Some(vec![
224            crate::clusters::codec::CommandField { tag: 0, name: "web_rtc_session_id", kind: crate::clusters::codec::FieldKind::U32, optional: false, nullable: false },
225            crate::clusters::codec::CommandField { tag: 1, name: "sdp", kind: crate::clusters::codec::FieldKind::String, optional: false, nullable: false },
226        ]),
227        0x05 => Some(vec![
228            crate::clusters::codec::CommandField { tag: 0, name: "web_rtc_session_id", kind: crate::clusters::codec::FieldKind::U32, optional: false, nullable: false },
229        ]),
230        0x06 => Some(vec![
231            crate::clusters::codec::CommandField { tag: 0, name: "web_rtc_session_id", kind: crate::clusters::codec::FieldKind::U32, optional: false, nullable: false },
232            crate::clusters::codec::CommandField { tag: 1, name: "reason", kind: crate::clusters::codec::FieldKind::U8, optional: false, nullable: false },
233        ]),
234        _ => None,
235    }
236}
237
238pub fn encode_command_json(cmd_id: u32, args: &serde_json::Value) -> anyhow::Result<Vec<u8>> {
239    match cmd_id {
240        0x00 => Err(anyhow::anyhow!("command \"SolicitOffer\" has complex args: use raw mode")),
241        0x02 => Err(anyhow::anyhow!("command \"ProvideOffer\" has complex args: use raw mode")),
242        0x04 => {
243        let web_rtc_session_id = crate::clusters::codec::json_util::get_u8(args, "web_rtc_session_id")?;
244        let sdp = crate::clusters::codec::json_util::get_string(args, "sdp")?;
245        encode_provide_answer(web_rtc_session_id, sdp)
246        }
247        0x05 => {
248        let web_rtc_session_id = crate::clusters::codec::json_util::get_u8(args, "web_rtc_session_id")?;
249        encode_provide_ice_candidates(web_rtc_session_id)
250        }
251        0x06 => {
252        let web_rtc_session_id = crate::clusters::codec::json_util::get_u8(args, "web_rtc_session_id")?;
253        let reason = crate::clusters::codec::json_util::get_u8(args, "reason")?;
254        encode_end_session(web_rtc_session_id, reason)
255        }
256        _ => Err(anyhow::anyhow!("unknown command ID: 0x{:02X}", cmd_id)),
257    }
258}
259
260#[derive(Debug, serde::Serialize)]
261pub struct SolicitOfferResponse {
262    pub web_rtc_session_id: Option<u8>,
263    pub deferred_offer: Option<bool>,
264    pub video_stream_id: Option<u16>,
265    pub audio_stream_id: Option<u16>,
266}
267
268#[derive(Debug, serde::Serialize)]
269pub struct ProvideOfferResponse {
270    pub web_rtc_session_id: Option<u8>,
271    pub video_stream_id: Option<u16>,
272    pub audio_stream_id: Option<u16>,
273}
274
275// Command response decoders
276
277/// Decode SolicitOfferResponse command response (01)
278pub fn decode_solicit_offer_response(inp: &tlv::TlvItemValue) -> anyhow::Result<SolicitOfferResponse> {
279    if let tlv::TlvItemValue::List(_fields) = inp {
280        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
281        Ok(SolicitOfferResponse {
282                web_rtc_session_id: item.get_int(&[0]).map(|v| v as u8),
283                deferred_offer: item.get_bool(&[1]),
284                video_stream_id: item.get_int(&[2]).map(|v| v as u16),
285                audio_stream_id: item.get_int(&[3]).map(|v| v as u16),
286        })
287    } else {
288        Err(anyhow::anyhow!("Expected struct fields"))
289    }
290}
291
292/// Decode ProvideOfferResponse command response (03)
293pub fn decode_provide_offer_response(inp: &tlv::TlvItemValue) -> anyhow::Result<ProvideOfferResponse> {
294    if let tlv::TlvItemValue::List(_fields) = inp {
295        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
296        Ok(ProvideOfferResponse {
297                web_rtc_session_id: item.get_int(&[0]).map(|v| v as u8),
298                video_stream_id: item.get_int(&[1]).map(|v| v as u16),
299                audio_stream_id: item.get_int(&[2]).map(|v| v as u16),
300        })
301    } else {
302        Err(anyhow::anyhow!("Expected struct fields"))
303    }
304}
305
306// Typed facade (invokes + reads)
307
308/// Invoke `SolicitOffer` command on cluster `WebRTC Transport Provider`.
309pub async fn solicit_offer(conn: &crate::controller::Connection, endpoint: u16, params: SolicitOfferParams) -> anyhow::Result<SolicitOfferResponse> {
310    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_WEBRTC_TRANSPORT_PROVIDER, crate::clusters::defs::CLUSTER_WEBRTC_TRANSPORT_PROVIDER_CMD_ID_SOLICITOFFER, &encode_solicit_offer(params)?).await?;
311    decode_solicit_offer_response(&tlv)
312}
313
314/// Invoke `ProvideOffer` command on cluster `WebRTC Transport Provider`.
315pub async fn provide_offer(conn: &crate::controller::Connection, endpoint: u16, params: ProvideOfferParams) -> anyhow::Result<ProvideOfferResponse> {
316    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_WEBRTC_TRANSPORT_PROVIDER, crate::clusters::defs::CLUSTER_WEBRTC_TRANSPORT_PROVIDER_CMD_ID_PROVIDEOFFER, &encode_provide_offer(params)?).await?;
317    decode_provide_offer_response(&tlv)
318}
319
320/// Invoke `ProvideAnswer` command on cluster `WebRTC Transport Provider`.
321pub async fn provide_answer(conn: &crate::controller::Connection, endpoint: u16, web_rtc_session_id: u8, sdp: String) -> anyhow::Result<()> {
322    conn.invoke_request(endpoint, crate::clusters::defs::CLUSTER_ID_WEBRTC_TRANSPORT_PROVIDER, crate::clusters::defs::CLUSTER_WEBRTC_TRANSPORT_PROVIDER_CMD_ID_PROVIDEANSWER, &encode_provide_answer(web_rtc_session_id, sdp)?).await?;
323    Ok(())
324}
325
326/// Invoke `ProvideICECandidates` command on cluster `WebRTC Transport Provider`.
327pub async fn provide_ice_candidates(conn: &crate::controller::Connection, endpoint: u16, web_rtc_session_id: u8) -> anyhow::Result<()> {
328    conn.invoke_request(endpoint, crate::clusters::defs::CLUSTER_ID_WEBRTC_TRANSPORT_PROVIDER, crate::clusters::defs::CLUSTER_WEBRTC_TRANSPORT_PROVIDER_CMD_ID_PROVIDEICECANDIDATES, &encode_provide_ice_candidates(web_rtc_session_id)?).await?;
329    Ok(())
330}
331
332/// Invoke `EndSession` command on cluster `WebRTC Transport Provider`.
333pub async fn end_session(conn: &crate::controller::Connection, endpoint: u16, web_rtc_session_id: u8, reason: u8) -> anyhow::Result<()> {
334    conn.invoke_request(endpoint, crate::clusters::defs::CLUSTER_ID_WEBRTC_TRANSPORT_PROVIDER, crate::clusters::defs::CLUSTER_WEBRTC_TRANSPORT_PROVIDER_CMD_ID_ENDSESSION, &encode_end_session(web_rtc_session_id, reason)?).await?;
335    Ok(())
336}
337
338/// Read `CurrentSessions` attribute from cluster `WebRTC Transport Provider`.
339pub async fn read_current_sessions(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Vec<u8>> {
340    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_WEBRTC_TRANSPORT_PROVIDER, crate::clusters::defs::CLUSTER_WEBRTC_TRANSPORT_PROVIDER_ATTR_ID_CURRENTSESSIONS).await?;
341    decode_current_sessions(&tlv)
342}
343
matc/clusters/codec/web_rtc_provider.rs

matc/clusters/codec/
web_rtc_provider.rs
