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

//! Matter TLV encoders and decoders for Diagnostic Logs Cluster
//! Cluster ID: 0x0032
//!
//! This file is automatically generated from DiagnosticLogsCluster.xml

#![allow(clippy::too_many_arguments)]

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


// Import serialization helpers for octet strings
use crate::clusters::helpers::{serialize_opt_bytes_as_hex};

// Enum definitions

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[repr(u8)]
pub enum Intent {
    /// Logs to be used for end-user support
    Endusersupport = 0,
    /// Logs to be used for network diagnostics
    Networkdiag = 1,
    /// Obtain crash logs from the Node
    Crashlogs = 2,
}

impl Intent {
    /// Convert from u8 value
    pub fn from_u8(value: u8) -> Option<Self> {
        match value {
            0 => Some(Intent::Endusersupport),
            1 => Some(Intent::Networkdiag),
            2 => Some(Intent::Crashlogs),
            _ => None,
        }
    }

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

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

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[repr(u8)]
pub enum Status {
    /// Successful transfer of logs
    Success = 0,
    /// All logs have been transferred
    Exhausted = 1,
    /// No logs of the requested type available
    Nologs = 2,
    /// Unable to handle request, retry later
    Busy = 3,
    /// The request is denied, no logs being transferred
    Denied = 4,
}

impl Status {
    /// Convert from u8 value
    pub fn from_u8(value: u8) -> Option<Self> {
        match value {
            0 => Some(Status::Success),
            1 => Some(Status::Exhausted),
            2 => Some(Status::Nologs),
            3 => Some(Status::Busy),
            4 => Some(Status::Denied),
            _ => None,
        }
    }

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

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

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[repr(u8)]
pub enum TransferProtocol {
    /// Logs to be returned as a response
    Responsepayload = 0,
    /// Logs to be returned using BDX
    Bdx = 1,
}

impl TransferProtocol {
    /// Convert from u8 value
    pub fn from_u8(value: u8) -> Option<Self> {
        match value {
            0 => Some(TransferProtocol::Responsepayload),
            1 => Some(TransferProtocol::Bdx),
            _ => None,
        }
    }

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

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

// Command encoders

/// Encode RetrieveLogsRequest command (0x00)
pub fn encode_retrieve_logs_request(intent: Intent, requested_protocol: TransferProtocol, transfer_file_designator: Option<String>) -> anyhow::Result<Vec<u8>> {
    let mut tlv_fields: Vec<tlv::TlvItemEnc> = Vec::new();
    tlv_fields.push((0, tlv::TlvItemValueEnc::UInt8(intent.to_u8())).into());
    tlv_fields.push((1, tlv::TlvItemValueEnc::UInt8(requested_protocol.to_u8())).into());
    if let Some(x) = transfer_file_designator { tlv_fields.push((2, tlv::TlvItemValueEnc::String(x)).into()); }
    let tlv = tlv::TlvItemEnc {
        tag: 0,
        value: tlv::TlvItemValueEnc::StructInvisible(tlv_fields),
    };
    Ok(tlv.encode()?)
}

// Command listing

pub fn get_command_list() -> Vec<(u32, &'static str)> {
    vec![
        (0x00, "RetrieveLogsRequest"),
    ]
}

pub fn get_command_name(cmd_id: u32) -> Option<&'static str> {
    match cmd_id {
        0x00 => Some("RetrieveLogsRequest"),
        _ => 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: "intent", kind: crate::clusters::codec::FieldKind::Enum { name: "Intent", variants: &[(0, "Endusersupport"), (1, "Networkdiag"), (2, "Crashlogs")] }, optional: false, nullable: false },
            crate::clusters::codec::CommandField { tag: 1, name: "requested_protocol", kind: crate::clusters::codec::FieldKind::Enum { name: "TransferProtocol", variants: &[(0, "Responsepayload"), (1, "Bdx")] }, optional: false, nullable: false },
            crate::clusters::codec::CommandField { tag: 2, name: "transfer_file_designator", kind: crate::clusters::codec::FieldKind::String, optional: true, nullable: false },
        ]),
        _ => None,
    }
}

pub fn encode_command_json(cmd_id: u32, args: &serde_json::Value) -> anyhow::Result<Vec<u8>> {
    match cmd_id {
        0x00 => {
        let intent = {
            let n = crate::clusters::codec::json_util::get_u64(args, "intent")?;
            Intent::from_u8(n as u8).ok_or_else(|| anyhow::anyhow!("invalid Intent: {}", n))?
        };
        let requested_protocol = {
            let n = crate::clusters::codec::json_util::get_u64(args, "requested_protocol")?;
            TransferProtocol::from_u8(n as u8).ok_or_else(|| anyhow::anyhow!("invalid TransferProtocol: {}", n))?
        };
        let transfer_file_designator = crate::clusters::codec::json_util::get_opt_string(args, "transfer_file_designator")?;
        encode_retrieve_logs_request(intent, requested_protocol, transfer_file_designator)
        }
        _ => Err(anyhow::anyhow!("unknown command ID: 0x{:02X}", cmd_id)),
    }
}

#[derive(Debug, serde::Serialize)]
pub struct RetrieveLogsResponse {
    pub status: Option<Status>,
    #[serde(serialize_with = "serialize_opt_bytes_as_hex")]
    pub log_content: Option<Vec<u8>>,
    pub utc_time_stamp: Option<u64>,
    pub time_since_boot: Option<u8>,
}

// Command response decoders

/// Decode RetrieveLogsResponse command response (01)
pub fn decode_retrieve_logs_response(inp: &tlv::TlvItemValue) -> anyhow::Result<RetrieveLogsResponse> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(RetrieveLogsResponse {
                status: item.get_int(&[0]).and_then(|v| Status::from_u8(v as u8)),
                log_content: item.get_octet_string_owned(&[1]),
                utc_time_stamp: item.get_int(&[2]),
                time_since_boot: item.get_int(&[3]).map(|v| v as u8),
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}

// Typed facade (invokes + reads)

/// Invoke `RetrieveLogsRequest` command on cluster `Diagnostic Logs`.
pub async fn retrieve_logs_request(conn: &crate::controller::Connection, endpoint: u16, intent: Intent, requested_protocol: TransferProtocol, transfer_file_designator: Option<String>) -> anyhow::Result<RetrieveLogsResponse> {
    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_DIAGNOSTIC_LOGS, crate::clusters::defs::CLUSTER_DIAGNOSTIC_LOGS_CMD_ID_RETRIEVELOGSREQUEST, &encode_retrieve_logs_request(intent, requested_protocol, transfer_file_designator)?).await?;
    decode_retrieve_logs_response(&tlv)
}