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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

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

//! The microgrid API client trait and its implementation for the generated gRPC
//! client.

use tonic::transport::Channel;

use crate::proto::microgrid::{
    AugmentElectricalComponentBoundsRequest, AugmentElectricalComponentBoundsResponse,
    ListElectricalComponentConnectionsRequest, ListElectricalComponentConnectionsResponse,
    ListElectricalComponentsRequest, ListElectricalComponentsResponse,
    ReceiveElectricalComponentTelemetryStreamRequest,
    ReceiveElectricalComponentTelemetryStreamResponse,
};

/// A trait representing the microgrid API client.
///
/// Includes all the client methods that are used by the `MicrogridClientActor`.
#[async_trait::async_trait]
pub trait MicrogridApiClient: Send + Sync + 'static {
    async fn list_electrical_components(
        &mut self,
        request: impl tonic::IntoRequest<ListElectricalComponentsRequest> + Send,
    ) -> std::result::Result<tonic::Response<ListElectricalComponentsResponse>, tonic::Status>;

    async fn list_electrical_component_connections(
        &mut self,
        request: impl tonic::IntoRequest<ListElectricalComponentConnectionsRequest> + Send,
    ) -> std::result::Result<
        tonic::Response<ListElectricalComponentConnectionsResponse>,
        tonic::Status,
    >;

    type TelemetryStream: futures::Stream<
            Item = std::result::Result<
                ReceiveElectricalComponentTelemetryStreamResponse,
                tonic::Status,
            >,
        > + Send
        + Unpin
        + 'static;

    async fn receive_electrical_component_telemetry_stream(
        &mut self,
        request: impl tonic::IntoRequest<ReceiveElectricalComponentTelemetryStreamRequest> + Send,
    ) -> std::result::Result<tonic::Response<Self::TelemetryStream>, tonic::Status>;

    async fn augment_electrical_component_bounds(
        &mut self,
        request: impl tonic::IntoRequest<AugmentElectricalComponentBoundsRequest> + Send,
    ) -> std::result::Result<tonic::Response<AugmentElectricalComponentBoundsResponse>, tonic::Status>;
}

/// Implement the MicrogridApiClient trait for the generated gRPC client.
///
/// Forwards calls to the underlying gRPC client methods, without any additional logic.
#[async_trait::async_trait]
impl MicrogridApiClient for crate::proto::microgrid::microgrid_client::MicrogridClient<Channel> {
    async fn list_electrical_components(
        &mut self,
        request: impl tonic::IntoRequest<ListElectricalComponentsRequest> + Send,
    ) -> std::result::Result<tonic::Response<ListElectricalComponentsResponse>, tonic::Status> {
        self.list_electrical_components(request).await
    }

    async fn list_electrical_component_connections(
        &mut self,
        request: impl tonic::IntoRequest<ListElectricalComponentConnectionsRequest> + Send,
    ) -> std::result::Result<
        tonic::Response<ListElectricalComponentConnectionsResponse>,
        tonic::Status,
    > {
        self.list_electrical_component_connections(request).await
    }

    type TelemetryStream =
        tonic::codec::Streaming<ReceiveElectricalComponentTelemetryStreamResponse>;

    async fn receive_electrical_component_telemetry_stream(
        &mut self,
        request: impl tonic::IntoRequest<ReceiveElectricalComponentTelemetryStreamRequest> + Send,
    ) -> std::result::Result<tonic::Response<Self::TelemetryStream>, tonic::Status> {
        self.receive_electrical_component_telemetry_stream(request)
            .await
    }

    async fn augment_electrical_component_bounds(
        &mut self,
        request: impl tonic::IntoRequest<AugmentElectricalComponentBoundsRequest> + Send,
    ) -> std::result::Result<tonic::Response<AugmentElectricalComponentBoundsResponse>, tonic::Status>
    {
        self.augment_electrical_component_bounds(request).await
    }
}