Skip to main content

spodes_rs/spodus/
nameplate.rs

1//! ИВКЭ nameplate / passport data (СТО 34.01-5.1-013-2023, §10.14).
2//!
3//! The passport parameters are exposed as `Data` (IC 1) objects at fixed OBIS
4//! codes. Text identifiers are carried as octet-strings, the production year as
5//! a long-unsigned, dates as date-time octet-strings and the firmware checksum
6//! as an octet-string.
7
8use crate::classes::data::Data;
9use crate::classes::profile_generic::ProfileGeneric;
10use crate::interface::InterfaceClass;
11use crate::types::CosemDataType;
12
13use super::obis;
14use super::profile::reference_profile;
15
16/// The ИВКЭ passport data (§10.14).
17#[derive(Clone, Debug, Default)]
18pub struct Nameplate {
19    /// Serial number.
20    pub serial_number: String,
21    /// Model designation.
22    pub model: String,
23    /// Firmware version.
24    pub firmware_version: String,
25    /// Manufacturer name.
26    pub manufacturer: String,
27    /// Production year.
28    pub production_year: u16,
29    /// Hardware version.
30    pub hardware_version: String,
31    /// СПОДУС specification version.
32    pub spodus_version: String,
33    /// Last firmware-update date, as date-time octets (empty if unknown).
34    pub last_update_date: Vec<u8>,
35    /// Identifier of the non-metrological firmware part.
36    pub nonmetrological_firmware_id: String,
37    /// Checksum of the metrological firmware part.
38    pub metrological_firmware_checksum: Vec<u8>,
39}
40
41impl Nameplate {
42    /// Builds the `Data` objects for every passport parameter.
43    pub fn objects(&self) -> Vec<Data> {
44        let text = |s: &str| CosemDataType::OctetString(s.as_bytes().to_vec());
45        vec![
46            Data::new(obis::serial_number(), text(&self.serial_number)),
47            Data::new(obis::model(), text(&self.model)),
48            Data::new(obis::firmware_version(), text(&self.firmware_version)),
49            Data::new(obis::manufacturer(), text(&self.manufacturer)),
50            Data::new(obis::production_year(), CosemDataType::LongUnsigned(self.production_year)),
51            Data::new(obis::hardware_version(), text(&self.hardware_version)),
52            Data::new(obis::spodus_version(), text(&self.spodus_version)),
53            Data::new(obis::last_update_date(), CosemDataType::DateTime(self.last_update_date.clone())),
54            Data::new(obis::nonmetrological_firmware_id(), text(&self.nonmetrological_firmware_id)),
55            Data::new(
56                obis::metrological_firmware_checksum(),
57                CosemDataType::OctetString(self.metrological_firmware_checksum.clone()),
58            ),
59        ]
60    }
61
62    /// Builds the passport-data reference profile (§10.14, `0.0.94.7.0.255`,
63    /// IC 7 v1): one row aggregating every passport parameter, with the
64    /// individual passport OBIS codes as the columns.
65    pub fn profile(&self) -> ProfileGeneric {
66        let objects = self.objects();
67        let columns: Vec<_> = objects.iter().map(|o| o.logical_name().clone()).collect();
68        let row = objects.iter().map(|o| o.attributes()[1].1.clone()).collect();
69        reference_profile(obis::nameplate_profile(), &columns, vec![CosemDataType::Structure(row)])
70    }
71}
72
73#[cfg(test)]
74mod tests {
75    use super::*;
76    use crate::interface::InterfaceClass;
77
78    #[test]
79    fn nameplate_builds_data_objects() {
80        let plate = Nameplate {
81            serial_number: "IVKE-0001".to_string(),
82            model: "GW-100".to_string(),
83            firmware_version: "1.2.3".to_string(),
84            manufacturer: "Acme".to_string(),
85            production_year: 2026,
86            hardware_version: "revB".to_string(),
87            spodus_version: "СТО 013-2023".to_string(),
88            last_update_date: vec![0x07, 0xE6, 0x07, 0x04],
89            nonmetrological_firmware_id: "app-42".to_string(),
90            metrological_firmware_checksum: vec![0xDE, 0xAD, 0xBE, 0xEF],
91        };
92        let objects = plate.objects();
93        assert_eq!(objects.len(), 10);
94
95        // Every object is a Data (class_id 1) at the right OBIS.
96        assert!(objects.iter().all(|o| o.class_id() == 1));
97        assert_eq!(objects[0].logical_name(), &obis::serial_number());
98
99        // Serial number is an octet-string of the text.
100        assert_eq!(objects[0].attributes()[1].1, CosemDataType::OctetString(b"IVKE-0001".to_vec()));
101        // Production year is a long-unsigned.
102        let year = objects.iter().find(|o| o.logical_name() == &obis::production_year()).unwrap();
103        assert_eq!(year.attributes()[1].1, CosemDataType::LongUnsigned(2026));
104    }
105
106    #[test]
107    fn nameplate_profile_aggregates_passport() {
108        let plate = Nameplate { serial_number: "IVKE-0001".to_string(), production_year: 2026, ..Default::default() };
109        let profile = plate.profile();
110        assert_eq!(profile.class_id(), 7);
111        assert_eq!(profile.version(), 1);
112        assert_eq!(profile.logical_name(), &obis::nameplate_profile());
113
114        let attrs = profile.attributes();
115        // One row with the ten passport values; ten capture columns.
116        let CosemDataType::Array(rows) = &attrs[1].1 else { panic!("buffer array") };
117        assert_eq!(rows.len(), 1);
118        let CosemDataType::Structure(values) = &rows[0] else { panic!("row structure") };
119        assert_eq!(values.len(), 10);
120        assert_eq!(values[0], CosemDataType::OctetString(b"IVKE-0001".to_vec()));
121        let CosemDataType::Array(caps) = &attrs[2].1 else { panic!("capture array") };
122        assert_eq!(caps.len(), 10);
123    }
124}