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
61
62
63
64
65
66
67
68
69
70
71

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

//! Metrics supported by the logical meter.

use crate::logical_meter::formula::aggregation_formula::AggregationFormula;
use crate::logical_meter::formula::coalesce_formula::CoalesceFormula;
use crate::{
    logical_meter::formula, logical_meter::formula::FormulaSubscriber,
    proto::common::metrics::Metric as MetricPb,
};

pub trait Metric:
    std::fmt::Display + std::fmt::Debug + Clone + Copy + PartialEq + Eq + Sync + 'static
{
    type FormulaType: FormulaSubscriber<QuantityType = Self::QuantityType>
        + formula::graph_formula_provider::GraphFormulaProvider<MetricType = Self>
        + 'static;

    type QuantityType: crate::quantity::Quantity;

    const METRIC: MetricPb;
}

macro_rules! define_metric {
    ($({
        name: $metric_name:ident,
        formula: $formula:ident,
        quantity: $quantity:ident
    }),+ $(,)?) => {
        $(
            // Define a metric
            #[derive(Debug, Clone, Copy, PartialEq, Eq)]
            pub struct $metric_name;

            // Implement the AcMetric trait for the metric
            impl Metric for $metric_name {
                type FormulaType = $formula<$metric_name>;
                type QuantityType = crate::quantity::$quantity;

                const METRIC: MetricPb = MetricPb::$metric_name;
            }

            impl std::fmt::Display for $metric_name {
                fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                    write!(f, "{}", stringify!($metric_name))
                }
            }

        )+
    };
}

define_metric! {
    { name: AcPowerActive,         formula: AggregationFormula, quantity: Power },
    { name: AcPowerReactive,       formula: AggregationFormula, quantity: ReactivePower },
    { name: AcCurrent,             formula: AggregationFormula, quantity: Current },
    { name: AcCurrentPhase1,       formula: AggregationFormula, quantity: Current },
    { name: AcCurrentPhase2,       formula: AggregationFormula, quantity: Current },
    { name: AcCurrentPhase3,       formula: AggregationFormula, quantity: Current },

    { name: AcVoltage,             formula: CoalesceFormula,    quantity: Voltage },
    { name: AcVoltagePhase1N,      formula: CoalesceFormula,    quantity: Voltage },
    { name: AcVoltagePhase2N,      formula: CoalesceFormula,    quantity: Voltage },
    { name: AcVoltagePhase3N,      formula: CoalesceFormula,    quantity: Voltage },
    { name: AcVoltagePhase1Phase2, formula: CoalesceFormula,    quantity: Voltage },
    { name: AcVoltagePhase2Phase3, formula: CoalesceFormula,    quantity: Voltage },
    { name: AcVoltagePhase3Phase1, formula: CoalesceFormula,    quantity: Voltage },

    { name: AcFrequency,           formula: CoalesceFormula,    quantity: Frequency },
}