# 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/20/42/b58df184075a60c63691d262aaf117fbe1a601c3084ee7072f1fb873d917/frequenz-api-dispatch-0.15.1.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.15.1",
"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": "e57fad3de7e6ee54ecc7e1deb7e9e2c952d5f50efc334371af197ed4ad0ca41e",
"md5": "2f6d9f2e417a86fde54d6d87fd73d00c",
"sha256": "09ea7391b1551e64ac1f9e5aa7defc58e8fb87eddcdab7f416388d3c0c69ff58"
},
"downloads": -1,
"filename": "frequenz_api_dispatch-0.15.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f6d9f2e417a86fde54d6d87fd73d00c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.11",
"size": 21422,
"upload_time": "2024-08-14T13:36:27",
"upload_time_iso_8601": "2024-08-14T13:36:27.611347Z",
"url": "https://files.pythonhosted.org/packages/e5/7f/ad3de7e6ee54ecc7e1deb7e9e2c952d5f50efc334371af197ed4ad0ca41e/frequenz_api_dispatch-0.15.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2042b58df184075a60c63691d262aaf117fbe1a601c3084ee7072f1fb873d917",
"md5": "d29ed39866201bef69485f1731c7a743",
"sha256": "1f591e7afbcc0eba4d0a748d889b937df7c57f4c4db56a3a85c0ab9273ac9b84"
},
"downloads": -1,
"filename": "frequenz-api-dispatch-0.15.1.tar.gz",
"has_sig": false,
"md5_digest": "d29ed39866201bef69485f1731c7a743",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.11",
"size": 100746,
"upload_time": "2024-08-14T13:36:29",
"upload_time_iso_8601": "2024-08-14T13:36:29.190544Z",
"url": "https://files.pythonhosted.org/packages/20/42/b58df184075a60c63691d262aaf117fbe1a601c3084ee7072f1fb873d917/frequenz-api-dispatch-0.15.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 13:36:29",
"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
