Project

General

Profile

Revision 241

Updated libdragonfly documentation.

View differences:

wireless_8h-source.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: wireless.h Source File</title>
4 4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 5
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6
</head><body>
7
<!-- Generated by Doxygen 1.4.6 -->
7
<!-- Generated by Doxygen 1.5.3 -->
8 8
<div class="tabs">
9 9
  <ul>
10 10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 11
    <li><a href="modules.html"><span>Modules</span></a></li>
12 12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
    <li id="current"><a href="files.html"><span>Files</span></a></li>
14
  </ul></div>
15
<div class="tabs">
16
  <ul>
17
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
18
    <li><a href="globals.html"><span>Globals</span></a></li>
19
  </ul></div>
13
    <li class="current"><a href="files.html"><span>Files</span></a></li>
14
  </ul>
15
</div>
20 16
<h1>wireless.h</h1><a href="wireless_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
21 17
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef WIRELESS_H</span>
22 18
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define WIRELESS_H</span>
......
26 22
<a name="l00018"></a><a class="code" href="wireless_8h.html#f083cc95511287866eeb4337fdc75eeb">00018</a> <span class="comment"></span><span class="preprocessor">#define WL_MAX_PACKET_GROUPS 16</span>
27 23
<a name="l00019"></a>00019 <span class="preprocessor"></span>
28 24
<a name="l00050"></a><a class="code" href="structPacketGroupHandler.html">00050</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
29
<a name="l00051"></a>00051 <span class="keyword"></span>{
25
<a name="l00051"></a>00051 {
30 26
<a name="l00057"></a><a class="code" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">00057</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> groupCode;
31 27
<a name="l00058"></a>00058 
32 28
<a name="l00063"></a>00063         void (*timeout_handler) (void);
......
40 36
<a name="l00092"></a>00092         
41 37
<a name="l00093"></a>00093 } <a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>;
42 38
<a name="l00094"></a>00094 
43
<a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g629ceefdf83847af356d90e2df27041c">wl_init</a>(<span class="keywordtype">void</span>);
44
<a name="l00098"></a>00098 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2">wl_terminate</a>(<span class="keywordtype">void</span>);
45
<a name="l00100"></a>00100 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703">wl_do</a>(<span class="keywordtype">void</span>);
46
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107">wl_register_packet_group</a>(<a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>* h);
47
<a name="l00104"></a>00104 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wl_unregister_packet_group</a>(<a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>* h);
39
<a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g629ceefdf83847af356d90e2df27041c" title="Initialize the wireless library.">wl_init</a>(<span class="keywordtype">void</span>);
40
<a name="l00098"></a>00098 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2" title="Uninitialize the wireless library.">wl_terminate</a>(<span class="keywordtype">void</span>);
41
<a name="l00100"></a>00100 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do</a>(<span class="keywordtype">void</span>);
42
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107" title="Register a packet group with the wireless library.">wl_register_packet_group</a>(<a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>* h);
43
<a name="l00104"></a>00104 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7" title="Unregister a packet group with the wireless library.">wl_unregister_packet_group</a>(<a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>* h);
48 44
<a name="l00105"></a>00105 
49
<a name="l00107"></a>00107 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#ga7175b13dbfc0b11b341fbe0ad7c637c">wl_send_robot_to_robot_global_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type,
45
<a name="l00107"></a>00107 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#ga7175b13dbfc0b11b341fbe0ad7c637c" title="Send a packet to a specific robot in any PAN.">wl_send_robot_to_robot_global_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type,
50 46
<a name="l00108"></a>00108                 <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest, <span class="keywordtype">char</span> frame);
51
<a name="l00110"></a>00110 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#gafaca74445d215cef2b2e0ae1a1c72ba">wl_send_robot_to_robot_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type,
47
<a name="l00110"></a>00110 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#gafaca74445d215cef2b2e0ae1a1c72ba" title="Send a packet to a specific robot in our PAN.">wl_send_robot_to_robot_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type,
52 48
<a name="l00111"></a>00111                 <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest, <span class="keywordtype">char</span> frame);
53
<a name="l00113"></a>00113 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#gdd534c99c49d5207fe09f02af304c1ad">wl_send_global_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type,
49
<a name="l00113"></a>00113 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#gdd534c99c49d5207fe09f02af304c1ad" title="Send a packet to all robots.">wl_send_global_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type,
54 50
<a name="l00114"></a>00114                 <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">char</span> frame);
55
<a name="l00116"></a>00116 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa">wl_send_pan_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type,
51
<a name="l00116"></a>00116 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa" title="Send a packet to all robots in our PAN.">wl_send_pan_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type,
56 52
<a name="l00117"></a>00117                 <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">char</span> frame);
57 53
<a name="l00118"></a>00118 
58
<a name="l00120"></a>00120 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g211ccf907dce4493813573e20264e542">wl_set_pan</a>(<span class="keywordtype">int</span> pan);
59
<a name="l00122"></a>00122 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a>(<span class="keywordtype">void</span>);
60
<a name="l00124"></a>00124 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba">wl_set_channel</a>(<span class="keywordtype">int</span> channel);
61
<a name="l00126"></a>00126 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a>(<span class="keywordtype">void</span>);
62
<a name="l00128"></a>00128 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g90cb41c855ac3da028e8f1278bd49f4f">wl_get_xbee_id</a>(<span class="keywordtype">void</span>);
63
<a name="l00129"></a>00129  <span class="comment">// end defgroup</span>
64
<a name="l00131"></a>00131 
65
<a name="l00132"></a>00132 <span class="preprocessor">#endif</span>
66
<a name="l00133"></a>00133 <span class="preprocessor"></span>
67
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Oct 31 17:54:43 2007 for libwireless by&nbsp;
54
<a name="l00120"></a>00120 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g211ccf907dce4493813573e20264e542" title="Set the PAN we are using.">wl_set_pan</a>(<span class="keywordtype">int</span> pan);
55
<a name="l00122"></a>00122 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7" title="Get the PAN we are using.">wl_get_pan</a>(<span class="keywordtype">void</span>);
56
<a name="l00124"></a>00124 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba" title="Set the channel we are using.">wl_set_channel</a>(<span class="keywordtype">int</span> channel);
57
<a name="l00126"></a>00126 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b" title="Get the channel we are using.">wl_get_channel</a>(<span class="keywordtype">void</span>);
58
<a name="l00128"></a>00128 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g90cb41c855ac3da028e8f1278bd49f4f" title="Get the 16-bit address of the XBee module.">wl_get_xbee_id</a>(<span class="keywordtype">void</span>);
59
<a name="l00130"></a>00130 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c" title="Set the com port on a computer, undefined on the robot.">wl_set_com_port</a>(<span class="keywordtype">char</span>* port);
60
<a name="l00131"></a>00131  <span class="comment">// end defgroup</span>
61
<a name="l00133"></a>00133 
62
<a name="l00134"></a>00134 <span class="preprocessor">#endif</span>
63
<a name="l00135"></a>00135 <span class="preprocessor"></span>
64
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 22:16:24 2007 for libwireless by&nbsp;
68 65
<a href="http://www.doxygen.org/index.html">
69
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
66
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
70 67
</body>
71 68
</html>

Also available in: Unified diff