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
443
444
445
446
447
448
449
450
451
452
453
//! Matter TLV encoders and decoders for Commodity Price Cluster
//! Cluster ID: 0x0095
//!
//! This file is automatically generated from CommodityPrice.xml

#![allow(clippy::too_many_arguments)]

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


// Bitmap definitions

/// CommodityPriceDetail bitmap type
pub type CommodityPriceDetail = u8;

/// Constants for CommodityPriceDetail
pub mod commoditypricedetail {
    /// A textual description of a price; e.g. the name of a rate plan.
    pub const DESCRIPTION: u8 = 0x01;
    /// A breakdown of the component parts of a price; e.g. generation, delivery, etc.
    pub const COMPONENTS: u8 = 0x02;
}

// Struct definitions

#[derive(Debug, serde::Serialize)]
pub struct CommodityPriceComponent {
    pub price: Option<u8>,
    pub source: Option<u8>,
    pub description: Option<String>,
    pub tariff_component_id: Option<u32>,
}

#[derive(Debug, serde::Serialize)]
pub struct CommodityPrice {
    pub period_start: Option<u64>,
    pub period_end: Option<u64>,
    pub price: Option<u8>,
    pub price_level: Option<i16>,
    pub description: Option<String>,
    pub components: Option<Vec<CommodityPriceComponent>>,
}

// Command encoders

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

/// Encode GetDetailedForecastRequest command (0x02)
pub fn encode_get_detailed_forecast_request(details: CommodityPriceDetail) -> anyhow::Result<Vec<u8>> {
    let tlv = tlv::TlvItemEnc {
        tag: 0,
        value: tlv::TlvItemValueEnc::StructInvisible(vec![
        (0, tlv::TlvItemValueEnc::UInt8(details)).into(),
        ]),
    };
    Ok(tlv.encode()?)
}

// Attribute decoders

/// Decode TariffUnit attribute (0x0000)
pub fn decode_tariff_unit(inp: &tlv::TlvItemValue) -> anyhow::Result<u8> {
    if let tlv::TlvItemValue::Int(v) = inp {
        Ok(*v as u8)
    } else {
        Err(anyhow::anyhow!("Expected UInt8"))
    }
}

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

/// Decode CurrentPrice attribute (0x0002)
pub fn decode_current_price(inp: &tlv::TlvItemValue) -> anyhow::Result<Option<CommodityPrice>> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        // Struct with fields
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(Some(CommodityPrice {
                period_start: item.get_int(&[0]),
                period_end: item.get_int(&[1]),
                price: item.get_int(&[2]).map(|v| v as u8),
                price_level: item.get_int(&[3]).map(|v| v as i16),
                description: item.get_string_owned(&[4]),
                components: {
                    if let Some(tlv::TlvItemValue::List(l)) = item.get(&[5]) {
                        let mut items = Vec::new();
                        for list_item in l {
                            items.push(CommodityPriceComponent {
                price: list_item.get_int(&[0]).map(|v| v as u8),
                source: list_item.get_int(&[1]).map(|v| v as u8),
                description: list_item.get_string_owned(&[2]),
                tariff_component_id: list_item.get_int(&[3]).map(|v| v as u32),
                            });
                        }
                        Some(items)
                    } else {
                        None
                    }
                },
        }))
    //} else if let tlv::TlvItemValue::Null = inp {
    //    // Null value for nullable struct
    //    Ok(None)
    } else {
    Ok(None)
    //    Err(anyhow::anyhow!("Expected struct fields or null"))
    }
}

/// Decode PriceForecast attribute (0x0003)
pub fn decode_price_forecast(inp: &tlv::TlvItemValue) -> anyhow::Result<Vec<CommodityPrice>> {
    let mut res = Vec::new();
    if let tlv::TlvItemValue::List(v) = inp {
        for item in v {
            res.push(CommodityPrice {
                period_start: item.get_int(&[0]),
                period_end: item.get_int(&[1]),
                price: item.get_int(&[2]).map(|v| v as u8),
                price_level: item.get_int(&[3]).map(|v| v as i16),
                description: item.get_string_owned(&[4]),
                components: {
                    if let Some(tlv::TlvItemValue::List(l)) = item.get(&[5]) {
                        let mut items = Vec::new();
                        for list_item in l {
                            items.push(CommodityPriceComponent {
                price: list_item.get_int(&[0]).map(|v| v as u8),
                source: list_item.get_int(&[1]).map(|v| v as u8),
                description: list_item.get_string_owned(&[2]),
                tariff_component_id: list_item.get_int(&[3]).map(|v| v as u32),
                            });
                        }
                        Some(items)
                    } else {
                        None
                    }
                },
            });
        }
    }
    Ok(res)
}


// 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 != 0x0095 {
        return format!("{{\"error\": \"Invalid cluster ID. Expected 0x0095, got {}\"}}", cluster_id);
    }

    match attribute_id {
        0x0000 => {
            match decode_tariff_unit(tlv_value) {
                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
                Err(e) => format!("{{\"error\": \"{}\"}}", e),
            }
        }
        0x0001 => {
            match decode_currency(tlv_value) {
                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
                Err(e) => format!("{{\"error\": \"{}\"}}", e),
            }
        }
        0x0002 => {
            match decode_current_price(tlv_value) {
                Ok(value) => serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string()),
                Err(e) => format!("{{\"error\": \"{}\"}}", e),
            }
        }
        0x0003 => {
            match decode_price_forecast(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, "TariffUnit"),
        (0x0001, "Currency"),
        (0x0002, "CurrentPrice"),
        (0x0003, "PriceForecast"),
    ]
}

// Command listing

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

pub fn get_command_name(cmd_id: u32) -> Option<&'static str> {
    match cmd_id {
        0x00 => Some("GetDetailedPriceRequest"),
        0x02 => Some("GetDetailedForecastRequest"),
        _ => 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: "details", kind: crate::clusters::codec::FieldKind::Bitmap { name: "CommodityPriceDetail", bits: &[(1, "DESCRIPTION"), (2, "COMPONENTS")] }, optional: false, nullable: false },
        ]),
        0x02 => Some(vec![
            crate::clusters::codec::CommandField { tag: 0, name: "details", kind: crate::clusters::codec::FieldKind::Bitmap { name: "CommodityPriceDetail", bits: &[(1, "DESCRIPTION"), (2, "COMPONENTS")] }, optional: false, nullable: false },
        ]),
        _ => None,
    }
}

pub fn encode_command_json(cmd_id: u32, args: &serde_json::Value) -> anyhow::Result<Vec<u8>> {
    match cmd_id {
        0x00 => {
        let details = crate::clusters::codec::json_util::get_u8(args, "details")?;
        encode_get_detailed_price_request(details)
        }
        0x02 => {
        let details = crate::clusters::codec::json_util::get_u8(args, "details")?;
        encode_get_detailed_forecast_request(details)
        }
        _ => Err(anyhow::anyhow!("unknown command ID: 0x{:02X}", cmd_id)),
    }
}

#[derive(Debug, serde::Serialize)]
pub struct GetDetailedPriceResponse {
    pub current_price: Option<CommodityPrice>,
}

#[derive(Debug, serde::Serialize)]
pub struct GetDetailedForecastResponse {
    pub price_forecast: Option<Vec<CommodityPrice>>,
}

// Command response decoders

/// Decode GetDetailedPriceResponse command response (01)
pub fn decode_get_detailed_price_response(inp: &tlv::TlvItemValue) -> anyhow::Result<GetDetailedPriceResponse> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(GetDetailedPriceResponse {
                current_price: {
                    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(CommodityPrice {
                period_start: nested_item.get_int(&[0]),
                period_end: nested_item.get_int(&[1]),
                price: nested_item.get_int(&[2]).map(|v| v as u8),
                price_level: nested_item.get_int(&[3]).map(|v| v as i16),
                description: nested_item.get_string_owned(&[4]),
                components: {
                    if let Some(tlv::TlvItemValue::List(l)) = nested_item.get(&[5]) {
                        let mut items = Vec::new();
                        for list_item in l {
                            items.push(CommodityPriceComponent {
                price: list_item.get_int(&[0]).map(|v| v as u8),
                source: list_item.get_int(&[1]).map(|v| v as u8),
                description: list_item.get_string_owned(&[2]),
                tariff_component_id: list_item.get_int(&[3]).map(|v| v as u32),
                            });
                        }
                        Some(items)
                    } else {
                        None
                    }
                },
                            })
                        } else {
                            None
                        }
                    } else {
                        None
                    }
                },
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}

/// Decode GetDetailedForecastResponse command response (03)
pub fn decode_get_detailed_forecast_response(inp: &tlv::TlvItemValue) -> anyhow::Result<GetDetailedForecastResponse> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(GetDetailedForecastResponse {
                price_forecast: {
                    if let Some(tlv::TlvItemValue::List(l)) = item.get(&[0]) {
                        let mut items = Vec::new();
                        for list_item in l {
                            items.push(CommodityPrice {
                period_start: list_item.get_int(&[0]),
                period_end: list_item.get_int(&[1]),
                price: list_item.get_int(&[2]).map(|v| v as u8),
                price_level: list_item.get_int(&[3]).map(|v| v as i16),
                description: list_item.get_string_owned(&[4]),
                components: {
                    if let Some(tlv::TlvItemValue::List(l)) = list_item.get(&[5]) {
                        let mut items = Vec::new();
                        for list_item in l {
                            items.push(CommodityPriceComponent {
                price: list_item.get_int(&[0]).map(|v| v as u8),
                source: list_item.get_int(&[1]).map(|v| v as u8),
                description: list_item.get_string_owned(&[2]),
                tariff_component_id: list_item.get_int(&[3]).map(|v| v as u32),
                            });
                        }
                        Some(items)
                    } else {
                        None
                    }
                },
                            });
                        }
                        Some(items)
                    } else {
                        None
                    }
                },
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}

// Typed facade (invokes + reads)

/// Invoke `GetDetailedPriceRequest` command on cluster `Commodity Price`.
pub async fn get_detailed_price_request(conn: &crate::controller::Connection, endpoint: u16, details: CommodityPriceDetail) -> anyhow::Result<GetDetailedPriceResponse> {
    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_COMMODITY_PRICE, crate::clusters::defs::CLUSTER_COMMODITY_PRICE_CMD_ID_GETDETAILEDPRICEREQUEST, &encode_get_detailed_price_request(details)?).await?;
    decode_get_detailed_price_response(&tlv)
}

/// Invoke `GetDetailedForecastRequest` command on cluster `Commodity Price`.
pub async fn get_detailed_forecast_request(conn: &crate::controller::Connection, endpoint: u16, details: CommodityPriceDetail) -> anyhow::Result<GetDetailedForecastResponse> {
    let tlv = conn.invoke_request2(endpoint, crate::clusters::defs::CLUSTER_ID_COMMODITY_PRICE, crate::clusters::defs::CLUSTER_COMMODITY_PRICE_CMD_ID_GETDETAILEDFORECASTREQUEST, &encode_get_detailed_forecast_request(details)?).await?;
    decode_get_detailed_forecast_response(&tlv)
}

/// Read `TariffUnit` attribute from cluster `Commodity Price`.
pub async fn read_tariff_unit(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<u8> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_COMMODITY_PRICE, crate::clusters::defs::CLUSTER_COMMODITY_PRICE_ATTR_ID_TARIFFUNIT).await?;
    decode_tariff_unit(&tlv)
}

/// Read `Currency` attribute from cluster `Commodity Price`.
pub async fn read_currency(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Option<u8>> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_COMMODITY_PRICE, crate::clusters::defs::CLUSTER_COMMODITY_PRICE_ATTR_ID_CURRENCY).await?;
    decode_currency(&tlv)
}

/// Read `CurrentPrice` attribute from cluster `Commodity Price`.
pub async fn read_current_price(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Option<CommodityPrice>> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_COMMODITY_PRICE, crate::clusters::defs::CLUSTER_COMMODITY_PRICE_ATTR_ID_CURRENTPRICE).await?;
    decode_current_price(&tlv)
}

/// Read `PriceForecast` attribute from cluster `Commodity Price`.
pub async fn read_price_forecast(conn: &crate::controller::Connection, endpoint: u16) -> anyhow::Result<Vec<CommodityPrice>> {
    let tlv = conn.read_request2(endpoint, crate::clusters::defs::CLUSTER_ID_COMMODITY_PRICE, crate::clusters::defs::CLUSTER_COMMODITY_PRICE_ATTR_ID_PRICEFORECAST).await?;
    decode_price_forecast(&tlv)
}

#[derive(Debug, serde::Serialize)]
pub struct PriceChangeEvent {
    pub current_price: Option<CommodityPrice>,
}

// Event decoders

/// Decode PriceChange event (0x00, priority: info)
pub fn decode_price_change_event(inp: &tlv::TlvItemValue) -> anyhow::Result<PriceChangeEvent> {
    if let tlv::TlvItemValue::List(_fields) = inp {
        let item = tlv::TlvItem { tag: 0, value: inp.clone() };
        Ok(PriceChangeEvent {
                                current_price: {
                    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(CommodityPrice {
                period_start: nested_item.get_int(&[0]),
                period_end: nested_item.get_int(&[1]),
                price: nested_item.get_int(&[2]).map(|v| v as u8),
                price_level: nested_item.get_int(&[3]).map(|v| v as i16),
                description: nested_item.get_string_owned(&[4]),
                components: {
                    if let Some(tlv::TlvItemValue::List(l)) = nested_item.get(&[5]) {
                        let mut items = Vec::new();
                        for list_item in l {
                            items.push(CommodityPriceComponent {
                price: list_item.get_int(&[0]).map(|v| v as u8),
                source: list_item.get_int(&[1]).map(|v| v as u8),
                description: list_item.get_string_owned(&[2]),
                tariff_component_id: list_item.get_int(&[3]).map(|v| v as u32),
                            });
                        }
                        Some(items)
                    } else {
                        None
                    }
                },
                            })
                        } else {
                            None
                        }
                    } else {
                        None
                    }
                },
        })
    } else {
        Err(anyhow::anyhow!("Expected struct fields"))
    }
}