pi.h File Reference

Introduction

PI (Proportional and Integral) controller library.

Note

This library is meant to be API backwards-compatible with existing software. It uses DCL (digital control library)'s PI controller located in SDK's source/dcl folder.

Go to the source code of this file.

Data Structures
struct	PI_Obj
	Defines the PI controller object. More...

Typedefs
typedef struct _PI_Obj_ *	PI_Handle
	Defines the PI handle. More...

Functions
static float32_t	PI_getFbackValue (PI_Handle handle)
	Gets the feedback value in the PI controller. More...
static float32_t	PI_getFfwdValue (PI_Handle handle)
	Gets the feedforward value in the PI controller. More...
static void	PI_getGains (PI_Handle handle, float32_t *pKp, float32_t *pKi)
	Gets the gains in the PI controller. More...
static float32_t	PI_getKi (PI_Handle handle)
	Gets the integral gain in the PI controller. More...
static float32_t	PI_getKp (PI_Handle handle)
	Gets the proportional gain in the PI controller. More...
static void	PI_getMinMax (PI_Handle handle, float32_t *pOutMin, float32_t *pOutMax)
	Gets the minimum and maximum output value allowed in the PI controller. More...
static float32_t	PI_getOutMax (PI_Handle handle)
	Gets the maximum output value allowed in the PI controller. More...
static float32_t	PI_getOutMin (PI_Handle handle)
	Gets the minimum output value allowed in the PI controller. More...
static float32_t	PI_getRefValue (PI_Handle handle)
	Gets the reference value in the PI controller. More...
static float32_t	PI_getUi (PI_Handle handle)
	Gets the integrator start value in the PI controller. More...
PI_Obj *	PI_init (void *pMemory, const size_t numBytes)
	Initializes the PI controller. More...
static void	PI_setFbackValue (PI_Handle handle, const float32_t fbackValue)
	Sets the feedback value in the PI controller. More...
static void	PI_setFfwdValue (PI_Handle handle, const float32_t ffwdValue)
	Sets the feedforward value in the PI controller. More...
static void	PI_setGains (PI_Handle handle, const float32_t Kp, const float32_t Ki)
	Sets the gains in the PI controller. More...
static void	PI_setKi (PI_Handle handle, const float32_t Ki)
	Sets the integral gain in the PI controller. More...
static void	PI_setKp (PI_Handle handle, const float32_t Kp)
	Sets the proportional gain in the PI controller. More...
static void	PI_setMinMax (PI_Handle handle, const float32_t outMin, const float32_t outMax)
	Sets the minimum and maximum output value allowed in the PI controller. More...
static void	PI_setOutMax (PI_Handle handle, const float32_t outMax)
	Sets the maximum output value allowed in the PI controller. More...
static void	PI_setOutMin (PI_Handle handle, const float32_t outMin)
	Sets the minimum output value allowed in the PI controller. More...
static void	PI_setRefValue (PI_Handle handle, const float32_t refValue)
	Sets the reference value in the PI controller. More...
static void	PI_setUi (PI_Handle handle, const float32_t Ui)
	Sets the integrator start value in the PI controller. More...
static void	PI_run_parallel (PI_Handle handle, const float32_t refValue, const float32_t fbackValue, const float32_t ffwdValue, float32_t *pOutValue)
	Runs the parallel form of the PI controller. More...
static void	PI_run_series (PI_Handle handle, const float32_t refValue, const float32_t fbackValue, const float32_t ffwdValue, float32_t *pOutValue)
	Runs the series form of the PI controller. More...
static void	PI_run (PI_Handle handle, const float32_t refValue, const float32_t fbackValue, float32_t *pOutValue)
	Runs the series form of the PI controller without updating the data strcture. More...