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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

//! Device (Geraet) business object.
//!
//! Represents a technical device in the energy infrastructure.

use serde::{Deserialize, Serialize};

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

/// A technical device used in the energy infrastructure.
///
/// German: Geraet
///
/// Devices are technical equipment like transformers, switches,
/// or other equipment in the energy network.
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::Device;
/// use bo4e_core::enums::DeviceCategory;
///
/// let device = Device {
///     device_id: Some("DEV001".to_string()),
///     device_category: Some(DeviceCategory::MeteringDevice),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "Geraet"))]
#[serde(rename_all = "camelCase")]
pub struct Device {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Device identification (Geraetkennung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "geraetkennung"))]
    pub device_id: Option<String>,

    /// Serial number (Seriennummer)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "seriennummer"))]
    pub serial_number: Option<String>,

    /// Device category (Geraeteklasse)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "geraeteklasse"))]
    pub device_category: Option<DeviceCategory>,

    /// Device type (Geraetetyp)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "geraetetyp"))]
    pub device_type: Option<DeviceType>,

    /// Manufacturer (Hersteller)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "hersteller"))]
    pub manufacturer: Option<String>,

    /// Model name (Modellbezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "modellbezeichnung"))]
    pub model: Option<String>,

    /// Manufacturing year (Baujahr)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "baujahr"))]
    pub manufacturing_year: Option<i32>,

    /// Installation date (Einbaudatum)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "einbaudatum"))]
    pub installation_date: Option<chrono::DateTime<chrono::Utc>>,

    /// Removal date (Ausbaudatum)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "ausbaudatum"))]
    pub removal_date: Option<chrono::DateTime<chrono::Utc>>,

    /// Firmware version (Firmware-Version)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "firmwareVersion"))]
    pub firmware_version: Option<String>,

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

    /// Associated metering location ID
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "messlokationsId"))]
    pub metering_location_id: Option<String>,
}

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

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

    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_device_creation() {
        let device = Device {
            device_id: Some("DEV001".to_string()),
            device_category: Some(DeviceCategory::MeteringDevice),
            ..Default::default()
        };

        assert_eq!(device.device_id, Some("DEV001".to_string()));
    }

    #[test]
    fn test_serialize() {
        let device = Device {
            meta: Bo4eMeta::with_type("Geraet"),
            device_id: Some("DEV001".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&device).unwrap();
        assert!(json.contains(r#""_typ":"Geraet""#));
    }

    #[test]
    fn test_roundtrip() {
        let device = Device {
            meta: Bo4eMeta::with_type("Geraet"),
            device_id: Some("DEV001".to_string()),
            serial_number: Some("SN123456".to_string()),
            device_category: Some(DeviceCategory::MeteringDevice),
            manufacturer: Some("Acme Corp".to_string()),
            manufacturing_year: Some(2023),
            ..Default::default()
        };

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

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