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

//! Time-of-use register (Zaehlzeitregister) component.

use serde::{Deserialize, Serialize};

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

/// A time-of-use register on a meter for different tariff periods.
///
/// German: Zaehlzeitregister
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::TimeOfUseRegister;
/// use bo4e_core::enums::{TariffTime, Unit};
///
/// let register = TimeOfUseRegister {
///     register_id: Some("HT".to_string()),
///     tariff_time: Some(TariffTime::HighTariff),
///     unit: Some(Unit::KilowattHour),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TimeOfUseRegister {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

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

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

    /// Tariff time period (Tarifzeit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tariff_time: Option<TariffTime>,

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

    /// Description of the register (Bezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Active start time in HH:MM format (Aktivzeitbeginn)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub active_start_time: Option<String>,

    /// Active end time in HH:MM format (Aktivzeitende)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub active_end_time: Option<String>,
}

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

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

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

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

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

    #[test]
    fn test_high_tariff_register() {
        let register = TimeOfUseRegister {
            register_id: Some("HT".to_string()),
            tariff_time: Some(TariffTime::HighTariff),
            unit: Some(Unit::KilowattHour),
            active_start_time: Some("06:00".to_string()),
            active_end_time: Some("22:00".to_string()),
            ..Default::default()
        };

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

    #[test]
    fn test_roundtrip() {
        let register = TimeOfUseRegister {
            register_id: Some("NT".to_string()),
            tariff_time: Some(TariffTime::LowTariff),
            ..Default::default()
        };

        let json = serde_json::to_string(&register).unwrap();
        let parsed: TimeOfUseRegister = serde_json::from_str(&json).unwrap();
        assert_eq!(register, parsed);
    }

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