frequenz-microgrid 0.2.2

A high-level interface to the Frequenz Microgrid API.
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

// License: MIT
// Copyright © 2026 Frequenz Energy-as-a-Service GmbH

//! Extensions to the generated protobuf code for electrical components.

use crate::{
    client::{ElectricalComponent, ElectricalComponentCategory},
    proto::common::microgrid::electrical_components::{
        InverterType, electrical_component_category_specific_info::Kind,
    },
};

impl ElectricalComponent {
    /// Returns true if the component is an inverter, false otherwise.
    pub fn is_inverter(&self) -> bool {
        matches!(
            ElectricalComponentCategory::try_from(self.category),
            Ok(ElectricalComponentCategory::Inverter)
        )
    }

    /// Returns true if the component is a PV inverter, false otherwise.
    pub fn is_pv_inverter(&self) -> bool {
        if let Some(info) = &self.category_specific_info
            && let Some(Kind::Inverter(inverter_info)) = &info.kind
        {
            return matches!(
                InverterType::try_from(inverter_info.r#type),
                Ok(InverterType::Pv)
            );
        }
        false
    }

    /// Returns true if the component is a battery inverter, false otherwise.
    pub fn is_battery_inverter(&self) -> bool {
        if let Some(info) = &self.category_specific_info
            && let Some(Kind::Inverter(inverter_info)) = &info.kind
        {
            return matches!(
                InverterType::try_from(inverter_info.r#type),
                Ok(InverterType::Battery)
            );
        }
        false
    }

    /// Returns true if the component is a hybrid inverter, false otherwise.
    pub fn is_hybrid_inverter(&self) -> bool {
        if let Some(info) = &self.category_specific_info
            && let Some(Kind::Inverter(inverter_info)) = &info.kind
        {
            return matches!(
                InverterType::try_from(inverter_info.r#type),
                Ok(InverterType::Hybrid)
            );
        }
        false
    }
}