Skip to main content

spodes_rs/spodus/
obis.rs

1//! OBIS codes of the СПОДУС / ИВКЭ information model (СТО 34.01-5.1-013-2023).
2//!
3//! Each function returns the [`ObisCode`] of a mandated object. Codes with a
4//! channel component (`0.b.…`) take the channel as an argument.
5
6use crate::obis::ObisCode;
7
8/// SAP assignment object of the management logical device (§10.1.8,
9/// `0.0.41.0.0.255`, IC 17). The management logical device itself has address 1.
10pub fn sap_assignment() -> ObisCode {
11    ObisCode::new(0, 0, 41, 0, 0, 255)
12}
13
14// --- Notifications (§8.5) --------------------------------------------------
15
16/// Push setup object (`0.0.25.9.0.255`, IC 40 v2).
17pub fn push_setup() -> ObisCode {
18    ObisCode::new(0, 0, 25, 9, 0, 255)
19}
20
21/// Event push-message object (§8.5.11, `0.0.96.50.0.255`, class Data).
22pub fn event_message() -> ObisCode {
23    ObisCode::new(0, 0, 96, 50, 0, 255)
24}
25
26/// Push-message filter mask (`0.0.97.98.10.255`, class Data).
27pub fn push_mask() -> ObisCode {
28    ObisCode::new(0, 0, 97, 98, 10, 255)
29}
30
31/// ИВКЭ logical name (`0.0.42.0.0.255`).
32pub fn ivke_logical_name() -> ObisCode {
33    ObisCode::new(0, 0, 42, 0, 0, 255)
34}
35
36// --- Nameplate / passport data (§10.14, class Data) ------------------------
37
38/// Passport-data reference profile (§10.14, `0.0.94.7.0.255`, Profile generic).
39pub fn nameplate_profile() -> ObisCode {
40    ObisCode::new(0, 0, 94, 7, 0, 255)
41}
42
43/// Time-difference-with-meters delta (`0.0.94.7.141.255`, class Data, unsigned).
44pub fn time_delta() -> ObisCode {
45    ObisCode::new(0, 0, 94, 7, 141, 255)
46}
47
48/// Discrete-inputs state bitmask (`0.0.96.3.1.255`, class Data, long-unsigned).
49pub fn discrete_inputs() -> ObisCode {
50    ObisCode::new(0, 0, 96, 3, 1, 255)
51}
52
53/// ИВКЭ serial number (`0.0.96.1.0.255`).
54pub fn serial_number() -> ObisCode {
55    ObisCode::new(0, 0, 96, 1, 0, 255)
56}
57
58/// ИВКЭ model (`0.0.96.1.1.255`).
59pub fn model() -> ObisCode {
60    ObisCode::new(0, 0, 96, 1, 1, 255)
61}
62
63/// Firmware version (`0.0.96.1.2.255`).
64pub fn firmware_version() -> ObisCode {
65    ObisCode::new(0, 0, 96, 1, 2, 255)
66}
67
68/// Manufacturer name (`0.0.96.1.3.255`).
69pub fn manufacturer() -> ObisCode {
70    ObisCode::new(0, 0, 96, 1, 3, 255)
71}
72
73/// Production year (`0.0.96.1.4.255`).
74pub fn production_year() -> ObisCode {
75    ObisCode::new(0, 0, 96, 1, 4, 255)
76}
77
78/// Hardware version (`0.0.0.2.1.255`).
79pub fn hardware_version() -> ObisCode {
80    ObisCode::new(0, 0, 0, 2, 1, 255)
81}
82
83/// СПОДУС specification version (`0.0.96.1.6.255`).
84pub fn spodus_version() -> ObisCode {
85    ObisCode::new(0, 0, 96, 1, 6, 255)
86}
87
88/// Last firmware-update date (`0.0.96.1.7.255`).
89pub fn last_update_date() -> ObisCode {
90    ObisCode::new(0, 0, 96, 1, 7, 255)
91}
92
93/// Non-metrological firmware identifier (`0.0.96.1.8.255`).
94pub fn nonmetrological_firmware_id() -> ObisCode {
95    ObisCode::new(0, 0, 96, 1, 8, 255)
96}
97
98/// Metrological firmware checksum (`0.0.96.1.10.255`).
99pub fn metrological_firmware_checksum() -> ObisCode {
100    ObisCode::new(0, 0, 96, 1, 10, 255)
101}
102
103// --- Meter management lists ------------------------------------------------
104
105/// Configured meter list (§10.2, `0.0.94.7.128.255`, class Data).
106pub fn meter_list() -> ObisCode {
107    ObisCode::new(0, 0, 94, 7, 128, 255)
108}
109
110/// Direct-channel table (§10.3, `0.0.94.7.129.255`, class Data).
111pub fn direct_channel_table() -> ObisCode {
112    ObisCode::new(0, 0, 94, 7, 129, 255)
113}
114
115/// ИВКЭ channel list (§10.4, `0.0.94.7.130.255`, Profile generic).
116pub fn channel_list() -> ObisCode {
117    ObisCode::new(0, 0, 94, 7, 130, 255)
118}
119
120/// Discovered-meters list (§10.5, `0.0.94.7.131.255`, Profile generic).
121pub fn discovered_meters() -> ObisCode {
122    ObisCode::new(0, 0, 94, 7, 131, 255)
123}
124
125/// Meter access policies (§10.6, `0.0.94.7.132.255`, array of Data structs).
126pub fn access_policies() -> ObisCode {
127    ObisCode::new(0, 0, 94, 7, 132, 255)
128}
129
130/// Meter data-exchange task list (§10.7, `0.0.94.7.133.255`, class Data).
131pub fn data_exchange_tasks() -> ObisCode {
132    ObisCode::new(0, 0, 94, 7, 133, 255)
133}
134
135// --- Journals (§10.9, §10.13) ----------------------------------------------
136
137/// Meter status table (§10.8, `0.0.94.7.134.255`, Profile generic).
138pub fn meter_status_table() -> ObisCode {
139    ObisCode::new(0, 0, 94, 7, 134, 255)
140}
141
142/// Meter data-exchange-status journal (§10.9, `0.0.94.7.135.255`, Profile generic).
143pub fn exchange_status_journal() -> ObisCode {
144    ObisCode::new(0, 0, 94, 7, 135, 255)
145}
146
147/// Object-correction journal (§10.10, `0.0.94.7.136.255`, Profile generic).
148pub fn object_correction_journal() -> ObisCode {
149    ObisCode::new(0, 0, 94, 7, 136, 255)
150}
151
152/// Numeric meter journal (§10.11, `0.0.94.7.137.255`, Profile generic).
153pub fn numeric_meter_journal() -> ObisCode {
154    ObisCode::new(0, 0, 94, 7, 137, 255)
155}
156
157/// Incoming-events table (§8.5.10, `0.0.94.7.140.255`, Profile generic).
158pub fn incoming_events_table() -> ObisCode {
159    ObisCode::new(0, 0, 94, 7, 140, 255)
160}
161
162/// Parameter-programming event log (§10.13, `0.0.96.11.3.255`).
163pub fn parameter_programming_log() -> ObisCode {
164    ObisCode::new(0, 0, 96, 11, 3, 255)
165}
166
167/// Access-control event log (§10.13, `0.0.96.11.6.255`).
168pub fn access_control_log() -> ObisCode {
169    ObisCode::new(0, 0, 96, 11, 6, 255)
170}
171
172/// Self-diagnostics event log (§10.13, `0.0.96.11.7.255`).
173pub fn self_diagnostics_log() -> ObisCode {
174    ObisCode::new(0, 0, 96, 11, 7, 255)
175}
176
177/// Switching event log for channel `b` (§10.13, `0.b.96.11.5.255`).
178pub fn switching_log(channel: u8) -> ObisCode {
179    ObisCode::new(0, channel, 96, 11, 5, 255)
180}
181
182/// Discrete-I/O event log for channel `b` (§10.13, `0.b.99.98.10.255`).
183pub fn discrete_io_log(channel: u8) -> ObisCode {
184    ObisCode::new(0, channel, 99, 98, 10, 255)
185}
186
187#[cfg(test)]
188mod tests {
189    use super::*;
190
191    #[test]
192    fn nameplate_codes() {
193        assert_eq!(serial_number().to_bytes(), vec![0, 0, 96, 1, 0, 255]);
194        assert_eq!(hardware_version().to_bytes(), vec![0, 0, 0, 2, 1, 255]);
195        assert_eq!(spodus_version().to_bytes(), vec![0, 0, 96, 1, 6, 255]);
196        assert_eq!(metrological_firmware_checksum().to_bytes(), vec![0, 0, 96, 1, 10, 255]);
197    }
198
199    #[test]
200    fn meter_lists_and_management() {
201        assert_eq!(sap_assignment().to_bytes(), vec![0, 0, 41, 0, 0, 255]);
202        assert_eq!(ivke_logical_name().to_bytes(), vec![0, 0, 42, 0, 0, 255]);
203        assert_eq!(discovered_meters().to_bytes(), vec![0, 0, 94, 7, 131, 255]);
204        assert_eq!(access_policies().to_bytes(), vec![0, 0, 94, 7, 132, 255]);
205    }
206
207    #[test]
208    fn journal_codes() {
209        assert_eq!(parameter_programming_log().to_bytes(), vec![0, 0, 96, 11, 3, 255]);
210        assert_eq!(access_control_log().to_bytes(), vec![0, 0, 96, 11, 6, 255]);
211        assert_eq!(self_diagnostics_log().to_bytes(), vec![0, 0, 96, 11, 7, 255]);
212        // Channel-scoped journals.
213        assert_eq!(switching_log(1).to_bytes(), vec![0, 1, 96, 11, 5, 255]);
214        assert_eq!(discrete_io_log(2).to_bytes(), vec![0, 2, 99, 98, 10, 255]);
215    }
216}