bo4e-core 0.2.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
124
125
126
127
128
129
130

//! Meter register (Zaehlwerk) component.

use serde::{Deserialize, Serialize};

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

/// A register on a meter that records consumption.
///
/// German: Zaehlwerk
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::MeterRegister;
/// use bo4e_core::enums::{EnergyDirection, Unit};
///
/// let register = MeterRegister {
///     obis_code: Some("1-0:1.8.0".to_string()),
///     energy_direction: Some(EnergyDirection::FeedOut),
///     unit: Some(Unit::KilowattHour),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "Zaehlwerk"))]
#[serde(rename_all = "camelCase")]
pub struct MeterRegister {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Register number/ID (Zaehlwerkskennung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "zaehlwerkskennung"))]
    pub register_id: Option<String>,

    /// OBIS code (OBIS-Kennzahl)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "obisKennzahl"))]
    pub obis_code: Option<String>,

    /// Type of register (Registerart)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "registerart"))]
    pub register_type: Option<RegisterType>,

    /// Direction of energy flow (Energierichtung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "energierichtung"))]
    pub energy_direction: Option<EnergyDirection>,

    /// Unit of measurement (Einheit)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "einheit"))]
    pub unit: Option<Unit>,

    /// Number of decimal places (Nachkommastellen)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "nachkommastellen"))]
    pub decimal_places: Option<i32>,

    /// Multiplier/transformer ratio (Wandlerfaktor)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "wandlerfaktor"))]
    pub transformer_ratio: Option<f64>,

    /// Description (Bezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "bezeichnung"))]
    pub description: Option<String>,
}

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

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

    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_electricity_register() {
        let register = MeterRegister {
            obis_code: Some("1-0:1.8.0".to_string()),
            energy_direction: Some(EnergyDirection::FeedOut),
            unit: Some(Unit::KilowattHour),
            description: Some("Bezug".to_string()),
            ..Default::default()
        };

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

    #[test]
    fn test_roundtrip() {
        let register = MeterRegister {
            obis_code: Some("1-0:2.8.0".to_string()),
            energy_direction: Some(EnergyDirection::FeedIn),
            unit: Some(Unit::KilowattHour),
            ..Default::default()
        };

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

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