aboutsummaryrefslogtreecommitdiffstats
path: root/os/various/pid.h
diff options
context:
space:
mode:
authorFabien Poussin <fabien.poussin@gmail.com>2018-03-25 04:21:11 +0200
committerFabien Poussin <fabien.poussin@gmail.com>2018-03-25 04:21:11 +0200
commit71fe8e7ced20bbcea503e0ef22e155c09f63a1f7 (patch)
tree108aa57702235ab65a59b200489b2514e697739c /os/various/pid.h
parent261c37a0dbfb430cdfd6aac9a10733851e3cc2e7 (diff)
downloadChibiOS-Contrib-71fe8e7ced20bbcea503e0ef22e155c09f63a1f7.tar.gz
ChibiOS-Contrib-71fe8e7ced20bbcea503e0ef22e155c09f63a1f7.tar.bz2
ChibiOS-Contrib-71fe8e7ced20bbcea503e0ef22e155c09f63a1f7.zip
Renaming PID struct typedef to avoid conflicts
Diffstat (limited to 'os/various/pid.h')
-rw-r--r--os/various/pid.h54
1 files changed, 27 insertions, 27 deletions
diff --git a/os/various/pid.h b/os/various/pid.h
index 74d116d..49ccd6f 100644
--- a/os/various/pid.h
+++ b/os/various/pid.h
@@ -13,11 +13,11 @@
typedef struct {
-
+
float kp; // * (P)roportional Tuning Parameter
float ki; // * (I)ntegral Tuning Parameter
float kd; // * (D)erivative Tuning Parameter
-
+
float dispKp; // * we'll hold on to the tuning parameters in user-entered
float dispKi; // format for display purposes
float dispKd; //
@@ -36,43 +36,43 @@ typedef struct {
unsigned long sampleTime;
float outMin;
float outMax;
-
+
bool inAuto;
bool pOnE;
-} pid_t;
+} pidc_t;
//commonly used functions **************************************************************************
-void pid_create(pid_t* p, float* Input, float* Output, float* Setpoint, // * constructor. links the PID to the Input, Output, and
- float Kp, float Ki, float Kd, int POn, int Direction); // Setpoint. Initial tuning parameters are also set here.
- // (overload for specifying proportional mode)
+void pid_create(pidc_t* p, float* Input, float* Output, float* Setpoint, // * constructor. links the PID to the Input, Output, and
+ float Kp, float Ki, float Kd, int POn, int Direction); // Setpoint. Initial tuning parameters are also set here.
+ // (overload for specifying proportional mode)
-void pid_setMode(pid_t* p, int mode); // * sets PID to either Manual (0) or Auto (non-0)
+void pid_setMode(pidc_t* p, int mode); // * sets PID to either Manual (0) or Auto (non-0)
-bool pid_compute(pid_t* p); // * performs the PID calculation. it should be
- // called every time loop() cycles. ON/OFF and
- // calculation frequency can be set using SetMode
- // SetsampleTime respectively
+bool pid_compute(pidc_t* p); // * performs the PID calculation. it should be
+ // called every time loop() cycles. ON/OFF and
+ // calculation frequency can be set using SetMode
+ // SetsampleTime respectively
-void pid_setOutputLimits(pid_t* p, float Min, float Max); // * clamps the output to a specific range. 0-255 by default, but
- // it's likely the user will want to change this depending on
- // the application
+void pid_setOutputLimits(pidc_t* p, float Min, float Max); // * clamps the output to a specific range. 0-255 by default, but
+ // it's likely the user will want to change this depending on
+ // the application
//available but not commonly used functions ********************************************************
-void pid_setTunings(pid_t* p, float Kp, float Ki, float Kd, int POn); // * While most users will set the tunings once in the
- // constructor, this function gives the user the option
- // of changing tunings during runtime for Adaptive control
-
-void pid_setDirection(pid_t* p, int Direction); // * Sets the Direction, or "Action" of the controller. DIRECT
- // means the output will increase when error is positive. REVERSE
- // means the opposite. it's very unlikely that this will be needed
- // once it is set in the constructor.
-void pid_setSampleTime(pid_t* p, int NewSampleTime); // * sets the frequency, in Milliseconds, with which
- // the PID calculation is performed. default is 100
-
-void pid_initialize(pid_t* p);
+void pid_setTunings(pidc_t* p, float Kp, float Ki, float Kd, int POn); // * While most users will set the tunings once in the
+ // constructor, this function gives the user the option
+ // of changing tunings during runtime for Adaptive control
+
+void pid_setDirection(pidc_t* p, int Direction); // * Sets the Direction, or "Action" of the controller. DIRECT
+ // means the output will increase when error is positive. REVERSE
+ // means the opposite. it's very unlikely that this will be needed
+ // once it is set in the constructor.
+void pid_setSampleTime(pidc_t* p, int NewSampleTime); // * sets the frequency, in Milliseconds, with which
+ // the PID calculation is performed. default is 100
+
+void pid_initialize(pidc_t* p);
#endif