From 59d147ccf3c606830fff3b17926c3ee690ebf569 Mon Sep 17 00:00:00 2001 From: Florian Pose Date: Wed, 29 Apr 2009 13:15:56 +0000 Subject: [PATCH] Updated command doc. --- documentation/Makefile | 12 +++-- documentation/ethercat_doc.tex | 80 +++++++++++++++++++++++----------- 2 files changed, 63 insertions(+), 29 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index de5f4cf1..5c19210b 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -16,15 +16,21 @@ COMMANDS := \ data \ debug \ domains \ + download \ + foe_read \ + foe_write \ + graph \ master \ pdos \ + reg_read \ + reg_write \ sdos \ - download \ - upload \ - slaves \ sii_read \ sii_write \ + slaves \ states \ + upload \ + version \ xml EXT_PREFIX := external/ethercat_ diff --git a/documentation/ethercat_doc.tex b/documentation/ethercat_doc.tex index 8ef9a129..cb4fab99 100644 --- a/documentation/ethercat_doc.tex +++ b/documentation/ethercat_doc.tex @@ -2107,6 +2107,28 @@ sec.~\ref{sec:autonode} for how to install and configure it. %------------------------------------------------------------------------------ +\subsection{SDO Access} + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_download} + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_upload} + +%------------------------------------------------------------------------------ + +\subsection{File-Access over EtherCAT} + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_foe_read} + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_foe_write} + +%------------------------------------------------------------------------------ + +\subsection{Creating Topology Graphs} + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_graph} + +%------------------------------------------------------------------------------ + \subsection{Master and Ethernet Devices} \lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_master} @@ -2119,38 +2141,20 @@ sec.~\ref{sec:autonode} for how to install and configure it. %------------------------------------------------------------------------------ +\subsection{Register Access} + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_reg_read} + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_reg_write} + +%------------------------------------------------------------------------------ + \subsection{SDO Dictionary} \lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_sdos} %------------------------------------------------------------------------------ -\subsection{SDO Access} - -\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_download} - -\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_upload} - -%------------------------------------------------------------------------------ - -\subsection{Slaves on the Bus} - -Slave information can be gathered with the subcommand \lstinline+slaves+: - -\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_slaves} - -Below is a typical output: - -\begin{lstlisting} -$ `\textbf{ethercat slaves}` -0 0:0 PREOP + EK1100 Ethernet Kopplerklemme (2A E-Bus) -1 5555:0 PREOP + EL3162 2K. Ana. Eingang 0-10V -2 5555:1 PREOP + EL4102 2K. Ana. Ausgang 0-10V -3 5555:2 PREOP + EL2004 4K. Dig. Ausgang 24V, 0,5A -\end{lstlisting} - -%------------------------------------------------------------------------------ - \subsection{SII Access} \label{sec:siiaccess} \index{SII!Access} @@ -2205,12 +2209,36 @@ write operation may take a few seconds. %------------------------------------------------------------------------------ +\subsection{Slaves on the Bus} + +Slave information can be gathered with the subcommand \lstinline+slaves+: + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_slaves} + +Below is a typical output: + +\begin{lstlisting} +$ `\textbf{ethercat slaves}` +0 0:0 PREOP + EK1100 Ethernet Kopplerklemme (2A E-Bus) +1 5555:0 PREOP + EL3162 2K. Ana. Eingang 0-10V +2 5555:1 PREOP + EL4102 2K. Ana. Ausgang 0-10V +3 5555:2 PREOP + EL2004 4K. Dig. Ausgang 24V, 0,5A +\end{lstlisting} + +%------------------------------------------------------------------------------ + \subsection{Requesting Application-Layer States} \lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_states} %------------------------------------------------------------------------------ +\subsection{Displaying the Master Version} + +\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_version} + +%------------------------------------------------------------------------------ + \subsection{Generating Slave Description XML} \lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_xml}