bo4e-core 0.1.1

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

//! Time series value (Zeitreihenwert) component.

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

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

/// A single value in a time series.
///
/// German: Zeitreihenwert
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::TimeSeriesValue;
/// use bo4e_core::enums::Unit;
/// use chrono::Utc;
///
/// let value = TimeSeriesValue {
///     timestamp: Some(Utc::now()),
///     value: Some(1234.56),
///     unit: Some(Unit::KilowattHour),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TimeSeriesValue {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

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

    /// Value (Wert)
    #[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>,

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

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

    /// Sequence number in the time series (Sequenznummer)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sequence_number: Option<i64>,
}

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

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

    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_time_series_value() {
        let value = TimeSeriesValue {
            timestamp: Some(Utc.with_ymd_and_hms(2024, 1, 15, 12, 0, 0).unwrap()),
            value: Some(1234.56),
            unit: Some(Unit::KilowattHour),
            sequence_number: Some(1),
            ..Default::default()
        };

        let json = serde_json::to_string(&value).unwrap();
        assert!(json.contains("1234.56"));
    }

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

        let json = serde_json::to_string(&value).unwrap();
        let parsed: TimeSeriesValue = serde_json::from_str(&json).unwrap();
        assert_eq!(value.value, parsed.value);
        assert_eq!(value.status, parsed.status);
    }

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