Skip to content

Commit

Permalink
README.md correction
Browse files Browse the repository at this point in the history
  • Loading branch information
ThunderTecke committed Feb 7, 2023
1 parent b319de2 commit 990b9aa
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ python3 -m pip install PID_Py
from PID_Py.PID import PID

# Initialization
pid = PID(kp = 10.0, ki = 1.0, kd = 0.0)
pid = PID(kp = 10.0, ki = 5.0, kd = 0.0)

...

Expand Down Expand Up @@ -98,7 +98,7 @@ If your command must be limit you can use `outputLimits` parameters.
from PID_Py.PID import PID

# Initialization
pid = PID(kp = 10.0, ki = 5.0, kd = 0.0, outputLimits = (0, 100))
pid = PID(kp = 10.0, ki = 5.0, kd = 0.0, outputLimits = (-20, 20))

...

Expand Down Expand Up @@ -182,7 +182,7 @@ In the example above, the integral part value is freezed when the door is open.
The door is opened between 5 and 7 second. For the example, the setpoint is increase during the freezing.

### Deadband
A deadband can be set, by default its deactivated. It can be activated by entering a value to `deadband`. When the error is between [-`deadband`, `deadband`] for `deadbandActivationTime` (in second) the integral is no longer calculated. If the error exceed `deadband` the integral part recalculated.
A deadband can be set, by default its deactivated. It can be activated by entering a value to `deadband`. When the error is between [-`deadband`, `deadband`] for `deadbandActivationTime` (in second) the integral is no longer calculated. If the error exceed `deadband` the integral part is recalculated.

```Python
from PID_Py.PID import PID
Expand Down Expand Up @@ -285,7 +285,7 @@ plt.plot(pid.historian["TIME"], pid.historian["PROCESS_VALUE"], label="Process v
plt.legend()
plt.show()
```
In the example above, the PID historian records `setpoint`, `processValue` and `time`. Time is the elapsed time from the start. After that a graphic is draw with `matplotlib`.
In the example above, the PID historian records `setpoint`, `processValue`. `time` is also recorded when at least one parameter is recorded. Time is the elapsed time from the start. After that a graphic is draw with `matplotlib`.

#### Historian parameters list
- `P` : proportionnal part
Expand Down

0 comments on commit 990b9aa

Please sign in to comment.