Skip to main content

spodes_rs/spodus/
push.rs

1//! ИВКЭ notification objects (СТО 34.01-5.1-013-2023, §8.5).
2//!
3//! The event push-message object (§8.5.11, `0.0.96.50.0.255`) describes the
4//! aggregated meter events the ИВКЭ pushes upstream; the push-filter mask
5//! (`0.0.97.98.10.255`) selects which events are relayed.
6
7use crate::classes::data::Data;
8use crate::types::CosemDataType;
9
10use super::obis;
11
12/// One pushed meter event (§8.5.11, `message`).
13#[derive(Clone, Debug, Default)]
14pub struct EventMessage {
15    /// ИВКЭ logical name (16 octets).
16    pub uspd_ln: Vec<u8>,
17    /// Meter number.
18    pub meter_number: Vec<u8>,
19    /// Meter model.
20    pub meter_model: Vec<u8>,
21    /// Event date-time (octets).
22    pub date_time: Vec<u8>,
23    /// Field number within the meter's event-journal OBIS.
24    pub journal_id: u8,
25    /// Event code (per СПОДЭС / СПОДУС).
26    pub code: u16,
27}
28
29impl EventMessage {
30    fn to_structure(&self) -> CosemDataType {
31        CosemDataType::Structure(vec![
32            CosemDataType::OctetString(self.uspd_ln.clone()),
33            CosemDataType::OctetString(self.meter_number.clone()),
34            CosemDataType::OctetString(self.meter_model.clone()),
35            CosemDataType::DateTime(self.date_time.clone()),
36            CosemDataType::Unsigned(self.journal_id),
37            CosemDataType::LongUnsigned(self.code),
38        ])
39    }
40}
41
42/// The event push-message object (§8.5.11, `0.0.96.50.0.255`).
43#[derive(Clone, Debug, Default)]
44pub struct EventMessages {
45    messages: Vec<EventMessage>,
46}
47
48impl EventMessages {
49    /// Creates an empty event-message list.
50    pub fn new() -> Self {
51        Self::default()
52    }
53
54    /// Appends an event.
55    pub fn push(&mut self, message: EventMessage) {
56        self.messages.push(message);
57    }
58
59    /// Builds the COSEM `Data` (IC 1) object holding the `array message` (§8.5.11).
60    pub fn build(&self) -> Data {
61        let array = self.messages.iter().map(EventMessage::to_structure).collect();
62        Data::new(obis::event_message(), CosemDataType::Array(array))
63    }
64}
65
66/// Builds the push-filter mask object (`0.0.97.98.10.255`, IC 1). Its value type
67/// mirrors the meter's own push-mask object (§8.5.9), so it is supplied by the
68/// caller.
69pub fn push_mask(value: CosemDataType) -> Data {
70    Data::new(obis::push_mask(), value)
71}
72
73#[cfg(test)]
74mod tests {
75    use super::*;
76    use crate::interface::InterfaceClass;
77
78    #[test]
79    fn event_messages_build_data_object() {
80        let mut events = EventMessages::new();
81        events.push(EventMessage {
82            uspd_ln: b"IVKE000000000001".to_vec(),
83            meter_number: b"SIT12260004".to_vec(),
84            meter_model: b"SiT".to_vec(),
85            date_time: vec![0x07, 0xE6, 0x07, 0x04],
86            journal_id: 1,
87            code: 0x1C,
88        });
89        let object = events.build();
90        assert_eq!(object.class_id(), 1);
91        assert_eq!(object.logical_name(), &obis::event_message());
92        let CosemDataType::Array(rows) = &object.attributes()[1].1 else { panic!("array") };
93        let CosemDataType::Structure(fields) = &rows[0] else { panic!("message structure") };
94        assert_eq!(fields.len(), 6);
95        assert_eq!(fields[5], CosemDataType::LongUnsigned(0x1C));
96    }
97
98    #[test]
99    fn push_mask_wraps_value() {
100        let mask = push_mask(CosemDataType::DoubleLongUnsigned(0xFF00));
101        assert_eq!(mask.logical_name(), &obis::push_mask());
102        assert_eq!(mask.attributes()[1].1, CosemDataType::DoubleLongUnsigned(0xFF00));
103    }
104}