# Frequenz Dispatch API
[](https://github.com/frequenz-floss/frequenz-api-dispatch/actions/workflows/ci.yaml)
[](https://pypi.org/project/frequenz-api-dispatch/)
[](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).
Raw data
{
"_id": null,
"home_page": null,
"name": "frequenz-api-dispatch",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.11",
"maintainer_email": null,
"keywords": "frequenz, python, api, grpc, protobuf, rpc, dispatch, cloud, microgrid",
"author": null,
"author_email": "Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>",
"download_url": "https://files.pythonhosted.org/packages/27/c0/7f5d0a4492a7e8d3fe73e6f3e26466915019d742dfeaf1d834aa7858a070/frequenz-api-dispatch-0.13.0.tar.gz",
"platform": null,
"description": "# Frequenz Dispatch API\n\n[](https://github.com/frequenz-floss/frequenz-api-dispatch/actions/workflows/ci.yaml)\n[](https://pypi.org/project/frequenz-api-dispatch/)\n[](https://frequenz-floss.github.io/frequenz-api-dispatch/)\n\n## Introduction\n\nFrequenz gRPC API to propagate dispatches to microgrids.\n\nAlso 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\n\nDispatches might include, for example:\n\n* Hard shutdown of a location or an individual microgrid component\n* Charging or discharging a battery\n* Activation or deactivation of balancing power\n* Activation or deactivation of a power plant\n\nMicrogrid controllers are expected to regularly query this API to keep up to\ndate with what resources the cloud wishes them to deploy.\n\n## Contributing\n\nIf you want to know how to build this project and contribute to it, please\ncheck out the [Contributing Guide](CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Frequenz gRPC API to propagate dispatches to microgrids",
"version": "0.13.0",
"project_urls": {
"Changelog": "https://github.com/frequenz-floss/frequenz-api-dispatch/releases",
"Documentation": "https://frequenz-floss.github.io/frequenz-api-dispatch/",
"Issues": "https://github.com/frequenz-floss/frequenz-api-dispatch/issues",
"Repository": "https://github.com/frequenz-floss/frequenz-api-dispatch",
"Support": "https://github.com/frequenz-floss/frequenz-api-dispatch/discussions/categories/support"
},
"split_keywords": [
"frequenz",
" python",
" api",
" grpc",
" protobuf",
" rpc",
" dispatch",
" cloud",
" microgrid"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "17c5d89f41b87da277d324370d13201b4e9e59f16a9cb85b897fb5e0a43662ae",
"md5": "4459b196126f51a14ba1852d4f32bfaa",
"sha256": "bf5d676e2e70f834e434574ea78d819f3690d72ccc9e19d7240d613fd219d1a8"
},
"downloads": -1,
"filename": "frequenz_api_dispatch-0.13.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4459b196126f51a14ba1852d4f32bfaa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.11",
"size": 16527,
"upload_time": "2024-04-23T10:41:39",
"upload_time_iso_8601": "2024-04-23T10:41:39.463479Z",
"url": "https://files.pythonhosted.org/packages/17/c5/d89f41b87da277d324370d13201b4e9e59f16a9cb85b897fb5e0a43662ae/frequenz_api_dispatch-0.13.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "27c07f5d0a4492a7e8d3fe73e6f3e26466915019d742dfeaf1d834aa7858a070",
"md5": "05f1e60d363c9bd31139a0b20c7573db",
"sha256": "eaecaa8e01f29afd7c058f303c279400c2c5ab73fdcc97225b44317b4fe6ff67"
},
"downloads": -1,
"filename": "frequenz-api-dispatch-0.13.0.tar.gz",
"has_sig": false,
"md5_digest": "05f1e60d363c9bd31139a0b20c7573db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.11",
"size": 97133,
"upload_time": "2024-04-23T10:41:40",
"upload_time_iso_8601": "2024-04-23T10:41:40.618875Z",
"url": "https://files.pythonhosted.org/packages/27/c0/7f5d0a4492a7e8d3fe73e6f3e26466915019d742dfeaf1d834aa7858a070/frequenz-api-dispatch-0.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 10:41:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "frequenz-floss",
"github_project": "frequenz-api-dispatch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "frequenz-api-dispatch"
}
JSON
