NEVC-MTR1-t01/pid_8h_source.html

/* This file has been prepared for Doxygen automatic documentation generation.*/


#ifndef PID_H

#define PID_H


// Include standard integer type definitions

#include "stdint.h"


#define SCALING_FACTOR 256


#define SCALING_FACTOR_ENABLED FALSE


typedef struct pidData

{

     int16_t lastProcessValue;

     int32_t sumError;

     int16_t P_Factor;

     int16_t I_Factor;

     int16_t D_Factor;

     int16_t maxError;

     int32_t maxSumError;

#if (PID_K_D_ENABLE == TRUE)

     int16_t d_term;

#endif

     int16_t p_term;

     int32_t i_term;

} pidData_t;


#define MAX_INT 32767


#define MAX_LONG 2147483647L


#define MAX_I_TERM (MAX_LONG - (2 * (int32_t)MAX_INT))


// Boolean values

#define FALSE 0


#define TRUE (!FALSE)


// Function prototypes

void PIDInit(int16_t p_factor, int16_t i_factor, int16_t d_factor, pidData_t *pid);

uint16_t PIDController(int16_t setPoint, int16_t processValue, pidData_t *pid_st);

void PIDResetIntegrator(pidData_t *pid_st);


#endif /* PID_H */

PIDInit
void PIDInit(int16_t p_factor, int16_t i_factor, int16_t d_factor, pidData_t *pid)
Initialisation of PID controller parameters.
Definition pid.cpp:31

PIDController
uint16_t PIDController(int16_t setPoint, int16_t processValue, pidData_t *pid_st)
PID control algorithm.
Definition pid.cpp:54

PIDResetIntegrator
void PIDResetIntegrator(pidData_t *pid_st)
Resets the integrator in the PID regulator.
Definition pid.cpp:130

pidData_t
struct pidData pidData_t
PID Status.

pidData
PID Status.
Definition pid.h:47

pidData::maxSumError
int32_t maxSumError
Maximum allowed sum error, avoid overflow.
Definition pid.h:61

pidData::P_Factor
int16_t P_Factor
The Proportional tuning constant, given in x100.
Definition pid.h:53

pidData::maxError
int16_t maxError
Maximum allowed error, avoid overflow.
Definition pid.h:59

pidData::D_Factor
int16_t D_Factor
The Derivative tuning constant, given in x100.
Definition pid.h:57

pidData::d_term
int16_t d_term
The D-term represents the rate of change of the error.
Definition pid.h:64

pidData::sumError
int32_t sumError
Summation of errors, used for integrate calculations.
Definition pid.h:51

pidData::i_term
int32_t i_term
Definition pid.h:70

pidData::I_Factor
int16_t I_Factor
The Integral tuning constant, given in x100.
Definition pid.h:55

pidData::p_term
int16_t p_term
The P-term represents the immediate response to the current error.
Definition pid.h:67

pidData::lastProcessValue
int16_t lastProcessValue
Last process value, used to find derivative of process value.
Definition pid.h:49