32b/pid.h File Reference

Contains the public interface to the Proportional-Integral-Derivative (PID) 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	_PID_Obj_
	Defines the PID controller object. More...

Typedefs
typedef struct _PID_Obj_	PID_Obj
	Defines the PID controller object. More...
typedef struct _PID_Obj_ *	PID_Handle
	Defines the PID handle. More...

Functions
static _iq	PID_getFbackValue (PID_Handle handle)
	Gets the feedback value in the PID controller. More...
static void	PID_getGains (PID_Handle handle, _iq *pKp, _iq *pKi, _iq *pKd)
	Gets the gains in the PID controller. More...
static _iq	PID_getKd (PID_Handle handle)
	Gets the derivative gain in the PID controller. More...
static _iq	PID_getKi (PID_Handle handle)
	Gets the integral gain in the PID controller. More...
static _iq	PID_getKp (PID_Handle handle)
	Gets the proportional gain in the PID controller. More...
static void	PID_getMinMax (PID_Handle handle, _iq *pOutMin, _iq *pOutMax)
	Gets the minimum and maximum output value allowed in the PID controller. More...
static _iq	PID_getOutMax (PID_Handle handle)
	Gets the maximum output value allowed in the PID controller. More...
static _iq	PID_getOutMin (PID_Handle handle)
	Gets the minimum output value allowed in the PID controller. More...
static _iq	PID_getRefValue (PID_Handle handle)
	Gets the reference value in the PID controller. More...
static _iq	PID_getUi (PID_Handle handle)
	Gets the integrator start value in the PID controller. More...
PID_Handle	PID_init (void *pMemory, const size_t numBytes)
	Initializes the PID controller. More...
static void	PID_run (PID_Handle handle, const _iq refValue, const _iq fbackValue, _iq *pOutValue)
	Runs the PID controller. More...
static void	PID_run_spd (PID_Handle handle, const _iq refValue, const _iq fbackValue, _iq *pOutValue)
	Runs the PID controller for speed. More...
static void	PID_setFbackValue (PID_Handle handle, const _iq fbackValue)
	Sets the feedback value in the PID controller. More...
static void	PID_setGains (PID_Handle handle, const _iq Kp, const _iq Ki, const _iq Kd)
	Sets the gains in the PID controller. More...
static void	PID_setKd (PID_Handle handle, const _iq Kd)
	Sets the derivative gain in the PID controller. More...
static void	PID_setKi (PID_Handle handle, const _iq Ki)
	Sets the integral gain in the PID controller. More...
static void	PID_setKp (PID_Handle handle, const _iq Kp)
	Sets the proportional gain in the PID controller. More...
static void	PID_setMinMax (PID_Handle handle, const _iq outMin, const _iq outMax)
	Sets the minimum and maximum output value allowed in the PID controller. More...
static void	PID_setOutMax (PID_Handle handle, const _iq outMax)
	Sets the maximum output value allowed in the PID controller. More...
static void	PID_setOutMin (PID_Handle handle, const _iq outMin)
	Sets the minimum output value allowed in the PID controller. More...
static void	PID_setRefValue (PID_Handle handle, const _iq refValue)
	Sets the reference value in the PID controller. More...
static void	PID_setUi (PID_Handle handle, const _iq Ui)
	Sets the integrator start value in the PID controller. More...

Detailed Description

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

(C) Copyright 2011, Texas Instruments, Inc.

Definition in file 32b/pid.h.