| Name | simple-pid JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | A simple, easy to use PID controller |
| upload_time | 2024-07-21 13:27:32 |
| maintainer | None |
| docs_url | None |
| author | Martin Lundberg |
| requires_python | >=3.6 |
| license | None |
| keywords |
pid
controller
control
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# simple-pid
[](https://github.com/m-lundberg/simple-pid/actions?query=workflow%3Atests)
[](https://pypi.org/project/simple-pid/)
[](https://simple-pid.readthedocs.io/)
[](https://github.com/m-lundberg/simple-pid/blob/master/LICENSE.md)
[](https://pepy.tech/project/simple-pid)
[](https://github.com/psf/black)
A simple and easy to use PID controller in Python. If you want a PID controller without external dependencies that just works, this is for you! The PID was designed to be robust with help from [Brett Beauregards guide](http://brettbeauregard.com/blog/2011/04/improving-the-beginners-pid-introduction/).
Usage is very simple:
```python
from simple_pid import PID
pid = PID(1, 0.1, 0.05, setpoint=1)
# Assume we have a system we want to control in controlled_system
v = controlled_system.update(0)
while True:
# Compute new output from the PID according to the systems current value
control = pid(v)
# Feed the PID output to the system and get its current value
v = controlled_system.update(control)
```
## Installation
To install, run:
```
python -m pip install simple-pid
```
## Documentation
Documentation, including a user guide and complete API reference, can be found [here](https://simple-pid.readthedocs.io/).
## Tests
This project has a test suite using [`pytest`](https://docs.pytest.org/). To run the tests, install `pytest` and run:
```
pytest -v
```
## License
Licensed under the [MIT License](https://github.com/m-lundberg/simple-pid/blob/master/LICENSE.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "simple-pid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "pid, controller, control",
"author": "Martin Lundberg",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/78/0a/c670a4f4dea4b21c0b074b193c54698e5e047479e688c8d5495d264c9921/simple_pid-2.0.1.tar.gz",
"platform": null,
"description": "# simple-pid\n\n[](https://github.com/m-lundberg/simple-pid/actions?query=workflow%3Atests)\n[](https://pypi.org/project/simple-pid/)\n[](https://simple-pid.readthedocs.io/)\n[](https://github.com/m-lundberg/simple-pid/blob/master/LICENSE.md)\n[](https://pepy.tech/project/simple-pid)\n[](https://github.com/psf/black)\n\nA simple and easy to use PID controller in Python. If you want a PID controller without external dependencies that just works, this is for you! The PID was designed to be robust with help from [Brett Beauregards guide](http://brettbeauregard.com/blog/2011/04/improving-the-beginners-pid-introduction/).\n\nUsage is very simple:\n\n```python\nfrom simple_pid import PID\npid = PID(1, 0.1, 0.05, setpoint=1)\n\n# Assume we have a system we want to control in controlled_system\nv = controlled_system.update(0)\n\nwhile True:\n # Compute new output from the PID according to the systems current value\n control = pid(v)\n \n # Feed the PID output to the system and get its current value\n v = controlled_system.update(control)\n```\n\n\n## Installation\nTo install, run:\n\n```\npython -m pip install simple-pid\n```\n\n\n## Documentation\nDocumentation, including a user guide and complete API reference, can be found [here](https://simple-pid.readthedocs.io/).\n\n\n## Tests\nThis project has a test suite using [`pytest`](https://docs.pytest.org/). To run the tests, install `pytest` and run:\n\n```\npytest -v\n```\n\n\n## License\nLicensed under the [MIT License](https://github.com/m-lundberg/simple-pid/blob/master/LICENSE.md).\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple, easy to use PID controller",
"version": "2.0.1",
"project_urls": {
"Documentation": "https://simple-pid.readthedocs.io/",
"Homepage": "https://github.com/m-lundberg/simple-pid"
},
"split_keywords": [
"pid",
" controller",
" control"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee0e4d4fe01b21558a31a12e029a57cf677666c89c1b00cb82c1b53d0025cd63",
"md5": "810debb6057ea1e2157a632646769113",
"sha256": "1d53ed76b03d949ceea46b538fb22999d27899e2e655aa19b99c40f6edcedca6"
},
"downloads": -1,
"filename": "simple_pid-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "810debb6057ea1e2157a632646769113",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7194,
"upload_time": "2024-07-21T13:27:30",
"upload_time_iso_8601": "2024-07-21T13:27:30.688319Z",
"url": "https://files.pythonhosted.org/packages/ee/0e/4d4fe01b21558a31a12e029a57cf677666c89c1b00cb82c1b53d0025cd63/simple_pid-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "780ac670a4f4dea4b21c0b074b193c54698e5e047479e688c8d5495d264c9921",
"md5": "79fc6af22bb66553674026a3e4b7cf74",
"sha256": "5771761c54541c900e597d6c2e4ea93fd2cc98f4e48cb9eca265fba2e65be99e"
},
"downloads": -1,
"filename": "simple_pid-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "79fc6af22bb66553674026a3e4b7cf74",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 15577,
"upload_time": "2024-07-21T13:27:32",
"upload_time_iso_8601": "2024-07-21T13:27:32.037172Z",
"url": "https://files.pythonhosted.org/packages/78/0a/c670a4f4dea4b21c0b074b193c54698e5e047479e688c8d5495d264c9921/simple_pid-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-21 13:27:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "m-lundberg",
"github_project": "simple-pid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "simple-pid"
}
