doc/doxygen/latex/lifegrd_8h.tex
author nico
Thu, 07 Jun 2007 09:03:41 +0200
changeset 213 1df3055de547
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{lifegrd_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/lifegrd.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{lifegrd_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/lifegrd.h@{/home/epimerde/documents/tc11/CanFestival-3/include/lifegrd.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include $<$applicfg.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include \char`\"{}data.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
\subsection*{Typedefs}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
typedef void($\ast$) \hyperlink{lifegrd_8h_eca3959d33fceb33487363a0493d3b7d}{heartbeat\-Error\_\-t} (UNS8)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
void \hyperlink{lifegrd_8h_5249eb891f5677b80ccf01e604748524}{\_\-heartbeat\-Error} (UNS8 heartbeat\-ID)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
void \hyperlink{lifegrd_8h_8896f6846e4d020390f6953f3d98aa21}{heartbeat\-Init} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
void \hyperlink{lifegrd_8h_1b73047269c2a02065e12af18c6053c7}{heartbeat\-Stop} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
void \hyperlink{lifegrd_8h_b3248945e06e8b05518beddf665f174d}{proceed\-NODE\_\-GUARD} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, \hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
\subsection{Typedef Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
\hypertarget{lifegrd_8h_eca3959d33fceb33487363a0493d3b7d}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\index{lifegrd.h@{lifegrd.h}!heartbeatError_t@{heartbeatError\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\index{heartbeatError_t@{heartbeatError\_\-t}!lifegrd.h@{lifegrd.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\subsubsection[heartbeatError\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{lifegrd_8h_eca3959d33fceb33487363a0493d3b7d}{heartbeat\-Error\_\-t}(UNS8)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\label{lifegrd_8h_eca3959d33fceb33487363a0493d3b7d}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
Definition at line 29 of file lifegrd.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
\hypertarget{lifegrd_8h_5249eb891f5677b80ccf01e604748524}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\index{lifegrd.h@{lifegrd.h}!_heartbeatError@{\_\-heartbeatError}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\index{_heartbeatError@{\_\-heartbeatError}!lifegrd.h@{lifegrd.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
\subsubsection[\_\-heartbeatError]{\setlength{\rightskip}{0pt plus 5cm}void \_\-heartbeat\-Error (UNS8 {\em heartbeat\-ID})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\label{lifegrd_8h_5249eb891f5677b80ccf01e604748524}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
Definition at line 184 of file lifegrd.c.\hypertarget{lifegrd_8h_627254070e45c23f1776e12c524492ff}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
\index{lifegrd.h@{lifegrd.h}!getNodeState@{getNodeState}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
\index{getNodeState@{getNodeState}!lifegrd.h@{lifegrd.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
\label{lifegrd_8h_627254070e45c23f1776e12c524492ff}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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. 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
Definition at line 33 of file lifegrd.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
References struct\_\-s\_\-timer\_\-entry::d, and struct\_\-CO\_\-Data::NMTable.\hypertarget{lifegrd_8h_8896f6846e4d020390f6953f3d98aa21}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
\index{lifegrd.h@{lifegrd.h}!heartbeatInit@{heartbeatInit}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
\index{heartbeatInit@{heartbeatInit}!lifegrd.h@{lifegrd.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
\subsubsection[heartbeatInit]{\setlength{\rightskip}{0pt plus 5cm}void heartbeat\-Init (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
\label{lifegrd_8h_8896f6846e4d020390f6953f3d98aa21}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
Start heartbeat consumer and producer with respect to 0x1016 and 0x1017 object dictionary entries 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
Definition at line 147 of file lifegrd.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
\index{lifegrd.h@{lifegrd.h}!heartbeatStop@{heartbeatStop}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
\index{heartbeatStop@{heartbeatStop}!lifegrd.h@{lifegrd.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
\subsubsection[heartbeatStop]{\setlength{\rightskip}{0pt plus 5cm}void heartbeat\-Stop (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
\label{lifegrd_8h_1b73047269c2a02065e12af18c6053c7}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
Stop heartbeat consumer and producer 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
Definition at line 173 of file lifegrd.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
\index{lifegrd.h@{lifegrd.h}!proceedNODE_GUARD@{proceedNODE\_\-GUARD}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
\index{proceedNODE_GUARD@{proceedNODE\_\-GUARD}!lifegrd.h@{lifegrd.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
\label{lifegrd_8h_b3248945e06e8b05518beddf665f174d}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
\item[Parameters:]
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
\begin{description}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
\end{Desc}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
Definition at line 50 of file lifegrd.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    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.