Project

General

Profile

Revision 1427

Added by Chris Mar over 14 years ago

updated wl_basic code, docs, and test. it's ready to go.

View differences:

group__wl__basic.html
43 43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a packet to all robots in Basic Group  <a href="#ga72d4f604603ef2541b5f4d3ae467938e"></a><br/></td></tr>
44 44
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga0ad976b2b61cca0081123606101c97cd">wl_basic_packet_receive_handler</a> (char type, int source, unsigned char *packet, int length)</td></tr>
45 45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal default packet handler if none is specified on init  <a href="#ga0ad976b2b61cca0081123606101c97cd"></a><br/></td></tr>
46
<tr><td class="memItemLeft" align="right" valign="top">unsigned char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gad10a8456bc3d30d22fe1dbd40b6e0dbb">wl_basic_do_default</a> (void)</td></tr>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer  <a href="#gad10a8456bc3d30d22fe1dbd40b6e0dbb"></a><br/></td></tr>
46
<tr><td class="memItemLeft" align="right" valign="top">unsigned char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gac3f8a6f5c4d9c258ab9f29f9557632d0">wl_basic_do_default</a> (int *length)</td></tr>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer  <a href="#gac3f8a6f5c4d9c258ab9f29f9557632d0"></a><br/></td></tr>
48 48
<tr><td colspan="2"><h2>Variables</h2></td></tr>
49 49
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf0fa88111d706ef4e8b3bda5bc32596c"></a><!-- doxytag: member="wl_basic::wl_basic_group_handler" ref="gaf0fa88111d706ef4e8b3bda5bc32596c" args="" -->
50 50
<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaf0fa88111d706ef4e8b3bda5bc32596c">wl_basic_group_handler</a></td></tr>
......
58 58
<p>A high level abstraction of the wireless library.</p>
59 59
<p>This will allow you to easily send and receive packets. </p>
60 60
<hr/><h2>Function Documentation</h2>
61
<a class="anchor" id="gad10a8456bc3d30d22fe1dbd40b6e0dbb"></a><!-- doxytag: member="wl_basic.h::wl_basic_do_default" ref="gad10a8456bc3d30d22fe1dbd40b6e0dbb" args="(void)" -->
61
<a class="anchor" id="gac3f8a6f5c4d9c258ab9f29f9557632d0"></a><!-- doxytag: member="wl_basic.h::wl_basic_do_default" ref="gac3f8a6f5c4d9c258ab9f29f9557632d0" args="(int *length)" -->
62 62
<div class="memitem">
63 63
<div class="memproto">
64 64
      <table class="memname">
65 65
        <tr>
66 66
          <td class="memname">unsigned char* wl_basic_do_default </td>
67 67
          <td>(</td>
68
          <td class="paramtype">void&nbsp;</td>
69
          <td class="paramname"></td>
68
          <td class="paramtype">int *&nbsp;</td>
69
          <td class="paramname"> <em>length</em></td>
70 70
          <td>&nbsp;)&nbsp;</td>
71 71
          <td></td>
72 72
        </tr>
......
76 76

  
77 77
<p>wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer </p>
78 78
<p>Wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> for use with the Basic Wireless group. Can only be called if wl_basic_init_default and your packets are handled with the default packet handler. To access packet information, use <a class="el" href="structPacketInfo.html" title="struct that contains relevant packet information">PacketInfo</a> current_packet.</p>
79
<dl><dt><b>Parameters:</b></dt><dd>
80
  <table border="0" cellspacing="2" cellpadding="0">
81
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>a pointer to int to store the length of the data buffer</td></tr>
82
  </table>
83
  </dd>
84
</dl>
79 85
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the data of the packet just received, 0 if no new packet </dd></dl>
80 86

  
81 87
<p>References <a class="el" href="wl__basic_8h_source.html#l00046">current_packet</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p>
......
323 329
</div>
324 330
</div>
325 331
</div>
326
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by&nbsp;
332
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by&nbsp;
327 333
<a href="http://www.doxygen.org/index.html">
328 334
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
329 335
</body>

Also available in: Unified diff