Revision 1581
editing wireless branch, added error codes and constants
| branches/wireless/docs/libwireless/html/xbee_8c.html | ||
|---|---|---|
| 24 | 24 |
<h1>xbee.c File Reference</h1>XBee Interface. |
| 25 | 25 |
<a href="#_details">More...</a> |
| 26 | 26 |
<p> |
| 27 |
<code>#include "<a class="el" href="xbee_8h-source.html">xbee.h</a>"</code><br>
|
|
| 28 |
<code>#include "<a class="el" href="wl__defs_8h-source.html">wl_defs.h</a>"</code><br>
|
|
| 27 |
<code>#include "<a class="el" href="xbee_8h.html">xbee.h</a>"</code><br> |
|
| 28 |
<code>#include "<a class="el" href="wl__defs_8h.html">wl_defs.h</a>"</code><br> |
|
| 29 | 29 |
<code>#include <time.h></code><br> |
| 30 | 30 |
<code>#include <fcntl.h></code><br> |
| 31 | 31 |
<code>#include <unistd.h></code><br> |
| ... | ... | |
| 38 | 38 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 39 | 39 |
<tr><td></td></tr> |
| 40 | 40 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#fd0466c206d7e1f82ee407d114468e96">XBEE_PORT_DEFAULT</a> "/dev/ttyUSB1"</td></tr> |
|
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfd0466c206d7e1f82ee407d114468e96"></a><!-- doxytag: member="xbee.c::XBEE_PORT_DEFAULT" ref="gfd0466c206d7e1f82ee407d114468e96" args="" --> |
|
| 42 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gfd0466c206d7e1f82ee407d114468e96">XBEE_PORT_DEFAULT</a> "/dev/ttyUSB1"</td></tr> |
|
| 42 | 43 |
|
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee.c::XBEE_PAN_DEFAULT" ref="e6bb9bb274d6750f954762454807a5a7" args="" --> |
|
| 44 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#e6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a> 0xFFFF</td></tr> |
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The port to use the XBee from on the computer. <br></td></tr> |
|
| 45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g63d0ecb125d464ea34524e090648f70f"></a><!-- doxytag: member="xbee.c::XBEE_BUFFER_SIZE" ref="g63d0ecb125d464ea34524e090648f70f" args="" --> |
|
| 46 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_BUFFER_SIZE</b> 128</td></tr> |
|
| 45 | 47 |
|
| 48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb30af815d6e9494361629440f14e3716"></a><!-- doxytag: member="xbee.c::PACKET_BUFFER_SIZE" ref="gb30af815d6e9494361629440f14e3716" args="" --> |
|
| 49 |
#define </td><td class="memItemRight" valign="bottom"><b>PACKET_BUFFER_SIZE</b> 108</td></tr> |
|
| 50 |
|
|
| 51 |
<tr><td colspan="2"><div class="groupHeader">xbee options</div></td></tr> |
|
| 52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee.c::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" --> |
|
| 53 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#ge6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a> 0xFFFF</td></tr> |
|
| 54 |
|
|
| 46 | 55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset PAN, uses XBee default. <br></td></tr> |
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee.c::XBEE_CHANNEL_DEFAULT" ref="35f8b9d8e01e788f1e29928cba29f215" args="" -->
|
|
| 48 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a> 0</td></tr>
|
|
| 56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee.c::XBEE_CHANNEL_DEFAULT" ref="g35f8b9d8e01e788f1e29928cba29f215" args="" -->
|
|
| 57 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a> 0</td></tr>
|
|
| 49 | 58 |
|
| 50 | 59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset channel, uses XBee default. <br></td></tr> |
| 51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee.c::XBEE_BROADCAST" ref="93bbd21f7965e1697350f950cedff5c4" args="" -->
|
|
| 52 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a> 0xFFFF</td></tr>
|
|
| 60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee.c::XBEE_BROADCAST" ref="g93bbd21f7965e1697350f950cedff5c4" args="" -->
|
|
| 61 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a> 0xFFFF</td></tr>
|
|
| 53 | 62 |
|
| 54 | 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Broadcast to all robots in the PAN. <br></td></tr> |
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_NONE" ref="bca7356c2b8183fd41b5ca9a82dd962b" args="" -->
|
|
| 56 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#bca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a> 0x00</td></tr>
|
|
| 64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_NONE" ref="gbca7356c2b8183fd41b5ca9a82dd962b" args="" -->
|
|
| 65 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gbca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a> 0x00</td></tr>
|
|
| 57 | 66 |
|
| 58 | 67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">No special options. <br></td></tr> |
| 59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_DISABLE_RESPONSE" ref="cf9509013302590dca5ce3db63c64609" args="" -->
|
|
| 60 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#cf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a> 0x01</td></tr>
|
|
| 68 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_DISABLE_RESPONSE" ref="gcf9509013302590dca5ce3db63c64609" args="" -->
|
|
| 69 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gcf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a> 0x01</td></tr>
|
|
| 61 | 70 |
|
| 62 | 71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br></td></tr> |
| 63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="57382f888360b5b19f0de3b6f1f7c5a3" args="" -->
|
|
| 64 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a> 0x04</td></tr>
|
|
| 72 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="g57382f888360b5b19f0de3b6f1f7c5a3" args="" -->
|
|
| 73 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a> 0x04</td></tr>
|
|
| 65 | 74 |
|
| 66 | 75 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the packet to all PANS. <br></td></tr> |
| 67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee.c::XBEE_TX_STATUS" ref="7840d8b64c8bec12d8b8d32e845a638a" args="" -->
|
|
| 68 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a> 0x89</td></tr>
|
|
| 76 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee.c::XBEE_TX_STATUS" ref="g7840d8b64c8bec12d8b8d32e845a638a" args="" -->
|
|
| 77 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a> 0x89</td></tr>
|
|
| 69 | 78 |
|
| 70 | 79 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A transmit status packet. <br></td></tr> |
| 71 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee.c::XBEE_RX" ref="c2b1262a3a1eb4a9f7ead366af71c32c" args="" -->
|
|
| 72 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#c2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a> 0x81</td></tr>
|
|
| 80 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee.c::XBEE_RX" ref="gc2b1262a3a1eb4a9f7ead366af71c32c" args="" -->
|
|
| 81 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gc2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a> 0x81</td></tr>
|
|
| 73 | 82 |
|
| 74 | 83 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A packet received from another XBee. <br></td></tr> |
| 75 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72aa42b35714e06ac26df31b06a8bf39"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_START" ref="72aa42b35714e06ac26df31b06a8bf39" args="" --> |
|
| 84 |
<tr><td colspan="2"><div class="groupHeader">xbee frame types</div></td></tr> |
|
| 85 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g72aa42b35714e06ac26df31b06a8bf39"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_START" ref="g72aa42b35714e06ac26df31b06a8bf39" args="" --> |
|
| 76 | 86 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_START</b> 0x7E</td></tr> |
| 77 | 87 |
|
| 78 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be7468473089e3cdd2ed85cac2244d49"></a><!-- doxytag: member="xbee.c::XBEE_GET_PACKET_TIMEOUT" ref="be7468473089e3cdd2ed85cac2244d49" args="" -->
|
|
| 88 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbe7468473089e3cdd2ed85cac2244d49"></a><!-- doxytag: member="xbee.c::XBEE_GET_PACKET_TIMEOUT" ref="gbe7468473089e3cdd2ed85cac2244d49" args="" -->
|
|
| 79 | 89 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_GET_PACKET_TIMEOUT</b> 1000</td></tr> |
| 80 | 90 |
|
| 81 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0fc9d7b1078703227c91e1352b708c5"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_STATUS" ref="e0fc9d7b1078703227c91e1352b708c5" args="" -->
|
|
| 91 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge0fc9d7b1078703227c91e1352b708c5"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_STATUS" ref="ge0fc9d7b1078703227c91e1352b708c5" args="" -->
|
|
| 82 | 92 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_STATUS</b> 0x8A</td></tr> |
| 83 | 93 |
|
| 84 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="106780ab66c38464e90af25ae3cc73de"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND" ref="106780ab66c38464e90af25ae3cc73de" args="" -->
|
|
| 94 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g106780ab66c38464e90af25ae3cc73de"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND" ref="g106780ab66c38464e90af25ae3cc73de" args="" -->
|
|
| 85 | 95 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND</b> 0x08</td></tr> |
| 86 | 96 |
|
| 87 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac9e8cc2d9fdda49b77aed7d9380bfde"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND_RESPONSE" ref="ac9e8cc2d9fdda49b77aed7d9380bfde" args="" -->
|
|
| 97 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gac9e8cc2d9fdda49b77aed7d9380bfde"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND_RESPONSE" ref="gac9e8cc2d9fdda49b77aed7d9380bfde" args="" -->
|
|
| 88 | 98 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND_RESPONSE</b> 0x88</td></tr> |
| 89 | 99 |
|
| 90 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31af21123fe9b33803cdf96626776d32"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_64" ref="31af21123fe9b33803cdf96626776d32" args="" -->
|
|
| 100 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g31af21123fe9b33803cdf96626776d32"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_64" ref="g31af21123fe9b33803cdf96626776d32" args="" -->
|
|
| 91 | 101 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_64</b> 0x00</td></tr> |
| 92 | 102 |
|
| 93 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30aa14f9ad880c0bdcd15d7b6dfe4e84"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_16" ref="30aa14f9ad880c0bdcd15d7b6dfe4e84" args="" -->
|
|
| 103 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g30aa14f9ad880c0bdcd15d7b6dfe4e84"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_16" ref="g30aa14f9ad880c0bdcd15d7b6dfe4e84" args="" -->
|
|
| 94 | 104 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_16</b> 0x01</td></tr> |
| 95 | 105 |
|
| 96 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="301ee4ce1fc94e5c6ccd160a0bfa83a7"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_STATUS" ref="301ee4ce1fc94e5c6ccd160a0bfa83a7" args="" -->
|
|
| 106 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g301ee4ce1fc94e5c6ccd160a0bfa83a7"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_STATUS" ref="g301ee4ce1fc94e5c6ccd160a0bfa83a7" args="" -->
|
|
| 97 | 107 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_STATUS</b> XBEE_TX_STATUS</td></tr> |
| 98 | 108 |
|
| 99 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba621d0a00f41acc7e059b5abf4802ad"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_64" ref="ba621d0a00f41acc7e059b5abf4802ad" args="" -->
|
|
| 109 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gba621d0a00f41acc7e059b5abf4802ad"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_64" ref="gba621d0a00f41acc7e059b5abf4802ad" args="" -->
|
|
| 100 | 110 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_64</b> 0x80</td></tr> |
| 101 | 111 |
|
| 102 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b80e57bcad9ccaa20022e8d4968ec66"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_16" ref="5b80e57bcad9ccaa20022e8d4968ec66" args="" -->
|
|
| 112 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5b80e57bcad9ccaa20022e8d4968ec66"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_16" ref="g5b80e57bcad9ccaa20022e8d4968ec66" args="" -->
|
|
| 103 | 113 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_16</b> XBEE_RX</td></tr> |
| 104 | 114 |
|
| 105 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63d0ecb125d464ea34524e090648f70f"></a><!-- doxytag: member="xbee.c::XBEE_BUFFER_SIZE" ref="63d0ecb125d464ea34524e090648f70f" args="" --> |
|
| 106 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_BUFFER_SIZE</b> 128</td></tr> |
|
| 107 |
|
|
| 108 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b30af815d6e9494361629440f14e3716"></a><!-- doxytag: member="xbee.c::PACKET_BUFFER_SIZE" ref="b30af815d6e9494361629440f14e3716" args="" --> |
|
| 109 |
#define </td><td class="memItemRight" valign="bottom"><b>PACKET_BUFFER_SIZE</b> 108</td></tr> |
|
| 110 |
|
|
| 111 | 115 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 112 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee_send_read_at_command</a> (char *command)</td></tr>
|
|
| 116 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee_send_read_at_command</a> (char *command)</td></tr>
|
|
| 113 | 117 |
|
| 114 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> ()</td></tr> |
|
| 118 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> (void)</td></tr>
|
|
| 115 | 119 |
|
| 116 | 120 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af"></a><br></td></tr> |
| 117 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> ()</td></tr> |
|
| 121 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> (void)</td></tr>
|
|
| 118 | 122 |
|
| 119 | 123 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></td></tr> |
| 120 | 124 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr> |
| 121 | 125 |
|
| 122 | 126 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c"></a><br></td></tr> |
| 123 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *dest)</td></tr>
|
|
| 127 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *packet)</td></tr>
|
|
| 124 | 128 |
|
| 125 | 129 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="group__xbee.html#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr> |
| 126 | 130 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee_set_pan_id</a> (int id)</td></tr> |
| 127 | 131 |
|
| 128 | 132 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b"></a><br></td></tr> |
| 129 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee_get_pan_id</a> ()</td></tr> |
|
| 133 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee_get_pan_id</a> (void)</td></tr>
|
|
| 130 | 134 |
|
| 131 | 135 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="group__xbee.html#g7755cd8db87703c9e9943153660b8052"></a><br></td></tr> |
| 132 | 136 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee_set_channel</a> (int channel)</td></tr> |
| ... | ... | |
| 135 | 139 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> (void)</td></tr> |
| 136 | 140 |
|
| 137 | 141 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel the XBee is currently using. <a href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a"></a><br></td></tr> |
| 138 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee_get_address</a> ()</td></tr> |
|
| 142 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee_get_address</a> (void)</td></tr>
|
|
| 139 | 143 |
|
| 140 | 144 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's 16-bit address. <a href="group__xbee.html#g7c53e8a8492494a61ca306875d633309"></a><br></td></tr> |
| 141 | 145 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1e9e3c2abf0ff683ca8e591c3851cf0a"></a><!-- doxytag: member="xbee.c::xbee_set_com_port" ref="g1e9e3c2abf0ff683ca8e591c3851cf0a" args="(char *port)" --> |
| ... | ... | |
| 143 | 147 |
|
| 144 | 148 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr> |
| 145 | 149 |
<tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
| 146 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65685824a9cbbc9da05be520d0d80d12"></a><!-- doxytag: member="xbee.c::arrival_buf" ref="65685824a9cbbc9da05be520d0d80d12" args="[XBEE_BUFFER_SIZE]" -->
|
|
| 150 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g65685824a9cbbc9da05be520d0d80d12"></a><!-- doxytag: member="xbee.c::arrival_buf" ref="g65685824a9cbbc9da05be520d0d80d12" args="[XBEE_BUFFER_SIZE]" -->
|
|
| 147 | 151 |
char </td><td class="memItemRight" valign="bottom"><b>arrival_buf</b> [XBEE_BUFFER_SIZE]</td></tr> |
| 148 | 152 |
|
| 149 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7ae7d59f0f2dabc258c678996b59b22"></a><!-- doxytag: member="xbee.c::buffer_last" ref="b7ae7d59f0f2dabc258c678996b59b22" args="" -->
|
|
| 153 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb7ae7d59f0f2dabc258c678996b59b22"></a><!-- doxytag: member="xbee.c::buffer_last" ref="gb7ae7d59f0f2dabc258c678996b59b22" args="" -->
|
|
| 150 | 154 |
volatile int </td><td class="memItemRight" valign="bottom"><b>buffer_last</b> = 0</td></tr> |
| 151 | 155 |
|
| 152 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a38080e2a4d6f0497f3c2faf487a0952"></a><!-- doxytag: member="xbee.c::buffer_first" ref="a38080e2a4d6f0497f3c2faf487a0952" args="" -->
|
|
| 156 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga38080e2a4d6f0497f3c2faf487a0952"></a><!-- doxytag: member="xbee.c::buffer_first" ref="ga38080e2a4d6f0497f3c2faf487a0952" args="" -->
|
|
| 153 | 157 |
volatile int </td><td class="memItemRight" valign="bottom"><b>buffer_first</b> = 0</td></tr> |
| 154 | 158 |
|
| 155 | 159 |
</table> |
| 156 | 160 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 157 |
XBee Interface. |
|
| 158 |
<p> |
|
| 159 | 161 |
Copyright (c) 2009 Colony Project<p> |
| 160 | 162 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
| 161 | 163 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
| 162 | 164 |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p> |
| 163 | 165 |
Implementation of low level communication with the XBee in API mode.<p> |
| 164 | 166 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 165 |
<hr><h2>Define Documentation</h2> |
|
| 166 |
<a class="anchor" name="fd0466c206d7e1f82ee407d114468e96"></a><!-- doxytag: member="xbee.c::XBEE_PORT_DEFAULT" ref="fd0466c206d7e1f82ee407d114468e96" args="" --> |
|
| 167 |
<div class="memitem"> |
|
| 168 |
<div class="memproto"> |
|
| 169 |
<table class="memname"> |
|
| 170 |
<tr> |
|
| 171 |
<td class="memname">#define XBEE_PORT_DEFAULT "/dev/ttyUSB1" </td> |
|
| 172 |
</tr> |
|
| 173 |
</table> |
|
| 174 | 167 |
</div> |
| 175 |
<div class="memdoc"> |
|
| 176 |
|
|
| 177 |
<p> |
|
| 178 |
The port to use the XBee from on the computer. Also, a backup port if the other is used. |
|
| 179 |
</div> |
|
| 180 |
</div><p> |
|
| 181 |
<hr><h2>Function Documentation</h2> |
|
| 182 |
<a class="anchor" name="2fbd69862a11b6bcc5cfdb9f182bcdb9"></a><!-- doxytag: member="xbee.c::xbee_send_read_at_command" ref="2fbd69862a11b6bcc5cfdb9f182bcdb9" args="(char *command)" --> |
|
| 183 |
<div class="memitem"> |
|
| 184 |
<div class="memproto"> |
|
| 185 |
<table class="memname"> |
|
| 186 |
<tr> |
|
| 187 |
<td class="memname">int xbee_send_read_at_command </td> |
|
| 188 |
<td>(</td> |
|
| 189 |
<td class="paramtype">char * </td> |
|
| 190 |
<td class="paramname"> <em>command</em> </td> |
|
| 191 |
<td> ) </td> |
|
| 192 |
<td></td> |
|
| 193 |
</tr> |
|
| 194 |
</table> |
|
| 195 |
</div> |
|
| 196 |
<div class="memdoc"> |
|
| 197 |
|
|
| 198 |
<p> |
|
| 199 |
Sends an AT command to read a parameter.<p> |
|
| 200 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 201 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 202 |
<tr><td valign="top"></td><td valign="top"><em>command</em> </td><td>the AT command to send. For exmaple, use ID to read the PAN ID and MY to return the XBee ID. See the XBee reference guide for a complete listing. </td></tr> |
|
| 203 |
</table> |
|
| 204 |
</dl> |
|
| 205 |
|
|
| 206 |
</div> |
|
| 207 |
</div><p> |
|
| 208 |
</div> |
|
| 209 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by |
|
| 168 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by |
|
| 210 | 169 |
<a href="http://www.doxygen.org/index.html"> |
| 211 | 170 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 212 | 171 |
</body> |
| branches/wireless/docs/libwireless/html/wl__defs_8h.html | ||
|---|---|---|
| 25 | 25 |
<a href="#_details">More...</a> |
| 26 | 26 |
<p> |
| 27 | 27 |
<code>#include <stdint.h></code><br> |
| 28 |
|
|
| 29 |
<p> |
|
| 30 |
<a href="wl__defs_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 28 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 31 | 29 |
<tr><td></td></tr> |
| 32 | 30 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="798466231ef137f248b55dbfbce36fd7"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_INIT_FAILED" ref="798466231ef137f248b55dbfbce36fd7" args="" -->
|
|
| 34 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="wl__defs_8h.html#798466231ef137f248b55dbfbce36fd7">WL_ERROR_INIT_FAILED</a> INT8_C(-1)</td></tr>
|
|
| 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2b8a799ce85bb21788e58e1c23c16fc0"></a><!-- doxytag: member="wl_defs.h::WL_SUCCESS" ref="g2b8a799ce85bb21788e58e1c23c16fc0" args="" -->
|
|
| 32 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g2b8a799ce85bb21788e58e1c23c16fc0">WL_SUCCESS</a> INT8_C(0)</td></tr>
|
|
| 35 | 33 |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Success. <br></td></tr> |
|
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g798466231ef137f248b55dbfbce36fd7"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_INIT_FAILED" ref="g798466231ef137f248b55dbfbce36fd7" args="" --> |
|
| 36 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g798466231ef137f248b55dbfbce36fd7">WL_ERROR_INIT_FAILED</a> INT8_C(-1)</td></tr> |
|
| 37 |
|
|
| 36 | 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for init failure. <br></td></tr> |
| 37 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63e64a790913362ecf505e1a7e8347b8"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_INIT_ALREADY_INITD" ref="63e64a790913362ecf505e1a7e8347b8" args="" -->
|
|
| 38 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="wl__defs_8h.html#63e64a790913362ecf505e1a7e8347b8">WL_ERROR_INIT_ALREADY_INITD</a> INT8_C(-2)</td></tr>
|
|
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g63e64a790913362ecf505e1a7e8347b8"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_INIT_ALREADY_INITD" ref="g63e64a790913362ecf505e1a7e8347b8" args="" -->
|
|
| 40 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g63e64a790913362ecf505e1a7e8347b8">WL_ERROR_INIT_ALREADY_INITD</a> INT8_C(-2)</td></tr>
|
|
| 39 | 41 |
|
| 40 | 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for duplicate init calls. <br></td></tr> |
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="099f03f9edae294ce4989433f73c141e"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_LIBRARY_NOT_INITD" ref="099f03f9edae294ce4989433f73c141e" args="" -->
|
|
| 42 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="wl__defs_8h.html#099f03f9edae294ce4989433f73c141e">WL_ERROR_LIBRARY_NOT_INITD</a> INT8_C(-3)</td></tr>
|
|
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g099f03f9edae294ce4989433f73c141e"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_LIBRARY_NOT_INITD" ref="g099f03f9edae294ce4989433f73c141e" args="" -->
|
|
| 44 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g099f03f9edae294ce4989433f73c141e">WL_ERROR_LIBRARY_NOT_INITD</a> INT8_C(-3)</td></tr>
|
|
| 43 | 45 |
|
| 44 | 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for not calling init. <br></td></tr> |
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g54de37a8427bf7372cfefa925cd0acf6"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_TERMINATION_FAILED" ref="g54de37a8427bf7372cfefa925cd0acf6" args="" --> |
|
| 48 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g54de37a8427bf7372cfefa925cd0acf6">WL_ERROR_TERMINATION_FAILED</a> INT8_C(-4)</td></tr> |
|
| 49 |
|
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for failed termination. <br></td></tr> |
|
| 51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g11477a5a024fd6898e4449bf08761207"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_FAILED_REGISTRATION" ref="g11477a5a024fd6898e4449bf08761207" args="" --> |
|
| 52 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g11477a5a024fd6898e4449bf08761207">WL_ERROR_FAILED_REGISTRATION</a> INT8_C(-5)</td></tr> |
|
| 53 |
|
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for failed packet group registration. <br></td></tr> |
|
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g43f851eae7eed2576351d336001c21d2"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_ARGUMENT" ref="g43f851eae7eed2576351d336001c21d2" args="" --> |
|
| 56 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g43f851eae7eed2576351d336001c21d2">WL_ERROR_ARGUMENT</a> INT8_C(-6)</td></tr> |
|
| 57 |
|
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error in arguments. <br></td></tr> |
|
| 59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2a775d59e55e9435505b4a908c522a0a"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_SEND" ref="g2a775d59e55e9435505b4a908c522a0a" args="" --> |
|
| 60 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g2a775d59e55e9435505b4a908c522a0a">WL_ERROR_SEND</a> INT8_C(-10)</td></tr> |
|
| 61 |
|
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for send failure. <br></td></tr> |
|
| 63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4bffaed18853133c76af57b89771b234"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_BAD_GROUP" ref="g4bffaed18853133c76af57b89771b234" args="" --> |
|
| 64 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g4bffaed18853133c76af57b89771b234">WL_ERROR_BAD_GROUP</a> INT8_C(-11)</td></tr> |
|
| 65 |
|
|
| 66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for a bad group number. <br></td></tr> |
|
| 67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g76d08a0e32732a63dc93d2cdf95c8fd0"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_SCOPE" ref="g76d08a0e32732a63dc93d2cdf95c8fd0" args="" --> |
|
| 68 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g76d08a0e32732a63dc93d2cdf95c8fd0">WL_ERROR_SCOPE</a> INIT8_C(-12)</td></tr> |
|
| 69 |
|
|
| 70 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for a bad scope. <br></td></tr> |
|
| 71 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9c528907279e6ace3aae7a7b19ad7687"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_ADDRESS" ref="g9c528907279e6ace3aae7a7b19ad7687" args="" --> |
|
| 72 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g9c528907279e6ace3aae7a7b19ad7687">WL_ERROR_ADDRESS</a> INIT8_C(-13)</td></tr> |
|
| 73 |
|
|
| 74 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for a bad robot address. <br></td></tr> |
|
| 75 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g33881dd2ec8ad0c2f67e40491a2f7c1a"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_MODE" ref="g33881dd2ec8ad0c2f67e40491a2f7c1a" args="" --> |
|
| 76 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g33881dd2ec8ad0c2f67e40491a2f7c1a">WL_ERROR_MODE</a> INIT8_C(-14)</td></tr> |
|
| 77 |
|
|
| 78 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for a bad mode. <br></td></tr> |
|
| 45 | 79 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eaadbf5f5646a5b3ec10510b93ce2968"></a><!-- doxytag: member="wl_defs.h::WL_DEBUG_PRINT" ref="eaadbf5f5646a5b3ec10510b93ce2968" args="(s)" --> |
| 46 | 80 |
#define </td><td class="memItemRight" valign="bottom"><b>WL_DEBUG_PRINT</b>(s)</td></tr> |
| 47 | 81 |
|
| ... | ... | |
| 53 | 87 |
|
| 54 | 88 |
</table> |
| 55 | 89 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 56 |
Definitions for Wireless. |
|
| 57 |
<p> |
|
| 58 | 90 |
Copyright (c) 2009 Colony Project<p> |
| 59 | 91 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
| 60 | 92 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
| ... | ... | |
| 62 | 94 |
Contains definitions for wireless, debugging information, etc.<p> |
| 63 | 95 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 64 | 96 |
</div> |
| 65 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 97 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 66 | 98 |
<a href="http://www.doxygen.org/index.html"> |
| 67 | 99 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 68 | 100 |
</body> |
| branches/wireless/docs/libwireless/html/xbee_8h.html | ||
|---|---|---|
| 25 | 25 |
<a href="#_details">More...</a> |
| 26 | 26 |
<p> |
| 27 | 27 |
<code>#include <stdint.h></code><br> |
| 28 |
|
|
| 29 |
<p> |
|
| 30 |
<a href="xbee_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 28 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 31 | 29 |
<tr><td></td></tr> |
| 32 | 30 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 33 | 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> (void)</td></tr> |
| ... | ... | |
| 67 | 65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset XBee. <br></td></tr> |
| 68 | 66 |
</table> |
| 69 | 67 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 70 |
Contains definitions for using the XBee. |
|
| 71 |
<p> |
|
| 72 | 68 |
Copyright (c) 2009 Colony Project<p> |
| 73 | 69 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
| 74 | 70 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
| ... | ... | |
| 76 | 72 |
Contains definitions for interfacing with the XBee module, from either a robot or a computer. To use a robot, define ROBOT in <a class="el" href="wl__defs_8h.html" title="Definitions for Wireless.">wl_defs.h</a>, and to use a computer, don't define ROBOT.<p> |
| 77 | 73 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 78 | 74 |
</div> |
| 79 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 75 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 80 | 76 |
<a href="http://www.doxygen.org/index.html"> |
| 81 | 77 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 82 | 78 |
</body> |
| branches/wireless/docs/libwireless/html/globals.html | ||
|---|---|---|
| 28 | 28 |
</div> |
| 29 | 29 |
<div class="tabs"> |
| 30 | 30 |
<ul> |
| 31 |
<li><a href="#index_b"><span>b</span></a></li> |
|
| 32 |
<li><a href="#index_f"><span>f</span></a></li> |
|
| 33 |
<li><a href="#index_g"><span>g</span></a></li> |
|
| 34 |
<li><a href="#index_h"><span>h</span></a></li> |
|
| 35 |
<li><a href="#index_n"><span>n</span></a></li> |
|
| 36 |
<li><a href="#index_p"><span>p</span></a></li> |
|
| 37 |
<li><a href="#index_r"><span>r</span></a></li> |
|
| 31 | 38 |
<li><a href="#index_w"><span>w</span></a></li> |
| 32 | 39 |
<li><a href="#index_x"><span>x</span></a></li> |
| 33 | 40 |
</ul> |
| ... | ... | |
| 36 | 43 |
<div class="contents"> |
| 37 | 44 |
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: |
| 38 | 45 |
<p> |
| 46 |
<h3><a class="anchor" name="index_b">- b -</a></h3><ul> |
|
| 47 |
<li>BROADCAST |
|
| 48 |
: <a class="el" href="group__wl__defines.html#gc286e1243ab6be2c950c277e5e1377f9">wireless.h</a> |
|
| 49 |
</ul> |
|
| 50 |
<h3><a class="anchor" name="index_f">- f -</a></h3><ul> |
|
| 51 |
<li>FAST |
|
| 52 |
: <a class="el" href="group__wl__defines.html#g8091c2bcff55cbe0a4a145fd5fb7c22d">wireless.h</a> |
|
| 53 |
</ul> |
|
| 54 |
<h3><a class="anchor" name="index_g">- g -</a></h3><ul> |
|
| 55 |
<li>GLOBAL |
|
| 56 |
: <a class="el" href="group__wl__defines.html#g3de33738fd3c7e77bffbcfaefc3e7645">wireless.h</a> |
|
| 57 |
</ul> |
|
| 58 |
<h3><a class="anchor" name="index_h">- h -</a></h3><ul> |
|
| 59 |
<li>HIGH_PRIORITY |
|
| 60 |
: <a class="el" href="group__wl__defines.html#ged801c122c559efe4677d351d07747b4">wireless.h</a> |
|
| 61 |
</ul> |
|
| 62 |
<h3><a class="anchor" name="index_n">- n -</a></h3><ul> |
|
| 63 |
<li>NORMAL_PRIORITY |
|
| 64 |
: <a class="el" href="group__wl__defines.html#gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3">wireless.h</a> |
|
| 65 |
</ul> |
|
| 66 |
<h3><a class="anchor" name="index_p">- p -</a></h3><ul> |
|
| 67 |
<li>PAN |
|
| 68 |
: <a class="el" href="group__wl__defines.html#g11ed0d4e68673af6d575ed529ddf2130">wireless.h</a> |
|
| 69 |
</ul> |
|
| 70 |
<h3><a class="anchor" name="index_r">- r -</a></h3><ul> |
|
| 71 |
<li>RELIABLE |
|
| 72 |
: <a class="el" href="group__wl__defines.html#g5bda06b0f5767eeca91b1383c0898c19">wireless.h</a> |
|
| 73 |
</ul> |
|
| 39 | 74 |
<h3><a class="anchor" name="index_w">- w -</a></h3><ul> |
| 75 |
<li>wl_ack_check() |
|
| 76 |
: <a class="el" href="group__wl__functions.html#ga364aa4d9cc8c789f05401e8adf44785">wireless.h</a> |
|
| 77 |
, <a class="el" href="group__wireless.html#ga364aa4d9cc8c789f05401e8adf44785">wireless_send.c</a> |
|
| 40 | 78 |
<li>wl_ack_error() |
| 41 |
: <a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wireless.h</a> |
|
| 79 |
: <a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wireless_send.c</a> |
|
| 80 |
, <a class="el" href="group__wl__functions.html#g11aeeac54834f0357794ae60a7513acf">wireless.h</a> |
|
| 81 |
<li>wl_ack_reset() |
|
| 82 |
: <a class="el" href="group__wl__functions.html#g62e126abfcd382ec02524dd2f45a8a7b">wireless.h</a> |
|
| 83 |
, <a class="el" href="group__wireless.html#g62e126abfcd382ec02524dd2f45a8a7b">wireless_send.c</a> |
|
| 42 | 84 |
<li>wl_dispatch() |
| 43 |
: <a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wireless.h</a> |
|
| 85 |
: <a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wireless_receive.c</a> |
|
| 86 |
, <a class="el" href="group__wl__functions.html#ge91c1e1940dfbbd063fdcfb86049c64a">wireless.h</a> |
|
| 87 |
<li>WL_ERROR_ADDRESS |
|
| 88 |
: <a class="el" href="group__wl__error.html#g9c528907279e6ace3aae7a7b19ad7687">wl_defs.h</a> |
|
| 89 |
<li>WL_ERROR_ARGUMENT |
|
| 90 |
: <a class="el" href="group__wl__error.html#g43f851eae7eed2576351d336001c21d2">wl_defs.h</a> |
|
| 91 |
<li>WL_ERROR_BAD_GROUP |
|
| 92 |
: <a class="el" href="group__wl__error.html#g4bffaed18853133c76af57b89771b234">wl_defs.h</a> |
|
| 93 |
<li>WL_ERROR_FAILED_REGISTRATION |
|
| 94 |
: <a class="el" href="group__wl__error.html#g11477a5a024fd6898e4449bf08761207">wl_defs.h</a> |
|
| 44 | 95 |
<li>WL_ERROR_INIT_ALREADY_INITD |
| 45 |
: <a class="el" href="wl__defs_8h.html#63e64a790913362ecf505e1a7e8347b8">wl_defs.h</a>
|
|
| 96 |
: <a class="el" href="group__wl__error.html#g63e64a790913362ecf505e1a7e8347b8">wl_defs.h</a>
|
|
| 46 | 97 |
<li>WL_ERROR_INIT_FAILED |
| 47 |
: <a class="el" href="wl__defs_8h.html#798466231ef137f248b55dbfbce36fd7">wl_defs.h</a>
|
|
| 98 |
: <a class="el" href="group__wl__error.html#g798466231ef137f248b55dbfbce36fd7">wl_defs.h</a>
|
|
| 48 | 99 |
<li>WL_ERROR_LIBRARY_NOT_INITD |
| 49 |
: <a class="el" href="wl__defs_8h.html#099f03f9edae294ce4989433f73c141e">wl_defs.h</a> |
|
| 100 |
: <a class="el" href="group__wl__error.html#g099f03f9edae294ce4989433f73c141e">wl_defs.h</a> |
|
| 101 |
<li>WL_ERROR_MODE |
|
| 102 |
: <a class="el" href="group__wl__error.html#g33881dd2ec8ad0c2f67e40491a2f7c1a">wl_defs.h</a> |
|
| 103 |
<li>WL_ERROR_SCOPE |
|
| 104 |
: <a class="el" href="group__wl__error.html#g76d08a0e32732a63dc93d2cdf95c8fd0">wl_defs.h</a> |
|
| 105 |
<li>WL_ERROR_SEND |
|
| 106 |
: <a class="el" href="group__wl__error.html#g2a775d59e55e9435505b4a908c522a0a">wl_defs.h</a> |
|
| 107 |
<li>WL_ERROR_TERMINATION_FAILED |
|
| 108 |
: <a class="el" href="group__wl__error.html#g54de37a8427bf7372cfefa925cd0acf6">wl_defs.h</a> |
|
| 50 | 109 |
<li>wl_get() |
| 51 |
: <a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wireless.h</a> |
|
| 110 |
: <a class="el" href="group__wl__functions.html#ga5a965e3443e4b2b60243225c50ecca7">wireless.h</a> |
|
| 111 |
, <a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wireless_receive.c</a> |
|
| 52 | 112 |
<li>wl_get_basic() |
| 53 |
: <a class="el" href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817">wireless.h</a> |
|
| 113 |
: <a class="el" href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817">wireless_receive.c</a> |
|
| 114 |
, <a class="el" href="group__wl__functions.html#ge2509e2b6bc61faa26d87b1d87881817">wireless.h</a> |
|
| 54 | 115 |
<li>wl_init() |
| 55 | 116 |
: <a class="el" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009">wireless.c</a> |
| 117 |
, <a class="el" href="group__wl__functions.html#g6a8d6179b1fe27f762937f0b47af2009">wireless.h</a> |
|
| 56 | 118 |
<li>wl_register_handler() |
| 57 |
: <a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wireless.c</a> |
|
| 119 |
: <a class="el" href="group__wl__functions.html#g8af34a6265a5d6af3a1525bb51e61d54">wireless.h</a> |
|
| 120 |
, <a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wireless.c</a> |
|
| 58 | 121 |
<li>wl_send() |
| 59 |
: <a class="el" href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wireless.h</a> |
|
| 122 |
: <a class="el" href="group__wireless.html#gf0c80262c96d3410bf0f1266871ffe3e">wireless_send.c</a> |
|
| 123 |
, <a class="el" href="group__wl__functions.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wireless.h</a> |
|
| 60 | 124 |
<li>wl_send_basic() |
| 61 |
: <a class="el" href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wireless.h</a> |
|
| 125 |
: <a class="el" href="group__wireless.html#g461b4558be666fefb9bf41edfd5ea500">wireless_send.c</a> |
|
| 126 |
, <a class="el" href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wireless.h</a> |
|
| 62 | 127 |
<li>wl_send_global() |
| 63 |
: <a class="el" href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2">wireless.h</a> |
|
| 128 |
: <a class="el" href="group__wl__functions.html#gd92093466d82f3f0c732ffe8323228d2">wireless.h</a> |
|
| 129 |
, <a class="el" href="group__wireless.html#g48e2d69b71010e23ca5c7b2de595ae4f">wireless_send.c</a> |
|
| 64 | 130 |
<li>wl_send_pan() |
| 65 |
: <a class="el" href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076">wireless.h</a> |
|
| 131 |
: <a class="el" href="group__wl__functions.html#g7886c2a37b7350211699dcabe48ff076">wireless.h</a> |
|
| 132 |
, <a class="el" href="group__wireless.html#gaef3438cea00f6f3d3de16d54ec33d51">wireless_send.c</a> |
|
| 66 | 133 |
<li>wl_send_robot() |
| 67 |
: <a class="el" href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60">wireless.h</a> |
|
| 134 |
: <a class="el" href="group__wireless.html#g4a728d521deae8f12b9d40a62027600b">wireless_send.c</a> |
|
| 135 |
, <a class="el" href="group__wl__functions.html#gbb08f7957bd0256c51f424fa770d3e60">wireless.h</a> |
|
| 136 |
<li>WL_SUCCESS |
|
| 137 |
: <a class="el" href="group__wl__error.html#g2b8a799ce85bb21788e58e1c23c16fc0">wl_defs.h</a> |
|
| 68 | 138 |
<li>wl_terminate() |
| 69 | 139 |
: <a class="el" href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f">wireless.c</a> |
| 140 |
, <a class="el" href="group__wl__functions.html#g223f437c2bc8ab8a3ac2e0e06841120f">wireless.h</a> |
|
| 70 | 141 |
</ul> |
| 71 | 142 |
<h3><a class="anchor" name="index_x">- x -</a></h3><ul> |
| 72 | 143 |
<li>XBEE_BROADCAST |
| 73 |
: <a class="el" href="xbee_8c.html#93bbd21f7965e1697350f950cedff5c4">xbee.c</a>
|
|
| 144 |
: <a class="el" href="group__xbee__const.html#g93bbd21f7965e1697350f950cedff5c4">xbee.c</a>
|
|
| 74 | 145 |
<li>XBEE_CHANNEL_DEFAULT |
| 75 |
: <a class="el" href="xbee_8c.html#35f8b9d8e01e788f1e29928cba29f215">xbee.c</a>
|
|
| 146 |
: <a class="el" href="group__xbee__const.html#g35f8b9d8e01e788f1e29928cba29f215">xbee.c</a>
|
|
| 76 | 147 |
<li>xbee_get_address() |
| 77 |
: <a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee.h</a> |
|
| 78 |
, <a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee.c</a> |
|
| 148 |
: <a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee.c</a> |
|
| 79 | 149 |
<li>xbee_get_channel() |
| 80 | 150 |
: <a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee.c</a> |
| 81 |
, <a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee.h</a> |
|
| 82 | 151 |
<li>xbee_get_packet() |
| 83 |
: <a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee.h</a> |
|
| 84 |
, <a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee.c</a> |
|
| 152 |
: <a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee.c</a> |
|
| 85 | 153 |
<li>xbee_get_pan_id() |
| 86 | 154 |
: <a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee.c</a> |
| 87 |
, <a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee.h</a> |
|
| 88 | 155 |
<li>xbee_lib_init() |
| 89 | 156 |
: <a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee.c</a> |
| 90 |
, <a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee.h</a> |
|
| 91 | 157 |
<li>XBEE_OPTIONS_BROADCAST_ALL_PANS |
| 92 |
: <a class="el" href="xbee_8c.html#57382f888360b5b19f0de3b6f1f7c5a3">xbee.c</a>
|
|
| 158 |
: <a class="el" href="group__xbee__const.html#g57382f888360b5b19f0de3b6f1f7c5a3">xbee.c</a>
|
|
| 93 | 159 |
<li>XBEE_OPTIONS_DISABLE_RESPONSE |
| 94 |
: <a class="el" href="xbee_8c.html#cf9509013302590dca5ce3db63c64609">xbee.c</a>
|
|
| 160 |
: <a class="el" href="group__xbee__const.html#gcf9509013302590dca5ce3db63c64609">xbee.c</a>
|
|
| 95 | 161 |
<li>XBEE_OPTIONS_NONE |
| 96 |
: <a class="el" href="xbee_8c.html#bca7356c2b8183fd41b5ca9a82dd962b">xbee.c</a>
|
|
| 162 |
: <a class="el" href="group__xbee__const.html#gbca7356c2b8183fd41b5ca9a82dd962b">xbee.c</a>
|
|
| 97 | 163 |
<li>XBEE_PAN_DEFAULT |
| 98 |
: <a class="el" href="xbee_8c.html#e6bb9bb274d6750f954762454807a5a7">xbee.c</a>
|
|
| 164 |
: <a class="el" href="group__xbee__const.html#ge6bb9bb274d6750f954762454807a5a7">xbee.c</a>
|
|
| 99 | 165 |
<li>XBEE_PORT_DEFAULT |
| 100 |
: <a class="el" href="xbee_8c.html#fd0466c206d7e1f82ee407d114468e96">xbee.c</a>
|
|
| 166 |
: <a class="el" href="group__xbee__const.html#gfd0466c206d7e1f82ee407d114468e96">xbee.c</a>
|
|
| 101 | 167 |
<li>xbee_reset() |
| 102 | 168 |
: <a class="el" href="group__xbee.html#gfcfccfa7323041108202275eba913be7">xbee.h</a> |
| 103 | 169 |
<li>XBEE_RX |
| 104 |
: <a class="el" href="xbee_8c.html#c2b1262a3a1eb4a9f7ead366af71c32c">xbee.c</a>
|
|
| 170 |
: <a class="el" href="group__xbee__const.html#gc2b1262a3a1eb4a9f7ead366af71c32c">xbee.c</a>
|
|
| 105 | 171 |
<li>xbee_send_packet() |
| 106 | 172 |
: <a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee.c</a> |
| 107 |
, <a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee.h</a> |
|
| 108 | 173 |
<li>xbee_send_read_at_command() |
| 109 |
: <a class="el" href="xbee_8c.html#2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee.c</a>
|
|
| 174 |
: <a class="el" href="group__xbee.html#g2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee.c</a>
|
|
| 110 | 175 |
<li>xbee_set_channel() |
| 111 | 176 |
: <a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee.c</a> |
| 112 |
, <a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee.h</a> |
|
| 113 | 177 |
<li>xbee_set_com_port() |
| 114 |
: <a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee.h</a> |
|
| 115 |
, <a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee.c</a> |
|
| 178 |
: <a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee.c</a> |
|
| 116 | 179 |
<li>xbee_set_pan_id() |
| 117 | 180 |
: <a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee.c</a> |
| 118 |
, <a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee.h</a> |
|
| 119 | 181 |
<li>xbee_terminate() |
| 120 | 182 |
: <a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee.c</a> |
| 121 |
, <a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee.h</a> |
|
| 122 | 183 |
<li>XBEE_TX_STATUS |
| 123 |
: <a class="el" href="xbee_8c.html#7840d8b64c8bec12d8b8d32e845a638a">xbee.c</a>
|
|
| 184 |
: <a class="el" href="group__xbee__const.html#g7840d8b64c8bec12d8b8d32e845a638a">xbee.c</a>
|
|
| 124 | 185 |
</ul> |
| 125 | 186 |
</div> |
| 126 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 187 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 127 | 188 |
<a href="http://www.doxygen.org/index.html"> |
| 128 | 189 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 129 | 190 |
</body> |
| branches/wireless/docs/libwireless/html/globals_defs.html | ||
|---|---|---|
| 31 | 31 |
|
| 32 | 32 |
<p> |
| 33 | 33 |
<ul> |
| 34 |
<li>BROADCAST |
|
| 35 |
: <a class="el" href="group__wl__defines.html#gc286e1243ab6be2c950c277e5e1377f9">wireless.h</a> |
|
| 36 |
<li>FAST |
|
| 37 |
: <a class="el" href="group__wl__defines.html#g8091c2bcff55cbe0a4a145fd5fb7c22d">wireless.h</a> |
|
| 38 |
<li>GLOBAL |
|
| 39 |
: <a class="el" href="group__wl__defines.html#g3de33738fd3c7e77bffbcfaefc3e7645">wireless.h</a> |
|
| 40 |
<li>HIGH_PRIORITY |
|
| 41 |
: <a class="el" href="group__wl__defines.html#ged801c122c559efe4677d351d07747b4">wireless.h</a> |
|
| 42 |
<li>NORMAL_PRIORITY |
|
| 43 |
: <a class="el" href="group__wl__defines.html#gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3">wireless.h</a> |
|
| 44 |
<li>PAN |
|
| 45 |
: <a class="el" href="group__wl__defines.html#g11ed0d4e68673af6d575ed529ddf2130">wireless.h</a> |
|
| 46 |
<li>RELIABLE |
|
| 47 |
: <a class="el" href="group__wl__defines.html#g5bda06b0f5767eeca91b1383c0898c19">wireless.h</a> |
|
| 48 |
<li>WL_ERROR_ADDRESS |
|
| 49 |
: <a class="el" href="group__wl__error.html#g9c528907279e6ace3aae7a7b19ad7687">wl_defs.h</a> |
|
| 50 |
<li>WL_ERROR_ARGUMENT |
|
| 51 |
: <a class="el" href="group__wl__error.html#g43f851eae7eed2576351d336001c21d2">wl_defs.h</a> |
|
| 52 |
<li>WL_ERROR_BAD_GROUP |
|
| 53 |
: <a class="el" href="group__wl__error.html#g4bffaed18853133c76af57b89771b234">wl_defs.h</a> |
|
| 54 |
<li>WL_ERROR_FAILED_REGISTRATION |
|
| 55 |
: <a class="el" href="group__wl__error.html#g11477a5a024fd6898e4449bf08761207">wl_defs.h</a> |
|
| 34 | 56 |
<li>WL_ERROR_INIT_ALREADY_INITD |
| 35 |
: <a class="el" href="wl__defs_8h.html#63e64a790913362ecf505e1a7e8347b8">wl_defs.h</a>
|
|
| 57 |
: <a class="el" href="group__wl__error.html#g63e64a790913362ecf505e1a7e8347b8">wl_defs.h</a>
|
|
| 36 | 58 |
<li>WL_ERROR_INIT_FAILED |
| 37 |
: <a class="el" href="wl__defs_8h.html#798466231ef137f248b55dbfbce36fd7">wl_defs.h</a>
|
|
| 59 |
: <a class="el" href="group__wl__error.html#g798466231ef137f248b55dbfbce36fd7">wl_defs.h</a>
|
|
| 38 | 60 |
<li>WL_ERROR_LIBRARY_NOT_INITD |
| 39 |
: <a class="el" href="wl__defs_8h.html#099f03f9edae294ce4989433f73c141e">wl_defs.h</a> |
|
| 61 |
: <a class="el" href="group__wl__error.html#g099f03f9edae294ce4989433f73c141e">wl_defs.h</a> |
|
| 62 |
<li>WL_ERROR_MODE |
|
| 63 |
: <a class="el" href="group__wl__error.html#g33881dd2ec8ad0c2f67e40491a2f7c1a">wl_defs.h</a> |
|
| 64 |
<li>WL_ERROR_SCOPE |
|
| 65 |
: <a class="el" href="group__wl__error.html#g76d08a0e32732a63dc93d2cdf95c8fd0">wl_defs.h</a> |
|
| 66 |
<li>WL_ERROR_SEND |
|
| 67 |
: <a class="el" href="group__wl__error.html#g2a775d59e55e9435505b4a908c522a0a">wl_defs.h</a> |
|
| 68 |
<li>WL_ERROR_TERMINATION_FAILED |
|
| 69 |
: <a class="el" href="group__wl__error.html#g54de37a8427bf7372cfefa925cd0acf6">wl_defs.h</a> |
|
| 70 |
<li>WL_SUCCESS |
|
| 71 |
: <a class="el" href="group__wl__error.html#g2b8a799ce85bb21788e58e1c23c16fc0">wl_defs.h</a> |
|
| 40 | 72 |
<li>XBEE_BROADCAST |
| 41 |
: <a class="el" href="xbee_8c.html#93bbd21f7965e1697350f950cedff5c4">xbee.c</a>
|
|
| 73 |
: <a class="el" href="group__xbee__const.html#g93bbd21f7965e1697350f950cedff5c4">xbee.c</a>
|
|
| 42 | 74 |
<li>XBEE_CHANNEL_DEFAULT |
| 43 |
: <a class="el" href="xbee_8c.html#35f8b9d8e01e788f1e29928cba29f215">xbee.c</a>
|
|
| 75 |
: <a class="el" href="group__xbee__const.html#g35f8b9d8e01e788f1e29928cba29f215">xbee.c</a>
|
|
| 44 | 76 |
<li>XBEE_OPTIONS_BROADCAST_ALL_PANS |
| 45 |
: <a class="el" href="xbee_8c.html#57382f888360b5b19f0de3b6f1f7c5a3">xbee.c</a>
|
|
| 77 |
: <a class="el" href="group__xbee__const.html#g57382f888360b5b19f0de3b6f1f7c5a3">xbee.c</a>
|
|
| 46 | 78 |
<li>XBEE_OPTIONS_DISABLE_RESPONSE |
| 47 |
: <a class="el" href="xbee_8c.html#cf9509013302590dca5ce3db63c64609">xbee.c</a>
|
|
| 79 |
: <a class="el" href="group__xbee__const.html#gcf9509013302590dca5ce3db63c64609">xbee.c</a>
|
|
| 48 | 80 |
<li>XBEE_OPTIONS_NONE |
| 49 |
: <a class="el" href="xbee_8c.html#bca7356c2b8183fd41b5ca9a82dd962b">xbee.c</a>
|
|
| 81 |
: <a class="el" href="group__xbee__const.html#gbca7356c2b8183fd41b5ca9a82dd962b">xbee.c</a>
|
|
| 50 | 82 |
<li>XBEE_PAN_DEFAULT |
| 51 |
: <a class="el" href="xbee_8c.html#e6bb9bb274d6750f954762454807a5a7">xbee.c</a>
|
|
| 83 |
: <a class="el" href="group__xbee__const.html#ge6bb9bb274d6750f954762454807a5a7">xbee.c</a>
|
|
| 52 | 84 |
<li>XBEE_PORT_DEFAULT |
| 53 |
: <a class="el" href="xbee_8c.html#fd0466c206d7e1f82ee407d114468e96">xbee.c</a>
|
|
| 85 |
: <a class="el" href="group__xbee__const.html#gfd0466c206d7e1f82ee407d114468e96">xbee.c</a>
|
|
| 54 | 86 |
<li>XBEE_RX |
| 55 |
: <a class="el" href="xbee_8c.html#c2b1262a3a1eb4a9f7ead366af71c32c">xbee.c</a>
|
|
| 87 |
: <a class="el" href="group__xbee__const.html#gc2b1262a3a1eb4a9f7ead366af71c32c">xbee.c</a>
|
|
| 56 | 88 |
<li>XBEE_TX_STATUS |
| 57 |
: <a class="el" href="xbee_8c.html#7840d8b64c8bec12d8b8d32e845a638a">xbee.c</a>
|
|
| 89 |
: <a class="el" href="group__xbee__const.html#g7840d8b64c8bec12d8b8d32e845a638a">xbee.c</a>
|
|
| 58 | 90 |
</ul> |
| 59 | 91 |
</div> |
| 60 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 92 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 61 | 93 |
<a href="http://www.doxygen.org/index.html"> |
| 62 | 94 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 63 | 95 |
</body> |
| branches/wireless/docs/libwireless/html/wireless_8c.html | ||
|---|---|---|
| 24 | 24 |
<h1>wireless.c File Reference</h1>Wireless library. |
| 25 | 25 |
<a href="#_details">More...</a> |
| 26 | 26 |
<p> |
| 27 |
<code>#include "<a class="el" href="wl__defs_8h-source.html">wl_defs.h</a>"</code><br>
|
|
| 28 |
<code>#include "<a class="el" href="wireless_8h-source.html">wireless.h</a>"</code><br>
|
|
| 27 |
<code>#include "<a class="el" href="wl__defs_8h.html">wl_defs.h</a>"</code><br> |
|
| 28 |
<code>#include "<a class="el" href="wireless_8h.html">wireless.h</a>"</code><br> |
|
| 29 | 29 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 30 | 30 |
<tr><td></td></tr> |
| 31 | 31 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| ... | ... | |
| 40 | 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to register new packet handlers (for non-default groups only). <a href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr> |
| 41 | 41 |
</table> |
| 42 | 42 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 43 |
Wireless library. |
|
| 44 |
<p> |
|
| 45 | 43 |
Copyright (c) 2009 Colony Project<p> |
| 46 | 44 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
| 47 | 45 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
| ... | ... | |
| 49 | 47 |
Implementation of high level wireless communication.<p> |
| 50 | 48 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 51 | 49 |
</div> |
| 52 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 50 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 53 | 51 |
<a href="http://www.doxygen.org/index.html"> |
| 54 | 52 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 55 | 53 |
</body> |
| branches/wireless/docs/libwireless/html/wireless__receive_8c.html | ||
|---|---|---|
| 24 | 24 |
<h1>wireless_receive.c File Reference</h1>Wireless library receive functions. |
| 25 | 25 |
<a href="#_details">More...</a> |
| 26 | 26 |
<p> |
| 27 |
<code>#include "<a class="el" href="wl__defs_8h-source.html">wl_defs.h</a>"</code><br>
|
|
| 28 |
<code>#include "<a class="el" href="wireless_8h-source.html">wireless.h</a>"</code><br>
|
|
| 27 |
<code>#include "<a class="el" href="wl__defs_8h.html">wl_defs.h</a>"</code><br> |
|
| 28 |
<code>#include "<a class="el" href="wireless_8h.html">wireless.h</a>"</code><br> |
|
| 29 | 29 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 30 | 30 |
<tr><td></td></tr> |
| 31 | 31 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| ... | ... | |
| 41 | 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr> |
| 42 | 42 |
</table> |
| 43 | 43 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 44 |
Wireless library receive functions. |
|
| 45 |
<p> |
|
| 46 | 44 |
Copyright (c) 2009 Colony Project<p> |
| 47 | 45 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
| 48 | 46 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
| ... | ... | |
| 50 | 48 |
Implementation of high level wireless communication. This is the receive functions portion of the library.<p> |
| 51 | 49 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 52 | 50 |
</div> |
| 53 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 51 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 54 | 52 |
<a href="http://www.doxygen.org/index.html"> |
| 55 | 53 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 56 | 54 |
</body> |
| branches/wireless/docs/libwireless/html/wireless_8h.html | ||
|---|---|---|
| 25 | 25 |
<a href="#_details">More...</a> |
| 26 | 26 |
<p> |
| 27 | 27 |
<code>#include <stdint.h></code><br> |
| 28 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 29 |
<tr><td></td></tr> |
|
| 30 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
| 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3de33738fd3c7e77bffbcfaefc3e7645"></a><!-- doxytag: member="wireless.h::GLOBAL" ref="g3de33738fd3c7e77bffbcfaefc3e7645" args="" --> |
|
| 32 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g3de33738fd3c7e77bffbcfaefc3e7645">GLOBAL</a> UINT8_C(0)</td></tr> |
|
| 28 | 33 |
|
| 29 |
<p> |
|
| 30 |
<a href="wireless_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 31 |
<tr><td></td></tr> |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">global scope <br></td></tr> |
|
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g11ed0d4e68673af6d575ed529ddf2130"></a><!-- doxytag: member="wireless.h::PAN" ref="g11ed0d4e68673af6d575ed529ddf2130" args="" --> |
|
| 36 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g11ed0d4e68673af6d575ed529ddf2130">PAN</a> UINT8_C(1)</td></tr> |
|
| 37 |
|
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">local pan scope <br></td></tr> |
|
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc286e1243ab6be2c950c277e5e1377f9"></a><!-- doxytag: member="wireless.h::BROADCAST" ref="gc286e1243ab6be2c950c277e5e1377f9" args="" --> |
|
| 40 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gc286e1243ab6be2c950c277e5e1377f9">BROADCAST</a> UINT16_C(0xFFFF)</td></tr> |
|
| 41 |
|
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">broadcast address <br></td></tr> |
|
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5bda06b0f5767eeca91b1383c0898c19"></a><!-- doxytag: member="wireless.h::RELIABLE" ref="g5bda06b0f5767eeca91b1383c0898c19" args="" --> |
|
| 44 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g5bda06b0f5767eeca91b1383c0898c19">RELIABLE</a> UINT8_C(0)</td></tr> |
|
| 45 |
|
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">reliable (TCP) mode <br></td></tr> |
|
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8091c2bcff55cbe0a4a145fd5fb7c22d"></a><!-- doxytag: member="wireless.h::FAST" ref="g8091c2bcff55cbe0a4a145fd5fb7c22d" args="" --> |
|
| 48 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g8091c2bcff55cbe0a4a145fd5fb7c22d">FAST</a> UINT8_C(1)</td></tr> |
|
| 49 |
|
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">fast (UDP) mode <br></td></tr> |
|
| 51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3"></a><!-- doxytag: member="wireless.h::NORMAL_PRIORITY" ref="gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3" args="" --> |
|
| 52 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3">NORMAL_PRIORITY</a> UINT8_C(0)</td></tr> |
|
| 53 |
|
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">standard priority <br></td></tr> |
|
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ged801c122c559efe4677d351d07747b4"></a><!-- doxytag: member="wireless.h::HIGH_PRIORITY" ref="ged801c122c559efe4677d351d07747b4" args="" --> |
|
| 56 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ged801c122c559efe4677d351d07747b4">HIGH_PRIORITY</a> UINT8_C(1)</td></tr> |
|
| 57 |
|
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">high priority, handle immediately <br></td></tr> |
|
| 32 | 59 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr>
|
|
| 60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr>
|
|
| 34 | 61 |
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize wireless. <a href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009"></a><br></td></tr>
|
|
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr>
|
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize wireless. <a href="group__wl__functions.html#g6a8d6179b1fe27f762937f0b47af2009"></a><br></td></tr>
|
|
| 63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr>
|
|
| 37 | 64 |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminate wireless. <a href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f"></a><br></td></tr> |
|
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)</td></tr> |
|
| 65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminate wireless. <a href="group__wl__functions.html#g223f437c2bc8ab8a3ac2e0e06841120f"></a><br></td></tr> |
|
| 66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gaa4e0d7014a74d0d59c08f9fbbf40bd7"></a><!-- doxytag: member="wireless.h::wl_send" ref="gaa4e0d7014a74d0d59c08f9fbbf40bd7" args="(char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)" --> |
|
| 67 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)</td></tr> |
|
| 40 | 68 |
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The core send function. This will take all possible arguments and send all types of packets. <a href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7"></a><br></td></tr>
|
|
| 42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr>
|
|
| 69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The core send function. This will take all possible arguments and send all types of packets. <br></td></tr> |
|
| 70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gd92093466d82f3f0c732ffe8323228d2">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr>
|
|
| 43 | 71 |
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel. <a href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2"></a><br></td></tr>
|
|
| 45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr>
|
|
| 72 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel. <a href="group__wl__functions.html#gd92093466d82f3f0c732ffe8323228d2"></a><br></td></tr>
|
|
| 73 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g7886c2a37b7350211699dcabe48ff076">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr>
|
|
| 46 | 74 |
|
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan. <a href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076"></a><br></td></tr> |
|
| 48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)</td></tr> |
|
| 75 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan. <a href="group__wl__functions.html#g7886c2a37b7350211699dcabe48ff076"></a><br></td></tr> |
|
| 76 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbb08f7957bd0256c51f424fa770d3e60"></a><!-- doxytag: member="wireless.h::wl_send_robot" ref="gbb08f7957bd0256c51f424fa770d3e60" args="(char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)" --> |
|
| 77 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gbb08f7957bd0256c51f424fa770d3e60">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)</td></tr> |
|
| 49 | 78 |
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel to a specific robot. <a href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60"></a><br></td></tr>
|
|
| 51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wl_send_basic</a> (char *data, uint8_t length)</td></tr>
|
|
| 79 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel to a specific robot. <br></td></tr> |
|
| 80 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wl_send_basic</a> (char *data, uint8_t length)</td></tr>
|
|
| 52 | 81 |
|
| 53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><br></td></tr>
|
|
| 54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr>
|
|
| 82 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><br></td></tr>
|
|
| 83 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr>
|
|
| 55 | 84 |
|
| 56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors, and resets number to zero. <a href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr>
|
|
| 57 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr>
|
|
| 85 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors. <a href="group__wl__functions.html#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr>
|
|
| 86 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr>
|
|
| 58 | 87 |
|
| 59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The main receive function. Dispatches packets for registered handlers and returns next basic packet if available. <a href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7"></a><br></td></tr>
|
|
| 60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817">wl_get_basic</a> (char *data, uint8_t length)</td></tr>
|
|
| 88 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks a specific packet for the acknowledgement status. <a href="group__wl__functions.html#ga364aa4d9cc8c789f05401e8adf44785"></a><br></td></tr>
|
|
| 89 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr>
|
|
| 61 | 90 |
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next basic packet if available. <a href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817"></a><br></td></tr> |
|
| 91 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets acknowledgement statistics back to zero. <a href="group__wl__functions.html#g62e126abfcd382ec02524dd2f45a8a7b"></a><br></td></tr> |
|
| 92 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr> |
|
| 93 |
|
|
| 94 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The main receive function. Dispatches packets for registered handlers and returns next basic packet if available. <a href="group__wl__functions.html#ga5a965e3443e4b2b60243225c50ecca7"></a><br></td></tr> |
|
| 95 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ge2509e2b6bc61faa26d87b1d87881817">wl_get_basic</a> (char *data, uint8_t length)</td></tr> |
|
| 96 |
|
|
| 97 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next basic packet if available. <a href="group__wl__functions.html#ge2509e2b6bc61faa26d87b1d87881817"></a><br></td></tr> |
|
| 63 | 98 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge91c1e1940dfbbd063fdcfb86049c64a"></a><!-- doxytag: member="wireless.h::wl_dispatch" ref="ge91c1e1940dfbbd063fdcfb86049c64a" args="(void)" --> |
| 64 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr>
|
|
| 99 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ge91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr>
|
|
| 65 | 100 |
|
| 66 | 101 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr> |
| 67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr>
|
|
| 102 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr>
|
|
| 68 | 103 |
|
| 69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to register new packet handlers (for non-default groups only). <a href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr>
|
|
| 104 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to register new packet handlers (for non-default groups only). <a href="group__wl__functions.html#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr>
|
|
| 70 | 105 |
</table> |
| 71 | 106 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 72 |
Contains definitions for using the wireless library. |
|
| 73 |
<p> |
|
| 74 | 107 |
Copyright (c) 2009 Colony Project<p> |
| 75 | 108 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
| 76 | 109 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
| ... | ... | |
| 78 | 111 |
Contains definitions for interfacing with the wireless library.<p> |
| 79 | 112 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 80 | 113 |
</div> |
| 81 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 114 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 82 | 115 |
<a href="http://www.doxygen.org/index.html"> |
| 83 | 116 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 84 | 117 |
</body> |
| branches/wireless/docs/libwireless/html/group__xbee.html | ||
|---|---|---|
| 20 | 20 |
<p> |
| 21 | 21 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 22 | 22 |
<tr><td></td></tr> |
| 23 |
<tr><td colspan="2"><br><h2>Modules</h2></td></tr> |
|
| 24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html">xbee constants</a></td></tr> |
|
| 25 |
|
|
| 23 | 26 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee_send_read_at_command</a> (char *command)</td></tr> |
|
| 28 |
|
|
| 24 | 29 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> (void)</td></tr> |
| 25 | 30 |
|
| 26 | 31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="#g3d5fbb6aae8dda99240ec38108a645af"></a><br></td></tr> |
| 27 | 32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> (void)</td></tr> |
| 28 | 33 |
|
| 29 | 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr> |
|
| 36 |
|
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="#g7c44bc25fda954efde574ee8d735073c"></a><br></td></tr> |
|
| 30 | 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *packet)</td></tr> |
| 31 | 39 |
|
| 32 | 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr> |
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr> |
|
| 34 |
|
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="#g7c44bc25fda954efde574ee8d735073c"></a><br></td></tr> |
|
| 36 | 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee_set_pan_id</a> (int id)</td></tr> |
| 37 | 42 |
|
| 38 | 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="#gde50cbefd7ba8d7361ce2654a298748b"></a><br></td></tr> |
| ... | ... | |
| 56 | 61 |
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gfcfccfa7323041108202275eba913be7">xbee_reset</a> (void)</td></tr> |
| 57 | 62 |
|
| 58 | 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset XBee. <br></td></tr> |
| 64 |
<tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
|
| 65 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g65685824a9cbbc9da05be520d0d80d12"></a><!-- doxytag: member="xbee::arrival_buf" ref="g65685824a9cbbc9da05be520d0d80d12" args="[XBEE_BUFFER_SIZE]" --> |
|
| 66 |
char </td><td class="memItemRight" valign="bottom"><b>arrival_buf</b> [XBEE_BUFFER_SIZE]</td></tr> |
|
| 67 |
|
|
| 68 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb7ae7d59f0f2dabc258c678996b59b22"></a><!-- doxytag: member="xbee::buffer_last" ref="gb7ae7d59f0f2dabc258c678996b59b22" args="" --> |
|
| 69 |
volatile int </td><td class="memItemRight" valign="bottom"><b>buffer_last</b> = 0</td></tr> |
|
| 70 |
|
|
| 71 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga38080e2a4d6f0497f3c2faf487a0952"></a><!-- doxytag: member="xbee::buffer_first" ref="ga38080e2a4d6f0497f3c2faf487a0952" args="" --> |
|
| 72 |
volatile int </td><td class="memItemRight" valign="bottom"><b>buffer_first</b> = 0</td></tr> |
|
| 73 |
|
|
| 59 | 74 |
</table> |
| 60 | 75 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 61 |
Interface with the XBee module. |
|
| 62 |
<p> |
|
| 63 | 76 |
Interface with the XBee module. <hr><h2>Function Documentation</h2> |
| 64 |
<a class="anchor" name="g7c53e8a8492494a61ca306875d633309"></a><!-- doxytag: member="xbee.h::xbee_get_address" ref="g7c53e8a8492494a61ca306875d633309" args="(void)" -->
|
|
| 77 |
<a class="anchor" name="g7c53e8a8492494a61ca306875d633309"></a><!-- doxytag: member="xbee.c::xbee_get_address" ref="g7c53e8a8492494a61ca306875d633309" args="(void)" -->
|
|
| 65 | 78 |
<div class="memitem"> |
| 66 | 79 |
<div class="memproto"> |
| 67 | 80 |
<table class="memname"> |
| 68 | 81 |
<tr> |
| 69 | 82 |
<td class="memname">unsigned int xbee_get_address </td> |
| 70 | 83 |
<td>(</td> |
| 71 |
<td class="paramtype">void </td> |
|
| 72 | 84 |
<td class="paramname"> </td> |
| 73 | 85 |
<td> ) </td> |
| 74 | 86 |
<td></td> |
| ... | ... | |
| 78 | 90 |
<div class="memdoc"> |
| 79 | 91 |
|
| 80 | 92 |
<p> |
| 81 |
Get the XBee's 16-bit address. |
|
| 82 |
<p> |
|
| 83 | 93 |
Get the 16-bit address of the XBee. This is used to specify who to send messages to and who messages are from.<p> |
| 84 | 94 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee. </dd></dl> |
| 85 | 95 |
|
| 86 | 96 |
</div> |
| 87 | 97 |
</div><p> |
| 88 |
<a class="anchor" name="g133706db81f69ba0a3c169b7a3f42d2a"></a><!-- doxytag: member="xbee.h::xbee_get_channel" ref="g133706db81f69ba0a3c169b7a3f42d2a" args="(void)" -->
|
|
| 98 |
<a class="anchor" name="g133706db81f69ba0a3c169b7a3f42d2a"></a><!-- doxytag: member="xbee.c::xbee_get_channel" ref="g133706db81f69ba0a3c169b7a3f42d2a" args="(void)" -->
|
|
| 89 | 99 |
<div class="memitem"> |
| 90 | 100 |
<div class="memproto"> |
| 91 | 101 |
<table class="memname"> |
| ... | ... | |
| 102 | 112 |
<div class="memdoc"> |
| 103 | 113 |
|
| 104 | 114 |
<p> |
| 105 |
Get the channel the XBee is currently using. |
|
| 106 |
<p> |
|
| 107 | 115 |
Returns the channel which the XBee is currently using.<p> |
| 108 | 116 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl> |
| 109 | 117 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14" title="Set the channel the XBee is currently using.">xbee_set_channel</a> </dd></dl> |
| 110 | 118 |
|
| 111 | 119 |
</div> |
| 112 | 120 |
</div><p> |
| 113 |
<a class="anchor" name="g00fbdd9d849171588df736f8b608589d"></a><!-- doxytag: member="xbee.h::xbee_get_packet" ref="g00fbdd9d849171588df736f8b608589d" args="(unsigned char *packet)" -->
|
|
| 121 |
<a class="anchor" name="g00fbdd9d849171588df736f8b608589d"></a><!-- doxytag: member="xbee.c::xbee_get_packet" ref="g00fbdd9d849171588df736f8b608589d" args="(unsigned char *packet)" -->
|
|
| 114 | 122 |
<div class="memitem"> |
| 115 | 123 |
<div class="memproto"> |
| 116 | 124 |
<table class="memname"> |
| ... | ... | |
| 127 | 135 |
<div class="memdoc"> |
| 128 | 136 |
|
| 129 | 137 |
<p> |
| 130 |
Get a packet from the XBee. |
|
| 131 |
<p> |
|
| 132 | 138 |
Reads a packet received from the XBee. This function is non-blocking. The resulting packet is stored in dest. Only returns transmission response packets and received packets. The returned packet does not include header information or the checksum. This method also handles special packets dealt with by the XBee library, and so should be called frequently while the XBee is in use.<br> |
| 133 | 139 |
<br> |
| 134 | 140 |
<p> |
| ... | ... | |
| 157 | 163 |
|
| 158 | 164 |
</div> |
| 159 | 165 |
</div><p> |
| 160 |
<a class="anchor" name="g7755cd8db87703c9e9943153660b8052"></a><!-- doxytag: member="xbee.h::xbee_get_pan_id" ref="g7755cd8db87703c9e9943153660b8052" args="(void)" -->
|
|
| 166 |
<a class="anchor" name="g7755cd8db87703c9e9943153660b8052"></a><!-- doxytag: member="xbee.c::xbee_get_pan_id" ref="g7755cd8db87703c9e9943153660b8052" args="(void)" -->
|
|
| 161 | 167 |
<div class="memitem"> |
| 162 | 168 |
<div class="memproto"> |
| 163 | 169 |
<table class="memname"> |
| 164 | 170 |
<tr> |
| 165 | 171 |
<td class="memname">unsigned int xbee_get_pan_id </td> |
| 166 | 172 |
<td>(</td> |
| 167 |
<td class="paramtype">void </td> |
|
| 168 | 173 |
<td class="paramname"> </td> |
| 169 | 174 |
<td> ) </td> |
| 170 | 175 |
<td></td> |
| ... | ... | |
| 174 | 179 |
<div class="memdoc"> |
| 175 | 180 |
|
| 176 | 181 |
<p> |
| 177 |
Get the XBee's PAN ID. |
|
| 178 |
<p> |
|
| 179 | 182 |
Get the PAN ID for the XBee.<p> |
| 180 | 183 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the personal area network id, or XBEE_PAN_DEFAULT if it has not yet been set. </dd></dl> |
| 181 | 184 |
|
| 182 | 185 |
</div> |
| 183 | 186 |
</div><p> |
| 184 |
<a class="anchor" name="g3d5fbb6aae8dda99240ec38108a645af"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g3d5fbb6aae8dda99240ec38108a645af" args="(void)" -->
|
|
| 187 |
<a class="anchor" name="g3d5fbb6aae8dda99240ec38108a645af"></a><!-- doxytag: member="xbee.c::xbee_lib_init" ref="g3d5fbb6aae8dda99240ec38108a645af" args="(void)" -->
|
|
| 185 | 188 |
<div class="memitem"> |
| 186 | 189 |
<div class="memproto"> |
| 187 | 190 |
<table class="memname"> |
| 188 | 191 |
<tr> |
| 189 | 192 |
<td class="memname">int xbee_lib_init </td> |
| 190 | 193 |
<td>(</td> |
| 191 |
<td class="paramtype">void </td> |
|
| 192 | 194 |
<td class="paramname"> </td> |
| 193 | 195 |
<td> ) </td> |
| 194 | 196 |
<td></td> |
| ... | ... | |
| 198 | 200 |
<div class="memdoc"> |
| 199 | 201 |
|
| 200 | 202 |
<p> |
| 201 |
Initialize the XBee library. |
|
| 202 |
<p> |
|
| 203 | 203 |
Initializes the XBee library so that other functions may be used. |
| 204 | 204 |
</div> |
| 205 | 205 |
</div><p> |
| 206 |
<a class="anchor" name="g7c44bc25fda954efde574ee8d735073c"></a><!-- doxytag: member="xbee.h::xbee_send_packet" ref="g7c44bc25fda954efde574ee8d735073c" args="(char *packet, int len, int dest, char options, char frame)" -->
|
|
| 206 |
<a class="anchor" name="g7c44bc25fda954efde574ee8d735073c"></a><!-- doxytag: member="xbee.c::xbee_send_packet" ref="g7c44bc25fda954efde574ee8d735073c" args="(char *packet, int len, int dest, char options, char frame)" -->
|
|
| 207 | 207 |
<div class="memitem"> |
| 208 | 208 |
<div class="memproto"> |
| 209 | 209 |
<table class="memname"> |
| ... | ... | |
| 247 | 247 |
<div class="memdoc"> |
| 248 | 248 |
|
| 249 | 249 |
<p> |
| 250 |
Send a packet to the XBee. |
|
| 251 |
<p> |
|
| 252 | 250 |
Send the specified packet.<p> |
| 253 | 251 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 254 | 252 |
<table border="0" cellspacing="2" cellpadding="0"> |
| ... | ... | |
| 262 | 260 |
|
| 263 | 261 |
</div> |
| 264 | 262 |
</div><p> |
| 265 |
<a class="anchor" name="gb93170c493c5cdfd43a7b640c6ed1d14"></a><!-- doxytag: member="xbee.h::xbee_set_channel" ref="gb93170c493c5cdfd43a7b640c6ed1d14" args="(int channel)" -->
|
|
| 263 |
<a class="anchor" name="g2fbd69862a11b6bcc5cfdb9f182bcdb9"></a><!-- doxytag: member="xbee.c::xbee_send_read_at_command" ref="g2fbd69862a11b6bcc5cfdb9f182bcdb9" args="(char *command)" -->
|
|
| 266 | 264 |
<div class="memitem"> |
| 267 | 265 |
<div class="memproto"> |
| 268 | 266 |
<table class="memname"> |
| 269 | 267 |
<tr> |
| 268 |
<td class="memname">int xbee_send_read_at_command </td> |
|
| 269 |
<td>(</td> |
|
| 270 |
<td class="paramtype">char * </td> |
|
| 271 |
<td class="paramname"> <em>command</em> </td> |
|
| 272 |
<td> ) </td> |
|
| 273 |
<td></td> |
|
| 274 |
</tr> |
|
| 275 |
</table> |
|
| 276 |
</div> |
|
| 277 |
<div class="memdoc"> |
|
| 278 |
|
|
| 279 |
<p> |
|
| 280 |
Sends an AT command to read a parameter.<p> |
|
| 281 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 282 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 283 |
<tr><td valign="top"></td><td valign="top"><em>command</em> </td><td>the AT command to send. For exmaple, use ID to read the PAN ID and MY to return the XBee ID. See the XBee reference guide for a complete listing. </td></tr> |
|
| 284 |
</table> |
|
| 285 |
</dl> |
|
| 286 |
|
|
| 287 |
</div> |
|
| 288 |
</div><p> |
|
| 289 |
<a class="anchor" name="gb93170c493c5cdfd43a7b640c6ed1d14"></a><!-- doxytag: member="xbee.c::xbee_set_channel" ref="gb93170c493c5cdfd43a7b640c6ed1d14" args="(int channel)" --> |
|
| 290 |
<div class="memitem"> |
|
| 291 |
<div class="memproto"> |
|
| 292 |
<table class="memname"> |
|
| 293 |
<tr> |
|
| 270 | 294 |
<td class="memname">int xbee_set_channel </td> |
| 271 | 295 |
<td>(</td> |
| 272 | 296 |
<td class="paramtype">int </td> |
| ... | ... | |
| 279 | 303 |
<div class="memdoc"> |
| 280 | 304 |
|
| 281 | 305 |
<p> |
| 282 |
Set the channel the XBee is currently using. |
|
| 283 |
<p> |
|
| 284 | 306 |
Set the channel the XBee is using.<p> |
| 285 | 307 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 286 | 308 |
<table border="0" cellspacing="2" cellpadding="0"> |
| ... | ... | |
| 291 | 313 |
|
| 292 | 314 |
</div> |
| 293 | 315 |
</div><p> |
| 294 |
<a class="anchor" name="gde50cbefd7ba8d7361ce2654a298748b"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="gde50cbefd7ba8d7361ce2654a298748b" args="(int id)" -->
|
|
| 316 |
<a class="anchor" name="gde50cbefd7ba8d7361ce2654a298748b"></a><!-- doxytag: member="xbee.c::xbee_set_pan_id" ref="gde50cbefd7ba8d7361ce2654a298748b" args="(int id)" -->
|
|
| 295 | 317 |
<div class="memitem"> |
| 296 | 318 |
<div class="memproto"> |
| 297 | 319 |
<table class="memname"> |
| ... | ... | |
| 308 | 330 |
<div class="memdoc"> |
| 309 | 331 |
|
| 310 | 332 |
<p> |
| 311 |
Set the PAN ID for the XBee. |
|
| 312 |
<p> |
|
| 313 | 333 |
Sets the personal area network id.<p> |
| 314 | 334 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 315 | 335 |
<table border="0" cellspacing="2" cellpadding="0"> |
| ... | ... | |
| 319 | 339 |
|
| 320 | 340 |
</div> |
| 321 | 341 |
</div><p> |
| 322 |
<a class="anchor" name="g9334ac71dca1ddd697b1a35a361ade6a"></a><!-- doxytag: member="xbee.h::xbee_terminate" ref="g9334ac71dca1ddd697b1a35a361ade6a" args="(void)" -->
|
|
| 342 |
<a class="anchor" name="g9334ac71dca1ddd697b1a35a361ade6a"></a><!-- doxytag: member="xbee.c::xbee_terminate" ref="g9334ac71dca1ddd697b1a35a361ade6a" args="(void)" -->
|
|
| 323 | 343 |
<div class="memitem"> |
| 324 | 344 |
<div class="memproto"> |
| 325 | 345 |
<table class="memname"> |
| 326 | 346 |
<tr> |
| 327 | 347 |
<td class="memname">void xbee_terminate </td> |
| 328 | 348 |
<td>(</td> |
| 329 |
<td class="paramtype">void </td> |
|
| 330 | 349 |
<td class="paramname"> </td> |
| 331 | 350 |
<td> ) </td> |
| 332 | 351 |
<td></td> |
| ... | ... | |
| 336 | 355 |
<div class="memdoc"> |
| 337 | 356 |
|
| 338 | 357 |
<p> |
| 339 |
Uninitialize the XBee library. |
|
| 340 |
<p> |
|
| 341 | 358 |
Call when finished using the XBee library. This releases all sued resources. |
| 342 | 359 |
</div> |
| 343 | 360 |
</div><p> |
| 344 | 361 |
</div> |
| 345 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 362 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 346 | 363 |
<a href="http://www.doxygen.org/index.html"> |
| 347 | 364 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 348 | 365 |
</body> |
| branches/wireless/docs/libwireless/html/globals_func.html | ||
|---|---|---|
| 37 | 37 |
|
| 38 | 38 |
<p> |
| 39 | 39 |
<h3><a class="anchor" name="index_w">- w -</a></h3><ul> |
| 40 |
<li>wl_ack_check() |
|
| 41 |
: <a class="el" href="group__wl__functions.html#ga364aa4d9cc8c789f05401e8adf44785">wireless.h</a> |
|
| 42 |
, <a class="el" href="group__wireless.html#ga364aa4d9cc8c789f05401e8adf44785">wireless_send.c</a> |
|
| 40 | 43 |
<li>wl_ack_error() |
| 41 |
: <a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wireless.h</a> |
|
| 44 |
: <a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wireless_send.c</a> |
|
| 45 |
, <a class="el" href="group__wl__functions.html#g11aeeac54834f0357794ae60a7513acf">wireless.h</a> |
|
| 46 |
<li>wl_ack_reset() |
|
| 47 |
: <a class="el" href="group__wl__functions.html#g62e126abfcd382ec02524dd2f45a8a7b">wireless.h</a> |
|
| 48 |
, <a class="el" href="group__wireless.html#g62e126abfcd382ec02524dd2f45a8a7b">wireless_send.c</a> |
|
| 42 | 49 |
<li>wl_dispatch() |
| 43 |
: <a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wireless.h</a> |
|
| 50 |
: <a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wireless_receive.c</a> |
|
| 51 |
, <a class="el" href="group__wl__functions.html#ge91c1e1940dfbbd063fdcfb86049c64a">wireless.h</a> |
|
| 44 | 52 |
<li>wl_get() |
| 45 |
: <a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wireless.h</a> |
|
| 53 |
: <a class="el" href="group__wl__functions.html#ga5a965e3443e4b2b60243225c50ecca7">wireless.h</a> |
|
| 54 |
, <a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wireless_receive.c</a> |
|
| 46 | 55 |
<li>wl_get_basic() |
| 47 |
: <a class="el" href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817">wireless.h</a> |
|
| 56 |
: <a class="el" href="group__wl__functions.html#ge2509e2b6bc61faa26d87b1d87881817">wireless.h</a> |
|
| 57 |
, <a class="el" href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817">wireless_receive.c</a> |
|
| 48 | 58 |
<li>wl_init() |
| 49 | 59 |
: <a class="el" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009">wireless.c</a> |
| 60 |
, <a class="el" href="group__wl__functions.html#g6a8d6179b1fe27f762937f0b47af2009">wireless.h</a> |
|
| 50 | 61 |
<li>wl_register_handler() |
| 51 |
: <a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wireless.c</a> |
|
| 62 |
: <a class="el" href="group__wl__functions.html#g8af34a6265a5d6af3a1525bb51e61d54">wireless.h</a> |
|
| 63 |
, <a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wireless.c</a> |
|
| 52 | 64 |
<li>wl_send() |
| 53 |
: <a class="el" href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wireless.h</a> |
|
| 65 |
: <a class="el" href="group__wl__functions.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wireless.h</a> |
|
| 66 |
, <a class="el" href="group__wireless.html#gf0c80262c96d3410bf0f1266871ffe3e">wireless_send.c</a> |
|
| 54 | 67 |
<li>wl_send_basic() |
| 55 |
: <a class="el" href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wireless.h</a> |
|
| 68 |
: <a class="el" href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wireless.h</a> |
|
| 69 |
, <a class="el" href="group__wireless.html#g461b4558be666fefb9bf41edfd5ea500">wireless_send.c</a> |
|
| 56 | 70 |
<li>wl_send_global() |
| 57 |
: <a class="el" href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2">wireless.h</a> |
|
| 71 |
: <a class="el" href="group__wl__functions.html#gd92093466d82f3f0c732ffe8323228d2">wireless.h</a> |
|
| 72 |
, <a class="el" href="group__wireless.html#g48e2d69b71010e23ca5c7b2de595ae4f">wireless_send.c</a> |
|
| 58 | 73 |
<li>wl_send_pan() |
| 59 |
: <a class="el" href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076">wireless.h</a> |
|
| 74 |
: <a class="el" href="group__wl__functions.html#g7886c2a37b7350211699dcabe48ff076">wireless.h</a> |
|
| 75 |
, <a class="el" href="group__wireless.html#gaef3438cea00f6f3d3de16d54ec33d51">wireless_send.c</a> |
|
| 60 | 76 |
<li>wl_send_robot() |
| 61 |
: <a class="el" href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60">wireless.h</a> |
|
| 77 |
: <a class="el" href="group__wireless.html#g4a728d521deae8f12b9d40a62027600b">wireless_send.c</a> |
|
| 78 |
, <a class="el" href="group__wl__functions.html#gbb08f7957bd0256c51f424fa770d3e60">wireless.h</a> |
|
| 62 | 79 |
<li>wl_terminate() |
| 63 |
: <a class="el" href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f">wireless.c</a> |
|
| 80 |
: <a class="el" href="group__wl__functions.html#g223f437c2bc8ab8a3ac2e0e06841120f">wireless.h</a> |
|
| 81 |
, <a class="el" href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f">wireless.c</a> |
|
| 64 | 82 |
</ul> |
| 65 | 83 |
<h3><a class="anchor" name="index_x">- x -</a></h3><ul> |
| 66 | 84 |
<li>xbee_get_address() |
| 67 | 85 |
: <a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee.c</a> |
| 68 |
, <a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee.h</a> |
|
| 69 | 86 |
<li>xbee_get_channel() |
| 70 |
: <a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee.h</a> |
|
| 71 |
, <a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee.c</a> |
|
| 87 |
: <a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee.c</a> |
|
| 72 | 88 |
<li>xbee_get_packet() |
| 73 | 89 |
: <a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee.c</a> |
| 74 |
, <a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee.h</a> |
|
| 75 | 90 |
<li>xbee_get_pan_id() |
| 76 |
: <a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee.h</a> |
|
| 77 |
, <a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee.c</a> |
|
| 91 |
: <a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee.c</a> |
|
| 78 | 92 |
<li>xbee_lib_init() |
| 79 | 93 |
: <a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee.c</a> |
| 80 |
, <a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee.h</a> |
|
| 81 | 94 |
<li>xbee_reset() |
| 82 | 95 |
: <a class="el" href="group__xbee.html#gfcfccfa7323041108202275eba913be7">xbee.h</a> |
| 83 | 96 |
<li>xbee_send_packet() |
| 84 | 97 |
: <a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee.c</a> |
| 85 |
, <a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee.h</a> |
|
| 86 | 98 |
<li>xbee_send_read_at_command() |
| 87 |
: <a class="el" href="xbee_8c.html#2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee.c</a>
|
|
| 99 |
: <a class="el" href="group__xbee.html#g2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee.c</a>
|
|
| 88 | 100 |
<li>xbee_set_channel() |
| 89 |
: <a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee.h</a> |
|
| 90 |
, <a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee.c</a> |
|
| 101 |
: <a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee.c</a> |
|
| 91 | 102 |
<li>xbee_set_com_port() |
| 92 | 103 |
: <a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee.c</a> |
| 93 |
, <a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee.h</a> |
|
| 94 | 104 |
<li>xbee_set_pan_id() |
| 95 | 105 |
: <a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee.c</a> |
| 96 |
, <a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee.h</a> |
|
| 97 | 106 |
<li>xbee_terminate() |
| 98 |
: <a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee.h</a> |
|
| 99 |
, <a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee.c</a> |
|
| 107 |
: <a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee.c</a> |
|
| 100 | 108 |
</ul> |
| 101 | 109 |
</div> |
| 102 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 110 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 103 | 111 |
<a href="http://www.doxygen.org/index.html"> |
| 104 | 112 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 105 | 113 |
</body> |
| branches/wireless/docs/libwireless/html/wireless__send_8c.html | ||
|---|---|---|
| 24 | 24 |
<h1>wireless_send.c File Reference</h1>Wireless library send functions. |
| 25 | 25 |
<a href="#_details">More...</a> |
| 26 | 26 |
<p> |
| 27 |
<code>#include "<a class="el" href="wl__defs_8h-source.html">wl_defs.h</a>"</code><br>
|
|
| 28 |
<code>#include "<a class="el" href="wireless_8h-source.html">wireless.h</a>"</code><br>
|
|
| 27 |
<code>#include "<a class="el" href="wl__defs_8h.html">wl_defs.h</a>"</code><br> |
|
| 28 |
<code>#include "<a class="el" href="wireless_8h.html">wireless.h</a>"</code><br> |
|
| 29 | 29 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 30 | 30 |
<tr><td></td></tr> |
| 31 | 31 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)</td></tr>
|
|
| 32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gf0c80262c96d3410bf0f1266871ffe3e">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)</td></tr>
|
|
| 33 | 33 |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The core send function. This will take all possible arguments and send all types of packets. <a href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7"></a><br></td></tr> |
|
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
| 34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g48e2d69b71010e23ca5c7b2de595ae4f">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
| 36 | 35 |
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel. <a href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2"></a><br></td></tr>
|
|
| 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr>
|
|
| 36 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel. <a href="group__wireless.html#g48e2d69b71010e23ca5c7b2de595ae4f"></a><br></td></tr>
|
|
| 37 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaef3438cea00f6f3d3de16d54ec33d51">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr>
|
|
| 39 | 38 |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan. <a href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076"></a><br></td></tr>
|
|
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)</td></tr>
|
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan. <a href="group__wireless.html#gaef3438cea00f6f3d3de16d54ec33d51"></a><br></td></tr>
|
|
| 40 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4a728d521deae8f12b9d40a62027600b">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)</td></tr>
|
|
| 42 | 41 |
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel to a specific robot. <a href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60"></a><br></td></tr> |
|
| 44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wl_send_basic</a> (char *data, uint8_t length)</td></tr> |
|
| 42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g461b4558be666fefb9bf41edfd5ea500">wl_send_basic</a> (char *data, uint8_t length)</td></tr> |
|
| 45 | 43 |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><br></td></tr>
|
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="group__wireless.html#g461b4558be666fefb9bf41edfd5ea500"></a><br></td></tr>
|
|
| 47 | 45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr> |
| 48 | 46 |
|
| 49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors, and resets number to zero. <a href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr> |
|
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors. <a href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr> |
|
| 48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr> |
|
| 49 |
|
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks a specific packet for the acknowledgement status. <a href="group__wireless.html#ga364aa4d9cc8c789f05401e8adf44785"></a><br></td></tr> |
|
| 51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr> |
|
| 52 |
|
|
| 53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets acknowledgement statistics back to zero. <a href="group__wireless.html#g62e126abfcd382ec02524dd2f45a8a7b"></a><br></td></tr> |
|
| 50 | 54 |
</table> |
| 51 | 55 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 52 |
Wireless library send functions. |
|
| 53 |
<p> |
|
| 54 | 56 |
Copyright (c) 2009 Colony Project<p> |
| 55 | 57 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
| 56 | 58 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
| ... | ... | |
| 58 | 60 |
Implementation of high level wireless communication. This is the send functions portion of the library.<p> |
| 59 | 61 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 60 | 62 |
</div> |
| 61 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 63 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 62 | 64 |
<a href="http://www.doxygen.org/index.html"> |
| 63 | 65 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 64 | 66 |
</body> |
| branches/wireless/docs/libwireless/html/files.html | ||
|---|---|---|
| 23 | 23 |
<div class="contents"> |
| 24 | 24 |
<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table> |
| 25 | 25 |
<tr><td class="indexkey"><a class="el" href="wireless_8c.html">wireless.c</a></td><td class="indexvalue">Wireless library </td></tr> |
| 26 |
<tr><td class="indexkey"><a class="el" href="wireless_8h.html">wireless.h</a> <a href="wireless_8h-source.html">[code]</a></td><td class="indexvalue">Contains definitions for using the wireless library </td></tr>
|
|
| 26 |
<tr><td class="indexkey"><a class="el" href="wireless_8h.html">wireless.h</a></td><td class="indexvalue">Contains definitions for using the wireless library </td></tr> |
|
| 27 | 27 |
<tr><td class="indexkey"><a class="el" href="wireless__receive_8c.html">wireless_receive.c</a></td><td class="indexvalue">Wireless library receive functions </td></tr> |
| 28 | 28 |
<tr><td class="indexkey"><a class="el" href="wireless__send_8c.html">wireless_send.c</a></td><td class="indexvalue">Wireless library send functions </td></tr> |
| 29 |
<tr><td class="indexkey"><a class="el" href="wl__defs_8h.html">wl_defs.h</a> <a href="wl__defs_8h-source.html">[code]</a></td><td class="indexvalue">Definitions for Wireless </td></tr>
|
|
| 29 |
<tr><td class="indexkey"><a class="el" href="wl__defs_8h.html">wl_defs.h</a></td><td class="indexvalue">Definitions for Wireless </td></tr> |
|
| 30 | 30 |
<tr><td class="indexkey"><a class="el" href="xbee_8c.html">xbee.c</a></td><td class="indexvalue">XBee Interface </td></tr> |
| 31 |
<tr><td class="indexkey"><a class="el" href="xbee_8h.html">xbee.h</a> <a href="xbee_8h-source.html">[code]</a></td><td class="indexvalue">Contains definitions for using the XBee </td></tr>
|
|
| 31 |
<tr><td class="indexkey"><a class="el" href="xbee_8h.html">xbee.h</a></td><td class="indexvalue">Contains definitions for using the XBee </td></tr> |
|
| 32 | 32 |
</table> |
| 33 | 33 |
</div> |
| 34 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 34 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 35 | 35 |
<a href="http://www.doxygen.org/index.html"> |
| 36 | 36 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 37 | 37 |
</body> |
| branches/wireless/docs/libwireless/html/index.html | ||
|---|---|---|
| 1 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>Colony: Main Page</title>
|
|
| 3 |
<title>Colony: The Wireless Library</title>
|
|
| 4 | 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 5 | 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 6 | 6 |
</head><body> |
| ... | ... | |
| 15 | 15 |
</div> |
| 16 | 16 |
</div> |
| 17 | 17 |
<div class="contents"> |
| 18 |
<h1>Colony Documentation</h1>
|
|
| 18 |
<h1>The Wireless Library</h1>
|
|
| 19 | 19 |
<p> |
| 20 |
<h3 align="center">1577 </h3></div> |
|
| 21 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by |
|
| 20 |
<h3 align="center">1577 </h3>This is the documentation for the Colony wireless library.<br> |
|
| 21 |
<br> |
|
| 22 |
Xbee documentation can be found under <a class="el" href="group__xbee.html">XBee</a> <br> |
|
| 23 |
Higher level wireless documentation can be found under <a class="el" href="group__wireless.html">Wireless</a> <br> |
|
| 24 |
</div> |
|
| 25 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by |
|
| 22 | 26 |
<a href="http://www.doxygen.org/index.html"> |
| 23 | 27 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 24 | 28 |
</body> |
| branches/wireless/docs/libwireless/html/modules.html | ||
|---|---|---|
| 17 | 17 |
<div class="contents"> |
| 18 | 18 |
<h1>Modules</h1>Here is a list of all modules:<ul> |
| 19 | 19 |
<li><a class="el" href="group__wireless.html">Wireless</a> |
| 20 |
<ul> |
|
| 21 |
<li><a class="el" href="group__wl__defines.html">Public Constants</a> |
|
| 22 |
<li><a class="el" href="group__wl__functions.html">Public API Functions</a> |
|
| 23 |
<li><a class="el" href="group__wl__error.html">Error Codes</a> |
|
| 24 |
</ul> |
|
| 20 | 25 |
<li><a class="el" href="group__xbee.html">XBee</a> |
| 26 |
<ul> |
|
| 27 |
<li><a class="el" href="group__xbee__const.html">xbee constants</a> |
|
| 21 | 28 |
</ul> |
| 29 |
</ul> |
|
| 22 | 30 |
</div> |
| 23 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
| 31 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
| 24 | 32 |
<a href="http://www.doxygen.org/index.html"> |
| 25 | 33 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 26 | 34 |
</body> |
| branches/wireless/docs/libwireless/html/group__wireless.html | ||
|---|---|---|
| 20 | 20 |
<p> |
| 21 | 21 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 22 | 22 |
<tr><td></td></tr> |
| 23 |
<tr><td colspan="2"><br><h2>Modules</h2></td></tr> |
|
| 24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html">Public Constants</a></td></tr> |
|
| 25 |
|
|
| 26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html">Public API Functions</a></td></tr> |
|
| 27 |
|
|
| 28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html">Error Codes</a></td></tr> |
|
| 29 |
|
|
| 23 | 30 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 24 | 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr> |
| 25 | 32 |
|
| ... | ... | |
| 30 | 37 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr> |
| 31 | 38 |
|
| 32 | 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to register new packet handlers (for non-default groups only). <a href="#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr> |
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)</td></tr> |
|
| 34 |
|
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The core send function. This will take all possible arguments and send all types of packets. <a href="#gaa4e0d7014a74d0d59c08f9fbbf40bd7"></a><br></td></tr> |
|
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
| 37 |
|
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel. <a href="#gd92093466d82f3f0c732ffe8323228d2"></a><br></td></tr> |
|
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
| 40 |
|
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan. <a href="#g7886c2a37b7350211699dcabe48ff076"></a><br></td></tr> |
|
| 42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)</td></tr> |
|
| 43 |
|
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel to a specific robot. <a href="#gbb08f7957bd0256c51f424fa770d3e60"></a><br></td></tr> |
|
| 45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wl_send_basic</a> (char *data, uint8_t length)</td></tr> |
|
| 46 |
|
|
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="#ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><br></td></tr> |
|
| 48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr> |
|
| 49 |
|
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors, and resets number to zero. <a href="#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr> |
|
| 51 | 40 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr> |
| 52 | 41 |
|
| 53 | 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The main receive function. Dispatches packets for registered handlers and returns next basic packet if available. <a href="#ga5a965e3443e4b2b60243225c50ecca7"></a><br></td></tr> |
| ... | ... | |
| 58 | 47 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr> |
| 59 | 48 |
|
| 60 | 49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr> |
| 50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gf0c80262c96d3410bf0f1266871ffe3e">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)</td></tr> |
|
| 51 |
|
|
| 52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g48e2d69b71010e23ca5c7b2de595ae4f">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
| 53 |
|
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel. <a href="#g48e2d69b71010e23ca5c7b2de595ae4f"></a><br></td></tr> |
|
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaef3438cea00f6f3d3de16d54ec33d51">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
| 56 |
|
|
| 57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan. <a href="#gaef3438cea00f6f3d3de16d54ec33d51"></a><br></td></tr> |
|
| 58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4a728d521deae8f12b9d40a62027600b">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)</td></tr> |
|
| 59 |
|
|
| 60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g461b4558be666fefb9bf41edfd5ea500">wl_send_basic</a> (char *data, uint8_t length)</td></tr> |
|
| 61 |
|
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="#g461b4558be666fefb9bf41edfd5ea500"></a><br></td></tr> |
|
| 63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr> |
|
| 64 |
|
|
| 65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors. <a href="#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr> |
|
| 66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr> |
|
| 67 |
|
|
| 68 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks a specific packet for the acknowledgement status. <a href="#ga364aa4d9cc8c789f05401e8adf44785"></a><br></td></tr> |
|
| 69 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr> |
|
| 70 |
|
|
| 71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets acknowledgement statistics back to zero. <a href="#g62e126abfcd382ec02524dd2f45a8a7b"></a><br></td></tr> |
|
| 61 | 72 |
</table> |
| 62 | 73 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 63 |
Interface with the wireless library. |
|
| 64 |
<p> |
|
| 65 | 74 |
Interface with the wireless library. <hr><h2>Function Documentation</h2> |
| 66 |
<a class="anchor" name="g11aeeac54834f0357794ae60a7513acf"></a><!-- doxytag: member="wireless.h::wl_ack_error" ref="g11aeeac54834f0357794ae60a7513acf" args="(void)" -->
|
|
| 75 |
<a class="anchor" name="ga364aa4d9cc8c789f05401e8adf44785"></a><!-- doxytag: member="wireless_send.c::wl_ack_check" ref="ga364aa4d9cc8c789f05401e8adf44785" args="(uint8_t packet)" -->
|
|
| 67 | 76 |
<div class="memitem"> |
| 68 | 77 |
<div class="memproto"> |
| 69 | 78 |
<table class="memname"> |
| 70 | 79 |
<tr> |
| 80 |
<td class="memname">int8_t wl_ack_check </td> |
|
| 81 |
<td>(</td> |
|
| 82 |
<td class="paramtype">uint8_t </td> |
|
| 83 |
<td class="paramname"> <em>packet</em> </td> |
|
| 84 |
<td> ) </td> |
|
| 85 |
<td></td> |
|
| 86 |
</tr> |
|
| 87 |
</table> |
|
| 88 |
</div> |
|
| 89 |
<div class="memdoc"> |
|
| 90 |
|
|
| 91 |
<p> |
|
| 92 |
acknowledgement error check check if a specific packet has been lost note: buffer will overflow ever 255 packets<p> |
|
| 93 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 94 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 95 |
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>number</td></tr> |
|
| 96 |
</table> |
|
| 97 |
</dl> |
|
| 98 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0=still sending,1=ack received,-1=ack failure </dd></dl> |
|
| 99 |
|
|
| 100 |
</div> |
|
| 101 |
</div><p> |
|
| 102 |
<a class="anchor" name="g11aeeac54834f0357794ae60a7513acf"></a><!-- doxytag: member="wireless_send.c::wl_ack_error" ref="g11aeeac54834f0357794ae60a7513acf" args="(void)" --> |
|
| 103 |
<div class="memitem"> |
|
| 104 |
<div class="memproto"> |
|
| 105 |
<table class="memname"> |
|
| 106 |
<tr> |
|
| 71 | 107 |
<td class="memname">int8_t wl_ack_error </td> |
| 72 | 108 |
<td>(</td> |
| 73 | 109 |
<td class="paramtype">void </td> |
| ... | ... | |
| 80 | 116 |
<div class="memdoc"> |
| 81 | 117 |
|
| 82 | 118 |
<p> |
| 83 |
Returns the number of acknowledgment errors, and resets number to zero. |
|
| 84 |
<p> |
|
| 85 |
acknowledgment error you call this function periodically to check if any of the packets you have sent have been lost<p> |
|
| 119 |
acknowledgment error check if any of the packets you have sent have been lost.<p> |
|
| 86 | 120 |
note that all other error checking will be handled by library, so your user behavior won't have to worry about it<p> |
| 87 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>an error code (or maybe the # of packets you have lost) </dd></dl>
|
|
| 121 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the # of packets lost (up to 255) </dd></dl>
|
|
| 88 | 122 |
|
| 89 | 123 |
</div> |
| 90 | 124 |
</div><p> |
| 91 |
<a class="anchor" name="ga5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless.h::wl_get" ref="ga5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" -->
|
|
| 125 |
<a class="anchor" name="g62e126abfcd382ec02524dd2f45a8a7b"></a><!-- doxytag: member="wireless_send.c::wl_ack_reset" ref="g62e126abfcd382ec02524dd2f45a8a7b" args="(void)" -->
|
|
| 92 | 126 |
<div class="memitem"> |
| 93 | 127 |
<div class="memproto"> |
| 94 | 128 |
<table class="memname"> |
| 95 | 129 |
<tr> |
| 130 |
<td class="memname">void wl_ack_reset </td> |
|
| 131 |
<td>(</td> |
|
| 132 |
<td class="paramtype">void </td> |
|
| 133 |
<td class="paramname"> </td> |
|
| 134 |
<td> ) </td> |
|
| 135 |
<td></td> |
|
| 136 |
</tr> |
|
| 137 |
</table> |
|
| 138 |
</div> |
|
| 139 |
<div class="memdoc"> |
|
Also available in: Unified diff