https://github.com/frequenz-floss/frequenz-api-dispatch

gRPC+protobuf specification and Python bindings for the Frequenz Dispatch API
https://github.com/frequenz-floss/frequenz-api-dispatch

api dispatch frequenz grpc protobuf python rpc

Last synced: 9 months ago
JSON representation

gRPC+protobuf specification and Python bindings for the Frequenz Dispatch API

• Host: GitHub
• URL: https://github.com/frequenz-floss/frequenz-api-dispatch
• Owner: frequenz-floss
• License: mit
• Created: 2023-05-30T13:40:14.000Z (over 2 years ago)
• Default Branch: v0.x.x
• Last Pushed: 2025-04-23T09:19:33.000Z (9 months ago)
• Last Synced: 2025-04-23T10:25:20.582Z (9 months ago)
• Topics: api, dispatch, frequenz, grpc, protobuf, python, rpc
• Language: Python
• Homepage: https://frequenz-floss.github.io/frequenz-api-dispatch/
• Size: 3.06 MB
• Stars: 2
• Watchers: 3
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# Frequenz Dispatch API

[![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)

[![PyPI Package](https://img.shields.io/pypi/v/frequenz-api-dispatch)](https://pypi.org/project/frequenz-api-dispatch/)

[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-api-dispatch/)

## Introduction

Frequenz gRPC API to propagate dispatches to microgrids.

Also checkout the [high-level overview](https://github.com/frequenz-floss/frequenz-sdk-python/wiki/APIs-stack-and-repositories-structure) of the various api repositories and how they work together

Dispatches might include, for example:

* Hard shutdown of a location or an individual microgrid component

* Charging or discharging a battery

* Activation or deactivation of balancing power

* Activation or deactivation of a power plant

Microgrid controllers are expected to regularly query this API to keep up to

date with what resources the cloud wishes them to deploy.

## Contributing

If you want to know how to build this project and contribute to it, please

check out the [Contributing Guide](CONTRIBUTING.md).