This is the README file of the IgH EtherCAT Master.

这是 IgH EtherCAT Master 的自述文件。

Contents:

内容：

[[TOC]]

[[目录]]

General Information

基本信息

This is an open-source EtherCAT master implementation for Linux 2.6 or newer. 这是一个适用于Linux 2.6或更高版本的开源EtherCAT主实现。 See the features file for a list of features. For more information, see http://etherlab.org/en/ethercat. 有关功能列表，请参阅功能文件。欲了解更多信息 信息，请参阅 http://etherlab.org/en/ethercat。 or contact 或联系

Dipl.-Ing. (FH) Florian Pose fp@igh.de
Ingenieurgemeinschaft IgH
Nordsternstraße 66
D-45329 Essen
http://igh.de

Documentation

文档

Handbook

手册 The PDF documentation is generated via LaTeX and can be build with the following steps: PDF文档是通过LaTeX生成的，可以使用 以下步骤：

cd documentation
make

The PDF is automatically held up-to-date and can be downloaded from GitLab. PDF 会自动保持最新状态，可从以下位置下载 GitLab。

Doxygen

To generate the Doxygen documentation, the following commands can be used. Therefore, the configure script must have run (see the install file). 要生成 Doxygen 文档，可以使用以下命令。 因此，配置脚本必须已运行（请参阅安装 文件）。

git submodule update --init
make doc

An up-to-date Doxygen output can be found on docs.etherlab.org. 最新的Doxygen输出可以在 docs.etherlab.org 上找到。

Requirements

要求

Software requirements

软件要求 Configured sources for the Linux 2.6 (or newer) kernel are required to build the EtherCAT master. 构建 Linux 2.6（或更高版本）内核需要配置源代码 EtherCAT主站。

Hardware requirements

硬件要求 A table of supported hardware can be found at http://etherlab.org/en/ethercat/hardware.php. 可在 http://etherlab.org/en/ethercat/hardware.php 中找到支持的硬件表。

Building and installing

构建和安装 See the install file. 请参阅安装文件。

Realtime and 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). 支持 Linux 内核的实时补丁，但不是必需的。这 实时处理必须由调用模块完成（请参阅 API 文档）。EtherCAT主代码本身是被动的（除了 空闲模式和 EoE）。 To avoid frame timeouts, deactivating DMA access for hard drives is recommended (hdparm -d0 <DEV>). 为避免帧超时，停用硬盘驱动器的 DMA 访问是 推荐 （）。hdparm -d0

License

许可证 Copyright (C) 2006-2023 Florian Pose, Ingenieurgemeinschaft IgH 版权所有 （C） 2006-2023 弗洛里安姿势，工程师协会 IgH This file is part of the IgH EtherCAT Master. 此文件是 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 version 2, as published by the Free Software Foundation. IgH EtherCAT Master是免费软件;您可以重新分发它和/或 根据 GNU 通用公共许可证版本 2 的条款对其进行修改，作为 由自由软件基金会发布。 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. 分发IgH EtherCAT主站是希望它有用，但是 无任何保证;甚至没有适销性的暗示保证或 适用于特定目的。请参阅 GNU 通用公共许可证了解更多信息 详。 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 您应该已经收到一份 GNU 通用公共许可证的副本以及 IgH EtherCAT Master;如果没有，请写信给自由软件基金会， 富兰克林街 51 号，五楼，波士顿，MA 02110-1301 美国

The license mentioned above concerns the source code only. Using the EtherCAT technology and brand is only permitted in compliance with the industrial property and similar rights of Beckhoff Automation GmbH. 上述许可证仅涉及源代码。使用EtherCAT浏览器 技术和品牌只允许符合工业要求 Beckhoff Automation GmbH 的财产和类似权利。

Coding Style

编码风格 Developers shall use the coding style rules in the coding style file. 开发者应在编码风格中使用编码风格规则 文件。