MotorWare f2806x Module API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

32b/pid.c
Go to the documentation of this file.
1 /* --COPYRIGHT--,BSD
2 * Copyright (c) 2012, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * --/COPYRIGHT--*/
37
38
39 // **************************************************************************
40 // the includes
41
42 #include "sw/modules/pid/src/32b/pid.h"
43
44
45 // **************************************************************************
46 // the defines
47
48
49 // **************************************************************************
50 // the globals
51
52
53 // **************************************************************************
54 // the functions
55
56 PID_Handle PID_init(void *pMemory,const size_t numBytes)
57 {
58 PID_Handle handle;
59
60
61 if(numBytes < sizeof(PID_Obj))
62 return((PID_Handle)NULL);
63
64 // assign the handle
65 handle = (PID_Handle)pMemory;
66
67 // set some defaults
68 PID_setUi(handle,_IQ(0.0));
69 PID_setRefValue(handle,_IQ(0.0));
70 PID_setFbackValue(handle,_IQ(0.0));
71
72 return(handle);
73 } // end of PID_init() function
74
75 // end of file
_IQ
#define _IQ(A)
Definition: 32b/IQmathLib.h:319
PID_setUi
static void PID_setUi(PID_Handle handle, const _iq Ui)
Sets the integrator start value in the PID controller.
Definition: 32b/pid.h:409
pid.h
Contains the public interface to the Proportional-Integral-Derivative (PID) controller module routine...
PID_setRefValue
static void PID_setRefValue(PID_Handle handle, const _iq refValue)
Sets the reference value in the PID controller.
Definition: 32b/pid.h:396
PID_Handle
struct _PID_Obj_ * PID_Handle
Defines the PID handle.
Definition: 32b/pid.h:93
PID_init
PID_Handle PID_init(void *pMemory, const size_t numBytes)
Initializes the PID controller.
Definition: 32b/pid.c:56
_PID_Obj_
Defines the PID controller object.
Definition: 32b/pid.h:74
PID_setFbackValue
static void PID_setFbackValue(PID_Handle handle, const _iq fbackValue)
Sets the feedback value in the PID controller.
Definition: 32b/pid.h:286