Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / group__wl__basic.html @ 1380

History | View | Annotate | Download (11.4 KB)

1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 
<title>libwireless: Wireless Basic</title>
4 
<link href="tabs.css" rel="stylesheet" type="text/css">
5 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.9 -->
8 
<div class="navigation" id="top">
9 
  <div class="tabs">
10 
    <ul>
11 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 
      <li><a href="modules.html"><span>Modules</span></a></li>
13 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
14 
      <li><a href="files.html"><span>Files</span></a></li>
15 
    </ul>
16 
  </div>
17 
</div>
18 
<div class="contents">
19 
<h1>Wireless Basic</h1>Wireless abstraction for easily sending and receing packets.
20 
<a href="#_details">More...</a>
21 
<p>
22 
<table border="0" cellpadding="0" cellspacing="0">
23 
<tr><td></td></tr>
24 
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
25 
<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 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_BASIC_GROUP</b>&nbsp;&nbsp;&nbsp;8</td></tr>
27 

    		
  

  

    
      28
    
    
      
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


    		
  

  

    
      29
    
    
      
<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
    
    
      

    		
  

  

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


    		
  

  

    
      32
    
    
      
<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
    
    
      

    		
  

  

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


    		
  

  

    
      35
    
    
      
<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#gd5d7334484e49cc3cb9ebe2cfc323115">wl_basic_send_robot_packet</a> (char type, char *data, int len, int dest)</td></tr>


    		
  

  

    
      36
    
    
      

    		
  

  

    
      37
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a packet to a single robot in Basic Group  <a href="#gd5d7334484e49cc3cb9ebe2cfc323115"></a><br></td></tr>


    		
  

  

    
      38
    
    
      
<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
    
    
      

    		
  

  

    
      40
    
    
      
<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>


    		
  

  

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


    		
  

  

    
      42
    
    
      
<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
    
    
      
<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
    
    
      

    		
  

  

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


    		
  

  

    
      46
    
    
      
</table>


    		
  

  

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


    		
  

  

    
      48
    
    
      
Wireless abstraction for easily sending and receing packets. 


    		
  

  

    
      49
    
    
      
<p>


    		
  

  

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


    		
  

  

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


    		
  

  

    
      52
    
    
      
<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
    
    
      
<div class="memitem">


    		
  

  

    
      54
    
    
      
<div class="memproto">


    		
  

  

    
      55
    
    
      
      <table class="memname">


    		
  

  

    
      56
    
    
      
        <tr>


    		
  

  

    
      57
    
    
      
          <td class="memname">int wl_basic_init           </td>


    		
  

  

    
      58
    
    
      
          <td>(</td>


    		
  

  

    
      59
    
    
      
          <td class="paramtype">void(*)(char type, int source, unsigned char *packet, int length)&nbsp;</td>


    		
  

  

    
      60
    
    
      
          <td class="paramname"> <em>handle_receive</em>          </td>


    		
  

  

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


    		
  

  

    
      62
    
    
      
          <td></td>


    		
  

  

    
      63
    
    
      
        </tr>


    		
  

  

    
      64
    
    
      
      </table>


    		
  

  

    
      65
    
    
      
</div>


    		
  

  

    
      66
    
    
      
<div class="memdoc">


    		
  

  

    
      67
    
    
      

    		
  

  

    
      68
    
    
      
<p>


    		
  

  

    
      69
    
    
      
init wireless for Basic Group 


    		
  

  

    
      70
    
    
      
<p>


    		
  

  

    
      71
    
    
      
Wrapper for <a class="el" href="group__wireless.html#gedd4562415e273ce6537f9c1a0f2701b" title="Initialize the wireless library.">wl_init()</a>. Initializes wireless and registers a packet handler function for Basic Group.<p>


    		
  

  

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


    		
  

  

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


    		
  

  

    
      74
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>handle_receive</em>&nbsp;</td><td>function pointer to handler function for Basic Group </td></tr>


    		
  

  

    
      75
    
    
      
  </table>


    		
  

  

    
      76
    
    
      
</dl>


    		
  

  

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


    		
  

  

    
      78
    
    
      

    		
  

  

    
      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>


    		
  

  

    
      80
    
    
      

    		
  

  

    
      81
    
    
      
</div>


    		
  

  

    
      82
    
    
      
</div><p>


    		
  

  

    
      83
    
    
      
<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
    
    
      
<div class="memitem">


    		
  

  

    
      85
    
    
      
<div class="memproto">


    		
  

  

    
      86
    
    
      
      <table class="memname">


    		
  

  

    
      87
    
    
      
        <tr>


    		
  

  

    
      88
    
    
      
          <td class="memname">void wl_basic_register_handler           </td>


    		
  

  

    
      89
    
    
      
          <td>(</td>


    		
  

  

    
      90
    
    
      
          <td class="paramtype">void(*)(char type, int source, unsigned char *packet, int length)&nbsp;</td>


    		
  

  

    
      91
    
    
      
          <td class="paramname"> <em>handle_receive</em>          </td>


    		
  

  

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


    		
  

  

    
      93
    
    
      
          <td></td>


    		
  

  

    
      94
    
    
      
        </tr>


    		
  

  

    
      95
    
    
      
      </table>


    		
  

  

    
      96
    
    
      
</div>


    		
  

  

    
      97
    
    
      
<div class="memdoc">


    		
  

  

    
      98
    
    
      

    		
  

  

    
      99
    
    
      
<p>


    		
  

  

    
      100
    
    
      
internal function to register a packet handler function 


    		
  

  

    
      101
    
    
      
<p>


    		
  

  

    
      102
    
    
      
Internal function to register a packet group handler for Basic Group<p>


    		
  

  

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


    		
  

  

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


    		
  

  

    
      105
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>handle_receive</em>&nbsp;</td><td>function pointer to handler function for Basic Group </td></tr>


    		
  

  

    
      106
    
    
      
  </table>


    		
  

  

    
      107
    
    
      
</dl>


    		
  

  

    
      108
    
    
      

    		
  

  

    
      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>


    		
  

  

    
      110
    
    
      

    		
  

  

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


    		
  

  

    
      112
    
    
      

    		
  

  

    
      113
    
    
      
</div>


    		
  

  

    
      114
    
    
      
</div><p>


    		
  

  

    
      115
    
    
      
<a class="anchor" name="g72d4f604603ef2541b5f4d3ae467938e"></a><!-- doxytag: member="wl_basic.h::wl_basic_send_global_packet" ref="g72d4f604603ef2541b5f4d3ae467938e" args="(char type, char *data, int len)" -->


    		
  

  

    
      116
    
    
      
<div class="memitem">


    		
  

  

    
      117
    
    
      
<div class="memproto">


    		
  

  

    
      118
    
    
      
      <table class="memname">


    		
  

  

    
      119
    
    
      
        <tr>


    		
  

  

    
      120
    
    
      
          <td class="memname">void wl_basic_send_global_packet           </td>


    		
  

  

    
      121
    
    
      
          <td>(</td>


    		
  

  

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


    		
  

  

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


    		
  

  

    
      124
    
    
      
        </tr>


    		
  

  

    
      125
    
    
      
        <tr>


    		
  

  

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


    		
  

  

    
      127
    
    
      
          <td></td>


    		
  

  

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


    		
  

  

    
      129
    
    
      
          <td class="paramname"> <em>data</em>, </td>


    		
  

  

    
      130
    
    
      
        </tr>


    		
  

  

    
      131
    
    
      
        <tr>


    		
  

  

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


    		
  

  

    
      133
    
    
      
          <td></td>


    		
  

  

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


    		
  

  

    
      135
    
    
      
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>


    		
  

  

    
      136
    
    
      
        </tr>


    		
  

  

    
      137
    
    
      
        <tr>


    		
  

  

    
      138
    
    
      
          <td></td>


    		
  

  

    
      139
    
    
      
          <td>)</td>


    		
  

  

    
      140
    
    
      
          <td></td><td></td><td></td>


    		
  

  

    
      141
    
    
      
        </tr>


    		
  

  

    
      142
    
    
      
      </table>


    		
  

  

    
      143
    
    
      
</div>


    		
  

  

    
      144
    
    
      
<div class="memdoc">


    		
  

  

    
      145
    
    
      

    		
  

  

    
      146
    
    
      
<p>


    		
  

  

    
      147
    
    
      
send a packet to all robots in Basic Group 


    		
  

  

    
      148
    
    
      
<p>


    		
  

  

    
      149
    
    
      
Send a packet to all robots in Basic Group<p>


    		
  

  

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


    		
  

  

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


    		
  

  

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


    		
  

  

    
      153
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>Packet buffer, data you want to send </td></tr>


    		
  

  

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


    		
  

  

    
      155
    
    
      
  </table>


    		
  

  

    
      156
    
    
      
</dl>


    		
  

  

    
      157
    
    
      

    		
  

  

    
      158
    
    
      
<p>References <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p>


    		
  

  

    
      159
    
    
      

    		
  

  

    
      160
    
    
      
</div>


    		
  

  

    
      161
    
    
      
</div><p>


    		
  

  

    
      162
    
    
      
<a class="anchor" name="gd5d7334484e49cc3cb9ebe2cfc323115"></a><!-- doxytag: member="wl_basic.h::wl_basic_send_robot_packet" ref="gd5d7334484e49cc3cb9ebe2cfc323115" args="(char type, char *data, int len, int dest)" -->


    		
  

  

    
      163
    
    
      
<div class="memitem">


    		
  

  

    
      164
    
    
      
<div class="memproto">


    		
  

  

    
      165
    
    
      
      <table class="memname">


    		
  

  

    
      166
    
    
      
        <tr>


    		
  

  

    
      167
    
    
      
          <td class="memname">void wl_basic_send_robot_packet           </td>


    		
  

  

    
      168
    
    
      
          <td>(</td>


    		
  

  

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


    		
  

  

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


    		
  

  

    
      171
    
    
      
        </tr>


    		
  

  

    
      172
    
    
      
        <tr>


    		
  

  

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


    		
  

  

    
      174
    
    
      
          <td></td>


    		
  

  

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


    		
  

  

    
      176
    
    
      
          <td class="paramname"> <em>data</em>, </td>


    		
  

  

    
      177
    
    
      
        </tr>


    		
  

  

    
      178
    
    
      
        <tr>


    		
  

  

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


    		
  

  

    
      180
    
    
      
          <td></td>


    		
  

  

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


    		
  

  

    
      182
    
    
      
          <td class="paramname"> <em>len</em>, </td>


    		
  

  

    
      183
    
    
      
        </tr>


    		
  

  

    
      184
    
    
      
        <tr>


    		
  

  

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


    		
  

  

    
      186
    
    
      
          <td></td>


    		
  

  

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


    		
  

  

    
      188
    
    
      
          <td class="paramname"> <em>dest</em></td><td>&nbsp;</td>


    		
  

  

    
      189
    
    
      
        </tr>


    		
  

  

    
      190
    
    
      
        <tr>


    		
  

  

    
      191
    
    
      
          <td></td>


    		
  

  

    
      192
    
    
      
          <td>)</td>


    		
  

  

    
      193
    
    
      
          <td></td><td></td><td></td>


    		
  

  

    
      194
    
    
      
        </tr>


    		
  

  

    
      195
    
    
      
      </table>


    		
  

  

    
      196
    
    
      
</div>


    		
  

  

    
      197
    
    
      
<div class="memdoc">


    		
  

  

    
      198
    
    
      

    		
  

  

    
      199
    
    
      
<p>


    		
  

  

    
      200
    
    
      
send a packet to a single robot in Basic Group 


    		
  

  

    
      201
    
    
      
<p>


    		
  

  

    
      202
    
    
      
Send a packet to a single robot in Basic Group<p>


    		
  

  

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


    		
  

  

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


    		
  

  

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


    		
  

  

    
      206
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>Packet buffer, data you want to send </td></tr>


    		
  

  

    
      207
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>Length of the data buffer in bytes  Robot ID of the destination robot </td></tr>


    		
  

  

    
      208
    
    
      
  </table>


    		
  

  

    
      209
    
    
      
</dl>


    		
  

  

    
      210
    
    
      

    		
  

  

    
      211
    
    
      
<p>References <a class="el" href="wireless_8c_source.html#l00252">wl_send_robot_to_robot_global_packet()</a>.</p>


    		
  

  

    
      212
    
    
      

    		
  

  

    
      213
    
    
      
</div>


    		
  

  

    
      214
    
    
      
</div><p>


    		
  

  

    
      215
    
    
      
</div>


    		
  

  

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


    		
  

  

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


    		
  

  

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


    		
  

  

    
      219
    
    
      
</body>


    		
  

  

    
      220
    
    
      
</html>