Skip to main content

spodes_rs/classes/
extended_register.rs

1use crate::interface::InterfaceClass;
2use crate::obis::ObisCode;
3use crate::types::attrs::{Choice, DateTime, ScalerUnit};
4use crate::types::{BerError, CosemDataType};
5use serde::{Deserialize, Serialize};
6use std::any::Any;
7
8/// The `ExtendedRegister` interface class (class_id = 4): the current value of a
9/// measured quantity with extra metadata such as status and capture time, per
10/// IEC 62056-6-2.
11///
12/// Attributes (IEC 62056-6-2, Table 9):
13/// - attr 1: logical_name (octet-string) — OBIS code
14/// - attr 2: value (CHOICE) — any numeric type
15/// - attr 3: scaler_unit (scal_unit_type) — {scaler, unit}
16/// - attr 4: status (CHOICE) — measurement status
17/// - attr 5: capture_time (octet-string) — date-time
18#[derive(Clone, Serialize, Deserialize, Debug)]
19pub struct ExtendedRegister {
20    logical_name: ObisCode,
21    value: Choice,
22    scaler_unit: ScalerUnit,
23    status: Choice,
24    capture_time: DateTime,
25}
26
27impl ExtendedRegister {
28    /// Creates a new `ExtendedRegister` object.
29    pub fn new(
30        logical_name: ObisCode,
31        value: Choice,
32        scaler_unit: ScalerUnit,
33        status: Choice,
34        capture_time: DateTime,
35    ) -> Self {
36        ExtendedRegister { logical_name, value, scaler_unit, status, capture_time }
37    }
38
39    /// Returns the value attribute (attr 2).
40    pub fn value(&self) -> &Choice {
41        &self.value
42    }
43
44    /// Returns the scaler_unit attribute (attr 3).
45    pub fn scaler_unit(&self) -> &ScalerUnit {
46        &self.scaler_unit
47    }
48
49    /// Returns the status attribute (attr 4).
50    pub fn status(&self) -> &Choice {
51        &self.status
52    }
53
54    /// Returns the capture_time attribute (attr 5).
55    pub fn capture_time(&self) -> &DateTime {
56        &self.capture_time
57    }
58
59    /// Resets the register value to 0 and clears the status and capture time.
60    ///
61    /// # Returns
62    /// * `Ok(CosemDataType::Null)` - On successful reset.
63    /// * `Err(String)` - If the value type does not support reset.
64    fn reset(&mut self) -> Result<CosemDataType, String> {
65        match &self.value {
66            CosemDataType::Integer(_) => {
67                self.value = CosemDataType::Integer(0);
68                self.status = CosemDataType::Null;
69                self.capture_time = DateTime::new([0u8; 12]);
70                Ok(CosemDataType::Null)
71            }
72            CosemDataType::Long(_) => {
73                self.value = CosemDataType::Long(0);
74                self.status = CosemDataType::Null;
75                self.capture_time = DateTime::new([0u8; 12]);
76                Ok(CosemDataType::Null)
77            }
78            CosemDataType::DoubleLong(_) => {
79                self.value = CosemDataType::DoubleLong(0);
80                self.status = CosemDataType::Null;
81                self.capture_time = DateTime::new([0u8; 12]);
82                Ok(CosemDataType::Null)
83            }
84            CosemDataType::Unsigned(_) => {
85                self.value = CosemDataType::Unsigned(0);
86                self.status = CosemDataType::Null;
87                self.capture_time = DateTime::new([0u8; 12]);
88                Ok(CosemDataType::Null)
89            }
90            CosemDataType::LongUnsigned(_) => {
91                self.value = CosemDataType::LongUnsigned(0);
92                self.status = CosemDataType::Null;
93                self.capture_time = DateTime::new([0u8; 12]);
94                Ok(CosemDataType::Null)
95            }
96            CosemDataType::DoubleLongUnsigned(_) => {
97                self.value = CosemDataType::DoubleLongUnsigned(0);
98                self.status = CosemDataType::Null;
99                self.capture_time = DateTime::new([0u8; 12]);
100                Ok(CosemDataType::Null)
101            }
102            _ => Err("Unsupported value type for reset".to_string()),
103        }
104    }
105
106    /// Captures the current value, updating the status and capture time.
107    ///
108    /// # Returns
109    /// * `Ok(CosemDataType::Null)` - On a successful capture.
110    /// * `Err(String)` - On error.
111    fn capture(&mut self) -> CosemDataType {
112        self.status = CosemDataType::Unsigned(1);
113        self.capture_time = DateTime::new([0x07, 0xE5, 0x05, 0x01, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
114        CosemDataType::Null
115    }
116}
117
118impl InterfaceClass for ExtendedRegister {
119    fn class_id(&self) -> u16 {
120        4
121    }
122
123    fn version(&self) -> u8 {
124        0
125    }
126
127    fn logical_name(&self) -> &ObisCode {
128        &self.logical_name
129    }
130
131    fn attributes(&self) -> Vec<(u8, CosemDataType)> {
132        vec![
133            (1, CosemDataType::OctetString(self.logical_name.to_bytes())),
134            (2, self.value.clone()),
135            (3, self.scaler_unit.clone().into()),
136            (4, self.status.clone()),
137            (5, self.capture_time.clone().into()),
138        ]
139    }
140
141    fn methods(&self) -> Vec<(u8, String)> {
142        vec![(1, "reset".to_string()), (2, "capture".to_string())]
143    }
144
145    fn serialize_ber(&self, buf: &mut Vec<u8>) -> Result<(), BerError> {
146        let mut seq_buf = Vec::new();
147        CosemDataType::LongUnsigned(self.class_id()).serialize_ber(&mut seq_buf)?;
148        for (_, attr) in self.attributes() {
149            attr.serialize_ber(&mut seq_buf)?;
150        }
151        buf.push(0x02); // structure [2]
152        write_length(1 + self.attributes().len(), buf); // length = element count
153        buf.extend_from_slice(&seq_buf);
154        Ok(())
155    }
156
157    fn deserialize_ber(&mut self, data: &[u8]) -> Result<(), BerError> {
158        let (tlv, rest) = CosemDataType::deserialize_ber(data)?;
159        if !rest.is_empty() {
160            return Err(BerError::InvalidTag);
161        }
162        if let CosemDataType::Structure(seq) = tlv {
163            if seq.len() == 6 {
164                if let CosemDataType::LongUnsigned(class_id) = seq[0] {
165                    if class_id != self.class_id() {
166                        return Err(BerError::InvalidValue);
167                    }
168                } else {
169                    return Err(BerError::InvalidTag);
170                }
171                if let CosemDataType::OctetString(obis) = &seq[1] {
172                    if obis.len() == 6 {
173                        self.logical_name = ObisCode::new(obis[0], obis[1], obis[2], obis[3], obis[4], obis[5]);
174                    } else {
175                        return Err(BerError::InvalidLength);
176                    }
177                } else {
178                    return Err(BerError::InvalidTag);
179                }
180                self.value = seq[2].clone();
181                self.scaler_unit = ScalerUnit::try_from(&seq[3]).map_err(|_| BerError::InvalidValue)?;
182                self.status = seq[4].clone();
183                self.capture_time = DateTime::try_from(&seq[5]).map_err(|_| BerError::InvalidValue)?;
184                return Ok(());
185            }
186            return Err(BerError::InvalidLength);
187        }
188        Err(BerError::InvalidTag)
189    }
190
191    fn invoke_method(&mut self, method_id: u8, _params: Option<CosemDataType>) -> Result<CosemDataType, String> {
192        match method_id {
193            1 => self.reset(),
194            2 => Ok(self.capture()),
195            _ => Err(format!("Method {method_id} not supported for ExtendedRegister class")),
196        }
197    }
198
199    fn as_any(&self) -> &dyn Any {
200        self
201    }
202}
203
204/// Writes a length in BER (short or long form).
205#[allow(clippy::cast_possible_truncation)] // length < 128 and num_octets in 1..=8 always fit u8
206fn write_length(length: usize, buf: &mut Vec<u8>) {
207    if length < 128 {
208        buf.push(length as u8);
209    } else {
210        let bytes = (length as u64).to_be_bytes();
211        let first_non_zero = bytes.iter().position(|&b| b != 0).unwrap_or(7);
212        let num_octets = 8 - first_non_zero;
213        buf.push(0x80 | num_octets as u8);
214        buf.extend_from_slice(&bytes[first_non_zero..]);
215    }
216}