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

//! Matter TLV encoders and decoders for Account Login Cluster
//! Cluster ID: 0x050E
//!
//! This file is automatically generated from AccountLogin.xml

#![allow(clippy::too_many_arguments)]

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


// Command encoders

/// Encode GetSetupPIN command (0x00)
pub fn encode_get_setup_pin(temp_account_identifier: String) -> anyhow::Result<Vec<u8>> {
    let tlv = tlv::TlvItemEnc {
        tag: 0,
        value: tlv::TlvItemValueEnc::StructInvisible(vec![
        (0, tlv::TlvItemValueEnc::String(temp_account_identifier)).into(),
        ]),
    };
    Ok(tlv.encode()?)
}

/// Encode Login command (0x02)
pub fn encode_login(temp_account_identifier: String, setup_pin: String, node: Option<u64>) -> anyhow::Result<Vec<u8>> {
    let mut tlv_fields: Vec<tlv::TlvItemEnc> = Vec::new();
    tlv_fields.push((0, tlv::TlvItemValueEnc::String(temp_account_identifier)).into());
    tlv_fields.push((1, tlv::TlvItemValueEnc::String(setup_pin)).into());
    if let Some(x) = node { tlv_fields.push((2, tlv::TlvItemValueEnc::UInt64(x)).into()); }
    let tlv = tlv::TlvItemEnc {
        tag: 0,
        value: tlv::TlvItemValueEnc::StructInvisible(tlv_fields),
    };
    Ok(tlv.encode()?)
}

/// Encode Logout command (0x03)
pub fn encode_logout(node: Option<u64>) -> anyhow::Result<Vec<u8>> {
    let mut tlv_fields: Vec<tlv::TlvItemEnc> = Vec::new();
    if let Some(x) = node { tlv_fields.push((0, tlv::TlvItemValueEnc::UInt64(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, "GetSetupPIN"),
        (0x02, "Login"),
        (0x03, "Logout"),
    ]
}

pub fn get_command_name(cmd_id: u32) -> Option<&'static str> {
    match cmd_id {
        0x00 => Some("GetSetupPIN"),
        0x02 => Some("Login"),
        0x03 => Some("Logout"),
        _ => 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: "temp_account_identifier", kind: crate::clusters::codec::FieldKind::String, optional: false, nullable: false },
        ]),
        0x02 => Some(vec![
            crate::clusters::codec::CommandField { tag: 0, name: "temp_account_identifier", kind: crate::clusters::codec::FieldKind::String, optional: false, nullable: false },
            crate::clusters::codec::CommandField { tag: 1, name: "setup_pin", kind: crate::clusters::codec::FieldKind::String, optional: false, nullable: false },
            crate::clusters::codec::CommandField { tag: 2, name: "node", kind: crate::clusters::codec::FieldKind::U64, optional: true, nullable: false },
        ]),
        0x03 => Some(vec![
            crate::clusters::codec::CommandField { tag: 0, name: "node", kind: crate::clusters::codec::FieldKind::U64, 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 temp_account_identifier = crate::clusters::codec::json_util::get_string(args, "temp_account_identifier")?;
        encode_get_setup_pin(temp_account_identifier)
        }
        0x02 => {
        let temp_account_identifier = crate::clusters::codec::json_util::get_string(args, "temp_account_identifier")?;
        let setup_pin = crate::clusters::codec::json_util::get_string(args, "setup_pin")?;
        let node = crate::clusters::codec::json_util::get_opt_u64(args, "node")?;
        encode_login(temp_account_identifier, setup_pin, node)
        }
        0x03 => {
        let node = crate::clusters::codec::json_util::get_opt_u64(args, "node")?;
        encode_logout(node)
        }
        _ => Err(anyhow::anyhow!("unknown command ID: 0x{:02X}", cmd_id)),
    }
}

#[derive(Debug, serde::Serialize)]
pub struct GetSetupPINResponse {
    pub setup_pin: Option<String>,
}

// Command response decoders

/// Decode GetSetupPINResponse command response (01)
pub fn decode_get_setup_pin_response(inp: &tlv::TlvItemValue) -> anyhow::Result<GetSetupPINResponse> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(GetSetupPINResponse {
                setup_pin: item.get_string_owned(&[0]),
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}

// Typed facade (invokes + reads)

/// Invoke `GetSetupPIN` command on cluster `Account Login`.
pub async fn get_setup_pin(conn: &crate::controller::Connection, endpoint: u16, temp_account_identifier: String) -> anyhow::Result<GetSetupPINResponse> {
    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_ACCOUNT_LOGIN, crate::clusters::defs::CLUSTER_ACCOUNT_LOGIN_CMD_ID_GETSETUPPIN, &encode_get_setup_pin(temp_account_identifier)?).await?;
    decode_get_setup_pin_response(&tlv)
}

/// Invoke `Login` command on cluster `Account Login`.
pub async fn login(conn: &crate::controller::Connection, endpoint: u16, temp_account_identifier: String, setup_pin: String, node: Option<u64>) -> anyhow::Result<()> {
    conn.invoke_request(endpoint, crate::clusters::defs::CLUSTER_ID_ACCOUNT_LOGIN, crate::clusters::defs::CLUSTER_ACCOUNT_LOGIN_CMD_ID_LOGIN, &encode_login(temp_account_identifier, setup_pin, node)?).await?;
    Ok(())
}

/// Invoke `Logout` command on cluster `Account Login`.
pub async fn logout(conn: &crate::controller::Connection, endpoint: u16, node: Option<u64>) -> anyhow::Result<()> {
    conn.invoke_request(endpoint, crate::clusters::defs::CLUSTER_ID_ACCOUNT_LOGIN, crate::clusters::defs::CLUSTER_ACCOUNT_LOGIN_CMD_ID_LOGOUT, &encode_logout(node)?).await?;
    Ok(())
}

#[derive(Debug, serde::Serialize)]
pub struct LoggedOutEvent {
    pub node: Option<u64>,
}

// Event decoders

/// Decode LoggedOut event (0x00, priority: critical)
pub fn decode_logged_out_event(inp: &tlv::TlvItemValue) -> anyhow::Result<LoggedOutEvent> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(LoggedOutEvent {
                                node: item.get_int(&[0]),
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}