1use alloc::string::String;
9use alloc::vec::Vec;
10
11use bon::Builder;
12use serde::{Deserialize, Serialize};
13
14use super::common::{PowerRange, Timer, Transition};
15use super::{Id, NumberRange, Timestamp};
16
17#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Builder)]
19#[serde(deny_unknown_fields)]
20#[builder(on(String, into))]
21pub struct OperationMode {
22 pub id: Id,
24 #[serde(skip_serializing_if = "Option::is_none")]
26 pub diagnostic_label: Option<String>,
27 pub power_ranges: Vec<PowerRange>,
30 #[serde(skip_serializing_if = "Option::is_none")]
33 pub running_costs: Option<NumberRange>,
34 pub abnormal_condition_only: bool,
36}
37
38#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Builder)]
40#[serde(deny_unknown_fields)]
41pub struct SystemDescription {
42 #[cfg_attr(feature = "uuid", builder(default = Id::generate()))]
44 pub message_id: Id,
45 pub valid_from: Timestamp,
47 pub operation_modes: Vec<OperationMode>,
49 pub transitions: Vec<Transition>,
51 pub timers: Vec<Timer>,
53}
54
55impl SystemDescription {
56 #[must_use]
58 pub fn operation_mode(&self, id: &Id) -> Option<&OperationMode> {
59 self.operation_modes.iter().find(|m| m.id == *id)
60 }
61
62 #[must_use]
64 pub fn timer(&self, id: &Id) -> Option<&Timer> {
65 self.timers.iter().find(|t| t.id == *id)
66 }
67
68 #[must_use]
70 pub fn transition(&self, from: &Id, to: &Id) -> Option<&Transition> {
71 self.transitions
72 .iter()
73 .find(|t| t.from == *from && t.to == *to)
74 }
75}
76
77#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Builder)]
79#[serde(deny_unknown_fields)]
80pub struct Status {
81 #[cfg_attr(feature = "uuid", builder(default = Id::generate()))]
83 pub message_id: Id,
84 pub active_operation_mode_id: Id,
86 pub operation_mode_factor: f64,
88 #[serde(skip_serializing_if = "Option::is_none")]
91 pub previous_operation_mode_id: Option<Id>,
92 #[serde(skip_serializing_if = "Option::is_none")]
94 pub transition_timestamp: Option<Timestamp>,
95}
96
97#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Builder)]
102#[serde(deny_unknown_fields)]
103pub struct TimerStatus {
104 #[cfg_attr(feature = "uuid", builder(default = Id::generate()))]
106 pub message_id: Id,
107 pub timer_id: Id,
109 pub finished_at: Timestamp,
111}
112
113#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Builder)]
115#[serde(deny_unknown_fields)]
116pub struct Instruction {
117 #[cfg_attr(feature = "uuid", builder(default = Id::generate()))]
119 pub message_id: Id,
120 pub id: Id,
122 pub execution_time: Timestamp,
124 pub operation_mode_id: Id,
126 pub operation_mode_factor: f64,
128 pub abnormal_condition: bool,
130}
131
132#[cfg(test)]
133mod tests {
134 use super::*;
135 use crate::types::common::CommodityQuantity;
136
137 #[test]
138 fn the_generator_example_from_the_whitepaper() {
139 let modes = alloc::vec![
142 OperationMode {
143 id: Id::new_const("off"),
144 diagnostic_label: Some("Off".into()),
145 power_ranges: alloc::vec![PowerRange::exactly(
146 0.0,
147 CommodityQuantity::ElectricPowerL1
148 )],
149 running_costs: None,
150 abnormal_condition_only: false,
151 },
152 OperationMode {
153 id: Id::new_const("reduced"),
154 diagnostic_label: Some("Reduced power".into()),
155 power_ranges: alloc::vec![PowerRange::exactly(
156 -1800.0,
157 CommodityQuantity::ElectricPowerL1
158 )],
159 running_costs: None,
160 abnormal_condition_only: false,
161 },
162 ];
163 let system = SystemDescription {
164 message_id: Id::new_const("m1"),
165 valid_from: Timestamp::UNIX_EPOCH,
166 operation_modes: modes,
167 transitions: alloc::vec![Transition::simple(
168 Id::new_const("t1"),
169 Id::new_const("off"),
170 Id::new_const("reduced")
171 )],
172 timers: Vec::new(),
173 };
174 assert!(system.operation_mode(&Id::new_const("reduced")).is_some());
175 assert!(
176 system
177 .transition(&Id::new_const("off"), &Id::new_const("reduced"))
178 .is_some()
179 );
180 assert!(
183 system
184 .transition(&Id::new_const("reduced"), &Id::new_const("off"))
185 .is_none()
186 );
187 }
188
189 #[test]
190 fn the_timer_status_has_no_actuator() {
191 let json = serde_json::to_string(&TimerStatus {
192 message_id: Id::new_const("m1"),
193 timer_id: Id::new_const("timer0"),
194 finished_at: Timestamp::UNIX_EPOCH,
195 })
196 .unwrap();
197 assert!(!json.contains("actuator_id"));
198 }
199}