Metadata-Version: 2.1
Name: simple-pid
Version: 0.1.0
Summary: A simple, easy to use PID controller
Home-page: https://github.com/m-lundberg/simple-pid
Author: Martin Lundberg
License: MIT
Project-URL: Documentation, https://simple-pid.readthedocs.io/
Project-URL: Source, https://github.com/m-lundberg/simple-pid
Keywords: pid controller control
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: docs
Requires-Dist: m2r; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'

# simple-pid

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 ouput 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)
```

Complete API documentation can be found [here](https://simple-pid.readthedocs.io/en/latest/simple_pid.html#module-simple_pid.PID).

## Installation


