Skip to content

Commit beac91d

Browse files
committed
Update README.md
1 parent 7687725 commit beac91d

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,25 @@ Development began with a fork of the Arduino PID Library. Some modifications and
3030

3131
### Functions
3232

33-
[QuickPID::QuickPID Constructor](#QuickPID::QuickPID Constructor)
33+
[QuickPID Constructor](#QuickPID Constructor)
3434

35-
[Compute()](#Compute())
35+
[Compute](#Compute)
3636

37-
[SetTunings()](#SetTunings())
37+
[SetTunings](#SetTunings)
3838

39-
[SetSampleTime()](#SetSampleTime())
39+
[SetSampleTime](#SetSampleTime)
4040

41-
[SetOutputLimits()](#SetOutputLimits())
41+
[SetOutputLimits](#SetOutputLimits)
4242

43-
[SetMode()](#SetMode())
43+
[SetMode](#SetMode)
4444

45-
[Initialize()](#Initialize())
45+
[Initialize](#Initialize)
4646

47-
[SetControllerDirection()](#SetControllerDirection())
47+
[SetControllerDirection](#SetControllerDirection)
4848

49-
[Display Functions](#Display Functions())
49+
[Display Functions](#Display Functions)
5050

51-
[Utility Functions](#Utility Functions())
51+
[Utility Functions](#Utility Functions)
5252

5353
### Self Test Example (RC Filter):
5454

@@ -69,7 +69,7 @@ The new `kpi` and `kpd` parameters are calculated in the `SetTunings()` function
6969
kpd = kp * (1 - pOn) + kd;
7070
```
7171

72-
#### QuickPID::QuickPID Constructor
72+
#### QuickPID Constructor
7373

7474
```c++
7575
QuickPID::QuickPID(int16_t* Input, int16_t* Output, int16_t* Setpoint,
@@ -88,15 +88,15 @@ QuickPID::QuickPID(int16_t* Input, int16_t* Output, int16_t* Setpoint,
8888

8989
This allows you to use Proportional on Error without explicitly saying so.
9090

91-
#### Compute()
91+
#### Compute
9292

9393
```c++
9494
bool QuickPID::Compute()
9595
```
9696

9797
This function contains the PID algorithm and it should be called once every loop(). Most of the time it will just return false without doing anything. However, at a frequency specified by `SetSampleTime` it will calculate a new Output and return true.
9898

99-
#### SetTunings()
99+
#### SetTunings
100100

101101
```c++
102102
void QuickPID::SetTunings(float Kp, float Ki, float Kd, float POn)
@@ -110,39 +110,39 @@ void QuickPID::SetTunings(float Kp, float Ki, float Kd)
110110

111111
Set Tunings using the last remembered POn setting.
112112

113-
#### SetSampleTime()
113+
#### SetSampleTime
114114

115115
```c++
116116
void QuickPID::SetSampleTimeUs(uint32_t NewSampleTimeUs)
117117
```
118118
119119
Sets the period, in microseconds, at which the calculation is performed. The default is 100ms.
120120
121-
#### SetOutputLimits()
121+
#### SetOutputLimits
122122
123123
```c++
124124
void QuickPID::SetOutputLimits(int16_t Min, int16_t Max)
125125
```
126126

127127
The PID controller is designed to vary its output within a given range. By default this range is 0-255, the Arduino PWM range.
128128

129-
#### SetMode()
129+
#### SetMode
130130

131131
```c++
132132
void QuickPID::SetMode(bool Mode)
133133
```
134134
135135
Allows the controller Mode to be set to `MANUAL` (0) or `AUTOMATIC` (non-zero). when the transition from manual to automatic occurs, the controller is automatically initialized.
136136
137-
#### Initialize()
137+
#### Initialize
138138
139139
```c++
140140
void QuickPID::Initialize()
141141
```
142142

143143
Does all the things that need to happen to ensure a bumpless transfer from manual to automatic mode.
144144

145-
#### SetControllerDirection()
145+
#### SetControllerDirection
146146

147147
```c++
148148
void QuickPID::SetControllerDirection(bool Direction)

0 commit comments

Comments
 (0)