INSTALL
author Edouard Tisserant <edouard.tisserant@gmail.com>
Mon, 01 Oct 2018 22:05:31 +0200
branchstable-1.5
changeset 2718 137cdf41bcec
parent 1883 57b500c062fe
permissions -rw-r--r--
Cosmetic change : rtdm_in_rt_context instead of ipipe_root_p.
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
1331
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1214
diff changeset
     7
vim: set spelllang=en spell tw=78
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1214
diff changeset
     8
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     9
-------------------------------------------------------------------------------
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
Building and installing
355
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    12
=======================
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    13
1331
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1214
diff changeset
    14
The complete build and installation procedure is described in the respective
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1214
diff changeset
    15
section of the documentation available from http://etherlab.org/en/ethercat.
355
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    16
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    17
-------------------------------------------------------------------------------
380
971d079ff771 Updated INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 355
diff changeset
    18
785
c7e600cd2812 Updated README etc.
Florian Pose <fp@igh-essen.com>
parents: 560
diff changeset
    19
For the impatient: The procedure mainly consists of calling
380
971d079ff771 Updated INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 355
diff changeset
    20
1883
57b500c062fe Added bootstrap call to INSTALL.
Florian Pose <fp@igh-essen.com>
parents: 1331
diff changeset
    21
$ ./boostrap # to create the configure script, if downloaded from the repo
57b500c062fe Added bootstrap call to INSTALL.
Florian Pose <fp@igh-essen.com>
parents: 1331
diff changeset
    22
487
448b0b23b905 Updated documentation.
Florian Pose <fp@igh-essen.com>
parents: 380
diff changeset
    23
$ ./configure
1331
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1214
diff changeset
    24
$ make all modules
380
971d079ff771 Updated INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 355
diff changeset
    25
1331
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1214
diff changeset
    26
... and as root:
487
448b0b23b905 Updated documentation.
Florian Pose <fp@igh-essen.com>
parents: 380
diff changeset
    27
1331
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1214
diff changeset
    28
# make modules_install install
1106
745a0cc03143 Added depmod call to docs.
Florian Pose <fp@igh-essen.com>
parents: 1081
diff changeset
    29
# depmod
487
448b0b23b905 Updated documentation.
Florian Pose <fp@igh-essen.com>
parents: 380
diff changeset
    30
1331
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1214
diff changeset
    31
... and linking the init script and copying the sysconfig file from $PREFIX/etc
1017
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    32
to the appropriate locations and customizing the sysconfig file.
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    33
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    34
# ln -s ${PREFIX}/etc/init.d/ethercat /etc/init.d/ethercat
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    35
# cp ${PREFIX}/etc/sysconfig/ethercat /etc/sysconfig/ethercat
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    36
# vi /etc/sysconfig/ethercat
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    37
1214
63802a52dd69 udev docs.
Florian Pose <fp@igh-essen.com>
parents: 1106
diff changeset
    38
Make sure, that the 'udev' package is installed, to automatically create the
63802a52dd69 udev docs.
Florian Pose <fp@igh-essen.com>
parents: 1106
diff changeset
    39
EtherCAT character devices. The character devices will be created with mode
63802a52dd69 udev docs.
Florian Pose <fp@igh-essen.com>
parents: 1106
diff changeset
    40
0660 and group root by default. If you want to give normal users reading
63802a52dd69 udev docs.
Florian Pose <fp@igh-essen.com>
parents: 1106
diff changeset
    41
access, create a udev rule like this:
1017
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    42
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    43
# echo KERNEL==\"EtherCAT[0-9]*\", MODE=\"0664\" > /etc/udev/rules.d/99-EtherCAT.rules
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    44
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    45
Now you can start the EtherCAT master:
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    46
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    47
# /etc/init.d/ethercat start
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    48
1081
66c60b99c2e8 Minor change.
Florian Pose <fp@igh-essen.com>
parents: 1017
diff changeset
    49
Have a look at the examples/ subdirectory for some application examples.
66c60b99c2e8 Minor change.
Florian Pose <fp@igh-essen.com>
parents: 1017
diff changeset
    50
1017
b9224ef0546c Updated install script; udev rule.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    51
Have fun!
380
971d079ff771 Updated INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 355
diff changeset
    52
971d079ff771 Updated INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 355
diff changeset
    53
-------------------------------------------------------------------------------