SOEM/doc/html/ethercatprint_8h.html

170 lines
7.3 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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>SOEM: ethercatprint.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SOEM
&#160;<span id="projectnumber">v1.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3012a2599d87e3128fe81d8c5dd7e75c.html">soem</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ethercatprint.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Headerfile for <a class="el" href="ethercatprint_8c.html" title="Module to convert EtherCAT errors to readable messages.">ethercatprint.c</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab87ddc03634dbaba946b6d96f2c77a5a"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethercatprint_8h.html#ab87ddc03634dbaba946b6d96f2c77a5a">ec_sdoerror2string</a> (uint16 sdoerrorcode)</td></tr>
<tr class="separator:ab87ddc03634dbaba946b6d96f2c77a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a921e6bce917181c18330ceb38f8937d1"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethercatprint_8h.html#a921e6bce917181c18330ceb38f8937d1">ec_ALstatuscode2string</a> (uint16 ALstatuscode)</td></tr>
<tr class="separator:a921e6bce917181c18330ceb38f8937d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e44b3454dae69578da7287201e1e527"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethercatprint_8h.html#a1e44b3454dae69578da7287201e1e527">ec_soeerror2string</a> (uint16 errorcode)</td></tr>
<tr class="separator:a1e44b3454dae69578da7287201e1e527"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a692aad76ae3f9720ab593651174788"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethercatprint_8h.html#a4a692aad76ae3f9720ab593651174788">ecx_elist2string</a> (<a class="el" href="structecx__contextt.html">ecx_contextt</a> *context)</td></tr>
<tr class="separator:a4a692aad76ae3f9720ab593651174788"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Headerfile for <a class="el" href="ethercatprint_8c.html" title="Module to convert EtherCAT errors to readable messages.">ethercatprint.c</a>. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a921e6bce917181c18330ceb38f8937d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ec_ALstatuscode2string </td>
<td>(</td>
<td class="paramtype">uint16&#160;</td>
<td class="paramname"><em>ALstatuscode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Look up text string that belongs to AL status code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ALstatuscode</td><td>= AL status code as defined in EtherCAT protocol </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>readable string </dd></dl>
</div>
</div>
<a class="anchor" id="ab87ddc03634dbaba946b6d96f2c77a5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ec_sdoerror2string </td>
<td>(</td>
<td class="paramtype">uint16&#160;</td>
<td class="paramname"><em>sdoerrorcode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e44b3454dae69578da7287201e1e527"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ec_soeerror2string </td>
<td>(</td>
<td class="paramtype">uint16&#160;</td>
<td class="paramname"><em>errorcode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Look up text string that belongs to SoE error code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">errorcode</td><td>= SoE error code as defined in EtherCAT protocol </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>readable string </dd></dl>
</div>
</div>
<a class="anchor" id="a4a692aad76ae3f9720ab593651174788"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ecx_elist2string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecx__contextt.html">ecx_contextt</a> *&#160;</td>
<td class="paramname"><em>context</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Look up error in ec_errorlist and convert to text string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>= context struct </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>readable string </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 26 2013 13:57:51 for SOEM by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>