Skip to main content

spodes_rs/classes/
iec_local_port_setup.rs

1use crate::interface::InterfaceClass;
2use crate::obis::ObisCode;
3use crate::types::{BerError, CosemDataType};
4use serde::{Deserialize, Serialize};
5use std::any::Any;
6
7/// Configuration structure used to build an [`IecLocalPortSetup`] object.
8#[derive(Clone, Serialize, Deserialize, Debug)]
9pub struct IecLocalPortSetupConfig {
10    /// Attribute 1: the object's logical name (OBIS code).
11    pub logical_name: ObisCode,
12    /// Class version: 0 or 1 (identical attribute set).
13    pub version: u8,
14    /// Attribute 2: default communication mode (enum).
15    pub default_mode: u8,
16    /// Attribute 3: default baud rate (enum).
17    pub default_baud: u8,
18    /// Attribute 4: proposed baud rate (enum).
19    pub prop_baud: u8,
20    /// Attribute 5: response time (enum).
21    pub response_time: u8,
22    /// Attribute 6: device address (octet-string).
23    pub device_addr: Vec<u8>,
24    /// Attribute 7: password 1 (octet-string).
25    pub pass_p1: Vec<u8>,
26    /// Attribute 8: password 2 (octet-string).
27    pub pass_p2: Vec<u8>,
28    /// Attribute 9: password W5 (octet-string).
29    pub pass_w5: Vec<u8>,
30}
31
32/// `IEC local port setup` interface class (class_id = 19) per IEC 62056-6-2
33/// ยง4.7.1. Configures the local (optical) port. Versions 0 and 1 share the same
34/// nine attributes. This class defines no specific methods.
35#[derive(Clone, Serialize, Deserialize, Debug)]
36pub struct IecLocalPortSetup {
37    version: u8,
38    logical_name: ObisCode,
39    default_mode: u8,
40    default_baud: u8,
41    prop_baud: u8,
42    response_time: u8,
43    device_addr: Vec<u8>,
44    pass_p1: Vec<u8>,
45    pass_p2: Vec<u8>,
46    pass_w5: Vec<u8>,
47}
48
49impl IecLocalPortSetup {
50    /// Builds a new [`IecLocalPortSetup`] from its configuration.
51    pub fn new(config: IecLocalPortSetupConfig) -> Self {
52        IecLocalPortSetup {
53            version: config.version,
54            logical_name: config.logical_name,
55            default_mode: config.default_mode,
56            default_baud: config.default_baud,
57            prop_baud: config.prop_baud,
58            response_time: config.response_time,
59            device_addr: config.device_addr,
60            pass_p1: config.pass_p1,
61            pass_p2: config.pass_p2,
62            pass_w5: config.pass_w5,
63        }
64    }
65}
66
67impl InterfaceClass for IecLocalPortSetup {
68    fn class_id(&self) -> u16 {
69        19
70    }
71
72    fn version(&self) -> u8 {
73        self.version
74    }
75
76    fn logical_name(&self) -> &ObisCode {
77        &self.logical_name
78    }
79
80    fn attributes(&self) -> Vec<(u8, CosemDataType)> {
81        vec![
82            (1, CosemDataType::OctetString(self.logical_name.to_bytes())),
83            (2, CosemDataType::Enum(self.default_mode)),
84            (3, CosemDataType::Enum(self.default_baud)),
85            (4, CosemDataType::Enum(self.prop_baud)),
86            (5, CosemDataType::Enum(self.response_time)),
87            (6, CosemDataType::OctetString(self.device_addr.clone())),
88            (7, CosemDataType::OctetString(self.pass_p1.clone())),
89            (8, CosemDataType::OctetString(self.pass_p2.clone())),
90            (9, CosemDataType::OctetString(self.pass_w5.clone())),
91        ]
92    }
93
94    fn methods(&self) -> Vec<(u8, String)> {
95        // The IEC local port setup class defines no specific methods.
96        vec![]
97    }
98
99    fn serialize_ber(&self, buf: &mut Vec<u8>) -> Result<(), BerError> {
100        let mut seq_buf = Vec::new();
101        CosemDataType::LongUnsigned(self.class_id()).serialize_ber(&mut seq_buf)?;
102        for (_, attr) in self.attributes() {
103            attr.serialize_ber(&mut seq_buf)?;
104        }
105        buf.push(0x02); // structure [2]
106        write_length(1 + self.attributes().len(), buf); // length = element count
107        buf.extend_from_slice(&seq_buf);
108        Ok(())
109    }
110
111    fn deserialize_ber(&mut self, data: &[u8]) -> Result<(), BerError> {
112        let (tlv, rest) = CosemDataType::deserialize_ber(data)?;
113        if !rest.is_empty() {
114            return Err(BerError::InvalidTag);
115        }
116        let CosemDataType::Structure(seq) = tlv else {
117            return Err(BerError::InvalidTag);
118        };
119        // class_id + 9 attributes.
120        if seq.len() != 10 {
121            return Err(BerError::InvalidLength);
122        }
123        if let CosemDataType::LongUnsigned(class_id) = seq[0] {
124            if class_id != self.class_id() {
125                return Err(BerError::InvalidValue);
126            }
127        } else {
128            return Err(BerError::InvalidTag);
129        }
130        if let CosemDataType::OctetString(obis) = &seq[1] {
131            if obis.len() == 6 {
132                self.logical_name = ObisCode::new(obis[0], obis[1], obis[2], obis[3], obis[4], obis[5]);
133            } else {
134                return Err(BerError::InvalidLength);
135            }
136        } else {
137            return Err(BerError::InvalidTag);
138        }
139        self.default_mode = take_enum(&seq[2])?;
140        self.default_baud = take_enum(&seq[3])?;
141        self.prop_baud = take_enum(&seq[4])?;
142        self.response_time = take_enum(&seq[5])?;
143        self.device_addr = take_octet_string(&seq[6])?;
144        self.pass_p1 = take_octet_string(&seq[7])?;
145        self.pass_p2 = take_octet_string(&seq[8])?;
146        self.pass_w5 = take_octet_string(&seq[9])?;
147        Ok(())
148    }
149
150    fn set_attribute(&mut self, attribute_id: u8, value: CosemDataType) -> Result<(), String> {
151        match attribute_id {
152            2 => {
153                self.default_mode = take_enum(&value).map_err(|_| "default_mode must be enum".to_string())?;
154                Ok(())
155            }
156            3 => {
157                self.default_baud = take_enum(&value).map_err(|_| "default_baud must be enum".to_string())?;
158                Ok(())
159            }
160            4 => {
161                self.prop_baud = take_enum(&value).map_err(|_| "prop_baud must be enum".to_string())?;
162                Ok(())
163            }
164            5 => {
165                self.response_time = take_enum(&value).map_err(|_| "response_time must be enum".to_string())?;
166                Ok(())
167            }
168            6 => {
169                self.device_addr =
170                    take_octet_string(&value).map_err(|_| "device_addr must be octet-string".to_string())?;
171                Ok(())
172            }
173            7 => {
174                self.pass_p1 = take_octet_string(&value).map_err(|_| "pass_p1 must be octet-string".to_string())?;
175                Ok(())
176            }
177            8 => {
178                self.pass_p2 = take_octet_string(&value).map_err(|_| "pass_p2 must be octet-string".to_string())?;
179                Ok(())
180            }
181            9 => {
182                self.pass_w5 = take_octet_string(&value).map_err(|_| "pass_w5 must be octet-string".to_string())?;
183                Ok(())
184            }
185            _ => Err(format!("IecLocalPortSetup attribute {attribute_id} is not writable")),
186        }
187    }
188
189    fn invoke_method(&mut self, method_id: u8, _params: Option<CosemDataType>) -> Result<CosemDataType, String> {
190        Err(format!("Method {method_id} not supported for IEC local port setup (no specific methods)"))
191    }
192
193    fn as_any(&self) -> &dyn Any {
194        self
195    }
196}
197
198fn take_enum(value: &CosemDataType) -> Result<u8, BerError> {
199    match value {
200        CosemDataType::Enum(v) => Ok(*v),
201        _ => Err(BerError::InvalidTag),
202    }
203}
204
205fn take_octet_string(value: &CosemDataType) -> Result<Vec<u8>, BerError> {
206    match value {
207        CosemDataType::OctetString(bytes) => Ok(bytes.clone()),
208        _ => Err(BerError::InvalidTag),
209    }
210}
211
212/// Writes a BER length octet (short or long form).
213#[allow(clippy::cast_possible_truncation)] // length < 128 and num_octets in 1..=8 always fit u8
214fn write_length(length: usize, buf: &mut Vec<u8>) {
215    if length < 128 {
216        buf.push(length as u8);
217    } else {
218        let bytes = (length as u64).to_be_bytes();
219        let first_non_zero = bytes.iter().position(|&b| b != 0).unwrap_or(7);
220        let num_octets = 8 - first_non_zero;
221        buf.push(0x80 | num_octets as u8);
222        buf.extend_from_slice(&bytes[first_non_zero..]);
223    }
224}
225
226#[cfg(test)]
227mod tests {
228    use super::*;
229
230    fn sample_versioned(version: u8) -> IecLocalPortSetup {
231        IecLocalPortSetup::new(IecLocalPortSetupConfig {
232            logical_name: ObisCode::new(0, 0, 20, 0, 0, 255),
233            version,
234            default_mode: 0,
235            default_baud: 5,
236            prop_baud: 5,
237            response_time: 0,
238            device_addr: b"01".to_vec(),
239            pass_p1: b"pass1".to_vec(),
240            pass_p2: b"pass2".to_vec(),
241            pass_w5: b"passw5".to_vec(),
242        })
243    }
244
245    #[test]
246    fn class_id_and_attributes() {
247        let obj = sample_versioned(1);
248        assert_eq!(obj.class_id(), 19);
249        assert_eq!(obj.version(), 1);
250        assert_eq!(obj.attributes().len(), 9);
251        assert!(obj.methods().is_empty());
252    }
253
254    #[test]
255    fn round_trip_all_versions() {
256        for version in 0..=1u8 {
257            let obj = sample_versioned(version);
258            let mut buf = Vec::new();
259            obj.serialize_ber(&mut buf).unwrap();
260            let mut decoded = sample_versioned(version);
261            decoded.default_mode = 9;
262            decoded.deserialize_ber(&buf).unwrap();
263            assert_eq!(decoded.attributes(), obj.attributes());
264        }
265    }
266}