SOES/soes/doc/html/index.html

72 lines
3.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>SOES: Simple Open EtherCAT Slave or SOES</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SOES&#160;<span id="projectnumber">v1.0.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Simple Open EtherCAT Slave or SOES </div> </div>
</div>
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="start"></a>
Tutorial</h2>
<p>For a tutorial on SOES See <a class="el" href="tutorial_8txt.html">tutorial.txt</a></p>
<h2><a class="anchor" id="overview"></a>
Overview</h2>
<p>SOES is an EtherCAT slave stack written in c. Its purpose is to learn and to use. All users are invited to study the source to get an understanding how an EtherCAT slave function</p>
<p>Features as of 1.0.0 :</p>
<ul>
<li>Address offset based HAL for easy ESC read/write access via any interface</li>
<li>Mailbox with data link layer</li>
<li>CoE</li>
<li>Object dictionary</li>
<li>SDO read and write for all sizes including segmented transfers</li>
<li>Easy portable C-code suited for embedded applications</li>
<li>Fixed PDO mapping</li>
<li>FoE with bootstrap template</li>
<li>Support for Little and Big endian targets.</li>
<li>Polling for interrupts</li>
</ul>
<h2><a class="anchor" id="legal"></a>
Legal notice</h2>
<p>SOES Simple Open EtherCAT Slave <br/>
Copyright (C) 2007-2013 Arthur Ketels <br/>
Copyright (C) 2012-2013 rt-labs <br/>
</p>
<p>SOES 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.</p>
<p>SOES 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.</p>
<p>As a special exception, if other files instantiate templates or use macros or inline functions from this file, or you compile this file and link it with other works to produce a work based on this file, this file does not by itself cause the resulting work to be covered by the GNU General Public License. However the source code for this file must still be made available in accordance with section (3) of the GNU General Public License.</p>
<p>This exception does not invalidate any other reasons why a work based on this file might be covered by the GNU General Public License.</p>
<p>The EtherCAT Technology, the trade name and logo "EtherCAT" are the intellectual property of, and protected by Beckhoff Automation GmbH. </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Jul 10 2013 11:14:19 for SOES by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>