matc 0.1.3

Matter protocol library (controller side)
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
//! Matter TLV encoders and decoders for Operational State Cluster
//! Cluster ID: 0x0060
//!
//! This file is automatically generated from OperationalState.xml

#![allow(clippy::too_many_arguments)]

use crate::tlv;
use anyhow;
use serde_json;


// Enum definitions

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[repr(u8)]
pub enum ErrorStateEnum {
    /// The device is not in an error state
    Noerror = 0,
    /// The device is unable to start or resume operation
    Unabletostartorresume = 1,
    /// The device was unable to complete the current operation
    Unabletocompleteoperation = 2,
    /// The device cannot process the command in its current state
    Commandinvalidinstate = 3,
}

impl ErrorStateEnum {
    /// Convert from u8 value
    pub fn from_u8(value: u8) -> Option<Self> {
        match value {
            0 => Some(ErrorStateEnum::Noerror),
            1 => Some(ErrorStateEnum::Unabletostartorresume),
            2 => Some(ErrorStateEnum::Unabletocompleteoperation),
            3 => Some(ErrorStateEnum::Commandinvalidinstate),
            _ => None,
        }
    }

    /// Convert to u8 value
    pub fn to_u8(self) -> u8 {
        self as u8
    }
}

impl From<ErrorStateEnum> for u8 {
    fn from(val: ErrorStateEnum) -> Self {
        val as u8
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[repr(u8)]
pub enum OperationalStateEnum {
    /// The device is stopped
    Stopped = 0,
    /// The device is operating
    Running = 1,
    /// The device is paused during an operation
    Paused = 2,
    /// The device is in an error state
    Error = 3,
}

impl OperationalStateEnum {
    /// Convert from u8 value
    pub fn from_u8(value: u8) -> Option<Self> {
        match value {
            0 => Some(OperationalStateEnum::Stopped),
            1 => Some(OperationalStateEnum::Running),
            2 => Some(OperationalStateEnum::Paused),
            3 => Some(OperationalStateEnum::Error),
            _ => None,
        }
    }

    /// Convert to u8 value
    pub fn to_u8(self) -> u8 {
        self as u8
    }
}

impl From<OperationalStateEnum> for u8 {
    fn from(val: OperationalStateEnum) -> Self {
        val as u8
    }
}

// Struct definitions

#[derive(Debug, serde::Serialize)]
pub struct ErrorState {
    pub error_state_id: Option<ErrorStateEnum>,
    pub error_state_label: Option<String>,
    pub error_state_details: Option<String>,
}

#[derive(Debug, serde::Serialize)]
pub struct OperationalState {
    pub operational_state_id: Option<OperationalStateEnum>,
    pub operational_state_label: Option<String>,
}

// Command encoders

// Attribute decoders

/// Decode PhaseList attribute (0x0000)
pub fn decode_phase_list(inp: &tlv::TlvItemValue) -> anyhow::Result<Vec<String>> {
    let mut res = Vec::new();
    if let tlv::TlvItemValue::List(v) = inp {
        for item in v {
            if let tlv::TlvItemValue::String(s) = &item.value {
                res.push(s.clone());
            }
        }
    }
    Ok(res)
}

/// Decode CurrentPhase attribute (0x0001)
pub fn decode_current_phase(inp: &tlv::TlvItemValue) -> anyhow::Result<Option<u8>> {
    if let tlv::TlvItemValue::Int(v) = inp {
        Ok(Some(*v as u8))
    } else {
        Ok(None)
    }
}

/// Decode CountdownTime attribute (0x0002)
pub fn decode_countdown_time(inp: &tlv::TlvItemValue) -> anyhow::Result<Option<u32>> {
    if let tlv::TlvItemValue::Int(v) = inp {
        Ok(Some(*v as u32))
    } else {
        Ok(None)
    }
}

/// Decode OperationalStateList attribute (0x0003)
pub fn decode_operational_state_list(inp: &tlv::TlvItemValue) -> anyhow::Result<Vec<OperationalState>> {
    let mut res = Vec::new();
    if let tlv::TlvItemValue::List(v) = inp {
        for item in v {
            res.push(OperationalState {
                operational_state_id: item.get_int(&[0]).and_then(|v| OperationalStateEnum::from_u8(v as u8)),
                operational_state_label: item.get_string_owned(&[1]),
            });
        }
    }
    Ok(res)
}

/// Decode OperationalState attribute (0x0004)
pub fn decode_operational_state(inp: &tlv::TlvItemValue) -> anyhow::Result<OperationalStateEnum> {
    if let tlv::TlvItemValue::Int(v) = inp {
        OperationalStateEnum::from_u8(*v as u8).ok_or_else(|| anyhow::anyhow!("Invalid enum value"))
    } else {
        Err(anyhow::anyhow!("Expected Integer"))
    }
}

/// Decode OperationalError attribute (0x0005)
pub fn decode_operational_error(inp: &tlv::TlvItemValue) -> anyhow::Result<ErrorState> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        // Struct with fields
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(ErrorState {
                error_state_id: item.get_int(&[0]).and_then(|v| ErrorStateEnum::from_u8(v as u8)),
                error_state_label: item.get_string_owned(&[1]),
                error_state_details: item.get_string_owned(&[2]),
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}


// JSON dispatcher function

/// Decode attribute value and return as JSON string
///
/// # Parameters
/// * `cluster_id` - The cluster identifier
/// * `attribute_id` - The attribute identifier
/// * `tlv_value` - The TLV value to decode
///
/// # Returns
/// JSON string representation of the decoded value or error
pub fn decode_attribute_json(cluster_id: u32, attribute_id: u32, tlv_value: &crate::tlv::TlvItemValue) -> String {
    // Verify this is the correct cluster
    if cluster_id != 0x0060 {
        return format!("{{\"error\": \"Invalid cluster ID. Expected 0x0060, got {}\"}}", cluster_id);
    }

    match attribute_id {
        0x0000 => {
            match decode_phase_list(tlv_value) {
                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
                Err(e) => format!("{{\"error\": \"{}\"}}", e),
            }
        }
        0x0001 => {
            match decode_current_phase(tlv_value) {
                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
                Err(e) => format!("{{\"error\": \"{}\"}}", e),
            }
        }
        0x0002 => {
            match decode_countdown_time(tlv_value) {
                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
                Err(e) => format!("{{\"error\": \"{}\"}}", e),
            }
        }
        0x0003 => {
            match decode_operational_state_list(tlv_value) {
                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
                Err(e) => format!("{{\"error\": \"{}\"}}", e),
            }
        }
        0x0004 => {
            match decode_operational_state(tlv_value) {
                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
                Err(e) => format!("{{\"error\": \"{}\"}}", e),
            }
        }
        0x0005 => {
            match decode_operational_error(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),
    }
}

/// Get list of all attributes supported by this cluster
///
/// # Returns
/// Vector of tuples containing (attribute_id, attribute_name)
pub fn get_attribute_list() -> Vec<(u32, &'static str)> {
    vec![
        (0x0000, "PhaseList"),
        (0x0001, "CurrentPhase"),
        (0x0002, "CountdownTime"),
        (0x0003, "OperationalStateList"),
        (0x0004, "OperationalState"),
        (0x0005, "OperationalError"),
    ]
}

// Command listing

pub fn get_command_list() -> Vec<(u32, &'static str)> {
    vec![
        (0x00, "Pause"),
        (0x01, "Stop"),
        (0x02, "Start"),
        (0x03, "Resume"),
    ]
}

pub fn get_command_name(cmd_id: u32) -> Option<&'static str> {
    match cmd_id {
        0x00 => Some("Pause"),
        0x01 => Some("Stop"),
        0x02 => Some("Start"),
        0x03 => Some("Resume"),
        _ => None,
    }
}

pub fn get_command_schema(cmd_id: u32) -> Option<Vec<crate::clusters::codec::CommandField>> {
    match cmd_id {
        0x00 => Some(vec![]),
        0x01 => Some(vec![]),
        0x02 => Some(vec![]),
        0x03 => Some(vec![]),
        _ => None,
    }
}

pub fn encode_command_json(cmd_id: u32, _args: &serde_json::Value) -> anyhow::Result<Vec<u8>> {
    match cmd_id {
        0x00 => Ok(vec![]),
        0x01 => Ok(vec![]),
        0x02 => Ok(vec![]),
        0x03 => Ok(vec![]),
        _ => Err(anyhow::anyhow!("unknown command ID: 0x{:02X}", cmd_id)),
    }
}

#[derive(Debug, serde::Serialize)]
pub struct OperationalCommandResponse {
    pub command_response_state: Option<ErrorState>,
}

// Command response decoders

/// Decode OperationalCommandResponse command response (04)
pub fn decode_operational_command_response(inp: &tlv::TlvItemValue) -> anyhow::Result<OperationalCommandResponse> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(OperationalCommandResponse {
                command_response_state: {
                    if let Some(nested_tlv) = item.get(&[0]) {
                        if let tlv::TlvItemValue::List(_) = nested_tlv {
                            let nested_item = tlv::TlvItem { tag: 0, value: nested_tlv.clone() };
                            Some(ErrorState {
                error_state_id: nested_item.get_int(&[0]).and_then(|v| ErrorStateEnum::from_u8(v as u8)),
                error_state_label: nested_item.get_string_owned(&[1]),
                error_state_details: nested_item.get_string_owned(&[2]),
                            })
                        } else {
                            None
                        }
                    } else {
                        None
                    }
                },
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}

// Typed facade (invokes + reads)

/// Invoke `Pause` command on cluster `Operational State`.
pub async fn pause(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<OperationalCommandResponse> {
    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_CMD_ID_PAUSE, &[]).await?;
    decode_operational_command_response(&tlv)
}

/// Invoke `Stop` command on cluster `Operational State`.
pub async fn stop(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<OperationalCommandResponse> {
    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_CMD_ID_STOP, &[]).await?;
    decode_operational_command_response(&tlv)
}

/// Invoke `Start` command on cluster `Operational State`.
pub async fn start(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<OperationalCommandResponse> {
    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_CMD_ID_START, &[]).await?;
    decode_operational_command_response(&tlv)
}

/// Invoke `Resume` command on cluster `Operational State`.
pub async fn resume(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<OperationalCommandResponse> {
    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_CMD_ID_RESUME, &[]).await?;
    decode_operational_command_response(&tlv)
}

/// Read `PhaseList` attribute from cluster `Operational State`.
pub async fn read_phase_list(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Vec<String>> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_ATTR_ID_PHASELIST).await?;
    decode_phase_list(&tlv)
}

/// Read `CurrentPhase` attribute from cluster `Operational State`.
pub async fn read_current_phase(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Option<u8>> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_ATTR_ID_CURRENTPHASE).await?;
    decode_current_phase(&tlv)
}

/// Read `CountdownTime` attribute from cluster `Operational State`.
pub async fn read_countdown_time(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Option<u32>> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_ATTR_ID_COUNTDOWNTIME).await?;
    decode_countdown_time(&tlv)
}

/// Read `OperationalStateList` attribute from cluster `Operational State`.
pub async fn read_operational_state_list(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Vec<OperationalState>> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_ATTR_ID_OPERATIONALSTATELIST).await?;
    decode_operational_state_list(&tlv)
}

/// Read `OperationalState` attribute from cluster `Operational State`.
pub async fn read_operational_state(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<OperationalStateEnum> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_ATTR_ID_OPERATIONALSTATE).await?;
    decode_operational_state(&tlv)
}

/// Read `OperationalError` attribute from cluster `Operational State`.
pub async fn read_operational_error(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<ErrorState> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_OPERATIONAL_STATE, crate::clusters::defs::CLUSTER_OPERATIONAL_STATE_ATTR_ID_OPERATIONALERROR).await?;
    decode_operational_error(&tlv)
}

#[derive(Debug, serde::Serialize)]
pub struct OperationalErrorEvent {
    pub error_state: Option<ErrorState>,
}

#[derive(Debug, serde::Serialize)]
pub struct OperationCompletionEvent {
    pub completion_error_code: Option<u8>,
    pub total_operational_time: Option<u32>,
    pub paused_time: Option<u32>,
}

// Event decoders

/// Decode OperationalError event (0x00, priority: critical)
pub fn decode_operational_error_event(inp: &tlv::TlvItemValue) -> anyhow::Result<OperationalErrorEvent> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(OperationalErrorEvent {
                                error_state: {
                    if let Some(nested_tlv) = item.get(&[0]) {
                        if let tlv::TlvItemValue::List(_) = nested_tlv {
                            let nested_item = tlv::TlvItem { tag: 0, value: nested_tlv.clone() };
                            Some(ErrorState {
                error_state_id: nested_item.get_int(&[0]).and_then(|v| ErrorStateEnum::from_u8(v as u8)),
                error_state_label: nested_item.get_string_owned(&[1]),
                error_state_details: nested_item.get_string_owned(&[2]),
                            })
                        } else {
                            None
                        }
                    } else {
                        None
                    }
                },
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}

/// Decode OperationCompletion event (0x01, priority: info)
pub fn decode_operation_completion_event(inp: &tlv::TlvItemValue) -> anyhow::Result<OperationCompletionEvent> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(OperationCompletionEvent {
                                completion_error_code: item.get_int(&[0]).map(|v| v as u8),
                                total_operational_time: item.get_int(&[1]).map(|v| v as u32),
                                paused_time: item.get_int(&[2]).map(|v| v as u32),
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}