aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEugeniy E. Mikhailov <evgmik@gmail.com>2024-06-25 23:54:40 -0400
committerEugeniy E. Mikhailov <evgmik@gmail.com>2024-06-25 23:54:40 -0400
commitad6f18d4b515d9e4c64d85d221740e74e9e7a52d (patch)
tree68ea7e48c5bf7e2ce87c77b2642d46783874d3b1
parent4951d890ad4ae3422a7ba717cb1c55ae7a891df5 (diff)
downloadqolab-ad6f18d4b515d9e4c64d85d221740e74e9e7a52d.tar.gz
qolab-ad6f18d4b515d9e4c64d85d221740e74e9e7a52d.zip
Docs for feedback
-rw-r--r--qolab/feedback/__init__.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/qolab/feedback/__init__.py b/qolab/feedback/__init__.py
index e2dc3c0..429258a 100644
--- a/qolab/feedback/__init__.py
+++ b/qolab/feedback/__init__.py
@@ -2,6 +2,9 @@ import time
from qolab.hardware.basic import BasicInstrument
class PID(BasicInstrument):
+ """Proportional–integral–derivative controller.
+ Calculates feedback gased on gains, time, and previous error signal measurements.
+ """
def __init__(self, Gp=0, Gi=0, Gd=0, sign=1, enable=True, *args, **kwds):
super().__init__(*args, **kwds)
self.config['Device model'] = 'Generic Software PID loop'