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