doc/doxygen/latex/TestMasterMicroMod_8c.tex
author nico
Tue, 05 Jun 2007 18:43:21 +0200
changeset 210 6b5a4c21e061
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\section{examples/Test\-Master\-Micro\-Mod/Test\-Master\-Micro\-Mod.c File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\label{TestMasterMicroMod_8c}\index{examples/TestMasterMicroMod/TestMasterMicroMod.c@{examples/TestMasterMicroMod/TestMasterMicroMod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
{\tt \#include $<$unistd.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
{\tt \#include $<$stdio.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include $<$string.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include $<$stdlib.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
{\tt \#include $<$signal.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
{\tt \#include \char`\"{}canfestival.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
{\tt \#include \char`\"{}Test\-Master\-Micro\-Mod.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
{\tt \#include \char`\"{}Test\-Master.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
void {\bf Test\-Master\_\-heartbeat\-Error} (UNS8 heartbeat\-ID)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
void {\bf Test\-Master\_\-initialisation} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
static void {\bf Configure\-Slave\-Node} ({\bf CO\_\-Data} $\ast$d, UNS8 node\-Id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
static void {\bf Check\-SDOAnd\-Continue} ({\bf CO\_\-Data} $\ast$d, UNS8 node\-Id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
void {\bf Test\-Master\_\-pre\-Operational} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
void {\bf Test\-Master\_\-operational} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
void {\bf Test\-Master\_\-stopped} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
void {\bf Test\-Master\_\-post\_\-sync} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
void {\bf Test\-Master\_\-post\_\-TPDO} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
void {\bf catch\_\-signal} (int sig)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
void {\bf help} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
void {\bf Init\-Nodes} ({\bf CO\_\-Data} $\ast$d, UNS32 id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
int {\bf main} (int argc, char $\ast$$\ast$argv)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
\subsection*{Variables}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
UNS8 {\bf slavenodeid}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
static {\bf init\_\-step} = 0
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
{\bf s\_\-BOARD} {\bf Master\-Board} = \{\char`\"{}32\char`\"{}, \char`\"{}125K\char`\"{}\}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!catch_signal@{catch\_\-signal}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
\index{catch_signal@{catch\_\-signal}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void catch\_\-signal (int {\em sig})}\label{TestMasterMicroMod_8c_f2dc378d0481adcc49b61efb98493a9b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!CheckSDOAndContinue@{CheckSDOAndContinue}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
\index{CheckSDOAndContinue@{CheckSDOAndContinue}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static void Check\-SDOAnd\-Continue ({\bf CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id})\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_8c_030d780d48bec13bd56374f0c4be26b6}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!ConfigureSlaveNode@{ConfigureSlaveNode}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
\index{ConfigureSlaveNode@{ConfigureSlaveNode}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static void Configure\-Slave\-Node ({\bf CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id})\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_8c_89903ebdfe78bc9cc97e0d142da9b820}
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
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!help@{help}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
\index{help@{help}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void help ()}\label{TestMasterMicroMod_8c_97ee70a8770dc30d06c744b24eb2fcfc}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!InitNodes@{InitNodes}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
\index{InitNodes@{InitNodes}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Init\-Nodes ({\bf CO\_\-Data} $\ast$ {\em d}, UNS32 {\em id})}\label{TestMasterMicroMod_8c_8a51032f7610fe37c131376e5a392fd5}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!main@{main}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\index{main@{main}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int main (int {\em argc}, char $\ast$$\ast$ {\em argv})}\label{TestMasterMicroMod_8c_3c04138a5bfe5d72780bb7e82a18e627}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!TestMaster_heartbeatError@{TestMaster\_\-heartbeatError}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
\index{TestMaster_heartbeatError@{TestMaster\_\-heartbeatError}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Test\-Master\_\-heartbeat\-Error (UNS8 {\em heartbeat\-ID})}\label{TestMasterMicroMod_8c_47eb45e75b4db150fb465fcf171ef4b4}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!TestMaster_initialisation@{TestMaster\_\-initialisation}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\index{TestMaster_initialisation@{TestMaster\_\-initialisation}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Test\-Master\_\-initialisation (void)}\label{TestMasterMicroMod_8c_e08dfb379eebaa62524fac5bba2196d5}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!TestMaster_operational@{TestMaster\_\-operational}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
\index{TestMaster_operational@{TestMaster\_\-operational}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Test\-Master\_\-operational (void)}\label{TestMasterMicroMod_8c_81c297f2b4b9676e906286bf46541fc1}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!TestMaster_post_sync@{TestMaster\_\-post\_\-sync}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
\index{TestMaster_post_sync@{TestMaster\_\-post\_\-sync}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Test\-Master\_\-post\_\-sync (void)}\label{TestMasterMicroMod_8c_9a8f72cab7f649481ca84ab2222dd179}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!TestMaster_post_TPDO@{TestMaster\_\-post\_\-TPDO}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
\index{TestMaster_post_TPDO@{TestMaster\_\-post\_\-TPDO}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Test\-Master\_\-post\_\-TPDO (void)}\label{TestMasterMicroMod_8c_5e466aa03eae00c269cf20359a7ee074}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!TestMaster_preOperational@{TestMaster\_\-preOperational}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
\index{TestMaster_preOperational@{TestMaster\_\-preOperational}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Test\-Master\_\-pre\-Operational (void)}\label{TestMasterMicroMod_8c_8fe2bae5bb407a3a71ee5fa5ea5d617f}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!TestMaster_stopped@{TestMaster\_\-stopped}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
\index{TestMaster_stopped@{TestMaster\_\-stopped}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Test\-Master\_\-stopped (void)}\label{TestMasterMicroMod_8c_897d573cafc13ac80abbc207c0ee41b0}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
\subsection{Variable Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!init_step@{init\_\-step}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
\index{init_step@{init\_\-step}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf init\_\-step} = 0\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_8c_ef9c66a2e9f5ef9f6475282320a1ebe9}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   125
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!MasterBoard@{MasterBoard}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   126
\index{MasterBoard@{MasterBoard}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   127
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf s\_\-BOARD} {\bf Master\-Board} = \{\char`\"{}32\char`\"{}, \char`\"{}125K\char`\"{}\}}\label{TestMasterMicroMod_8c_460b5e3b15bb47df23119998ea0fbd31}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   128
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   129
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   130
\index{TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}!slavenodeid@{slavenodeid}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   131
\index{slavenodeid@{slavenodeid}!TestMasterMicroMod.c@{Test\-Master\-Micro\-Mod.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   132
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}UNS8 {\bf slavenodeid}}\label{TestMasterMicroMod_8c_65effe41fa5288e7ab03a431d0c42b31}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   133
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   134