SOES/soes/doc/html/esc__coe_8h.html

147 lines
5.9 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: esc_coe.h File Reference</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><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">esc_coe.h File Reference</div> </div>
</div>
<div class="contents">
<p>Headerfile for <a class="el" href="esc__coe_8c.html" title="CAN over EtherCAT (CoE) module.">esc_coe.c</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="esc__coe_8h.html#a71c76794b7e4ed125cc9cda0e8508ccd">ESC_coeprocess</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="esc__coe_8h.html#a5d1fb9538a28be98ec8ee762140ada35">sizeTXPDO</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="esc__coe_8h.html#a836e3ff62cd9bba1ca2a5f5481104ba9">sizeRXPDO</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="esc__coe_8h.html#a414bacd094d9023838a396174a695f8d">ESC_objecthandler</a> (uint16 index, uint8 subindex)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Headerfile for <a class="el" href="esc__coe_8c.html" title="CAN over EtherCAT (CoE) module.">esc_coe.c</a>. </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a71c76794b7e4ed125cc9cda0e8508ccd"></a><!-- doxytag: member="esc_coe.h::ESC_coeprocess" ref="a71c76794b7e4ed125cc9cda0e8508ccd" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ESC_coeprocess </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Main CoE function checking the status on current mailbox buffers carrying data, distributing the mailboxes to appropriate CoE functions. On Error an MBX_error or SDO Abort will be sent depending on error cause. </p>
</div>
</div>
<a class="anchor" id="a414bacd094d9023838a396174a695f8d"></a><!-- doxytag: member="esc_coe.h::ESC_objecthandler" ref="a414bacd094d9023838a396174a695f8d" args="(uint16 index, uint8 subindex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ESC_objecthandler </td>
<td>(</td>
<td class="paramtype">uint16&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8&#160;</td>
<td class="paramname"><em>subindex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a836e3ff62cd9bba1ca2a5f5481104ba9"></a><!-- doxytag: member="esc_coe.h::sizeRXPDO" ref="a836e3ff62cd9bba1ca2a5f5481104ba9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16 sizeRXPDO </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculate the size in Bytes of RxPDOs by adding the objects in SyncManager SDO 1C12.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of RxPDOs in Bytes. </dd></dl>
</div>
</div>
<a class="anchor" id="a5d1fb9538a28be98ec8ee762140ada35"></a><!-- doxytag: member="esc_coe.h::sizeTXPDO" ref="a5d1fb9538a28be98ec8ee762140ada35" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16 sizeTXPDO </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculate the size in Bytes of TxPDOs by adding the objects in SyncManager SDO 1C13.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of TxPDOs in Bytes. </dd></dl>
</div>
</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>