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

//! Hardware component.

use serde::{Deserialize, Serialize};

use crate::enums::{DeviceCategory, DeviceType};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// Hardware component for representing physical devices.
///
/// This component represents hardware devices that are not meters,
/// such as transformers, communication equipment, or other technical devices.
///
/// German: Hardware
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::Hardware;
///
/// let hw = Hardware {
///     device_number: Some("HW-2024-001".to_string()),
///     description: Some("Current transformer".to_string()),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Hardware {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Device number assigned by the metering service operator (Gerätenummer)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub device_number: Option<String>,

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

    /// Category/class of the device (Geräteklasse)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub device_category: Option<DeviceCategory>,

    /// Specific type of the device (Gerätetyp)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub device_type: Option<DeviceType>,
}

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

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

    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_hardware_default() {
        let hw = Hardware::default();
        assert!(hw.device_number.is_none());
        assert!(hw.description.is_none());
    }

    #[test]
    fn test_hardware_serialize() {
        let hw = Hardware {
            device_number: Some("HW-001".to_string()),
            description: Some("Transformer unit".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&hw).unwrap();
        assert!(json.contains(r#""deviceNumber":"HW-001""#));
        assert!(json.contains(r#""description":"Transformer unit""#));
    }

    #[test]
    fn test_hardware_roundtrip() {
        let hw = Hardware {
            meta: Bo4eMeta::with_type("Hardware"),
            device_number: Some("HW-2024-002".to_string()),
            description: Some("Communication gateway".to_string()),
            device_category: None,
            device_type: None,
        };

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

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