bo4e_core/com/
meter_reading.rs

1//! Meter reading (Zaehlwerksstand) component.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::enums::{MeasuredValueStatus, ReadingType, Unit};
7use crate::traits::{Bo4eMeta, Bo4eObject};
8
9/// A meter reading at a specific point in time.
10///
11/// German: Zaehlwerksstand
12///
13/// # Example
14///
15/// ```rust
16/// use bo4e_core::com::MeterReading;
17/// use bo4e_core::enums::{ReadingType, Unit};
18/// use chrono::Utc;
19///
20/// let reading = MeterReading {
21///     timestamp: Some(Utc::now()),
22///     value: Some(12345.67),
23///     unit: Some(Unit::KilowattHour),
24///     reading_type: Some(ReadingType::RemoteReading),
25///     ..Default::default()
26/// };
27/// ```
28#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
29#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
30#[cfg_attr(feature = "json-schema", schemars(rename = "Zaehlwerksstand"))]
31#[serde(rename_all = "camelCase")]
32pub struct MeterReading {
33    /// BO4E metadata
34    #[serde(flatten)]
35    pub meta: Bo4eMeta,
36
37    /// Timestamp of the reading (Ablesezeitpunkt)
38    #[serde(skip_serializing_if = "Option::is_none")]
39    #[cfg_attr(feature = "json-schema", schemars(rename = "ablesezeitpunkt"))]
40    pub timestamp: Option<DateTime<Utc>>,
41
42    /// Meter reading value (Zaehlwerksstand)
43    #[serde(skip_serializing_if = "Option::is_none")]
44    #[cfg_attr(feature = "json-schema", schemars(rename = "zaehlwerksstand"))]
45    pub value: Option<f64>,
46
47    /// Unit of measurement (Einheit)
48    #[serde(skip_serializing_if = "Option::is_none")]
49    #[cfg_attr(feature = "json-schema", schemars(rename = "einheit"))]
50    pub unit: Option<Unit>,
51
52    /// Type of reading (Ableseart)
53    #[serde(skip_serializing_if = "Option::is_none")]
54    #[cfg_attr(feature = "json-schema", schemars(rename = "ableseart"))]
55    pub reading_type: Option<ReadingType>,
56
57    /// Status/quality of the reading (Status)
58    #[serde(skip_serializing_if = "Option::is_none")]
59    #[cfg_attr(feature = "json-schema", schemars(rename = "status"))]
60    pub status: Option<MeasuredValueStatus>,
61
62    /// OBIS code for the register (OBIS-Kennzahl)
63    #[serde(skip_serializing_if = "Option::is_none")]
64    #[cfg_attr(feature = "json-schema", schemars(rename = "obisKennzahl"))]
65    pub obis_code: Option<String>,
66
67    /// Register ID (Zaehlwerkskennung)
68    #[serde(skip_serializing_if = "Option::is_none")]
69    #[cfg_attr(feature = "json-schema", schemars(rename = "zaehlwerkskennung"))]
70    pub register_id: Option<String>,
71}
72
73impl Bo4eObject for MeterReading {
74    fn type_name_german() -> &'static str {
75        "Zaehlwerksstand"
76    }
77
78    fn type_name_english() -> &'static str {
79        "MeterReading"
80    }
81
82    fn meta(&self) -> &Bo4eMeta {
83        &self.meta
84    }
85
86    fn meta_mut(&mut self) -> &mut Bo4eMeta {
87        &mut self.meta
88    }
89}
90
91#[cfg(test)]
92mod tests {
93    use super::*;
94    use chrono::TimeZone;
95
96    #[test]
97    fn test_meter_reading() {
98        let reading = MeterReading {
99            timestamp: Some(Utc.with_ymd_and_hms(2024, 1, 1, 0, 0, 0).unwrap()),
100            value: Some(12345.67),
101            unit: Some(Unit::KilowattHour),
102            reading_type: Some(ReadingType::RemoteReading),
103            obis_code: Some("1-0:1.8.0".to_string()),
104            ..Default::default()
105        };
106
107        let json = serde_json::to_string(&reading).unwrap();
108        assert!(json.contains("12345.67"));
109        assert!(json.contains("1-0:1.8.0"));
110    }
111
112    #[test]
113    fn test_roundtrip() {
114        let reading = MeterReading {
115            timestamp: Some(Utc::now()),
116            value: Some(999.99),
117            unit: Some(Unit::CubicMeter),
118            ..Default::default()
119        };
120
121        let json = serde_json::to_string(&reading).unwrap();
122        let parsed: MeterReading = serde_json::from_str(&json).unwrap();
123        assert_eq!(reading.value, parsed.value);
124        assert_eq!(reading.unit, parsed.unit);
125    }
126
127    #[test]
128    fn test_bo4e_object_impl() {
129        assert_eq!(MeterReading::type_name_german(), "Zaehlwerksstand");
130        assert_eq!(MeterReading::type_name_english(), "MeterReading");
131    }
132}
bo4e_core/com/meter_reading.rs

bo4e_core/com/
meter_reading.rs
