32b/pi.h File Reference

Contains the public interface to the Proportional-Integral (PI) controller module routines. More...

#include "sw/modules/iqmath/src/32b/IQmathLib.h"
#include "sw/modules/types/src/types.h"

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_Obj
	Defines the PI controller object. More...
typedef struct _PI_Obj_ *	PI_Handle
	Defines the PI handle. More...

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

Detailed Description

Contains the public interface to the Proportional-Integral (PI) controller module routines.

(C) Copyright 2014, Texas Instruments, Inc.

Definition in file 32b/pi.h.