Skip to main content

spodes_rs/spodus/
meter.rs

1//! Meter registry and aggregation (СТО 34.01-5.1-013-2023, §10.2).
2//!
3//! The ИВКЭ keeps a configured list of the meters it serves (§10.2,
4//! `0.0.94.7.128.255`, class Data). Each meter is described by its composite
5//! identifier, model and communication channels. The registry also caches the
6//! last-read attribute values per meter (the aggregation the ИВКЭ serves
7//! upstream without re-polling).
8
9use std::collections::HashMap;
10
11use crate::classes::data::Data;
12use crate::obis::ObisCode;
13use crate::types::CosemDataType;
14
15use super::obis;
16
17/// One communication channel of a meter (§10.2, `channel`).
18#[derive(Clone, Debug, Default, PartialEq, Eq)]
19pub struct MeterChannel {
20    /// Channel identifier (`id`).
21    pub id: u8,
22    /// Meter address within the channel (`address`, may be empty).
23    pub address: Vec<u8>,
24}
25
26/// A configured meter (§10.2, `device_description`).
27#[derive(Clone, Debug, Default, PartialEq, Eq)]
28pub struct MeterDescriptor {
29    /// Composite meter identifier (manufacturer code + serial, e.g. `SIT12260004`).
30    pub meter_id: Vec<u8>,
31    /// Meter model.
32    pub meter_model: Vec<u8>,
33    /// Communication channels for reaching the meter.
34    pub channels: Vec<MeterChannel>,
35}
36
37impl MeterDescriptor {
38    fn to_structure(&self) -> CosemDataType {
39        let channels = self
40            .channels
41            .iter()
42            .map(|c| {
43                CosemDataType::Structure(vec![
44                    CosemDataType::Unsigned(c.id),
45                    CosemDataType::OctetString(c.address.clone()),
46                ])
47            })
48            .collect();
49        CosemDataType::Structure(vec![
50            CosemDataType::OctetString(self.meter_id.clone()),
51            CosemDataType::OctetString(self.meter_model.clone()),
52            CosemDataType::Array(channels),
53        ])
54    }
55}
56
57/// The configured meter list plus a per-meter aggregation cache.
58#[derive(Clone, Debug, Default)]
59pub struct MeterRegistry {
60    meters: Vec<MeterDescriptor>,
61    /// Cached last-read values: `meter_id` → list of `(obis, attribute, value)`.
62    cache: HashMap<Vec<u8>, Vec<(ObisCode, u8, CosemDataType)>>,
63}
64
65impl MeterRegistry {
66    /// Creates an empty registry.
67    pub fn new() -> Self {
68        Self::default()
69    }
70
71    /// Adds a meter, replacing any existing entry with the same `meter_id`.
72    pub fn add(&mut self, meter: MeterDescriptor) {
73        self.remove(&meter.meter_id);
74        self.meters.push(meter);
75    }
76
77    /// Removes a meter and all its cached data (§10.2: related data is removed).
78    pub fn remove(&mut self, meter_id: &[u8]) {
79        self.meters.retain(|m| m.meter_id != meter_id);
80        self.cache.remove(meter_id);
81    }
82
83    /// Looks up a meter by its identifier.
84    pub fn find(&self, meter_id: &[u8]) -> Option<&MeterDescriptor> {
85        self.meters.iter().find(|m| m.meter_id == meter_id)
86    }
87
88    /// The configured meters.
89    pub fn meters(&self) -> &[MeterDescriptor] {
90        &self.meters
91    }
92
93    /// Stores (or updates) a cached attribute value read from a meter.
94    pub fn store(&mut self, meter_id: &[u8], obis: ObisCode, attribute: u8, value: CosemDataType) {
95        let entries = self.cache.entry(meter_id.to_vec()).or_default();
96        if let Some(slot) = entries.iter_mut().find(|(o, a, _)| *o == obis && *a == attribute) {
97            slot.2 = value;
98        } else {
99            entries.push((obis, attribute, value));
100        }
101    }
102
103    /// Returns a cached attribute value, if present.
104    pub fn cached(&self, meter_id: &[u8], obis: &ObisCode, attribute: u8) -> Option<&CosemDataType> {
105        self.cache
106            .get(meter_id)
107            .and_then(|entries| entries.iter().find(|(o, a, _)| o == obis && *a == attribute).map(|(_, _, v)| v))
108    }
109
110    /// Builds the COSEM meter-list `Data` (IC 1) object (§10.2, `0.0.94.7.128.255`).
111    pub fn build_meter_list(&self) -> Data {
112        let array = self.meters.iter().map(MeterDescriptor::to_structure).collect();
113        Data::new(obis::meter_list(), CosemDataType::Array(array))
114    }
115}
116
117#[cfg(test)]
118mod tests {
119    use super::*;
120    use crate::interface::InterfaceClass;
121
122    fn sample() -> MeterDescriptor {
123        MeterDescriptor {
124            meter_id: b"SIT12260004".to_vec(),
125            meter_model: b"SiT".to_vec(),
126            channels: vec![MeterChannel { id: 1, address: b"\x02".to_vec() }],
127        }
128    }
129
130    #[test]
131    fn registry_add_find_remove() {
132        let mut registry = MeterRegistry::new();
133        registry.add(sample());
134        assert!(registry.find(b"SIT12260004").is_some());
135        assert_eq!(registry.meters().len(), 1);
136
137        // The meter-list object carries one device_description.
138        let list = registry.build_meter_list();
139        assert_eq!(list.class_id(), 1);
140        assert_eq!(list.logical_name(), &obis::meter_list());
141        let CosemDataType::Array(rows) = &list.attributes()[1].1 else { panic!("array") };
142        assert_eq!(rows.len(), 1);
143
144        registry.remove(b"SIT12260004");
145        assert!(registry.find(b"SIT12260004").is_none());
146    }
147
148    #[test]
149    fn aggregation_cache_stores_and_evicts() {
150        let mut registry = MeterRegistry::new();
151        registry.add(sample());
152        let energy = ObisCode::new(1, 0, 1, 8, 0, 255);
153        registry.store(b"SIT12260004", energy.clone(), 2, CosemDataType::DoubleLongUnsigned(1000));
154        assert_eq!(registry.cached(b"SIT12260004", &energy, 2), Some(&CosemDataType::DoubleLongUnsigned(1000)));
155        // Updating overwrites the cached value.
156        registry.store(b"SIT12260004", energy.clone(), 2, CosemDataType::DoubleLongUnsigned(2000));
157        assert_eq!(registry.cached(b"SIT12260004", &energy, 2), Some(&CosemDataType::DoubleLongUnsigned(2000)));
158        // Removing the meter drops its cache.
159        registry.remove(b"SIT12260004");
160        assert_eq!(registry.cached(b"SIT12260004", &energy, 2), None);
161    }
162}