# volttron-actuator
[](https://github.com/VOLTTRON/volttron-actuator/actions/workflows/run-tests.yml)
[](https://pypi.org/project/volttron-actuator/)
The Actuator Agent is used to manage write access to devices. Other agents may request scheduled times, called Tasks, to interact with one or more devices.
## Requirements
* python >= 3.10
* volttron >= 10.0
* tzlocal >= 4.2
* types-tzlocal >= 4.2.2.2
## Documentation
More detailed documentation can be found on [ReadTheDocs](https://volttron.readthedocs.io/en/modular/). The RST source
of the documentation for this component is located in the "docs" directory of this repository.
## Installation
Before installing, VOLTTRON should be installed and running. Its virtual environment should be active.
Information on how to install of the VOLTTRON platform can be found
[here](https://github.com/eclipse-volttron/volttron-core).
Install and start the volttron-actuator.
```shell
vctl install volttron-actuator --agent-config <path to agent config> --start
```
View the status of the installed agent
```shell
vctl status
```
## Development
Please see the following for contributing guidelines [contributing](https://github.com/eclipse-volttron/volttron-core/blob/develop/CONTRIBUTING.md).
Please see the following helpful guide about [developing modular VOLTTRON agents](https://github.com/eclipse-volttron/volttron-core/blob/develop/DEVELOPING_ON_MODULAR.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/VOLTTRON/volttron-actuator",
"name": "volttron-actuator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Mark Bonicillo",
"author_email": "volttron@pnnl.gov",
"download_url": "https://files.pythonhosted.org/packages/1f/55/978a1a856da3182c2cf73db4b5e12656925d9604ad6c76938dd6c9d6cba8/volttron_actuator-0.1.1a8.tar.gz",
"platform": null,
"description": "# volttron-actuator\n\n\n\n\n[](https://github.com/VOLTTRON/volttron-actuator/actions/workflows/run-tests.yml)\n[](https://pypi.org/project/volttron-actuator/)\n\n\nThe Actuator Agent is used to manage write access to devices. Other agents may request scheduled times, called Tasks, to interact with one or more devices.\n\n## Requirements\n\n* python >= 3.10\n* volttron >= 10.0\n* tzlocal >= 4.2\n* types-tzlocal >= 4.2.2.2\n\n## Documentation\n\nMore detailed documentation can be found on [ReadTheDocs](https://volttron.readthedocs.io/en/modular/). The RST source\nof the documentation for this component is located in the \"docs\" directory of this repository.\n\n## Installation\n\nBefore installing, VOLTTRON should be installed and running. Its virtual environment should be active.\nInformation on how to install of the VOLTTRON platform can be found\n[here](https://github.com/eclipse-volttron/volttron-core).\n\nInstall and start the volttron-actuator.\n\n```shell\nvctl install volttron-actuator --agent-config <path to agent config> --start\n```\n\nView the status of the installed agent\n\n```shell\nvctl status\n```\n\n## Development\n\nPlease see the following for contributing guidelines [contributing](https://github.com/eclipse-volttron/volttron-core/blob/develop/CONTRIBUTING.md).\n\nPlease see the following helpful guide about [developing modular VOLTTRON agents](https://github.com/eclipse-volttron/volttron-core/blob/develop/DEVELOPING_ON_MODULAR.md)\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The Actuator Agent is used to manage write access to devices. Other agents may request scheduled times, called Tasks, to interact with one or more devices.",
"version": "0.1.1a8",
"project_urls": {
"Homepage": "https://github.com/VOLTTRON/volttron-actuator",
"Repository": "https://github.com/VOLTTRON/volttron-actuator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "75fcdf9cc9c923bb6aa5ccd370dc6b9f5dc007b86e24d04519e9214f68b4289f",
"md5": "cfc822b587fc40d2cacd74c1078d44c7",
"sha256": "9874ec3de9aef4a2942f780ffe13d9199068d69f92d514381ada44e5a2c5c289"
},
"downloads": -1,
"filename": "volttron_actuator-0.1.1a8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cfc822b587fc40d2cacd74c1078d44c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 23793,
"upload_time": "2023-07-14T01:08:42",
"upload_time_iso_8601": "2023-07-14T01:08:42.449557Z",
"url": "https://files.pythonhosted.org/packages/75/fc/df9cc9c923bb6aa5ccd370dc6b9f5dc007b86e24d04519e9214f68b4289f/volttron_actuator-0.1.1a8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f55978a1a856da3182c2cf73db4b5e12656925d9604ad6c76938dd6c9d6cba8",
"md5": "5f4c3ba3c45b5d5c776650ccd7987523",
"sha256": "fbe91e65bfab6d85345a8d175ebb4903604abced09b0ee85ffc5b799335534a9"
},
"downloads": -1,
"filename": "volttron_actuator-0.1.1a8.tar.gz",
"has_sig": false,
"md5_digest": "5f4c3ba3c45b5d5c776650ccd7987523",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 23239,
"upload_time": "2023-07-14T01:08:43",
"upload_time_iso_8601": "2023-07-14T01:08:43.845845Z",
"url": "https://files.pythonhosted.org/packages/1f/55/978a1a856da3182c2cf73db4b5e12656925d9604ad6c76938dd6c9d6cba8/volttron_actuator-0.1.1a8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-14 01:08:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VOLTTRON",
"github_project": "volttron-actuator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "volttron-actuator"
}
JSON
