Metadata-Version: 2.1
Name: frequenz-api-dispatch
Version: 0.9.0
Summary: Frequenz dispatch gRPC API and bindings
Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
License: MIT
Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-api-dispatch/releases
Project-URL: Repository, https://github.com/frequenz-floss/frequenz-api-dispatch
Project-URL: Issues, https://github.com/frequenz-floss/frequenz-api-dispatch/issues
Project-URL: Support, https://github.com/frequenz-floss/frequenz-api-dispatch/discussions/categories/support
Keywords: frequenz,api,microgrid,grpc,dispatch
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries
Requires-Python: <4,>=3.11
Description-Content-Type: text/markdown
Requires-Dist: frequenz-api-common (<0.3,>=0.2.0)
Requires-Dist: googleapis-common-protos (<2,>=1.56.2)
Requires-Dist: grpcio (<2,>=1.51.1)
Provides-Extra: dev
Requires-Dist: frequenz-api-dispatch[dev-docstrings,dev-formatting,dev-mypy,dev-noxfile,dev-pylint,dev-pytest] ; extra == 'dev'
Provides-Extra: dev-docstrings
Requires-Dist: pydocstyle (==6.3.0) ; extra == 'dev-docstrings'
Requires-Dist: darglint (==1.8.1) ; extra == 'dev-docstrings'
Provides-Extra: dev-formatting
Requires-Dist: black (==23.3.0) ; extra == 'dev-formatting'
Requires-Dist: isort (==5.12.0) ; extra == 'dev-formatting'
Provides-Extra: dev-mypy
Requires-Dist: mypy (==1.1.1) ; extra == 'dev-mypy'
Requires-Dist: frequenz-api-dispatch[dev-noxfile,dev-pytest] ; extra == 'dev-mypy'
Provides-Extra: dev-noxfile
Requires-Dist: nox (==2022.11.21) ; extra == 'dev-noxfile'
Requires-Dist: frequenz-repo-config[api] (==0.2.0) ; extra == 'dev-noxfile'
Provides-Extra: dev-pylint
Requires-Dist: pylint (==2.17.1) ; extra == 'dev-pylint'
Requires-Dist: frequenz-api-dispatch[dev-noxfile,dev-pytest] ; extra == 'dev-pylint'
Provides-Extra: dev-pytest
Requires-Dist: pytest (==7.2.2) ; extra == 'dev-pytest'

Dispatch API
============

Our dispatch API allows individual edge locations to access the latest dispatch
decisions made cloud-side.

Dispatched resources 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.
