root / trunk / docs / libwireless / wireless_8h.html @ 192
History | View | Annotate | Download (8.96 KB)
| 1 | 19 | bcoltin | <!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"> |
||
| 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.4.6 -->
|
||
| 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 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 List</span></a></li> |
||
| 18 | <li><a href="globals.html"><span>Globals</span></a></li> |
||
| 19 | </ul></div> |
||
| 20 | <h1>wireless.h File Reference</h1>Contains definitions for the wireless library. <a href="#_details">More...</a> |
||
| 21 | <p>
|
||
| 22 | |||
| 23 | <p>
|
||
| 24 | <a href="wireless_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
| 25 | <tr><td></td></tr> |
||
| 26 | <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
||
| 27 | <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> |
||
| 28 | |||
| 29 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
| 30 | <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> |
||
| 31 | |||
| 32 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
| 33 | <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> |
||
| 34 | |||
| 35 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="group__wireless.html#g629ceefdf83847af356d90e2df27041c"></a><br></td></tr> |
||
| 36 | <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> |
||
| 37 | |||
| 38 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the wireless library. <a href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2"></a><br></td></tr> |
||
| 39 | <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> |
||
| 40 | |||
| 41 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Perform wireless library functionality. <a href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703"></a><br></td></tr> |
||
| 42 | <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> |
||
| 43 | |||
| 44 | <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> |
||
| 45 | <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> |
||
| 46 | |||
| 47 | <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> |
||
| 48 | <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> |
||
| 49 | |||
| 50 | <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> |
||
| 51 | <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> |
||
| 52 | |||
| 53 | <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> |
||
| 54 | <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> |
||
| 55 | |||
| 56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots. <a href="group__wireless.html#gdd534c99c49d5207fe09f02af304c1ad"></a><br></td></tr> |
||
| 57 | <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> |
||
| 58 | |||
| 59 | <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> |
||
| 60 | 60 | bcoltin | <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> |
| 61 | |||
| 62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN we are using. <a href="group__wireless.html#g211ccf907dce4493813573e20264e542"></a><br></td></tr> |
||
| 63 | <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> |
||
| 64 | |||
| 65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the PAN we are using. <a href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br></td></tr> |
||
| 66 | <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> |
||
| 67 | |||
| 68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel we are using. <a href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba"></a><br></td></tr> |
||
| 69 | <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> |
||
| 70 | |||
| 71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel we are using. <a href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b"></a><br></td></tr> |
||
| 72 | 19 | bcoltin | <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> |
| 73 | |||
| 74 | <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> |
||
| 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 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="" --><p> |
||
| 83 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
| 84 | <tr>
|
||
| 85 | <td class="mdRow"> |
||
| 86 | <table cellpadding="0" cellspacing="0" border="0"> |
||
| 87 | <tr>
|
||
| 88 | <td class="md" nowrap valign="top">#define WL_MAX_PACKET_GROUPS 16 </td> |
||
| 89 | </tr>
|
||
| 90 | </table>
|
||
| 91 | </td>
|
||
| 92 | </tr>
|
||
| 93 | </table>
|
||
| 94 | <table cellspacing="5" cellpadding="0" border="0"> |
||
| 95 | <tr>
|
||
| 96 | <td>
|
||
| 97 |
|
||
| 98 | </td>
|
||
| 99 | <td>
|
||
| 100 | |||
| 101 | <p>
|
||
| 102 | The maximum number of packet groups. </td>
|
||
| 103 | </tr>
|
||
| 104 | </table>
|
||
| 105 | 192 | bcoltin | <hr size="1"><address style="align: right;"><small>Generated on Wed Oct 31 17:54:43 2007 for libwireless by |
| 106 | 19 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
| 107 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
||
| 108 | </body>
|
||
| 109 | </html> |