IgH EtherCAT Master for Linux
Go to file
Florian Pose 56778ee323 prepared command-line tool. 2008-07-04 09:48:42 +00:00
devices Added Kbuild files to BUILT_SOURCES in Makefile.am files to create dependencies. 2008-06-30 15:51:46 +00:00
documentation prepared command-line tool. 2008-07-04 09:48:42 +00:00
examples Renamed ecrt_slave_config_sync_managers() to ecrt_slave_config_pdos(); 2008-07-02 14:06:10 +00:00
include Updated header docs, features and news file. 2008-07-02 14:28:30 +00:00
master Renamed ecrt_slave_config_sync_managers() to ecrt_slave_config_pdos(); 2008-07-02 14:06:10 +00:00
script Remove manual creation of device nodes, this is done by udev. 2008-06-17 13:27:28 +00:00
tools Renamed ecrt_slave_config_sync_managers() to ecrt_slave_config_pdos(); 2008-07-02 14:06:10 +00:00
AUTHORS Updated AUTHORS file. 2007-02-13 13:00:19 +00:00
COPYING Removed --foreign switch for autotools. 2006-11-06 09:43:36 +00:00
Doxyfile.in Updated doxygen docs. 2008-02-01 22:01:59 +00:00
FEATURES Updated header docs, features and news file. 2008-07-02 14:28:30 +00:00
INSTALL Minor change. 2008-07-02 12:19:25 +00:00
Kbuild.in Removed dummy master. 2008-04-03 15:31:34 +00:00
Makefile.am Added Kbuild files to BUILT_SOURCES in Makefile.am files to create dependencies. 2008-06-30 15:51:46 +00:00
NEWS NEWS. 2008-07-02 14:41:29 +00:00
README Added link to hardware table. 2008-02-04 13:50:20 +00:00
README.EoE Updated README etc. 2008-02-01 21:34:35 +00:00
TODO Renamed ecrt_slave_config_sync_managers() to ecrt_slave_config_pdos(); 2008-07-02 14:06:10 +00:00
bootstrap Auto-generate ChangeLog with mydist target. 2007-02-09 11:48:35 +00:00
configure.ac Removed MSR example; adapted RTAI example; README files for examples. 2008-07-02 12:16:48 +00:00
globals.h Equalized defines against duplicated header inclusion. 2008-04-03 15:49:24 +00:00

README

-------------------------------------------------------------------------------

This is the README file of the IgH EtherCAT Master.

$Id$

Contents:
1) General Information
2) Requirements
3) Building and installing
4) Realtime & Tuning
5) License

-------------------------------------------------------------------------------

1) General Information
======================

This is an open-source EtherCAT master implementation for Linux 2.6.

See the FEATURES file for a list of features. For more information, see
http://etherlab.org/en/ethercat.

or contact

Dipl.-Ing. (FH) Florian Pose <fp@igh-essen.com>
Ingenieurgemeinschaft IgH
Heinz-Baecker-Str. 34
D-45356 Essen
http://igh-essen.com

-------------------------------------------------------------------------------

2) Requirements
===============

1) Software requirements

Configured sources for the Linux 2.6 kernel are required to build the EtherCAT
master.

2) Hardware requirements

A table of supported hardware can be found at
http://etherlab.org/en/ethercat/hardware.php.

-------------------------------------------------------------------------------

3) Building and installing
==========================

See the INSTALL file.

-------------------------------------------------------------------------------

4) Realtime & Tuning
====================

Realtime patches for the Linux kernel are supported, but not required. The
realtime processing has to be done by the calling module (see API
documentation). The EtherCAT master code itself is passive (except for the idle
mode and EoE).

To avoid frame timeouts, deactivating DMA access for hard drives is
recommented (hdparm -d0 <DEV>).

-------------------------------------------------------------------------------

5) License
==========

Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

This file is part of the IgH EtherCAT Master.

The IgH EtherCAT Master is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.

The IgH EtherCAT Master is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with the IgH EtherCAT Master; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

The right to use EtherCAT Technology is granted and comes free of
charge under condition of compatibility of product made by
Licensee. People intending to distribute/sell products based on the
code, have to sign an agreement to guarantee that products using
software based on IgH EtherCAT master stay compatible with the actual
EtherCAT specification (which are released themselves as an open
standard) as the (only) precondition to have the right to use EtherCAT
Technology, IP and trade marks.

-------------------------------------------------------------------------------