|
1 \hypertarget{states_8h}{ |
|
2 \section{/home/epimerde/documents/tc11/Can\-Festival-3/include/states.h File Reference} |
|
3 \label{states_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/states.h@{/home/epimerde/documents/tc11/CanFestival-3/include/states.h}} |
|
4 } |
|
5 {\tt \#include $<$applicfg.h$>$}\par |
|
6 {\tt \#include \char`\"{}data.h\char`\"{}}\par |
|
7 \subsection*{Data Structures} |
|
8 \begin{CompactItemize} |
|
9 \item |
|
10 struct \hyperlink{structs__state__communication}{s\_\-state\_\-communication} |
|
11 \end{CompactItemize} |
|
12 \subsection*{Typedefs} |
|
13 \begin{CompactItemize} |
|
14 \item |
|
15 typedef enum \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646}{enum\_\-node\-State} \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} |
|
16 \item |
|
17 typedef void($\ast$) \hyperlink{states_8h_d0cd6d1eb89085da7cb9f32ce386e8bc}{initialisation\_\-t} (void) |
|
18 \item |
|
19 typedef void($\ast$) \hyperlink{states_8h_f4a6da4fe018afbe20eaf716c248e02a}{pre\-Operational\_\-t} (void) |
|
20 \item |
|
21 typedef void($\ast$) \hyperlink{states_8h_8aed99e590473f26db47a9c2dc5b73fc}{operational\_\-t} (void) |
|
22 \item |
|
23 typedef void($\ast$) \hyperlink{states_8h_c99397ce6341b6b5128104aee4c27ec5}{stopped\_\-t} (void) |
|
24 \end{CompactItemize} |
|
25 \subsection*{Enumerations} |
|
26 \begin{CompactItemize} |
|
27 \item |
|
28 enum \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646}{enum\_\-node\-State} \{ \par |
|
29 \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646eb3ae26d7a1629aa0fc6c83f46306cf5}{Initialisation} = 0x00, |
|
30 \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec6864684ab0fbbb76a8c897feb1cd806d56443}{Disconnected} = 0x01, |
|
31 \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec686466ea90df6fe966852496b4846da497fb0}{Connecting} = 0x02, |
|
32 \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec6864695fc3c631fbad8ca3dc8d5b69a3e0d5b}{Preparing} = 0x02, |
|
33 \par |
|
34 \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec686464d049c6d45e08a294523df186ad77a75}{Stopped} = 0x04, |
|
35 \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646a80594b1522cb686b981f56bbec45124}{Operational} = 0x05, |
|
36 \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646c747c16a9c4d7dec65cdab6e38df99b7}{Pre\_\-operational} = 0x7F, |
|
37 \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646cb4b5cb64be091d76f846380eb0afe59}{Unknown\_\-state} = 0x0F |
|
38 \} |
|
39 \end{CompactItemize} |
|
40 \subsection*{Functions} |
|
41 \begin{CompactItemize} |
|
42 \item |
|
43 void \hyperlink{states_8h_67ca1ac7ff49e88cf7847e408b258cae}{\_\-initialisation} (void) |
|
44 \item |
|
45 void \hyperlink{states_8h_f4e52eb187303eca1962bb6f74cb8169}{\_\-pre\-Operational} (void) |
|
46 \item |
|
47 void \hyperlink{states_8h_b31a0526e24de79a09ccc512db420d91}{\_\-operational} (void) |
|
48 \item |
|
49 void \hyperlink{states_8h_9117ccff20aaed468dd715517e77dbc3}{\_\-stopped} (void) |
|
50 \item |
|
51 void \hyperlink{states_8h_3f8975650604cc23582f19a43fd4e518}{can\-Dispatch} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, \hyperlink{structMessage}{Message} $\ast$m) |
|
52 \item |
|
53 \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} \hyperlink{states_8h_95d835785ba564bf6d92e3224c5e3848}{get\-State} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d) |
|
54 \item |
|
55 UNS8 \hyperlink{states_8h_0a5004efd1dedbee82a4f21ec5c44fb5}{set\-State} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} new\-State) |
|
56 \item |
|
57 UNS8 \hyperlink{states_8h_3020f2e5762f6e389a21382ec827b6a6}{get\-Node\-Id} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d) |
|
58 \item |
|
59 void \hyperlink{states_8h_d47a53979b9311a374d029f7923abbe1}{set\-Node\-Id} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id) |
|
60 \item |
|
61 void \hyperlink{states_8h_3e57769f3a958c103825263b7abdd92b}{init\-Pre\-Operational\-Mode} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d) |
|
62 \end{CompactItemize} |
|
63 |
|
64 |
|
65 \subsection{Typedef Documentation} |
|
66 \hypertarget{states_8h_5891f63a4c9243179838389a93d084e2}{ |
|
67 \index{states.h@{states.h}!e_nodeState@{e\_\-nodeState}} |
|
68 \index{e_nodeState@{e\_\-nodeState}!states.h@{states.h}} |
|
69 \subsubsection[e\_\-nodeState]{\setlength{\rightskip}{0pt plus 5cm}typedef enum \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646}{enum\_\-node\-State} \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State}}} |
|
70 \label{states_8h_5891f63a4c9243179838389a93d084e2} |
|
71 |
|
72 |
|
73 |
|
74 |
|
75 Definition at line 46 of file states.h.\hypertarget{states_8h_d0cd6d1eb89085da7cb9f32ce386e8bc}{ |
|
76 \index{states.h@{states.h}!initialisation_t@{initialisation\_\-t}} |
|
77 \index{initialisation_t@{initialisation\_\-t}!states.h@{states.h}} |
|
78 \subsubsection[initialisation\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{states_8h_d0cd6d1eb89085da7cb9f32ce386e8bc}{initialisation\_\-t}(void)}} |
|
79 \label{states_8h_d0cd6d1eb89085da7cb9f32ce386e8bc} |
|
80 |
|
81 |
|
82 Function that user app can overload |
|
83 |
|
84 Definition at line 61 of file states.h.\hypertarget{states_8h_8aed99e590473f26db47a9c2dc5b73fc}{ |
|
85 \index{states.h@{states.h}!operational_t@{operational\_\-t}} |
|
86 \index{operational_t@{operational\_\-t}!states.h@{states.h}} |
|
87 \subsubsection[operational\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{states_8h_8aed99e590473f26db47a9c2dc5b73fc}{operational\_\-t}(void)}} |
|
88 \label{states_8h_8aed99e590473f26db47a9c2dc5b73fc} |
|
89 |
|
90 |
|
91 |
|
92 |
|
93 Definition at line 63 of file states.h.\hypertarget{states_8h_f4a6da4fe018afbe20eaf716c248e02a}{ |
|
94 \index{states.h@{states.h}!preOperational_t@{preOperational\_\-t}} |
|
95 \index{preOperational_t@{preOperational\_\-t}!states.h@{states.h}} |
|
96 \subsubsection[preOperational\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{states_8h_f4a6da4fe018afbe20eaf716c248e02a}{pre\-Operational\_\-t}(void)}} |
|
97 \label{states_8h_f4a6da4fe018afbe20eaf716c248e02a} |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 Definition at line 62 of file states.h.\hypertarget{states_8h_c99397ce6341b6b5128104aee4c27ec5}{ |
|
103 \index{states.h@{states.h}!stopped_t@{stopped\_\-t}} |
|
104 \index{stopped_t@{stopped\_\-t}!states.h@{states.h}} |
|
105 \subsubsection[stopped\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{states_8h_c99397ce6341b6b5128104aee4c27ec5}{stopped\_\-t}(void)}} |
|
106 \label{states_8h_c99397ce6341b6b5128104aee4c27ec5} |
|
107 |
|
108 |
|
109 |
|
110 |
|
111 Definition at line 64 of file states.h. |
|
112 |
|
113 \subsection{Enumeration Type Documentation} |
|
114 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646}{ |
|
115 \index{states.h@{states.h}!enum_nodeState@{enum\_\-nodeState}} |
|
116 \index{enum_nodeState@{enum\_\-nodeState}!states.h@{states.h}} |
|
117 \subsubsection[enum\_\-nodeState]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{states_8h_3136d2815abe9d284f985e0a7ec68646}{enum\_\-node\-State}}} |
|
118 \label{states_8h_3136d2815abe9d284f985e0a7ec68646} |
|
119 |
|
120 |
|
121 \begin{Desc} |
|
122 \item[Enumerator: ]\par |
|
123 \begin{description} |
|
124 \index{Initialisation@{Initialisation}!states.h@{states.h}}\index{states.h@{states.h}!Initialisation@{Initialisation}}\item[{\em |
|
125 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646eb3ae26d7a1629aa0fc6c83f46306cf5}{ |
|
126 Initialisation} |
|
127 \label{states_8h_3136d2815abe9d284f985e0a7ec68646eb3ae26d7a1629aa0fc6c83f46306cf5} |
|
128 }]\index{Disconnected@{Disconnected}!states.h@{states.h}}\index{states.h@{states.h}!Disconnected@{Disconnected}}\item[{\em |
|
129 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec6864684ab0fbbb76a8c897feb1cd806d56443}{ |
|
130 Disconnected} |
|
131 \label{states_8h_3136d2815abe9d284f985e0a7ec6864684ab0fbbb76a8c897feb1cd806d56443} |
|
132 }]\index{Connecting@{Connecting}!states.h@{states.h}}\index{states.h@{states.h}!Connecting@{Connecting}}\item[{\em |
|
133 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec686466ea90df6fe966852496b4846da497fb0}{ |
|
134 Connecting} |
|
135 \label{states_8h_3136d2815abe9d284f985e0a7ec686466ea90df6fe966852496b4846da497fb0} |
|
136 }]\index{Preparing@{Preparing}!states.h@{states.h}}\index{states.h@{states.h}!Preparing@{Preparing}}\item[{\em |
|
137 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec6864695fc3c631fbad8ca3dc8d5b69a3e0d5b}{ |
|
138 Preparing} |
|
139 \label{states_8h_3136d2815abe9d284f985e0a7ec6864695fc3c631fbad8ca3dc8d5b69a3e0d5b} |
|
140 }]\index{Stopped@{Stopped}!states.h@{states.h}}\index{states.h@{states.h}!Stopped@{Stopped}}\item[{\em |
|
141 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec686464d049c6d45e08a294523df186ad77a75}{ |
|
142 Stopped} |
|
143 \label{states_8h_3136d2815abe9d284f985e0a7ec686464d049c6d45e08a294523df186ad77a75} |
|
144 }]\index{Operational@{Operational}!states.h@{states.h}}\index{states.h@{states.h}!Operational@{Operational}}\item[{\em |
|
145 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646a80594b1522cb686b981f56bbec45124}{ |
|
146 Operational} |
|
147 \label{states_8h_3136d2815abe9d284f985e0a7ec68646a80594b1522cb686b981f56bbec45124} |
|
148 }]\index{Pre_operational@{Pre\_\-operational}!states.h@{states.h}}\index{states.h@{states.h}!Pre_operational@{Pre\_\-operational}}\item[{\em |
|
149 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646c747c16a9c4d7dec65cdab6e38df99b7}{ |
|
150 Pre\_\-operational} |
|
151 \label{states_8h_3136d2815abe9d284f985e0a7ec68646c747c16a9c4d7dec65cdab6e38df99b7} |
|
152 }]\index{Unknown_state@{Unknown\_\-state}!states.h@{states.h}}\index{states.h@{states.h}!Unknown_state@{Unknown\_\-state}}\item[{\em |
|
153 \hypertarget{states_8h_3136d2815abe9d284f985e0a7ec68646cb4b5cb64be091d76f846380eb0afe59}{ |
|
154 Unknown\_\-state} |
|
155 \label{states_8h_3136d2815abe9d284f985e0a7ec68646cb4b5cb64be091d76f846380eb0afe59} |
|
156 }]\end{description} |
|
157 \end{Desc} |
|
158 |
|
159 |
|
160 |
|
161 Definition at line 35 of file states.h. |
|
162 |
|
163 \subsection{Function Documentation} |
|
164 \hypertarget{states_8h_67ca1ac7ff49e88cf7847e408b258cae}{ |
|
165 \index{states.h@{states.h}!_initialisation@{\_\-initialisation}} |
|
166 \index{_initialisation@{\_\-initialisation}!states.h@{states.h}} |
|
167 \subsubsection[\_\-initialisation]{\setlength{\rightskip}{0pt plus 5cm}void \_\-initialisation (void)}} |
|
168 \label{states_8h_67ca1ac7ff49e88cf7847e408b258cae} |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 Definition at line 234 of file states.c.\hypertarget{states_8h_b31a0526e24de79a09ccc512db420d91}{ |
|
174 \index{states.h@{states.h}!_operational@{\_\-operational}} |
|
175 \index{_operational@{\_\-operational}!states.h@{states.h}} |
|
176 \subsubsection[\_\-operational]{\setlength{\rightskip}{0pt plus 5cm}void \_\-operational (void)}} |
|
177 \label{states_8h_b31a0526e24de79a09ccc512db420d91} |
|
178 |
|
179 |
|
180 |
|
181 |
|
182 Definition at line 236 of file states.c.\hypertarget{states_8h_f4e52eb187303eca1962bb6f74cb8169}{ |
|
183 \index{states.h@{states.h}!_preOperational@{\_\-preOperational}} |
|
184 \index{_preOperational@{\_\-preOperational}!states.h@{states.h}} |
|
185 \subsubsection[\_\-preOperational]{\setlength{\rightskip}{0pt plus 5cm}void \_\-pre\-Operational (void)}} |
|
186 \label{states_8h_f4e52eb187303eca1962bb6f74cb8169} |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 Definition at line 235 of file states.c.\hypertarget{states_8h_9117ccff20aaed468dd715517e77dbc3}{ |
|
192 \index{states.h@{states.h}!_stopped@{\_\-stopped}} |
|
193 \index{_stopped@{\_\-stopped}!states.h@{states.h}} |
|
194 \subsubsection[\_\-stopped]{\setlength{\rightskip}{0pt plus 5cm}void \_\-stopped (void)}} |
|
195 \label{states_8h_9117ccff20aaed468dd715517e77dbc3} |
|
196 |
|
197 |
|
198 |
|
199 |
|
200 Definition at line 237 of file states.c.\hypertarget{states_8h_3f8975650604cc23582f19a43fd4e518}{ |
|
201 \index{states.h@{states.h}!canDispatch@{canDispatch}} |
|
202 \index{canDispatch@{canDispatch}!states.h@{states.h}} |
|
203 \subsubsection[canDispatch]{\setlength{\rightskip}{0pt plus 5cm}void can\-Dispatch (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}} |
|
204 \label{states_8h_3f8975650604cc23582f19a43fd4e518} |
|
205 |
|
206 |
|
207 Called by driver/app when receiving messages |
|
208 |
|
209 Definition at line 39 of file states.c. |
|
210 |
|
211 References Message::cob\_\-id, s\_\-state\_\-communication::cs\-Heartbeat, s\_\-state\_\-communication::cs\-PDO, s\_\-state\_\-communication::cs\-SDO, s\_\-state\_\-communication::cs\-SYNC, struct\_\-CO\_\-Data::Current\-Communication\-State, struct\_\-s\_\-timer\_\-entry::d, struct\_\-CO\_\-Data::iam\_\-a\_\-slave, NMT, NODE\_\-GUARD, PDO1rx, PDO1tx, PDO2rx, PDO2tx, PDO3rx, PDO3tx, PDO4rx, PDO4tx, proceed\-NMTstate\-Change(), proceed\-NODE\_\-GUARD(), proceed\-PDO(), proceed\-SDO(), proceed\-SYNC(), SDOrx, SDOtx, SYNC, and SHORT\_\-CAN::w.\hypertarget{states_8h_3020f2e5762f6e389a21382ec827b6a6}{ |
|
212 \index{states.h@{states.h}!getNodeId@{getNodeId}} |
|
213 \index{getNodeId@{getNodeId}!states.h@{states.h}} |
|
214 \subsubsection[getNodeId]{\setlength{\rightskip}{0pt plus 5cm}UNS8 get\-Node\-Id (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}} |
|
215 \label{states_8h_3020f2e5762f6e389a21382ec827b6a6} |
|
216 |
|
217 |
|
218 Returns the nod\-Id |
|
219 |
|
220 Definition at line 180 of file states.c. |
|
221 |
|
222 References struct\_\-CO\_\-Data::b\-Device\-Node\-Id, and struct\_\-s\_\-timer\_\-entry::d.\hypertarget{states_8h_95d835785ba564bf6d92e3224c5e3848}{ |
|
223 \index{states.h@{states.h}!getState@{getState}} |
|
224 \index{getState@{getState}!states.h@{states.h}} |
|
225 \subsubsection[getState]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} get\-State (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}} |
|
226 \label{states_8h_95d835785ba564bf6d92e3224c5e3848} |
|
227 |
|
228 |
|
229 Returns the state of the node |
|
230 |
|
231 Definition at line 33 of file states.c. |
|
232 |
|
233 References struct\_\-s\_\-timer\_\-entry::d, and struct\_\-CO\_\-Data::node\-State.\hypertarget{states_8h_3e57769f3a958c103825263b7abdd92b}{ |
|
234 \index{states.h@{states.h}!initPreOperationalMode@{initPreOperationalMode}} |
|
235 \index{initPreOperationalMode@{initPreOperationalMode}!states.h@{states.h}} |
|
236 \subsubsection[initPreOperationalMode]{\setlength{\rightskip}{0pt plus 5cm}void init\-Pre\-Operational\-Mode (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}} |
|
237 \label{states_8h_3e57769f3a958c103825263b7abdd92b} |
|
238 |
|
239 |
|
240 Some stuff to do when the node enter in pre-operational mode \hypertarget{states_8h_d47a53979b9311a374d029f7923abbe1}{ |
|
241 \index{states.h@{states.h}!setNodeId@{setNodeId}} |
|
242 \index{setNodeId@{setNodeId}!states.h@{states.h}} |
|
243 \subsubsection[setNodeId]{\setlength{\rightskip}{0pt plus 5cm}void set\-Node\-Id (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id})}} |
|
244 \label{states_8h_d47a53979b9311a374d029f7923abbe1} |
|
245 |
|
246 |
|
247 Define the node ID. Initialize the object dictionary |
|
248 |
|
249 Definition at line 186 of file states.c. |
|
250 |
|
251 References struct\_\-CO\_\-Data::b\-Device\-Node\-Id, struct\_\-s\_\-timer\_\-entry::d, struct\_\-CO\_\-Data::first\-Index, struct\_\-CO\_\-Data::last\-Index, struct\_\-CO\_\-Data::objdict, s\_\-quick\_\-index::PDO\_\-RCV, s\_\-quick\_\-index::PDO\_\-TRS, td\_\-subindex::p\-Object, td\_\-indextable::p\-Subindex, s\_\-quick\_\-index::SDO\_\-SVR, UNS16, UNS32, and UNS8.\hypertarget{states_8h_0a5004efd1dedbee82a4f21ec5c44fb5}{ |
|
252 \index{states.h@{states.h}!setState@{setState}} |
|
253 \index{setState@{setState}!states.h@{states.h}} |
|
254 \subsubsection[setState]{\setlength{\rightskip}{0pt plus 5cm}UNS8 set\-State (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, \hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} {\em new\-State})}} |
|
255 \label{states_8h_0a5004efd1dedbee82a4f21ec5c44fb5} |
|
256 |
|
257 |
|
258 Change the state of the node |
|
259 |
|
260 Definition at line 100 of file states.c. |
|
261 |
|
262 References struct\_\-s\_\-timer\_\-entry::d, decompo\_\-dcf(), struct\_\-CO\_\-Data::iam\_\-a\_\-slave, struct\_\-CO\_\-Data::initialisation, Initialisation, struct\_\-CO\_\-Data::node\-State, OD\_\-SUCCESSFUL, struct\_\-CO\_\-Data::operational, Operational, Pre\_\-operational, struct\_\-CO\_\-Data::pre\-Operational, ptr\-Table, struct\_\-CO\_\-Data::scan\-Index\-OD, struct\_\-CO\_\-Data::stopped, Stopped, switch\-Communication\-State(), UNS16, and UNS32. |