Skip to content

Commit a59ea08

Browse files
committed
Update README.md
1 parent 4d1ebee commit a59ea08

File tree

1 file changed

+22
-25
lines changed

1 file changed

+22
-25
lines changed

README.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,34 +28,10 @@ Development began with a fork of the Arduino PID Library. Some modifications and
2828
| QuickPID using `analogReadFast()` | 2.0 | 5.0 | 0.2 | 96 |
2929
| Arduino PID using `analogRead()` | 2.0 | 5.0 | 0.2 | 224 |
3030

31-
### Functions
32-
33-
[QuickPID_Constructor](#QuickPID_Constructor)
34-
35-
[Compute](#Compute)
36-
37-
[SetTunings](#SetTunings)
38-
39-
[SetSampleTime](#SetSampleTime)
40-
41-
[SetOutputLimits](#SetOutputLimits)
42-
43-
[SetMode](#SetMode)
44-
45-
[Initialize](#Initialize)
46-
47-
[SetControllerDirection](#SetControllerDirection)
48-
49-
[Display_Functions](#Display_Functions)
50-
51-
[Utility_Functions](#Utility_Functions)
52-
5331
### Self Test Example (RC Filter):
5432

5533
[This example](https://github.com/Dlloydev/QuickPID/wiki/QuickPID_RC_Filter) allows you to experiment with the four tuning parameters.
5634

57-
![pid_self_test_pom](https://user-images.githubusercontent.com/63488701/104389509-a66a8f00-5509-11eb-927b-1190231a1ee9.gif)
58-
5935
### Simplified PID Algorithm
6036

6137
```c++
@@ -69,6 +45,8 @@ The new `kpi` and `kpd` parameters are calculated in the `SetTunings()` function
6945
kpd = kp * (1 - pOn) + kd;
7046
```
7147

48+
### Functions
49+
7250
#### QuickPID_Constructor
7351

7452
```c++
@@ -78,7 +56,10 @@ QuickPID::QuickPID(int16_t* Input, int16_t* Output, int16_t* Setpoint,
7856
7957
- `Input`, `Output`, and `Setpoint` are pointers to the variables holding these values.
8058
- `Kp`, `Ki`, and `Kd` are the PID proportional, integral, and derivative gains.
81-
- `POn` is the Proportional on Error weighting value (0.0-1.0). This controls the amount of Proportional on Error and Proportional on Measurement factor that's used in the compute algorithm.
59+
- `POn` is the Proportional on Error weighting value (0.0-1.0). This controls the mix of Proportional on Error (PonE) and Proportional on Measurement (PonM) that's used in the compute algorithm. Note that POn controls the PonE amount, where the remainder (1-PonE) is the PonM amount. Also, the default POn is 0 (100% PonM, 0% PonE).
60+
61+
![POn](https://user-images.githubusercontent.com/63488701/104958919-fe3c4680-599e-11eb-851e-73f26291d3e5.gif)
62+
8263
- `ControllerDirection` Either DIRECT or REVERSE determines which direction the output will move for a given error. DIRECT is most common.
8364
8465
```c++
@@ -181,6 +162,19 @@ A faster configuration of `analogRead()`where a preset of 32 is used. Works with
181162
182163
If the definition isn't found, normal `analogRead()`is used to return a value.
183164
165+
### Change Log
166+
167+
#### Version 2.0.4
168+
169+
- Added `QuickPID_AdaptiveTunings.ino`, `QuickPID_Basic.ino`, `QuickPID_PonM.ino` and `QuickPID_RelayOutput.ino` to the examples folder.
170+
- `QuickPID_RelayOutput.ino` has the added feature of `minWindow` setting that sets the minimum on time for the relay.
171+
172+
#### Version 2.0.3
173+
174+
- Initial Version with modifications as listed in [features.](#Features)
175+
176+
------
177+
184178
### Original README (Arduino PID)
185179
186180
```
@@ -196,3 +190,6 @@ A faster configuration of `analogRead()`where a preset of 32 is used. Works with
196190
http://brettbeauregard.com/blog/2011/04/improving-the-beginners-pid-introduction/
197191
198192
- For function documentation see: http://playground.arduino.cc/Code/PIDLibrary
193+
194+
------
195+

0 commit comments

Comments
 (0)