INSTALL
author Florian Pose <fp@igh-essen.com>
Mon, 24 Apr 2006 10:28:18 +0000
changeset 200 72c969ea6558
parent 198 f7dff1ed01ba
child 355 3a652b240c48
permissions -rw-r--r--
Documentation update + Doxygen generate LaTeX reference manual.
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     1
-------------------------------------------------------------------------------
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     2
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     3
This is the INSTALL file of the IgH EtherCAT Master.
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     4
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     5
$Id$
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     6
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     7
-------------------------------------------------------------------------------
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     8
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     9
Building and installing
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    10
==========================
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    11
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    12
1) Create a copy of the configuration template:
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    13
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    14
  $ cp ethercat.conf.tmpl ethercat.conf
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    15
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    16
2) Adjust the variables in the configuration file to your needs.
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    17
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    18
3) Build the EtherCAT master and network device driver modules:
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    19
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    20
  $ make
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    21
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    22
4) Install the the EtherCAT master (as root):
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    23
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    24
  # make install
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    25
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    26
  This will create the following files and directories:
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    27
    - /etc/sysconfig/ethercat (configuration file)
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    28
    - /etc/init.d/ethercat    (startup script)
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    29
    - /usr/sbin/rcethercat    (link to startup script)
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    30
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    31
  The modules will be placed in /lib/modules/<KERNEL>/kernel/drivers/net
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    32
  (where <KERNEL> is the Linux kernel version configured in ethercat.conf).
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    33
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    34
-------------------------------------------------------------------------------