libs/SOEM
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update doxygen build instructions

Browse Source 
refer to README.md
This commit is contained in:
Hans-Erik Floryd 2016-02-16 14:14:59 +01:00
parent 725ddea4cd
commit 58e939575b
1 changed files with 8 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/soem.dox
View File

@ -3,7 +3,7 @@
* *
* \section start Tutorial * \section start Tutorial
* For a tutorial on SOEM See tutorial.txt * For a tutorial on SOEM See tutorial.txt
* *
* \section overview Overview * \section overview Overview
* SOEM is an EtherCAT master library written in c. Its purpose is to learn and * SOEM is an EtherCAT master library written in c. Its purpose is to learn and
* to use. All users are invited to study the source to get an understanding * to use. All users are invited to study the source to get an understanding
@ -55,7 +55,7 @@
* - Support for Little and Big endian targets. * - Support for Little and Big endian targets.
* *
* Features as of 1.1.3 : * Features as of 1.1.3 :
* - CoE, TxPDO and RxPDO, master is client (beta). * - CoE, TxPDO and RxPDO, master is client (beta).
* - FoE, Read and Write file (beta). * - FoE, Read and Write file (beta).
* *
* Features as of 1.1.4 : * Features as of 1.1.4 :
@ -114,24 +114,16 @@
* - Error messages updated to latest ETG1020 document. * - Error messages updated to latest ETG1020 document.
* - FoE transfers now support busy response. * - FoE transfers now support busy response.
* *
* \section start Getting started * \section build Build instructions
* *
* For Linux * See README.md in the root folder.
* - go to project directory *
* - source ./setup.sh linux * \section start Getting started
* - make all
* *
* For examples see simple_test.c in ~/test/linux/simple_test. * For examples see simple_test.c in ~/test/linux/simple_test.
* First try (assume EtherCAT on eth0): sudo ./simple_test eth0 * First try (assume EtherCAT on eth0): sudo ./simple_test eth0
* As SOEM uses RAW sockets it will need to run as root. * As SOEM uses RAW sockets it will need to run as root.
* *
* For Windows
* - have winpcap installed (included with WireShark)
* - go to project directory
* - for VC, run vcvarsall.bat
* f.e. : C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\vcvarsall.bat x86
* - run make_test_win32_all.bat
*
* \section bugs Squashed bugs * \section bugs Squashed bugs
* Version 1.1.3 * Version 1.1.3
* - Added missing Big-Endian conversion in ethercatconfig.c * - Added missing Big-Endian conversion in ethercatconfig.c
@ -186,7 +178,7 @@
* - Added intime target. * - Added intime target.
* - Added rtk\fec target. * - Added rtk\fec target.
* - Compiles under gcc / visual-c / intime / borland-c . * - Compiles under gcc / visual-c / intime / borland-c .
* - Added multi-threaded configuration for parallel configurations of slaves * - Added multi-threaded configuration for parallel configurations of slaves
* *
* \section legal Legal notice * \section legal Legal notice
* Copyright© 2005-2015 Speciaal Machinefabriek Ketels v.o.f. \n * Copyright© 2005-2015 Speciaal Machinefabriek Ketels v.o.f. \n
@ -222,4 +214,4 @@
* In case you did not receive a copy of the EtherCAT Master License along with * In case you did not receive a copy of the EtherCAT Master License along with
* SOEM write to Beckhoff Automation GmbH, Eiserstrasse 5, D-33415 Verl, Germany * SOEM write to Beckhoff Automation GmbH, Eiserstrasse 5, D-33415 Verl, Germany
* (www.beckhoff.com). * (www.beckhoff.com).
*/ */