Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
E
etherlabmaster
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Jira
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ICS Control System Infrastructure
etherlabmaster
Commits
ae34bf91
Commit
ae34bf91
authored
18 years ago
by
Florian Pose
Browse files
Options
Downloads
Patches
Plain Diff
Updated documentation.
parent
b7a6a8a6
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
Doxyfile
+1
-1
1 addition, 1 deletion
Doxyfile
INSTALL
+9
-5
9 additions, 5 deletions
INSTALL
documentation/ethercat_doc.tex
+26
-11
26 additions, 11 deletions
documentation/ethercat_doc.tex
with
36 additions
and
17 deletions
Doxyfile
+
1
−
1
View file @
ae34bf91
...
@@ -23,7 +23,7 @@ PROJECT_NAME = "IgH EtherCAT master"
...
@@ -23,7 +23,7 @@ PROJECT_NAME = "IgH EtherCAT master"
# This could be handy for archiving the generated documentation or
# This could be handy for archiving the generated documentation or
# if some version control system is used.
# if some version control system is used.
PROJECT_NUMBER = 1.1
PROJECT_NUMBER = 1.1
.1
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# base path where the generated documentation will be put.
...
...
This diff is collapsed.
Click to expand it.
INSTALL
+
9
−
5
View file @
ae34bf91
...
@@ -12,7 +12,7 @@ Building and installing
...
@@ -12,7 +12,7 @@ Building and installing
The building and installation procedure is described in section 2.1 in the
The building and installation procedure is described in section 2.1 in the
EtherCAT master documentation:
EtherCAT master documentation:
documentation/ethercat-doc.pdf
documentation/ethercat-doc.pdf
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
...
@@ -20,11 +20,15 @@ For the impatient:
...
@@ -20,11 +20,15 @@ For the impatient:
The procedure mainly consists of calling
The procedure mainly consists of calling
./configure
$ ./configure
make
$ make modules
make install
...and copying the init script and sysconfig files from $prefix/etc to the
(and as root)
# make modules_install
# make install
...and copying the init script and sysconfig file from $prefix/etc to the
appropriate locations and customizing the sysconfig file.
appropriate locations and customizing the sysconfig file.
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
This diff is collapsed.
Click to expand it.
documentation/ethercat_doc.tex
+
26
−
11
View file @
ae34bf91
...
@@ -41,6 +41,8 @@
...
@@ -41,6 +41,8 @@
\SVN
$
Date
$
\SVN
$
Date
$
\SVN
$
Revision
$
\SVN
$
Revision
$
\newcommand
{
\masterversion
}{
1.1.1
}
\makeindex
\makeindex
\makeglossary
\makeglossary
...
@@ -56,7 +58,7 @@
...
@@ -56,7 +58,7 @@
\rule
{
\textwidth
}{
1.5mm
}
\rule
{
\textwidth
}{
1.5mm
}
{
\Huge\bf
IgH
\includegraphics
[height=2.4ex]
{
images/ethercat
}
{
\Huge\bf
IgH
\includegraphics
[height=2.4ex]
{
images/ethercat
}
Master
1.1
\\
[1ex]
Master
\masterversion
\\
[1ex]
Documentation
}
Documentation
}
\vspace
{
1ex
}
\vspace
{
1ex
}
...
@@ -1290,7 +1292,7 @@ certain functions of the master interfaces.
...
@@ -1290,7 +1292,7 @@ certain functions of the master interfaces.
The master module gives information about it's state and events via
The master module gives information about it's state and events via
the syslog interface. The module loading command above should result
the syslog interface. The module loading command above should result
in the
following
syslog messages:
in the syslog messages
below (or similar)
:
\begin{lstlisting}
\begin{lstlisting}
EtherCAT: Master driver, 1.1 (stable) - rev. 513,
EtherCAT: Master driver, 1.1 (stable) - rev. 513,
...
@@ -4299,20 +4301,20 @@ examples for different realtime modules.
...
@@ -4299,20 +4301,20 @@ examples for different realtime modules.
The current EtherCAT master code is available at~
\cite
{
etherlab
}
or
The current EtherCAT master code is available at~
\cite
{
etherlab
}
or
can be obtained from the EtherLab
\textsuperscript
{
\textregistered
}
CD.
can be obtained from the EtherLab
\textsuperscript
{
\textregistered
}
CD.
The
\textit
{
tar.bz2
}
file has to be unpacked with the command below
The
\textit
{
tar.bz2
}
file has to be unpacked with the command
s
below
(or similar):
(or similar):
\begin{lstlisting}
\begin{lstlisting}
`
\$
` `
\textbf
{
tar xjf ethercat-
1.1-rXXX
.tar.bz2
}
`
`
\$
` `
\textbf
{
tar xjf ethercat-
\masterversion
.tar.bz2
}
`
`
\$
` `
\textbf
{
cd ethercat-
1.1-rXXX
/
}
`
`
\$
` `
\textbf
{
cd ethercat-
\masterversion
/
}
`
\end{lstlisting}
\end{lstlisting}
The tarball was created with GNU Autotools, so the build process
The tarball was created with GNU Autotools, so the build process
follows the
usual
commands:
follows the
below
commands:
\begin{lstlisting}
\begin{lstlisting}
`
\$
` `
\textbf
{
./configure
}
`
`
\$
` `
\textbf
{
./configure
}
`
`
\$
` `
\textbf
{
make
}
`
`
\$
` `
\textbf
{
make
modules
}
`
\end{lstlisting}
\end{lstlisting}
The default installation prefix is
\textit
{
/opt/etherlab
}
. It can be
The default installation prefix is
\textit
{
/opt/etherlab
}
. It can be
...
@@ -4327,17 +4329,30 @@ argument. Example:
...
@@ -4327,17 +4329,30 @@ argument. Example:
\begin{lstlisting}
\begin{lstlisting}
`
\$
` `
\textbf
{
./configure --with-linux="2.6.17-ipipe"
}
`
`
\$
` `
\textbf
{
./configure --with-linux="2.6.17-ipipe"
}
`
`
\$
` `
\textbf
{
make
}
`
`
\$
` `
\textbf
{
make
modules
}
`
\end{lstlisting}
\end{lstlisting}
The following commands have to be entered as
\textit
{
root
}
: To install
The below commands have to be entered as
\textit
{
root
}
: The first one
the kernel modules, headers, the init script, the sysconfig file and
will install the kernel modules to the kernel's modules directory. The
the user space tools, the below command has to be executed:
second one will install EtherCAT headers, the init script, the
sysconfig file and the user space tools to the prefix path.
\begin{lstlisting}
\begin{lstlisting}
# `
\textbf
{
make modules
\_
install
}
`
# `
\textbf
{
make install
}
`
# `
\textbf
{
make install
}
`
\end{lstlisting}
\end{lstlisting}
If the target kernel's modules directory is not under
\textit
{
/lib/modules
}
, a different destination directory can be
specified with the
\textit
{
DESTDIR
}
make variable. For example:
\begin{lstlisting}
# `
\textbf
{
make DESTDIR=/vol/nfs/root modules
\_
install
}
`
\end{lstlisting}
This command will install the compiled kernel modules to
\textit
{
/vol/nfs/root/lib/modules
}
, prepended by the kernel release.
If the EtherCAT master shall be run as a service
If the EtherCAT master shall be run as a service
(recommended
\footnote
{
Even if the EtherCAT master shall not be loaded
(recommended
\footnote
{
Even if the EtherCAT master shall not be loaded
on system startup, the use of the init script is recommended for
on system startup, the use of the init script is recommended for
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment