|
207
|
1 |
\hypertarget{lifegrd_8h}{
|
|
|
2 |
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/lifegrd.h File Reference}
|
|
|
3 |
\label{lifegrd_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/lifegrd.h@{/home/epimerde/documents/tc11/CanFestival-3/include/lifegrd.h}}
|
|
|
4 |
}
|
|
|
5 |
{\tt \#include $<$applicfg.h$>$}\par
|
|
|
6 |
{\tt \#include \char`\"{}data.h\char`\"{}}\par
|
|
|
7 |
\subsection*{Typedefs}
|
|
|
8 |
\begin{CompactItemize}
|
|
|
9 |
\item
|
|
|
10 |
typedef void($\ast$) \hyperlink{lifegrd_8h_eca3959d33fceb33487363a0493d3b7d}{heartbeat\-Error\_\-t} (UNS8)
|
|
|
11 |
\end{CompactItemize}
|
|
|
12 |
\subsection*{Functions}
|
|
|
13 |
\begin{CompactItemize}
|
|
|
14 |
\item
|
|
|
15 |
void \hyperlink{lifegrd_8h_5249eb891f5677b80ccf01e604748524}{\_\-heartbeat\-Error} (UNS8 heartbeat\-ID)
|
|
|
16 |
\item
|
|
|
17 |
\hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} \hyperlink{lifegrd_8h_627254070e45c23f1776e12c524492ff}{get\-Node\-State} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id)
|
|
|
18 |
\item
|
|
|
19 |
void \hyperlink{lifegrd_8h_8896f6846e4d020390f6953f3d98aa21}{heartbeat\-Init} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
|
|
|
20 |
\item
|
|
|
21 |
void \hyperlink{lifegrd_8h_1b73047269c2a02065e12af18c6053c7}{heartbeat\-Stop} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
|
|
|
22 |
\item
|
|
|
23 |
void \hyperlink{lifegrd_8h_b3248945e06e8b05518beddf665f174d}{proceed\-NODE\_\-GUARD} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, \hyperlink{structMessage}{Message} $\ast$m)
|
|
|
24 |
\end{CompactItemize}
|
|
|
25 |
|
|
|
26 |
|
|
|
27 |
\subsection{Typedef Documentation}
|
|
|
28 |
\hypertarget{lifegrd_8h_eca3959d33fceb33487363a0493d3b7d}{
|
|
|
29 |
\index{lifegrd.h@{lifegrd.h}!heartbeatError_t@{heartbeatError\_\-t}}
|
|
|
30 |
\index{heartbeatError_t@{heartbeatError\_\-t}!lifegrd.h@{lifegrd.h}}
|
|
|
31 |
\subsubsection[heartbeatError\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{lifegrd_8h_eca3959d33fceb33487363a0493d3b7d}{heartbeat\-Error\_\-t}(UNS8)}}
|
|
|
32 |
\label{lifegrd_8h_eca3959d33fceb33487363a0493d3b7d}
|
|
|
33 |
|
|
|
34 |
|
|
|
35 |
|
|
|
36 |
|
|
|
37 |
Definition at line 29 of file lifegrd.h.
|
|
|
38 |
|
|
|
39 |
\subsection{Function Documentation}
|
|
|
40 |
\hypertarget{lifegrd_8h_5249eb891f5677b80ccf01e604748524}{
|
|
|
41 |
\index{lifegrd.h@{lifegrd.h}!_heartbeatError@{\_\-heartbeatError}}
|
|
|
42 |
\index{_heartbeatError@{\_\-heartbeatError}!lifegrd.h@{lifegrd.h}}
|
|
|
43 |
\subsubsection[\_\-heartbeatError]{\setlength{\rightskip}{0pt plus 5cm}void \_\-heartbeat\-Error (UNS8 {\em heartbeat\-ID})}}
|
|
|
44 |
\label{lifegrd_8h_5249eb891f5677b80ccf01e604748524}
|
|
|
45 |
|
|
|
46 |
|
|
|
47 |
|
|
|
48 |
|
|
|
49 |
Definition at line 184 of file lifegrd.c.\hypertarget{lifegrd_8h_627254070e45c23f1776e12c524492ff}{
|
|
|
50 |
\index{lifegrd.h@{lifegrd.h}!getNodeState@{getNodeState}}
|
|
|
51 |
\index{getNodeState@{getNodeState}!lifegrd.h@{lifegrd.h}}
|
|
|
52 |
\subsubsection[getNodeState]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{states_8h_5891f63a4c9243179838389a93d084e2}{e\_\-node\-State} get\-Node\-State (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id})}}
|
|
|
53 |
\label{lifegrd_8h_627254070e45c23f1776e12c524492ff}
|
|
|
54 |
|
|
|
55 |
|
|
|
56 |
To read the state of a node This can be used by the master after having sent a life guard request, of by any node if it is waiting for heartbeat.
|
|
|
57 |
|
|
|
58 |
Definition at line 33 of file lifegrd.c.
|
|
|
59 |
|
|
|
60 |
References struct\_\-s\_\-timer\_\-entry::d, and struct\_\-CO\_\-Data::NMTable.\hypertarget{lifegrd_8h_8896f6846e4d020390f6953f3d98aa21}{
|
|
|
61 |
\index{lifegrd.h@{lifegrd.h}!heartbeatInit@{heartbeatInit}}
|
|
|
62 |
\index{heartbeatInit@{heartbeatInit}!lifegrd.h@{lifegrd.h}}
|
|
|
63 |
\subsubsection[heartbeatInit]{\setlength{\rightskip}{0pt plus 5cm}void heartbeat\-Init (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
|
|
|
64 |
\label{lifegrd_8h_8896f6846e4d020390f6953f3d98aa21}
|
|
|
65 |
|
|
|
66 |
|
|
|
67 |
Start heartbeat consumer and producer with respect to 0x1016 and 0x1017 object dictionary entries
|
|
|
68 |
|
|
|
69 |
Definition at line 147 of file lifegrd.c.
|
|
|
70 |
|
|
|
71 |
References Consumer\-Hearbeat\-Alarm(), struct\_\-CO\_\-Data::Consumer\-Heartbeat\-Count, struct\_\-CO\_\-Data::Consumer\-Heartbeat\-Entries, struct\_\-CO\_\-Data::Consumer\-Heart\-Beat\-Timers, struct\_\-s\_\-timer\_\-entry::d, MS\_\-TO\_\-TIMEVAL, On\-Heartbeat\-Producer\-Update(), Producer\-Hearbeat\-Alarm(), struct\_\-CO\_\-Data::Producer\-Heart\-Beat\-Time, struct\_\-CO\_\-Data::Producer\-Heart\-Beat\-Timer, Register\-Set\-ODentry\-Call\-Back(), Set\-Alarm(), TIMEVAL, struct\_\-CO\_\-Data::toggle, UNS16, UNS32, and UNS8.\hypertarget{lifegrd_8h_1b73047269c2a02065e12af18c6053c7}{
|
|
|
72 |
\index{lifegrd.h@{lifegrd.h}!heartbeatStop@{heartbeatStop}}
|
|
|
73 |
\index{heartbeatStop@{heartbeatStop}!lifegrd.h@{lifegrd.h}}
|
|
|
74 |
\subsubsection[heartbeatStop]{\setlength{\rightskip}{0pt plus 5cm}void heartbeat\-Stop (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
|
|
|
75 |
\label{lifegrd_8h_1b73047269c2a02065e12af18c6053c7}
|
|
|
76 |
|
|
|
77 |
|
|
|
78 |
Stop heartbeat consumer and producer
|
|
|
79 |
|
|
|
80 |
Definition at line 173 of file lifegrd.c.
|
|
|
81 |
|
|
|
82 |
References struct\_\-CO\_\-Data::Consumer\-Heartbeat\-Count, struct\_\-CO\_\-Data::Consumer\-Heart\-Beat\-Timers, struct\_\-s\_\-timer\_\-entry::d, Del\-Alarm(), struct\_\-CO\_\-Data::Producer\-Heart\-Beat\-Timer, and UNS8.\hypertarget{lifegrd_8h_b3248945e06e8b05518beddf665f174d}{
|
|
|
83 |
\index{lifegrd.h@{lifegrd.h}!proceedNODE_GUARD@{proceedNODE\_\-GUARD}}
|
|
|
84 |
\index{proceedNODE_GUARD@{proceedNODE\_\-GUARD}!lifegrd.h@{lifegrd.h}}
|
|
|
85 |
\subsubsection[proceedNODE\_\-GUARD]{\setlength{\rightskip}{0pt plus 5cm}void proceed\-NODE\_\-GUARD (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
|
|
|
86 |
\label{lifegrd_8h_b3248945e06e8b05518beddf665f174d}
|
|
|
87 |
|
|
|
88 |
|
|
|
89 |
This function is responsible to process a canopen-message which seams to be an NMT Error Control Messages. At them moment we assume that every NMT error control message is a heartbeat message. \begin{Desc}
|
|
|
90 |
\item[Parameters:]
|
|
|
91 |
\begin{description}
|
|
|
92 |
\item[{\em \hyperlink{structMessage}{Message}}]The CAN-message which has to be analysed. If a Boot\-Up message is detected, it will return the node\-Id of the Slave who booted up \end{description}
|
|
|
93 |
\end{Desc}
|
|
|
94 |
|
|
|
95 |
|
|
|
96 |
Definition at line 50 of file lifegrd.c.
|
|
|
97 |
|
|
|
98 |
References struct\_\-CO\_\-Data::b\-Device\-Node\-Id, struct\_\-CO\_\-Data::can\-Handle, can\-Send(), Message::cob\_\-id, Consumer\-Hearbeat\-Alarm(), struct\_\-CO\_\-Data::Consumer\-Heartbeat\-Count, struct\_\-CO\_\-Data::Consumer\-Heartbeat\-Entries, struct\_\-CO\_\-Data::Consumer\-Heart\-Beat\-Timers, struct\_\-s\_\-timer\_\-entry::d, Message::data, Del\-Alarm(), GET\_\-NODE\_\-ID, Initialisation, Message::len, MS\_\-TO\_\-TIMEVAL, MSG\_\-WAR, struct\_\-CO\_\-Data::NMTable, struct\_\-CO\_\-Data::node\-State, Message::rtr, Set\-Alarm(), TIMEVAL, struct\_\-CO\_\-Data::toggle, Unknown\_\-state, UNS32, UNS8, and SHORT\_\-CAN::w. |