documentation/ethercat_doc.tex
changeset 487 448b0b23b905
parent 379 7db3d4f573fa
child 813 bfc3f1ab52de
equal deleted inserted replaced
486:7313ed820882 487:448b0b23b905
    39   {\includegraphics[height=2.2ex]{images/ighsign}}}
    39   {\includegraphics[height=2.2ex]{images/ighsign}}}
    40 
    40 
    41 \SVN $Date$
    41 \SVN $Date$
    42 \SVN $Revision$
    42 \SVN $Revision$
    43 
    43 
       
    44 \newcommand{\masterversion}{1.1.1}
       
    45 
    44 \makeindex
    46 \makeindex
    45 \makeglossary
    47 \makeglossary
    46 
    48 
    47 %------------------------------------------------------------------------------
    49 %------------------------------------------------------------------------------
    48 
    50 
    54 \begin{titlepage}
    56 \begin{titlepage}
    55   \begin{center}
    57   \begin{center}
    56     \rule{\textwidth}{1.5mm}
    58     \rule{\textwidth}{1.5mm}
    57 
    59 
    58     {\Huge\bf IgH \includegraphics[height=2.4ex]{images/ethercat}
    60     {\Huge\bf IgH \includegraphics[height=2.4ex]{images/ethercat}
    59       Master 1.1\\[1ex]
    61       Master \masterversion\\[1ex]
    60       Documentation}
    62       Documentation}
    61 
    63 
    62     \vspace{1ex}
    64     \vspace{1ex}
    63     \rule{\textwidth}{1.5mm}
    65     \rule{\textwidth}{1.5mm}
    64 
    66 
  1288 
  1290 
  1289 \paragraph{Master Log Messages}
  1291 \paragraph{Master Log Messages}
  1290 
  1292 
  1291 The master module gives information about it's state and events via
  1293 The master module gives information about it's state and events via
  1292 the syslog interface. The module loading command above should result
  1294 the syslog interface. The module loading command above should result
  1293 in the following syslog messages:
  1295 in the syslog messages below (or similar):
  1294 
  1296 
  1295 \begin{lstlisting}
  1297 \begin{lstlisting}
  1296   EtherCAT: Master driver, 1.1 (stable) - rev. 513,
  1298   EtherCAT: Master driver, 1.1 (stable) - rev. 513,
  1297             compiled by fp at Aug  09 2006 09:43:50
  1299             compiled by fp at Aug  09 2006 09:43:50
  1298   EtherCAT: Initializing 2 EtherCAT master(s)...
  1300   EtherCAT: Initializing 2 EtherCAT master(s)...
  4297 \label{sec:make}
  4299 \label{sec:make}
  4298 \index{Master!Compilation}
  4300 \index{Master!Compilation}
  4299 
  4301 
  4300 The current EtherCAT master code is available at~\cite{etherlab} or
  4302 The current EtherCAT master code is available at~\cite{etherlab} or
  4301 can be obtained from the EtherLab\textsuperscript{\textregistered} CD.
  4303 can be obtained from the EtherLab\textsuperscript{\textregistered} CD.
  4302 The \textit{tar.bz2} file has to be unpacked with the command below
  4304 The \textit{tar.bz2} file has to be unpacked with the commands below
  4303 (or similar):
  4305 (or similar):
  4304 
  4306 
  4305 \begin{lstlisting}
  4307 \begin{lstlisting}
  4306   `\$` `\textbf{tar xjf ethercat-1.1-rXXX.tar.bz2}`
  4308   `\$` `\textbf{tar xjf ethercat-\masterversion.tar.bz2}`
  4307   `\$` `\textbf{cd ethercat-1.1-rXXX/}`
  4309   `\$` `\textbf{cd ethercat-\masterversion/}`
  4308 \end{lstlisting}
  4310 \end{lstlisting}
  4309 
  4311 
  4310 The tarball was created with GNU Autotools, so the build process
  4312 The tarball was created with GNU Autotools, so the build process
  4311 follows the usual commands:
  4313 follows the below commands:
  4312 
  4314 
  4313 \begin{lstlisting}
  4315 \begin{lstlisting}
  4314   `\$` `\textbf{./configure}`
  4316   `\$` `\textbf{./configure}`
  4315   `\$` `\textbf{make}`
  4317   `\$` `\textbf{make modules}`
  4316 \end{lstlisting}
  4318 \end{lstlisting}
  4317 
  4319 
  4318 The default installation prefix is \textit{/opt/etherlab}. It can be
  4320 The default installation prefix is \textit{/opt/etherlab}. It can be
  4319 changed with the \texttt{--prefix} argument.
  4321 changed with the \texttt{--prefix} argument.
  4320 
  4322 
  4325 kernel version can be specified with the \texttt{--with-linux}
  4327 kernel version can be specified with the \texttt{--with-linux}
  4326 argument. Example:
  4328 argument. Example:
  4327 
  4329 
  4328 \begin{lstlisting}
  4330 \begin{lstlisting}
  4329   `\$` `\textbf{./configure --with-linux="2.6.17-ipipe"}`
  4331   `\$` `\textbf{./configure --with-linux="2.6.17-ipipe"}`
  4330   `\$` `\textbf{make}`
  4332   `\$` `\textbf{make modules}`
  4331 \end{lstlisting}
  4333 \end{lstlisting}
  4332 
  4334 
  4333 The following commands have to be entered as \textit{root}: To install
  4335 The below commands have to be entered as \textit{root}: The first one
  4334 the kernel modules, headers, the init script, the sysconfig file and
  4336 will install the kernel modules to the kernel's modules directory. The
  4335 the user space tools, the below command has to be executed:
  4337 second one will install EtherCAT headers, the init script, the
       
  4338 sysconfig file and the user space tools to the prefix path.
  4336 
  4339 
  4337 \begin{lstlisting}
  4340 \begin{lstlisting}
       
  4341   # `\textbf{make modules\_install}`
  4338   # `\textbf{make install}`
  4342   # `\textbf{make install}`
  4339 \end{lstlisting}
  4343 \end{lstlisting}
       
  4344 
       
  4345 If the target kernel's modules directory is not under
       
  4346 \textit{/lib/modules}, a different destination directory can be
       
  4347 specified with the \textit{DESTDIR} make variable. For example:
       
  4348 
       
  4349 \begin{lstlisting}
       
  4350   # `\textbf{make DESTDIR=/vol/nfs/root modules\_install}`
       
  4351 \end{lstlisting}
       
  4352 
       
  4353 This command will install the compiled kernel modules to
       
  4354 \textit{/vol/nfs/root/lib/modules}, prepended by the kernel release.
  4340 
  4355 
  4341 If the EtherCAT master shall be run as a service
  4356 If the EtherCAT master shall be run as a service
  4342 (recommended\footnote{Even if the EtherCAT master shall not be loaded
  4357 (recommended\footnote{Even if the EtherCAT master shall not be loaded
  4343   on system startup, the use of the init script is recommended for
  4358   on system startup, the use of the init script is recommended for
  4344   manual (un-)loading.}), the init script and the sysconfig file have
  4359   manual (un-)loading.}), the init script and the sysconfig file have