bo4e_core/com/
time_series_value.rs

1//! Time series value (Zeitreihenwert) component.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::enums::{MeasuredValueStatus, Unit};
7use crate::traits::{Bo4eMeta, Bo4eObject};
8
9/// A single value in a time series.
10///
11/// German: Zeitreihenwert
12///
13/// # Example
14///
15/// ```rust
16/// use bo4e_core::com::TimeSeriesValue;
17/// use bo4e_core::enums::Unit;
18/// use chrono::Utc;
19///
20/// let value = TimeSeriesValue {
21///     timestamp: Some(Utc::now()),
22///     value: Some(1234.56),
23///     unit: Some(Unit::KilowattHour),
24///     ..Default::default()
25/// };
26/// ```
27#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
28#[serde(rename_all = "camelCase")]
29pub struct TimeSeriesValue {
30    /// BO4E metadata
31    #[serde(flatten)]
32    pub meta: Bo4eMeta,
33
34    /// Timestamp of the value (Zeitpunkt)
35    #[serde(skip_serializing_if = "Option::is_none")]
36    pub timestamp: Option<DateTime<Utc>>,
37
38    /// Value (Wert)
39    #[serde(skip_serializing_if = "Option::is_none")]
40    pub value: Option<f64>,
41
42    /// Unit of measurement (Einheit)
43    #[serde(skip_serializing_if = "Option::is_none")]
44    pub unit: Option<Unit>,
45
46    /// Status/quality of the value (Status)
47    #[serde(skip_serializing_if = "Option::is_none")]
48    pub status: Option<MeasuredValueStatus>,
49
50    /// OBIS code (OBIS-Kennzahl)
51    #[serde(skip_serializing_if = "Option::is_none")]
52    pub obis_code: Option<String>,
53
54    /// Sequence number in the time series (Sequenznummer)
55    #[serde(skip_serializing_if = "Option::is_none")]
56    pub sequence_number: Option<i64>,
57}
58
59impl Bo4eObject for TimeSeriesValue {
60    fn type_name_german() -> &'static str {
61        "Zeitreihenwert"
62    }
63
64    fn type_name_english() -> &'static str {
65        "TimeSeriesValue"
66    }
67
68    fn meta(&self) -> &Bo4eMeta {
69        &self.meta
70    }
71
72    fn meta_mut(&mut self) -> &mut Bo4eMeta {
73        &mut self.meta
74    }
75}
76
77#[cfg(test)]
78mod tests {
79    use super::*;
80    use chrono::TimeZone;
81
82    #[test]
83    fn test_time_series_value() {
84        let value = TimeSeriesValue {
85            timestamp: Some(Utc.with_ymd_and_hms(2024, 1, 15, 12, 0, 0).unwrap()),
86            value: Some(1234.56),
87            unit: Some(Unit::KilowattHour),
88            sequence_number: Some(1),
89            ..Default::default()
90        };
91
92        let json = serde_json::to_string(&value).unwrap();
93        assert!(json.contains("1234.56"));
94    }
95
96    #[test]
97    fn test_roundtrip() {
98        let value = TimeSeriesValue {
99            timestamp: Some(Utc::now()),
100            value: Some(999.99),
101            unit: Some(Unit::CubicMeter),
102            status: Some(MeasuredValueStatus::Read),
103            ..Default::default()
104        };
105
106        let json = serde_json::to_string(&value).unwrap();
107        let parsed: TimeSeriesValue = serde_json::from_str(&json).unwrap();
108        assert_eq!(value.value, parsed.value);
109        assert_eq!(value.status, parsed.status);
110    }
111
112    #[test]
113    fn test_bo4e_object_impl() {
114        assert_eq!(TimeSeriesValue::type_name_german(), "Zeitreihenwert");
115        assert_eq!(TimeSeriesValue::type_name_english(), "TimeSeriesValue");
116    }
117}
bo4e_core/com/time_series_value.rs

bo4e_core/com/
time_series_value.rs
