Project

General

Profile

Revision 1395

Added by Chris Mar over 14 years ago

updated wireless docs

View differences:

group__wl__basic.html
21 21 
<p>
22 22 
<table border="0" cellpadding="0" cellspacing="0">
23 23 
<tr><td></td></tr>
24 
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
25 
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>PacketInfo</b></td></tr>
26 

  		




  24
  27
  
    
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>


  		




  25
  28
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g366b705160e22c2a6c4ea2c3c22e3485"></a><!-- doxytag: member="wl_basic::WL_BASIC_GROUP" ref="g366b705160e22c2a6c4ea2c3c22e3485" args="" -->


  		




  26
  29
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_BASIC_GROUP</b>&nbsp;&nbsp;&nbsp;8</td></tr>


  		




  ......




  29
  32
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf">wl_basic_init</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr>


  		




  30
  33
  
    

  		




  31
  34
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">init wireless for Basic Group  <a href="#gae4a8ae98cc33955ee20b6e481d47adf"></a><br></td></tr>


  		




  
  35
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge482937c7c29521030a33ecbc5d2dd9d"></a><!-- doxytag: member="wl_basic::wl_basic_init_default" ref="ge482937c7c29521030a33ecbc5d2dd9d" args="(void)" -->


  		




  
  36
  
    
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ge482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> (void)</td></tr>


  		




  
  37
  
    

  		




  
  38
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">init wireless for Basic Group with default packet handling <br></td></tr>


  		




  32
  39
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr>


  		




  33
  40
  
    

  		




  34
  41
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal function to register a packet handler function  <a href="#gebc714e1bf382a98ac7a43762bf905c5"></a><br></td></tr>


  		




  ......




  38
  45
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e">wl_basic_send_global_packet</a> (char type, char *data, int len)</td></tr>


  		




  39
  46
  
    

  		




  40
  47
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a packet to all robots in Basic Group  <a href="#g72d4f604603ef2541b5f4d3ae467938e"></a><br></td></tr>


  		




  
  48
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g0ad976b2b61cca0081123606101c97cd">wl_basic_packet_receive_handler</a> (char type, int source, unsigned char *packet, int length)</td></tr>


  		




  
  49
  
    

  		




  
  50
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default packet handler if none is specified on init  <a href="#g0ad976b2b61cca0081123606101c97cd"></a><br></td></tr>


  		




  
  51
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae39ab95ba4a1b2ba2736f844c03cee7">wl_basic_do</a> (void)</td></tr>


  		




  
  52
  
    

  		




  
  53
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer  <a href="#gae39ab95ba4a1b2ba2736f844c03cee7"></a><br></td></tr>


  		




  41
  54
  
    
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>


  		




  42
  55
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf0fa88111d706ef4e8b3bda5bc32596c"></a><!-- doxytag: member="wl_basic::wl_basic_group_handler" ref="gf0fa88111d706ef4e8b3bda5bc32596c" args="" -->


  		




  43
  56
  
    
<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gf0fa88111d706ef4e8b3bda5bc32596c">wl_basic_group_handler</a></td></tr>


  		




  44
  57
  
    

  		




  45
  58
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> struct for Basic Group. <br></td></tr>


  		




  
  59
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6c9a887fb0b719948025f195efff1af9"></a><!-- doxytag: member="wl_basic::current_packet" ref="g6c9a887fb0b719948025f195efff1af9" args="" -->


  		




  
  60
  
    
struct PacketInfo&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g6c9a887fb0b719948025f195efff1af9">current_packet</a></td></tr>


  		




  
  61
  
    

  		




  
  62
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">current packet information, correct after <a class="el" href="group__wl__basic.html#gae39ab95ba4a1b2ba2736f844c03cee7" title="wrapper for wl_do() to return packet data buffer">wl_basic_do()</a> <br></td></tr>


  		




  46
  63
  
    
</table>


  		




  47
  64
  
    
<hr><a name="_details"></a><h2>Detailed Description</h2>


  		




  48
  65
  
    
Wireless abstraction for easily sending and receing packets. 


  		




  49
  66
  
    
<p>


  		




  50
  67
  
    
A high level abstraction of the wireless library.<p>


  		




  51
  68
  
    
This will allow you to easily send and receive packets. <hr><h2>Function Documentation</h2>


  		




  
  69
  
    
<a class="anchor" name="gae39ab95ba4a1b2ba2736f844c03cee7"></a><!-- doxytag: member="wl_basic.h::wl_basic_do" ref="gae39ab95ba4a1b2ba2736f844c03cee7" args="(void)" -->


  		




  
  70
  
    
<div class="memitem">


  		




  
  71
  
    
<div class="memproto">


  		




  
  72
  
    
      <table class="memname">


  		




  
  73
  
    
        <tr>


  		




  
  74
  
    
          <td class="memname">unsigned char* wl_basic_do           </td>


  		




  
  75
  
    
          <td>(</td>


  		




  
  76
  
    
          <td class="paramtype">void&nbsp;</td>


  		




  
  77
  
    
          <td class="paramname">          </td>


  		




  
  78
  
    
          <td>&nbsp;)&nbsp;</td>


  		




  
  79
  
    
          <td></td>


  		




  
  80
  
    
        </tr>


  		




  
  81
  
    
      </table>


  		




  
  82
  
    
</div>


  		




  
  83
  
    
<div class="memdoc">


  		




  
  84
  
    

  		




  
  85
  
    
<p>


  		




  
  86
  
    
wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer 


  		




  
  87
  
    
<p>


  		




  
  88
  
    
Wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a><p>


  		




  
  89
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to the data of the packet just received </dd></dl>


  		




  
  90
  
    

  		




  
  91
  
    
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p>


  		




  
  92
  
    

  		




  
  93
  
    
</div>


  		




  
  94
  
    
</div><p>


  		




  52
  95
  
    
<a class="anchor" name="gae4a8ae98cc33955ee20b6e481d47adf"></a><!-- doxytag: member="wl_basic.h::wl_basic_init" ref="gae4a8ae98cc33955ee20b6e481d47adf" args="(void(*handle_receive)(char type, int source, unsigned char *packet, int length))" -->


  		




  53
  96
  
    
<div class="memitem">


  		




  54
  97
  
    
<div class="memproto">


  		




  ......




  76
  119
  
    
</dl>


  		




  77
  120
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error </dd></dl>


  		




  78
  121
  
    

  		




  79
  
  
    
<p>References <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p>


  		




  
  122
  
    
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>, <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p>


  		




  80
  123
  
    

  		




  
  124
  
    
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_init_default()</a>.</p>


  		




  
  125
  
    

  		




  81
  126
  
    
</div>


  		




  82
  127
  
    
</div><p>


  		




  
  128
  
    
<a class="anchor" name="g0ad976b2b61cca0081123606101c97cd"></a><!-- doxytag: member="wl_basic.h::wl_basic_packet_receive_handler" ref="g0ad976b2b61cca0081123606101c97cd" args="(char type, int source, unsigned char *packet, int length)" -->


  		




  
  129
  
    
<div class="memitem">


  		




  
  130
  
    
<div class="memproto">


  		




  
  131
  
    
      <table class="memname">


  		




  
  132
  
    
        <tr>


  		




  
  133
  
    
          <td class="memname">void wl_basic_packet_receive_handler           </td>


  		




  
  134
  
    
          <td>(</td>


  		




  
  135
  
    
          <td class="paramtype">char&nbsp;</td>


  		




  
  136
  
    
          <td class="paramname"> <em>type</em>, </td>


  		




  
  137
  
    
        </tr>


  		




  
  138
  
    
        <tr>


  		




  
  139
  
    
          <td class="paramkey"></td>


  		




  
  140
  
    
          <td></td>


  		




  
  141
  
    
          <td class="paramtype">int&nbsp;</td>


  		




  
  142
  
    
          <td class="paramname"> <em>source</em>, </td>


  		




  
  143
  
    
        </tr>


  		




  
  144
  
    
        <tr>


  		




  
  145
  
    
          <td class="paramkey"></td>


  		




  
  146
  
    
          <td></td>


  		




  
  147
  
    
          <td class="paramtype">unsigned char *&nbsp;</td>


  		




  
  148
  
    
          <td class="paramname"> <em>packet</em>, </td>


  		




  
  149
  
    
        </tr>


  		




  
  150
  
    
        <tr>


  		




  
  151
  
    
          <td class="paramkey"></td>


  		




  
  152
  
    
          <td></td>


  		




  
  153
  
    
          <td class="paramtype">int&nbsp;</td>


  		




  
  154
  
    
          <td class="paramname"> <em>length</em></td><td>&nbsp;</td>


  		




  
  155
  
    
        </tr>


  		




  
  156
  
    
        <tr>


  		




  
  157
  
    
          <td></td>


  		




  
  158
  
    
          <td>)</td>


  		




  
  159
  
    
          <td></td><td></td><td></td>


  		




  
  160
  
    
        </tr>


  		




  
  161
  
    
      </table>


  		




  
  162
  
    
</div>


  		




  
  163
  
    
<div class="memdoc">


  		




  
  164
  
    

  		




  
  165
  
    
<p>


  		




  
  166
  
    
default packet handler if none is specified on init 


  		




  
  167
  
    
<p>


  		




  
  168
  
    
Default packet handler used if none is specified on init<p>


  		




  
  169
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  
  170
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  
  171
  
    
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>Packet type </td></tr>


  		




  
  172
  
    
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>Packet buffer, data you received </td></tr>


  		




  
  173
  
    
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>Length of the data buffer in bytes </td></tr>


  		




  
  174
  
    
  </table>


  		




  
  175
  
    
</dl>


  		




  
  176
  
    

  		




  
  177
  
    
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>.</p>


  		




  
  178
  
    

  		




  
  179
  
    
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_init_default()</a>.</p>


  		




  
  180
  
    

  		




  
  181
  
    
</div>


  		




  
  182
  
    
</div><p>


  		




  83
  183
  
    
<a class="anchor" name="gebc714e1bf382a98ac7a43762bf905c5"></a><!-- doxytag: member="wl_basic.h::wl_basic_register_handler" ref="gebc714e1bf382a98ac7a43762bf905c5" args="(void(*handle_receive)(char type, int source, unsigned char *packet, int length))" -->


  		




  84
  184
  
    
<div class="memitem">


  		




  85
  185
  
    
<div class="memproto">


  		




  ......




  106
  206
  
    
  </table>


  		




  107
  207
  
    
</dl>


  		




  108
  208
  
    

  		




  109
  
  
    
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, <a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>, <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>, <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>, <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>, <a class="el" href="wl__basic_8h_source.html#l00038">wl_basic_group_handler</a>, and <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p>


  		




  
  209
  
    
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, <a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>, <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>, <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>, <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>, <a class="el" href="wl__basic_8h_source.html#l00044">wl_basic_group_handler</a>, and <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p>


  		




  110
  210
  
    

  		




  111
  211
  
    
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00021">wl_basic_init()</a>.</p>


  		




  112
  212
  
    

  		




  ......




  213
  313
  
    
</div>


  		




  214
  314
  
    
</div><p>


  		




  215
  315
  
    
</div>


  		




  216
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;


  		




  
  316
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by&nbsp;


  		




  217
  317
  
    
<a href="http://www.doxygen.org/index.html">


  		




  218
  318
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


  		




  219
  319
  
    
</body>


  		












Also available in:  Unified diff