bo4e-core 0.1.0

Core types for BO4E (Business Objects for Energy)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! Meter reading (Zaehlwerksstand) component.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::enums::{MeasuredValueStatus, ReadingType, Unit};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// A meter reading at a specific point in time.
///
/// German: Zaehlwerksstand
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::MeterReading;
/// use bo4e_core::enums::{ReadingType, Unit};
/// use chrono::Utc;
///
/// let reading = MeterReading {
///     timestamp: Some(Utc::now()),
///     value: Some(12345.67),
///     unit: Some(Unit::KilowattHour),
///     reading_type: Some(ReadingType::RemoteReading),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct MeterReading {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Timestamp of the reading (Ablesezeitpunkt)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<DateTime<Utc>>,

    /// Meter reading value (Zaehlwerksstand)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<f64>,

    /// Unit of measurement (Einheit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unit: Option<Unit>,

    /// Type of reading (Ableseart)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reading_type: Option<ReadingType>,

    /// Status/quality of the reading (Status)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<MeasuredValueStatus>,

    /// OBIS code for the register (OBIS-Kennzahl)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub obis_code: Option<String>,

    /// Register ID (Zaehlwerkskennung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub register_id: Option<String>,
}

impl Bo4eObject for MeterReading {
    fn type_name_german() -> &'static str {
        "Zaehlwerksstand"
    }

    fn type_name_english() -> &'static str {
        "MeterReading"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use chrono::TimeZone;

    #[test]
    fn test_meter_reading() {
        let reading = MeterReading {
            timestamp: Some(Utc.with_ymd_and_hms(2024, 1, 1, 0, 0, 0).unwrap()),
            value: Some(12345.67),
            unit: Some(Unit::KilowattHour),
            reading_type: Some(ReadingType::RemoteReading),
            obis_code: Some("1-0:1.8.0".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&reading).unwrap();
        assert!(json.contains("12345.67"));
        assert!(json.contains("1-0:1.8.0"));
    }

    #[test]
    fn test_roundtrip() {
        let reading = MeterReading {
            timestamp: Some(Utc::now()),
            value: Some(999.99),
            unit: Some(Unit::CubicMeter),
            ..Default::default()
        };

        let json = serde_json::to_string(&reading).unwrap();
        let parsed: MeterReading = serde_json::from_str(&json).unwrap();
        assert_eq!(reading.value, parsed.value);
        assert_eq!(reading.unit, parsed.unit);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(MeterReading::type_name_german(), "Zaehlwerksstand");
        assert_eq!(MeterReading::type_name_english(), "MeterReading");
    }
}