root / trunk / docs / libwireless / wireless_8h.html @ 241
History | View | Annotate | Download (9.16 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.h File Reference</title> |
| 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.3 -->
|
| 8 |
<div class="tabs"> |
| 9 |
<ul>
|
| 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 13 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
| 14 |
</ul>
|
| 15 |
</div>
|
| 16 |
<h1>wireless.h File Reference</h1>Contains definitions for the wireless library. <a href="#_details">More...</a> |
| 17 |
<p>
|
| 18 |
|
| 19 |
<p>
|
| 20 |
<a href="wireless_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
| 21 |
<tr><td></td></tr> |
| 22 |
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
| 23 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a></td></tr> |
| 24 |
|
| 25 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="wireless_8h.html#f083cc95511287866eeb4337fdc75eeb">WL_MAX_PACKET_GROUPS</a> 16</td></tr> |
| 27 |
|
| 28 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 29 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g629ceefdf83847af356d90e2df27041c">wl_init</a> (void)</td></tr> |
| 30 |
|
| 31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="group__wireless.html#g629ceefdf83847af356d90e2df27041c"></a><br></td></tr> |
| 32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2">wl_terminate</a> (void)</td></tr> |
| 33 |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the wireless library. <a href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2"></a><br></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703">wl_do</a> (void)</td></tr> |
| 36 |
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform wireless library functionality. <a href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703"></a><br></td></tr> |
| 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107">wl_register_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr> |
| 39 |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a packet group with the wireless library. <a href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107"></a><br></td></tr> |
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wl_unregister_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr> |
| 42 |
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a packet group with the wireless library. <a href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7"></a><br></td></tr> |
| 44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga7175b13dbfc0b11b341fbe0ad7c637c">wl_send_robot_to_robot_global_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr> |
| 45 |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in any PAN. <a href="group__wireless.html#ga7175b13dbfc0b11b341fbe0ad7c637c"></a><br></td></tr> |
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gafaca74445d215cef2b2e0ae1a1c72ba">wl_send_robot_to_robot_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr> |
| 48 |
|
| 49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in our PAN. <a href="group__wireless.html#gafaca74445d215cef2b2e0ae1a1c72ba"></a><br></td></tr> |
| 50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gdd534c99c49d5207fe09f02af304c1ad">wl_send_global_packet</a> (char group, char type, char *data, int len, char frame)</td></tr> |
| 51 |
|
| 52 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots. <a href="group__wireless.html#gdd534c99c49d5207fe09f02af304c1ad"></a><br></td></tr> |
| 53 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa">wl_send_pan_packet</a> (char group, char type, char *data, int len, char frame)</td></tr> |
| 54 |
|
| 55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots in our PAN. <a href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa"></a><br></td></tr> |
| 56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g211ccf907dce4493813573e20264e542">wl_set_pan</a> (int pan)</td></tr> |
| 57 |
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN we are using. <a href="group__wireless.html#g211ccf907dce4493813573e20264e542"></a><br></td></tr> |
| 59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a> (void)</td></tr> |
| 60 |
|
| 61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the PAN we are using. <a href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br></td></tr> |
| 62 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba">wl_set_channel</a> (int channel)</td></tr> |
| 63 |
|
| 64 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel we are using. <a href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba"></a><br></td></tr> |
| 65 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a> (void)</td></tr> |
| 66 |
|
| 67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel we are using. <a href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b"></a><br></td></tr> |
| 68 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g90cb41c855ac3da028e8f1278bd49f4f">wl_get_xbee_id</a> (void)</td></tr> |
| 69 |
|
| 70 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the 16-bit address of the XBee module. <a href="group__wireless.html#g90cb41c855ac3da028e8f1278bd49f4f"></a><br></td></tr> |
| 71 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g344dead0023100eb40f8670a92c9ce5c"></a><!-- doxytag: member="wireless.h::wl_set_com_port" ref="g344dead0023100eb40f8670a92c9ce5c" args="(char *port)" --> |
| 72 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr> |
| 73 |
|
| 74 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr> |
| 75 |
</table>
|
| 76 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 77 |
Contains definitions for the wireless library. |
| 78 |
<p>
|
| 79 |
Contains functions for the wireless library.<p>
|
| 80 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
| 81 |
<hr><h2>Define Documentation</h2> |
| 82 |
<a class="anchor" name="f083cc95511287866eeb4337fdc75eeb"></a><!-- doxytag: member="wireless.h::WL_MAX_PACKET_GROUPS" ref="f083cc95511287866eeb4337fdc75eeb" args="" --> |
| 83 |
<div class="memitem"> |
| 84 |
<div class="memproto"> |
| 85 |
<table class="memname"> |
| 86 |
<tr>
|
| 87 |
<td class="memname">#define WL_MAX_PACKET_GROUPS 16 </td> |
| 88 |
</tr>
|
| 89 |
</table>
|
| 90 |
</div>
|
| 91 |
<div class="memdoc"> |
| 92 |
|
| 93 |
<p>
|
| 94 |
The maximum number of packet groups. |
| 95 |
</div>
|
| 96 |
</div><p> |
| 97 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 22:16:24 2007 for libwireless by |
| 98 |
<a href="http://www.doxygen.org/index.html"> |
| 99 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
| 100 |
</body>
|
| 101 |
</html>
|