Skip to main content

spodes_rs/classes/
data.rs

1use crate::interface::InterfaceClass;
2use crate::obis::ObisCode;
3use crate::types::attrs::Choice;
4use crate::types::{BerError, CosemDataType};
5use serde::{Deserialize, Serialize};
6use std::any::Any;
7
8/// The `Data` interface class (class_id = 1) holding simple data such as
9/// identifiers or static parameters, per IEC 62056-6-2.
10///
11/// Attributes (IEC 62056-6-2, Table 5):
12/// - attr 1: logical_name (octet-string) — OBIS code
13/// - attr 2: value (CHOICE) — any COSEM data type
14#[derive(Clone, Debug, Serialize, Deserialize)]
15pub struct Data {
16    logical_name: ObisCode,
17    value: Choice,
18}
19
20impl Data {
21    /// Creates a new `Data` object.
22    pub fn new(logical_name: ObisCode, value: Choice) -> Self {
23        Data { logical_name, value }
24    }
25
26    /// Returns the value attribute (attr 2).
27    pub fn value(&self) -> &Choice {
28        &self.value
29    }
30
31    /// Sets the value attribute (attr 2).
32    pub fn set_value(&mut self, value: Choice) {
33        self.value = value;
34    }
35}
36
37impl InterfaceClass for Data {
38    fn class_id(&self) -> u16 {
39        1
40    }
41
42    fn version(&self) -> u8 {
43        0
44    }
45
46    fn logical_name(&self) -> &ObisCode {
47        &self.logical_name
48    }
49
50    fn attributes(&self) -> Vec<(u8, CosemDataType)> {
51        vec![(1, CosemDataType::OctetString(self.logical_name.to_bytes())), (2, self.value.clone())]
52    }
53
54    fn methods(&self) -> Vec<(u8, String)> {
55        vec![(1, "reset".to_string())]
56    }
57
58    fn serialize_ber(&self, buf: &mut Vec<u8>) -> Result<(), BerError> {
59        let mut seq_buf = Vec::new();
60        CosemDataType::LongUnsigned(self.class_id()).serialize_ber(&mut seq_buf)?;
61        CosemDataType::OctetString(self.logical_name.to_bytes()).serialize_ber(&mut seq_buf)?;
62        self.value.serialize_ber(&mut seq_buf)?;
63        buf.push(0x02); // structure [2]
64        write_length(3, buf); // element count: class_id, logical_name, value
65        buf.extend_from_slice(&seq_buf);
66        Ok(())
67    }
68
69    fn deserialize_ber(&mut self, data: &[u8]) -> Result<(), BerError> {
70        let (tlv, rest) = CosemDataType::deserialize_ber(data)?;
71        if rest.is_empty() {
72            if let CosemDataType::Structure(seq) = tlv {
73                if seq.len() == 3 {
74                    if let CosemDataType::LongUnsigned(class_id) = seq[0] {
75                        if class_id != self.class_id() {
76                            return Err(BerError::InvalidValue);
77                        }
78                    } else {
79                        return Err(BerError::InvalidTag);
80                    }
81                    if let CosemDataType::OctetString(obis) = &seq[1] {
82                        if obis.len() == 6 {
83                            self.logical_name = ObisCode::new(obis[0], obis[1], obis[2], obis[3], obis[4], obis[5]);
84                        } else {
85                            return Err(BerError::InvalidLength);
86                        }
87                    } else {
88                        return Err(BerError::InvalidTag);
89                    }
90                    self.value = seq[2].clone();
91                    return Ok(());
92                }
93            }
94        }
95        Err(BerError::InvalidTag)
96    }
97
98    fn set_attribute(&mut self, attribute_id: u8, value: CosemDataType) -> Result<(), String> {
99        if attribute_id == 2 {
100            self.value = value;
101            Ok(())
102        } else {
103            Err(format!("Attribute {} not writable for Data", attribute_id))
104        }
105    }
106
107    fn invoke_method(&mut self, method_id: u8, _params: Option<CosemDataType>) -> Result<CosemDataType, String> {
108        match method_id {
109            // Method 1: `reset` — sets the value to its default (null-data),
110            // per IEC 62056-6-2 §4.3.1.3.1.
111            1 => {
112                self.value = CosemDataType::Null;
113                Ok(CosemDataType::Null)
114            }
115            _ => Err(format!("Method {method_id} not supported for Data class")),
116        }
117    }
118
119    fn as_any(&self) -> &dyn Any {
120        self
121    }
122}
123
124/// Writes a length in BER (short or long form).
125#[allow(clippy::cast_possible_truncation)] // length < 128 and num_octets in 1..=8 always fit u8
126fn write_length(length: usize, buf: &mut Vec<u8>) {
127    if length < 128 {
128        buf.push(length as u8);
129    } else {
130        let bytes = (length as u64).to_be_bytes();
131        let first_non_zero = bytes.iter().position(|&b| b != 0).unwrap_or(7);
132        let num_bytes = 8 - first_non_zero;
133        buf.push(0x80 | num_bytes as u8);
134        buf.extend_from_slice(&bytes[first_non_zero..]);
135    }
136}