File tree Expand file tree Collapse file tree 1 file changed +18
-9
lines changed
Expand file tree Collapse file tree 1 file changed +18
-9
lines changed Original file line number Diff line number Diff line change 1- Dispatch API
2- ============
1+ # Frequenz Dispatch API
32
4- Our dispatch API allows individual edge locations to access the latest dispatch
5- decisions made cloud-side.
3+ [ ![ Build Status] ( https://github.com/frequenz-floss/frequenz-api-dispatch/actions/workflows/ci.yaml/badge.svg )] ( https://github.com/frequenz-floss/frequenz-api-dispatch/actions/workflows/ci.yaml )
4+ [ ![ PyPI Package] ( https://img.shields.io/pypi/v/frequenz-api-dispatch )] ( https://pypi.org/project/frequenz-api-dispatch/ )
5+ [ ![ Docs] ( https://img.shields.io/badge/docs-latest-informational )] ( https://frequenz-floss.github.io/frequenz-api-dispatch/ )
66
7- Dispatched resources might include, for example:
7+ ## Introduction
88
9- * hard shutdown of a location or an individual microgrid component
10- * charging or discharging a battery
11- * activation or deactivation of balancing power
12- * activation or deactivation of a power plant
9+ Frequenz gRPC API to propagate dispatches to microgrids.
10+
11+ Dispatches might include, for example:
12+
13+ * Hard shutdown of a location or an individual microgrid component
14+ * Charging or discharging a battery
15+ * Activation or deactivation of balancing power
16+ * Activation or deactivation of a power plant
1317
1418Microgrid controllers are expected to regularly query this API to keep up to
1519date with what resources the cloud wishes them to deploy.
20+
21+ ## Contributing
22+
23+ If you want to know how to build this project and contribute to it, please
24+ check out the [ Contributing Guide] ( CONTRIBUTING.md ) .
You can’t perform that action at this time.
0 commit comments