| Line No. | Rev | Author | Line |
|---|---|---|---|
| 1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
| 3 | <title>Procyon AVRlib: stxetx.h File Reference</title> |
||
| 4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
| 5 | </head><body> |
||
| 6 | <!-- Generated by Doxygen 1.4.2 --> |
||
| 7 | <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
| 8 | <h1>stxetx.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
||
| 9 | |||
| 10 | <p> |
||
| 11 | Definition in file <a class="el" href="stxetx_8h-source.html">stxetx.h</a>. |
||
| 12 | <p> |
||
| 13 | <code>#include "<a class="el" href="buffer_8h-source.html">buffer.h</a>"</code><br> |
||
| 14 | <code>#include "<a class="el" href="stxetxconf_8h-source.html">stxetxconf.h</a>"</code><br> |
||
| 15 | |||
| 16 | <p> |
||
| 17 | <a href="stxetx_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
| 18 | <tr><td></td></tr> |
||
| 19 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
| 20 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7" doxytag="stxetx.h::STX"></a> |
||
| 21 | #define </td><td class="memItemRight" valign="bottom"><b>STX</b> 0x02</td></tr> |
||
| 22 | |||
| 23 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga8" doxytag="stxetx.h::ETX"></a> |
||
| 24 | #define </td><td class="memItemRight" valign="bottom"><b>ETX</b> 0x03</td></tr> |
||
| 25 | |||
| 26 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga9" doxytag="stxetx.h::STXETX_HEADERLENGTH"></a> |
||
| 27 | #define </td><td class="memItemRight" valign="bottom"><b>STXETX_HEADERLENGTH</b> 4</td></tr> |
||
| 28 | |||
| 29 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga10" doxytag="stxetx.h::STXETX_TRAILERLENGTH"></a> |
||
| 30 | #define </td><td class="memItemRight" valign="bottom"><b>STXETX_TRAILERLENGTH</b> 2</td></tr> |
||
| 31 | |||
| 32 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga11" doxytag="stxetx.h::STXETX_STATUSOFFSET"></a> |
||
| 33 | #define </td><td class="memItemRight" valign="bottom"><b>STXETX_STATUSOFFSET</b> 1</td></tr> |
||
| 34 | |||
| 35 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga12" doxytag="stxetx.h::STXETX_TYPEOFFSET"></a> |
||
| 36 | #define </td><td class="memItemRight" valign="bottom"><b>STXETX_TYPEOFFSET</b> 2</td></tr> |
||
| 37 | |||
| 38 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga13" doxytag="stxetx.h::STXETX_LENGTHOFFSET"></a> |
||
| 39 | #define </td><td class="memItemRight" valign="bottom"><b>STXETX_LENGTHOFFSET</b> 3</td></tr> |
||
| 40 | |||
| 41 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga14" doxytag="stxetx.h::STXETX_DATAOFFSET"></a> |
||
| 42 | #define </td><td class="memItemRight" valign="bottom"><b>STXETX_DATAOFFSET</b> 4</td></tr> |
||
| 43 | |||
| 44 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga15" doxytag="stxetx.h::STXETX_CHECKSUMOFFSET"></a> |
||
| 45 | #define </td><td class="memItemRight" valign="bottom"><b>STXETX_CHECKSUMOFFSET</b> 4</td></tr> |
||
| 46 | |||
| 47 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga16" doxytag="stxetx.h::STXETX_NOETXSTXCHECKSUM"></a> |
||
| 48 | #define </td><td class="memItemRight" valign="bottom"><b>STXETX_NOETXSTXCHECKSUM</b> 3</td></tr> |
||
| 49 | |||
| 50 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
| 51 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0" doxytag="stxetx.h::stxetxInit"></a> |
||
| 52 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__stxetx.html#ga0">stxetxInit</a> (void(*dataout_func)(unsigned char data))</td></tr> |
||
| 53 | |||
| 54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize STX/ETX packet protocol library. <br></td></tr> |
||
| 55 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1" doxytag="stxetx.h::stxetxSend"></a> |
||
| 56 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__stxetx.html#ga1">stxetxSend</a> (unsigned char status, unsigned char type, unsigned char datalength, unsigned char *dataptr)</td></tr> |
||
| 57 | |||
| 58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Send/Create STX/ETX packet. <br></td></tr> |
||
| 59 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="stxetx.h::stxetxProcess"></a> |
||
| 60 | unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__stxetx.html#ga2">stxetxProcess</a> (<a class="el" href="structstruct__cBuffer.html">cBuffer</a> *rxBuffer)</td></tr> |
||
| 61 | |||
| 62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a buffer containing STX/ETX packets. <br></td></tr> |
||
| 63 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="stxetx.h::stxetxGetRxPacketStatus"></a> |
||
| 64 | unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__stxetx.html#ga3">stxetxGetRxPacketStatus</a> (void)</td></tr> |
||
| 65 | |||
| 66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the received packet's status. <br></td></tr> |
||
| 67 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga4" doxytag="stxetx.h::stxetxGetRxPacketType"></a> |
||
| 68 | unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__stxetx.html#ga4">stxetxGetRxPacketType</a> (void)</td></tr> |
||
| 69 | |||
| 70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the received packet's type. <br></td></tr> |
||
| 71 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="stxetx.h::stxetxGetRxPacketDatalength"></a> |
||
| 72 | unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__stxetx.html#ga5">stxetxGetRxPacketDatalength</a> (void)</td></tr> |
||
| 73 | |||
| 74 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the received packet's datalength. <br></td></tr> |
||
| 75 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="stxetx.h::stxetxGetRxPacketData"></a> |
||
| 76 | unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__stxetx.html#ga6">stxetxGetRxPacketData</a> (void)</td></tr> |
||
| 77 | |||
| 78 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns pointer to the received packet's data. <br></td></tr> |
||
| 79 | </table> |
||
| 80 | <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:08 2006 for Procyon AVRlib by |
||
| 81 | <a href="http://www.doxygen.org/index.html"> |
||
| 82 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
| 83 | </body> |
||
| 84 | </html> |
Powered by WebSVN v2.8.3