MotorWare f2806x Module API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

32b/motor.h
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--*/
32 #ifndef _MOTOR_H_
33 #define _MOTOR_H_
34
39
40
41 // **************************************************************************
42 // the includes
43
44 #include "sw/modules/types/src/types.h"
45
46
51
52
53 // Include the algorithm overview defined in modules/<module>/docs/doxygen/doxygen.h
55
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59
60
61 // **************************************************************************
62 // the defines
63
64
65 // **************************************************************************
66 // the typedefs
67
68
71 typedef enum
72 {
73 MOTOR_Type_Induction=0,
74 MOTOR_Type_Pm
75 } MOTOR_Type_e;
76
77
80 typedef struct _MOTOR_Params_
81 {
82 MOTOR_Type_e type;
83
84 uint_least16_t numPolePairs;
85
86 float_t Lr_H;
87
88 float_t Ls_d_H;
89 float_t Ls_q_H;
90
91 float_t Rr_Ohm;
92
93 float_t Rs_Ohm;
94
95 float_t ratedFlux_VpHz;
96 } MOTOR_Params;
97
98
99 // **************************************************************************
100 // the functions
101
102
103 #ifdef __cplusplus
104 }
105 #endif // extern "C"
106
108 #endif // end of _MOTOR_H_ definition
109
110
111
112
113
types.h
Contains the public interface to the types definitions.
_MOTOR_Params_::ratedFlux_VpHz
float_t ratedFlux_VpHz
Defines the rated flux, V/Hz.
Definition: 32b/motor.h:95
_MOTOR_Params_::type
MOTOR_Type_e type
Defines the motor type.
Definition: 32b/motor.h:82
_MOTOR_Params_::numPolePairs
uint_least16_t numPolePairs
Defines the number of pole pairs.
Definition: 32b/motor.h:84
MOTOR_Type_Pm
permanent magnet
Definition: 32b/motor.h:74
MOTOR_Type_e
MOTOR_Type_e
Enumeration for the motor types.
Definition: 32b/motor.h:71
MOTOR_Type_Induction
induction
Definition: 32b/motor.h:73
_MOTOR_Params_::Ls_q_H
float_t Ls_q_H
Defines the quadrature stator inductance, H.
Definition: 32b/motor.h:89
_MOTOR_Params_::Ls_d_H
float_t Ls_d_H
Defines the direct stator inductance, H.
Definition: 32b/motor.h:88
_MOTOR_Params_::Rs_Ohm
float_t Rs_Ohm
Defines the stator resistance, Ohm.
Definition: 32b/motor.h:93
_MOTOR_Params_::Lr_H
float_t Lr_H
Defines the rotor inductance, H.
Definition: 32b/motor.h:86
_MOTOR_Params_::Rr_Ohm
float_t Rr_Ohm
Defines the rotor resistance, Ohm.
Definition: 32b/motor.h:91
_MOTOR_Params_
Defines the motor parameters.
Definition: 32b/motor.h:80
MOTOR_Params
struct _MOTOR_Params_ MOTOR_Params
Defines the motor parameters.
float_t
float float_t
Defines the portable data type for 32 bit, signed floating-point data.
Definition: types.h:121