1- // Frequenz Dispatch API
1+ // Frequenz Dispatch Automation API
22//
3- // Frequenz gRPC API to propagate dispatches to microgrids
3+ // Overview:
4+ // The API serves to automate the process of electricity dispatches for microgrids.
5+ // In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power
6+ // between different components within a microgrid or between a microgrid and the main grid.
7+ // This could be for the purpose of supply (sending electricity to the grid or components within the microgrid),
8+ // or demand (drawing electricity from the grid or from other components like batteries and solar arrays).
9+ //
10+ // Objective:
11+ // The primary objective of this API is to streamline and automate the complex task of electricity dispatching,
12+ // making it easier to manage local electricity supply and demand efficiently.
13+ //
14+ // Key Features:
15+ // - Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
16+ // - Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
17+ // - Fine-grained control: Dispatch individual microgrid components or entire component categories.
18+ //
19+ // Example Use Cases:
20+ // - Charging or discharging a battery based on optimal time-of-use rates.
21+ // - Limiting the output of a Photovoltaic (PV) array during periods of low demand.
22+ // - Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to
23+ // support grid operations.
24+ // - Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
25+ //
26+ // Target Audience:
27+ // This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid
28+ // electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in
29+ // electrical engineering and systems.
430//
531// Copyright:
632// Copyright 2022 Frequenz Energy-as-a-Service GmbH
@@ -21,12 +47,7 @@ import "google/protobuf/timestamp.proto";
2147
2248import "frequenz/api/common/components.proto" ;
2349
24- // The MicrogridDispatchService serves to automate the process of energy dispatches for various microgrids.
25- // In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power
26- // or energy between different components within a microgrid or between a microgrid and the main grid.
27- // This could be for the purpose of supply (sending energy to the grid, or to components within the microgrid),
28- // or demand (drawing energy from the grid or from other components like batteries and solar arrays).
29- // The service allows for both one-off dispatches, and recurring dispatches.
50+ // Service providing operations related to dispatching microgrid components.
3051service MicrogridDispatchService {
3152 // Returns a list of all dispatches
3253 rpc ListMicrogridDispatches (DispatchListRequest ) returns (DispatchList );
0 commit comments