Revision 689
Isn't used anymore. Getting rid of it.
| branches/battery/docs/libwireless/index.html | ||
|---|---|---|
| 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: Main Page</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 class="current"><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><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 16 |
<h1>libwireless Documentation</h1> |
|
| 17 |
<p> |
|
| 18 |
<h3 align="center">1.0 </h3><hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:22 2007 for libwireless by |
|
| 19 |
<a href="http://www.doxygen.org/index.html"> |
|
| 20 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
| 21 |
</body> |
|
| 22 |
</html> |
|
| branches/battery/docs/libwireless/modules.html | ||
|---|---|---|
| 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: Module Index</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 class="current"><a href="modules.html"><span>Modules</span></a></li> |
|
| 12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 16 |
<h1>libwireless Modules</h1>Here is a list of all modules:<ul> |
|
| 17 |
<li><a class="el" href="group__queue.html">Queue</a> |
|
| 18 |
<li><a class="el" href="group__sensormatrix.html">Sensor Matrix</a> |
|
| 19 |
<li><a class="el" href="group__wireless.html">Wireless</a> |
|
| 20 |
<li><a class="el" href="group__wlerror.html">Error Packets</a> |
|
| 21 |
<li><a class="el" href="group__tokenring.html">Token Ring</a> |
|
| 22 |
<li><a class="el" href="group__xbee.html">XBee</a> |
|
| 23 |
</ul> |
|
| 24 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:23 2007 for libwireless by |
|
| 25 |
<a href="http://www.doxygen.org/index.html"> |
|
| 26 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
| 27 |
</body> |
|
| 28 |
</html> |
|
| branches/battery/docs/libwireless/group__wireless.html | ||
|---|---|---|
| 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</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><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 16 |
<h1>Wireless</h1>Wireless definitions. |
|
| 17 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 18 |
<tr><td></td></tr> |
|
| 19 |
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
|
| 20 |
<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> |
|
| 21 |
|
|
| 22 |
<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> |
|
| 23 |
|
|
| 24 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
| 25 |
<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> |
|
| 26 |
|
|
| 27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="#g629ceefdf83847af356d90e2df27041c"></a><br></td></tr> |
|
| 28 |
<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> |
|
| 29 |
|
|
| 30 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the wireless library. <a href="#g66075ff87a1c9f2c0d7938a26c7830f2"></a><br></td></tr> |
|
| 31 |
<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> |
|
| 32 |
|
|
| 33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform wireless library functionality. <a href="#g5c1f1a0e20fc718e59edc29246afd703"></a><br></td></tr> |
|
| 34 |
<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> |
|
| 35 |
|
|
| 36 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a packet group with the wireless library. <a href="#g183343ed0594ec1c2b79bb4085d57107"></a><br></td></tr> |
|
| 37 |
<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> |
|
| 38 |
|
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a packet group with the wireless library. <a href="#gcdbedf6465798abc7af3bf5fea3d4dd7"></a><br></td></tr> |
|
| 40 |
<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> |
|
| 41 |
|
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in any PAN. <a href="#ga7175b13dbfc0b11b341fbe0ad7c637c"></a><br></td></tr> |
|
| 43 |
<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> |
|
| 44 |
|
|
| 45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in our PAN. <a href="#gafaca74445d215cef2b2e0ae1a1c72ba"></a><br></td></tr> |
|
| 46 |
<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> |
|
| 47 |
|
|
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots. <a href="#gdd534c99c49d5207fe09f02af304c1ad"></a><br></td></tr> |
|
| 49 |
<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> |
|
| 50 |
|
|
| 51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots in our PAN. <a href="#g0a1a0e4d885f0e0dde87160a16daa0aa"></a><br></td></tr> |
|
| 52 |
<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> |
|
| 53 |
|
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN we are using. <a href="#g211ccf907dce4493813573e20264e542"></a><br></td></tr> |
|
| 55 |
<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> |
|
| 56 |
|
|
| 57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the PAN we are using. <a href="#g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br></td></tr> |
|
| 58 |
<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> |
|
| 59 |
|
|
| 60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel we are using. <a href="#g9aac809e57c9eb93a2905ed544c93aba"></a><br></td></tr> |
|
| 61 |
<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> |
|
| 62 |
|
|
| 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel we are using. <a href="#g2d65d3e35b193da4213755c4bf61ab6b"></a><br></td></tr> |
|
| 64 |
<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> |
|
| 65 |
|
|
| 66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the 16-bit address of the XBee module. <a href="#g90cb41c855ac3da028e8f1278bd49f4f"></a><br></td></tr> |
|
| 67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g344dead0023100eb40f8670a92c9ce5c"></a><!-- doxytag: member="wireless::wl_set_com_port" ref="g344dead0023100eb40f8670a92c9ce5c" args="(char *port)" --> |
|
| 68 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr> |
|
| 69 |
|
|
| 70 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr> |
|
| 71 |
</table> |
|
| 72 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
| 73 |
Wireless definitions. |
|
| 74 |
<p> |
|
| 75 |
Contains functions and definitions for dealing with wireless functionality.<br> |
|
| 76 |
<br> |
|
| 77 |
<p> |
|
| 78 |
The wireless library provides a modular method for dealing with wireless packets, by allowing packet groups to be registered. A packet group is a collection of packets which share a packet group code. Each packet in the group also has a type. A packet group code and type are sent with each packet. When a packet with a group code registered in the wireless library is received, the corresponding event handler is called. The event handler uses the packet type and other information stored in the packet to respond.<br> |
|
| 79 |
<br> |
|
| 80 |
<p> |
|
| 81 |
This architecture allows different wireless functionality to be defined and handled separately, making it simpler and more efficient to take advantage of the XBee's wireless functionality. <hr><h2>Function Documentation</h2> |
|
| 82 |
<a class="anchor" name="g5c1f1a0e20fc718e59edc29246afd703"></a><!-- doxytag: member="wireless.h::wl_do" ref="g5c1f1a0e20fc718e59edc29246afd703" args="(void)" --> |
|
| 83 |
<div class="memitem"> |
|
| 84 |
<div class="memproto"> |
|
| 85 |
<table class="memname"> |
|
| 86 |
<tr> |
|
| 87 |
<td class="memname">void wl_do </td> |
|
| 88 |
<td>(</td> |
|
| 89 |
<td class="paramtype">void </td> |
|
| 90 |
<td class="paramname"> </td> |
|
| 91 |
<td> ) </td> |
|
| 92 |
<td width="100%"></td> |
|
| 93 |
</tr> |
|
| 94 |
</table> |
|
| 95 |
</div> |
|
| 96 |
<div class="memdoc"> |
|
| 97 |
|
|
| 98 |
<p> |
|
| 99 |
Perform wireless library functionality. |
|
| 100 |
<p> |
|
| 101 |
Performs wireless library functionality. This function must be called frequently for wireless to perform effectively. This function will call timeout handlers, as well as received packet and transmit status handlers. |
|
| 102 |
</div> |
|
| 103 |
</div><p> |
|
| 104 |
<a class="anchor" name="g2d65d3e35b193da4213755c4bf61ab6b"></a><!-- doxytag: member="wireless.h::wl_get_channel" ref="g2d65d3e35b193da4213755c4bf61ab6b" args="(void)" --> |
|
| 105 |
<div class="memitem"> |
|
| 106 |
<div class="memproto"> |
|
| 107 |
<table class="memname"> |
|
| 108 |
<tr> |
|
| 109 |
<td class="memname">int wl_get_channel </td> |
|
| 110 |
<td>(</td> |
|
| 111 |
<td class="paramtype">void </td> |
|
| 112 |
<td class="paramname"> </td> |
|
| 113 |
<td> ) </td> |
|
| 114 |
<td width="100%"></td> |
|
| 115 |
</tr> |
|
| 116 |
</table> |
|
| 117 |
</div> |
|
| 118 |
<div class="memdoc"> |
|
| 119 |
|
|
| 120 |
<p> |
|
| 121 |
Get the channel we are using. |
|
| 122 |
<p> |
|
| 123 |
Get the channel the XBee is part of.<p> |
|
| 124 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is part of</dd></dl> |
|
| 125 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba" title="Set the channel we are using.">wl_set_channel</a> </dd></dl> |
|
| 126 |
|
|
| 127 |
</div> |
|
| 128 |
</div><p> |
|
| 129 |
<a class="anchor" name="g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><!-- doxytag: member="wireless.h::wl_get_pan" ref="g4e6b5c97d40a8e7557a1b4b90a7d34f7" args="(void)" --> |
|
| 130 |
<div class="memitem"> |
|
| 131 |
<div class="memproto"> |
|
| 132 |
<table class="memname"> |
|
| 133 |
<tr> |
|
| 134 |
<td class="memname">int wl_get_pan </td> |
|
| 135 |
<td>(</td> |
|
| 136 |
<td class="paramtype">void </td> |
|
| 137 |
<td class="paramname"> </td> |
|
| 138 |
<td> ) </td> |
|
| 139 |
<td width="100%"></td> |
|
| 140 |
</tr> |
|
| 141 |
</table> |
|
| 142 |
</div> |
|
| 143 |
<div class="memdoc"> |
|
| 144 |
|
|
| 145 |
<p> |
|
| 146 |
Get the PAN we are using. |
|
| 147 |
<p> |
|
| 148 |
Get the PAN the XBee is currently part of.<p> |
|
| 149 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the PAN of the XBee</dd></dl> |
|
| 150 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g211ccf907dce4493813573e20264e542" title="Set the PAN we are using.">wl_set_pan</a> </dd></dl> |
|
| 151 |
|
|
| 152 |
</div> |
|
| 153 |
</div><p> |
|
| 154 |
<a class="anchor" name="g90cb41c855ac3da028e8f1278bd49f4f"></a><!-- doxytag: member="wireless.h::wl_get_xbee_id" ref="g90cb41c855ac3da028e8f1278bd49f4f" args="(void)" --> |
|
| 155 |
<div class="memitem"> |
|
| 156 |
<div class="memproto"> |
|
| 157 |
<table class="memname"> |
|
| 158 |
<tr> |
|
| 159 |
<td class="memname">unsigned int wl_get_xbee_id </td> |
|
| 160 |
<td>(</td> |
|
| 161 |
<td class="paramtype">void </td> |
|
| 162 |
<td class="paramname"> </td> |
|
| 163 |
<td> ) </td> |
|
| 164 |
<td width="100%"></td> |
|
| 165 |
</tr> |
|
| 166 |
</table> |
|
| 167 |
</div> |
|
| 168 |
<div class="memdoc"> |
|
| 169 |
|
|
| 170 |
<p> |
|
| 171 |
Get the 16-bit address of the XBee module. |
|
| 172 |
<p> |
|
| 173 |
Returns the 16-bit address of the XBee module.<p> |
|
| 174 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee module. </dd></dl> |
|
| 175 |
|
|
| 176 |
</div> |
|
| 177 |
</div><p> |
|
| 178 |
<a class="anchor" name="g629ceefdf83847af356d90e2df27041c"></a><!-- doxytag: member="wireless.h::wl_init" ref="g629ceefdf83847af356d90e2df27041c" args="(void)" --> |
|
| 179 |
<div class="memitem"> |
|
| 180 |
<div class="memproto"> |
|
| 181 |
<table class="memname"> |
|
| 182 |
<tr> |
|
| 183 |
<td class="memname">void wl_init </td> |
|
| 184 |
<td>(</td> |
|
| 185 |
<td class="paramtype">void </td> |
|
| 186 |
<td class="paramname"> </td> |
|
| 187 |
<td> ) </td> |
|
| 188 |
<td width="100%"></td> |
|
| 189 |
</tr> |
|
| 190 |
</table> |
|
| 191 |
</div> |
|
| 192 |
<div class="memdoc"> |
|
| 193 |
|
|
| 194 |
<p> |
|
| 195 |
Initialize the wireless library. |
|
| 196 |
<p> |
|
| 197 |
Initializes the wireless library. Must be called before any other function. |
|
| 198 |
</div> |
|
| 199 |
</div><p> |
|
| 200 |
<a class="anchor" name="g183343ed0594ec1c2b79bb4085d57107"></a><!-- doxytag: member="wireless.h::wl_register_packet_group" ref="g183343ed0594ec1c2b79bb4085d57107" args="(PacketGroupHandler *h)" --> |
|
| 201 |
<div class="memitem"> |
|
| 202 |
<div class="memproto"> |
|
| 203 |
<table class="memname"> |
|
| 204 |
<tr> |
|
| 205 |
<td class="memname">void wl_register_packet_group </td> |
|
| 206 |
<td>(</td> |
|
| 207 |
<td class="paramtype"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> * </td> |
|
| 208 |
<td class="paramname"> <em>h</em> </td> |
|
| 209 |
<td> ) </td> |
|
| 210 |
<td width="100%"></td> |
|
| 211 |
</tr> |
|
| 212 |
</table> |
|
| 213 |
</div> |
|
| 214 |
<div class="memdoc"> |
|
| 215 |
|
|
| 216 |
<p> |
|
| 217 |
Register a packet group with the wireless library. |
|
| 218 |
<p> |
|
| 219 |
Register a packet group with the wireless library. The event handlers in the packet group will be called whenever an event dealing with the packet group's group code occurs.<p> |
|
| 220 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 221 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 222 |
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>the <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> to register </td></tr> |
|
| 223 |
</table> |
|
| 224 |
</dl> |
|
| 225 |
|
|
| 226 |
</div> |
|
| 227 |
</div><p> |
|
| 228 |
<a class="anchor" name="gdd534c99c49d5207fe09f02af304c1ad"></a><!-- doxytag: member="wireless.h::wl_send_global_packet" ref="gdd534c99c49d5207fe09f02af304c1ad" args="(char group, char type, char *data, int len, char frame)" --> |
|
| 229 |
<div class="memitem"> |
|
| 230 |
<div class="memproto"> |
|
| 231 |
<table class="memname"> |
|
| 232 |
<tr> |
|
| 233 |
<td class="memname">void wl_send_global_packet </td> |
|
| 234 |
<td>(</td> |
|
| 235 |
<td class="paramtype">char </td> |
|
| 236 |
<td class="paramname"> <em>group</em>, </td> |
|
| 237 |
</tr> |
|
| 238 |
<tr> |
|
| 239 |
<td class="paramkey"></td> |
|
| 240 |
<td></td> |
|
| 241 |
<td class="paramtype">char </td> |
|
| 242 |
<td class="paramname"> <em>type</em>, </td> |
|
| 243 |
</tr> |
|
| 244 |
<tr> |
|
| 245 |
<td class="paramkey"></td> |
|
| 246 |
<td></td> |
|
| 247 |
<td class="paramtype">char * </td> |
|
| 248 |
<td class="paramname"> <em>data</em>, </td> |
|
| 249 |
</tr> |
|
| 250 |
<tr> |
|
| 251 |
<td class="paramkey"></td> |
|
| 252 |
<td></td> |
|
| 253 |
<td class="paramtype">int </td> |
|
| 254 |
<td class="paramname"> <em>len</em>, </td> |
|
| 255 |
</tr> |
|
| 256 |
<tr> |
|
| 257 |
<td class="paramkey"></td> |
|
| 258 |
<td></td> |
|
| 259 |
<td class="paramtype">char </td> |
|
| 260 |
<td class="paramname"> <em>frame</em></td><td> </td> |
|
| 261 |
</tr> |
|
| 262 |
<tr> |
|
| 263 |
<td></td> |
|
| 264 |
<td>)</td> |
|
| 265 |
<td></td><td></td><td width="100%"></td> |
|
| 266 |
</tr> |
|
| 267 |
</table> |
|
| 268 |
</div> |
|
| 269 |
<div class="memdoc"> |
|
| 270 |
|
|
| 271 |
<p> |
|
| 272 |
Send a packet to all robots. |
|
| 273 |
<p> |
|
| 274 |
Send a packet to all XBees in all PANs.<p> |
|
| 275 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 276 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 277 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
|
| 278 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
|
| 279 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
|
| 280 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
|
| 281 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
|
| 282 |
</table> |
|
| 283 |
</dl> |
|
| 284 |
|
|
| 285 |
</div> |
|
| 286 |
</div><p> |
|
| 287 |
<a class="anchor" name="g0a1a0e4d885f0e0dde87160a16daa0aa"></a><!-- doxytag: member="wireless.h::wl_send_pan_packet" ref="g0a1a0e4d885f0e0dde87160a16daa0aa" args="(char group, char type, char *data, int len, char frame)" --> |
|
| 288 |
<div class="memitem"> |
|
| 289 |
<div class="memproto"> |
|
| 290 |
<table class="memname"> |
|
| 291 |
<tr> |
|
| 292 |
<td class="memname">void wl_send_pan_packet </td> |
|
| 293 |
<td>(</td> |
|
| 294 |
<td class="paramtype">char </td> |
|
| 295 |
<td class="paramname"> <em>group</em>, </td> |
|
| 296 |
</tr> |
|
| 297 |
<tr> |
|
| 298 |
<td class="paramkey"></td> |
|
| 299 |
<td></td> |
|
| 300 |
<td class="paramtype">char </td> |
|
| 301 |
<td class="paramname"> <em>type</em>, </td> |
|
| 302 |
</tr> |
|
| 303 |
<tr> |
|
| 304 |
<td class="paramkey"></td> |
|
| 305 |
<td></td> |
|
| 306 |
<td class="paramtype">char * </td> |
|
| 307 |
<td class="paramname"> <em>data</em>, </td> |
|
| 308 |
</tr> |
|
| 309 |
<tr> |
|
| 310 |
<td class="paramkey"></td> |
|
| 311 |
<td></td> |
|
| 312 |
<td class="paramtype">int </td> |
|
| 313 |
<td class="paramname"> <em>len</em>, </td> |
|
| 314 |
</tr> |
|
| 315 |
<tr> |
|
| 316 |
<td class="paramkey"></td> |
|
| 317 |
<td></td> |
|
| 318 |
<td class="paramtype">char </td> |
|
| 319 |
<td class="paramname"> <em>frame</em></td><td> </td> |
|
| 320 |
</tr> |
|
| 321 |
<tr> |
|
| 322 |
<td></td> |
|
| 323 |
<td>)</td> |
|
| 324 |
<td></td><td></td><td width="100%"></td> |
|
| 325 |
</tr> |
|
| 326 |
</table> |
|
| 327 |
</div> |
|
| 328 |
<div class="memdoc"> |
|
| 329 |
|
|
| 330 |
<p> |
|
| 331 |
Send a packet to all robots in our PAN. |
|
| 332 |
<p> |
|
| 333 |
Send a packet to all XBee's in the same PAN.<p> |
|
| 334 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 335 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 336 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
|
| 337 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
|
| 338 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
|
| 339 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
|
| 340 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
|
| 341 |
</table> |
|
| 342 |
</dl> |
|
| 343 |
|
|
| 344 |
</div> |
|
| 345 |
</div><p> |
|
| 346 |
<a class="anchor" name="ga7175b13dbfc0b11b341fbe0ad7c637c"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_global_packet" ref="ga7175b13dbfc0b11b341fbe0ad7c637c" args="(char group, char type, char *data, int len, int dest, char frame)" --> |
|
| 347 |
<div class="memitem"> |
|
| 348 |
<div class="memproto"> |
|
| 349 |
<table class="memname"> |
|
| 350 |
<tr> |
|
| 351 |
<td class="memname">void wl_send_robot_to_robot_global_packet </td> |
|
| 352 |
<td>(</td> |
|
| 353 |
<td class="paramtype">char </td> |
|
| 354 |
<td class="paramname"> <em>group</em>, </td> |
|
| 355 |
</tr> |
|
| 356 |
<tr> |
|
| 357 |
<td class="paramkey"></td> |
|
| 358 |
<td></td> |
|
| 359 |
<td class="paramtype">char </td> |
|
| 360 |
<td class="paramname"> <em>type</em>, </td> |
|
| 361 |
</tr> |
|
| 362 |
<tr> |
|
| 363 |
<td class="paramkey"></td> |
|
| 364 |
<td></td> |
|
| 365 |
<td class="paramtype">char * </td> |
|
| 366 |
<td class="paramname"> <em>data</em>, </td> |
|
| 367 |
</tr> |
|
| 368 |
<tr> |
|
| 369 |
<td class="paramkey"></td> |
|
| 370 |
<td></td> |
|
| 371 |
<td class="paramtype">int </td> |
|
| 372 |
<td class="paramname"> <em>len</em>, </td> |
|
| 373 |
</tr> |
|
| 374 |
<tr> |
|
| 375 |
<td class="paramkey"></td> |
|
| 376 |
<td></td> |
|
| 377 |
<td class="paramtype">int </td> |
|
| 378 |
<td class="paramname"> <em>dest</em>, </td> |
|
| 379 |
</tr> |
|
| 380 |
<tr> |
|
| 381 |
<td class="paramkey"></td> |
|
| 382 |
<td></td> |
|
| 383 |
<td class="paramtype">char </td> |
|
| 384 |
<td class="paramname"> <em>frame</em></td><td> </td> |
|
| 385 |
</tr> |
|
| 386 |
<tr> |
|
| 387 |
<td></td> |
|
| 388 |
<td>)</td> |
|
| 389 |
<td></td><td></td><td width="100%"></td> |
|
| 390 |
</tr> |
|
| 391 |
</table> |
|
| 392 |
</div> |
|
| 393 |
<div class="memdoc"> |
|
| 394 |
|
|
| 395 |
<p> |
|
| 396 |
Send a packet to a specific robot in any PAN. |
|
| 397 |
<p> |
|
| 398 |
Send a packet to a specific XBee without specifying a PAN.<p> |
|
| 399 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 400 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 401 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
|
| 402 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
|
| 403 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
|
| 404 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
|
| 405 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the 16-bit address of the XBee to send the packet to </td></tr> |
|
| 406 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
|
| 407 |
</table> |
|
| 408 |
</dl> |
|
| 409 |
|
|
| 410 |
</div> |
|
| 411 |
</div><p> |
|
| 412 |
<a class="anchor" name="gafaca74445d215cef2b2e0ae1a1c72ba"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_packet" ref="gafaca74445d215cef2b2e0ae1a1c72ba" args="(char group, char type, char *data, int len, int dest, char frame)" --> |
|
| 413 |
<div class="memitem"> |
|
| 414 |
<div class="memproto"> |
|
| 415 |
<table class="memname"> |
|
| 416 |
<tr> |
|
| 417 |
<td class="memname">void wl_send_robot_to_robot_packet </td> |
|
| 418 |
<td>(</td> |
|
| 419 |
<td class="paramtype">char </td> |
|
| 420 |
<td class="paramname"> <em>group</em>, </td> |
|
| 421 |
</tr> |
|
| 422 |
<tr> |
|
| 423 |
<td class="paramkey"></td> |
|
| 424 |
<td></td> |
|
| 425 |
<td class="paramtype">char </td> |
|
| 426 |
<td class="paramname"> <em>type</em>, </td> |
|
| 427 |
</tr> |
|
| 428 |
<tr> |
|
| 429 |
<td class="paramkey"></td> |
|
| 430 |
<td></td> |
|
| 431 |
<td class="paramtype">char * </td> |
|
| 432 |
<td class="paramname"> <em>data</em>, </td> |
|
| 433 |
</tr> |
|
| 434 |
<tr> |
|
| 435 |
<td class="paramkey"></td> |
|
| 436 |
<td></td> |
|
| 437 |
<td class="paramtype">int </td> |
|
| 438 |
<td class="paramname"> <em>len</em>, </td> |
|
| 439 |
</tr> |
|
| 440 |
<tr> |
|
| 441 |
<td class="paramkey"></td> |
|
| 442 |
<td></td> |
|
| 443 |
<td class="paramtype">int </td> |
|
| 444 |
<td class="paramname"> <em>dest</em>, </td> |
|
| 445 |
</tr> |
|
| 446 |
<tr> |
|
| 447 |
<td class="paramkey"></td> |
|
| 448 |
<td></td> |
|
| 449 |
<td class="paramtype">char </td> |
|
| 450 |
<td class="paramname"> <em>frame</em></td><td> </td> |
|
| 451 |
</tr> |
|
| 452 |
<tr> |
|
| 453 |
<td></td> |
|
| 454 |
<td>)</td> |
|
| 455 |
<td></td><td></td><td width="100%"></td> |
|
| 456 |
</tr> |
|
| 457 |
</table> |
|
| 458 |
</div> |
|
| 459 |
<div class="memdoc"> |
|
| 460 |
|
|
| 461 |
<p> |
|
| 462 |
Send a packet to a specific robot in our PAN. |
|
| 463 |
<p> |
|
| 464 |
Send a packet to a specific XBee in the same PAN.<p> |
|
| 465 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 466 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 467 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
|
| 468 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
|
| 469 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
|
| 470 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
|
| 471 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the 16-bit address of the XBee to send the packet to </td></tr> |
|
| 472 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
|
| 473 |
</table> |
|
| 474 |
</dl> |
|
| 475 |
|
|
| 476 |
</div> |
|
| 477 |
</div><p> |
|
| 478 |
<a class="anchor" name="g9aac809e57c9eb93a2905ed544c93aba"></a><!-- doxytag: member="wireless.h::wl_set_channel" ref="g9aac809e57c9eb93a2905ed544c93aba" args="(int channel)" --> |
|
| 479 |
<div class="memitem"> |
|
| 480 |
<div class="memproto"> |
|
| 481 |
<table class="memname"> |
|
| 482 |
<tr> |
|
| 483 |
<td class="memname">void wl_set_channel </td> |
|
| 484 |
<td>(</td> |
|
| 485 |
<td class="paramtype">int </td> |
|
| 486 |
<td class="paramname"> <em>channel</em> </td> |
|
| 487 |
<td> ) </td> |
|
| 488 |
<td width="100%"></td> |
|
| 489 |
</tr> |
|
| 490 |
</table> |
|
| 491 |
</div> |
|
| 492 |
<div class="memdoc"> |
|
| 493 |
|
|
| 494 |
<p> |
|
| 495 |
Set the channel we are using. |
|
| 496 |
<p> |
|
| 497 |
Set the channel the XBee is listening to.<p> |
|
| 498 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 499 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 500 |
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>the new channel to join</td></tr> |
|
| 501 |
</table> |
|
| 502 |
</dl> |
|
| 503 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b" title="Get the channel we are using.">wl_get_channel</a> </dd></dl> |
|
| 504 |
|
|
| 505 |
</div> |
|
| 506 |
</div><p> |
|
| 507 |
<a class="anchor" name="g211ccf907dce4493813573e20264e542"></a><!-- doxytag: member="wireless.h::wl_set_pan" ref="g211ccf907dce4493813573e20264e542" args="(int pan)" --> |
|
| 508 |
<div class="memitem"> |
|
| 509 |
<div class="memproto"> |
|
| 510 |
<table class="memname"> |
|
| 511 |
<tr> |
|
| 512 |
<td class="memname">void wl_set_pan </td> |
|
| 513 |
<td>(</td> |
|
| 514 |
<td class="paramtype">int </td> |
|
| 515 |
<td class="paramname"> <em>pan</em> </td> |
|
| 516 |
<td> ) </td> |
|
| 517 |
<td width="100%"></td> |
|
| 518 |
</tr> |
|
| 519 |
</table> |
|
| 520 |
</div> |
|
| 521 |
<div class="memdoc"> |
|
| 522 |
|
|
| 523 |
<p> |
|
| 524 |
Set the PAN we are using. |
|
| 525 |
<p> |
|
| 526 |
Set the PAN for the XBee to join.<p> |
|
| 527 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 528 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 529 |
<tr><td valign="top"></td><td valign="top"><em>pan</em> </td><td>the new PAN</td></tr> |
|
| 530 |
</table> |
|
| 531 |
</dl> |
|
| 532 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7" title="Get the PAN we are using.">wl_get_pan</a> </dd></dl> |
|
| 533 |
|
|
| 534 |
</div> |
|
| 535 |
</div><p> |
|
| 536 |
<a class="anchor" name="g66075ff87a1c9f2c0d7938a26c7830f2"></a><!-- doxytag: member="wireless.h::wl_terminate" ref="g66075ff87a1c9f2c0d7938a26c7830f2" args="(void)" --> |
|
| 537 |
<div class="memitem"> |
|
| 538 |
<div class="memproto"> |
|
| 539 |
<table class="memname"> |
|
| 540 |
<tr> |
|
| 541 |
<td class="memname">void wl_terminate </td> |
|
| 542 |
<td>(</td> |
|
| 543 |
<td class="paramtype">void </td> |
|
| 544 |
<td class="paramname"> </td> |
|
| 545 |
<td> ) </td> |
|
| 546 |
<td width="100%"></td> |
|
| 547 |
</tr> |
|
| 548 |
</table> |
|
| 549 |
</div> |
|
| 550 |
<div class="memdoc"> |
|
| 551 |
|
|
| 552 |
<p> |
|
| 553 |
Uninitialize the wireless library. |
|
| 554 |
<p> |
|
| 555 |
Uninitializes the wireless library. |
|
| 556 |
</div> |
|
| 557 |
</div><p> |
|
| 558 |
<a class="anchor" name="gcdbedf6465798abc7af3bf5fea3d4dd7"></a><!-- doxytag: member="wireless.h::wl_unregister_packet_group" ref="gcdbedf6465798abc7af3bf5fea3d4dd7" args="(PacketGroupHandler *h)" --> |
|
| 559 |
<div class="memitem"> |
|
| 560 |
<div class="memproto"> |
|
| 561 |
<table class="memname"> |
|
| 562 |
<tr> |
|
| 563 |
<td class="memname">void wl_unregister_packet_group </td> |
|
| 564 |
<td>(</td> |
|
| 565 |
<td class="paramtype"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> * </td> |
|
| 566 |
<td class="paramname"> <em>h</em> </td> |
|
| 567 |
<td> ) </td> |
|
| 568 |
<td width="100%"></td> |
|
| 569 |
</tr> |
|
| 570 |
</table> |
|
| 571 |
</div> |
|
| 572 |
<div class="memdoc"> |
|
| 573 |
|
|
| 574 |
<p> |
|
| 575 |
Unregister a packet group with the wireless library. |
|
| 576 |
<p> |
|
| 577 |
Unregister a packet group from the wireless library.<p> |
|
| 578 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 579 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 580 |
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>the packet group to remove </td></tr> |
|
| 581 |
</table> |
|
| 582 |
</dl> |
|
| 583 |
|
|
| 584 |
</div> |
|
| 585 |
</div><p> |
|
| 586 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:23 2007 for libwireless by |
|
| 587 |
<a href="http://www.doxygen.org/index.html"> |
|
| 588 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
| 589 |
</body> |
|
| 590 |
</html> |
|
| branches/battery/docs/libwireless/group__tokenring.html | ||
|---|---|---|
| 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: Token Ring</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><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 16 |
<h1>Token Ring</h1>Wireless library token ring implementation. |
|
| 17 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 18 |
<tr><td></td></tr> |
|
| 19 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
| 20 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g7bfd97ec1f89b442b278bbcddc6b6ee1">wl_token_ring_register</a> (void)</td></tr> |
|
| 21 |
|
|
| 22 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register the token ring group with the wireless library. <a href="#g7bfd97ec1f89b442b278bbcddc6b6ee1"></a><br></td></tr> |
|
| 23 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e">wl_token_ring_unregister</a> (void)</td></tr> |
|
| 24 |
|
|
| 25 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister the token ring group with the wirelss library. <a href="#gde3dd682b6a757bab6ce4cbc9c518f8e"></a><br></td></tr> |
|
| 26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce">wl_token_ring_set_bom_functions</a> (void(*on_function)(void), void(*off_function)(void), int(*max_bom_function)(void))</td></tr> |
|
| 27 |
|
|
| 28 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the functions called to turn the bom on and off. <a href="#g0c407d5c215a97d58c67006bcc6e53ce"></a><br></td></tr> |
|
| 29 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gbdb1e2258d1c69086692d2d31e02fb27">wl_token_ring_join</a> (void)</td></tr> |
|
| 30 |
|
|
| 31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Join the token ring. <a href="#gbdb1e2258d1c69086692d2d31e02fb27"></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__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a">wl_token_ring_leave</a> (void)</td></tr> |
|
| 33 |
|
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Leave the token ring. <a href="#g6c2dd8742e100f63d4fb002707d1e85a"></a><br></td></tr> |
|
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b">wl_token_get_robots_in_ring</a> (void)</td></tr> |
|
| 36 |
|
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of robots in the token ring. <a href="#g0c61bb8892aa5513706e00cd8ce5ca8b"></a><br></td></tr> |
|
| 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g14e005f0b9582eca7e3585f247c4cd72">wl_token_is_robot_in_ring</a> (int robot)</td></tr> |
|
| 39 |
|
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether a given robot is in the token ring. <a href="#g14e005f0b9582eca7e3585f247c4cd72"></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__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a> (void)</td></tr> |
|
| 42 |
|
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin iterating through robots in the token ring. <a href="#g37ab9fb00e9eef273b4d0fcda81a2620"></a><br></td></tr> |
|
| 44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a> (void)</td></tr> |
|
| 45 |
|
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether there are more robots to iterate through. <a href="#gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><br></td></tr> |
|
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> (void)</td></tr> |
|
| 48 |
|
|
| 49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID of the next robot in the token ring. <a href="#gd9196324178877770d8ffc91d40893c3"></a><br></td></tr> |
|
| 50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gb4afd4b8e034d22d415f3c4a42a652fc">wl_token_get_sensor_reading</a> (int source, int dest)</td></tr> |
|
| 51 |
|
|
| 52 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the latest BOM reading between two robots. <a href="#gb4afd4b8e034d22d415f3c4a42a652fc"></a><br></td></tr> |
|
| 53 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g1938c1d79dd9438dcd413d6d26372877">wl_token_get_my_sensor_reading</a> (int dest)</td></tr> |
|
| 54 |
|
|
| 55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the latest BOM reading between us and another robot. <a href="#g1938c1d79dd9438dcd413d6d26372877"></a><br></td></tr> |
|
| 56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57">wl_token_get_num_robots</a> (void)</td></tr> |
|
| 57 |
|
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of robots in the sensor matrix. <a href="#gf0d311d4feae71afc8bcb0b8c8e6ba57"></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__tokenring.html#g5fe1508968d450a970b0d5417a06431d">wl_token_get_matrix_size</a> (void)</td></tr> |
|
| 60 |
|
|
| 61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of non-null elements in the sensor matrix. <a href="#g5fe1508968d450a970b0d5417a06431d"></a><br></td></tr> |
|
| 62 |
</table> |
|
| 63 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
| 64 |
Wireless library token ring implementation. |
|
| 65 |
<p> |
|
| 66 |
This packet group is used to form a token ring, which keeps track of the relative directions of the robots from one another. <hr><h2>Function Documentation</h2> |
|
| 67 |
<a class="anchor" name="g5fe1508968d450a970b0d5417a06431d"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_matrix_size" ref="g5fe1508968d450a970b0d5417a06431d" args="(void)" --> |
|
| 68 |
<div class="memitem"> |
|
| 69 |
<div class="memproto"> |
|
| 70 |
<table class="memname"> |
|
| 71 |
<tr> |
|
| 72 |
<td class="memname">int wl_token_get_matrix_size </td> |
|
| 73 |
<td>(</td> |
|
| 74 |
<td class="paramtype">void </td> |
|
| 75 |
<td class="paramname"> </td> |
|
| 76 |
<td> ) </td> |
|
| 77 |
<td width="100%"></td> |
|
| 78 |
</tr> |
|
| 79 |
</table> |
|
| 80 |
</div> |
|
| 81 |
<div class="memdoc"> |
|
| 82 |
|
|
| 83 |
<p> |
|
| 84 |
Return the number of non-null elements in the sensor matrix. |
|
| 85 |
<p> |
|
| 86 |
Returns the number of robots in the sensor matrix.<p> |
|
| 87 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the sensor matrix </dd></dl> |
|
| 88 |
|
|
| 89 |
</div> |
|
| 90 |
</div><p> |
|
| 91 |
<a class="anchor" name="g1938c1d79dd9438dcd413d6d26372877"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_my_sensor_reading" ref="g1938c1d79dd9438dcd413d6d26372877" args="(int dest)" --> |
|
| 92 |
<div class="memitem"> |
|
| 93 |
<div class="memproto"> |
|
| 94 |
<table class="memname"> |
|
| 95 |
<tr> |
|
| 96 |
<td class="memname">int wl_token_get_my_sensor_reading </td> |
|
| 97 |
<td>(</td> |
|
| 98 |
<td class="paramtype">int </td> |
|
| 99 |
<td class="paramname"> <em>dest</em> </td> |
|
| 100 |
<td> ) </td> |
|
| 101 |
<td width="100%"></td> |
|
| 102 |
</tr> |
|
| 103 |
</table> |
|
| 104 |
</div> |
|
| 105 |
<div class="memdoc"> |
|
| 106 |
|
|
| 107 |
<p> |
|
| 108 |
Return the latest BOM reading between us and another robot. |
|
| 109 |
<p> |
|
| 110 |
Returns the BOM reading we have for robot dest.<p> |
|
| 111 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 112 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 113 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the robot whose relative location is returned</td></tr> |
|
| 114 |
</table> |
|
| 115 |
</dl> |
|
| 116 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a BOM reading from us to robot dest, in the range 0-15, or -1 if it is unkown </dd></dl> |
|
| 117 |
|
|
| 118 |
</div> |
|
| 119 |
</div><p> |
|
| 120 |
<a class="anchor" name="gf0d311d4feae71afc8bcb0b8c8e6ba57"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_num_robots" ref="gf0d311d4feae71afc8bcb0b8c8e6ba57" args="(void)" --> |
|
| 121 |
<div class="memitem"> |
|
| 122 |
<div class="memproto"> |
|
| 123 |
<table class="memname"> |
|
| 124 |
<tr> |
|
| 125 |
<td class="memname">int wl_token_get_num_robots </td> |
|
| 126 |
<td>(</td> |
|
| 127 |
<td class="paramtype">void </td> |
|
| 128 |
<td class="paramname"> </td> |
|
| 129 |
<td> ) </td> |
|
| 130 |
<td width="100%"></td> |
|
| 131 |
</tr> |
|
| 132 |
</table> |
|
| 133 |
</div> |
|
| 134 |
<div class="memdoc"> |
|
| 135 |
|
|
| 136 |
<p> |
|
| 137 |
Return the number of robots in the sensor matrix. |
|
| 138 |
<p> |
|
| 139 |
Returns the number of robots currently in the token ring.<p> |
|
| 140 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl> |
|
| 141 |
|
|
| 142 |
</div> |
|
| 143 |
</div><p> |
|
| 144 |
<a class="anchor" name="g0c61bb8892aa5513706e00cd8ce5ca8b"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_robots_in_ring" ref="g0c61bb8892aa5513706e00cd8ce5ca8b" args="(void)" --> |
|
| 145 |
<div class="memitem"> |
|
| 146 |
<div class="memproto"> |
|
| 147 |
<table class="memname"> |
|
| 148 |
<tr> |
|
| 149 |
<td class="memname">int wl_token_get_robots_in_ring </td> |
|
| 150 |
<td>(</td> |
|
| 151 |
<td class="paramtype">void </td> |
|
| 152 |
<td class="paramname"> </td> |
|
| 153 |
<td> ) </td> |
|
| 154 |
<td width="100%"></td> |
|
| 155 |
</tr> |
|
| 156 |
</table> |
|
| 157 |
</div> |
|
| 158 |
<div class="memdoc"> |
|
| 159 |
|
|
| 160 |
<p> |
|
| 161 |
Return the number of robots in the token ring. |
|
| 162 |
<p> |
|
| 163 |
Returns the number of robots in the token ring.<p> |
|
| 164 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl> |
|
| 165 |
|
|
| 166 |
</div> |
|
| 167 |
</div><p> |
|
| 168 |
<a class="anchor" name="gb4afd4b8e034d22d415f3c4a42a652fc"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_sensor_reading" ref="gb4afd4b8e034d22d415f3c4a42a652fc" args="(int source, int dest)" --> |
|
| 169 |
<div class="memitem"> |
|
| 170 |
<div class="memproto"> |
|
| 171 |
<table class="memname"> |
|
| 172 |
<tr> |
|
| 173 |
<td class="memname">int wl_token_get_sensor_reading </td> |
|
| 174 |
<td>(</td> |
|
| 175 |
<td class="paramtype">int </td> |
|
| 176 |
<td class="paramname"> <em>source</em>, </td> |
|
| 177 |
</tr> |
|
| 178 |
<tr> |
|
| 179 |
<td class="paramkey"></td> |
|
| 180 |
<td></td> |
|
| 181 |
<td class="paramtype">int </td> |
|
| 182 |
<td class="paramname"> <em>dest</em></td><td> </td> |
|
| 183 |
</tr> |
|
| 184 |
<tr> |
|
| 185 |
<td></td> |
|
| 186 |
<td>)</td> |
|
| 187 |
<td></td><td></td><td width="100%"></td> |
|
| 188 |
</tr> |
|
| 189 |
</table> |
|
| 190 |
</div> |
|
| 191 |
<div class="memdoc"> |
|
| 192 |
|
|
| 193 |
<p> |
|
| 194 |
Return the latest BOM reading between two robots. |
|
| 195 |
<p> |
|
| 196 |
Returns the BOM reading robot source has for robot dest.<p> |
|
| 197 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 198 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 199 |
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the robot that made the BOM reading </td></tr> |
|
| 200 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the robot whose relative location is returned</td></tr> |
|
| 201 |
</table> |
|
| 202 |
</dl> |
|
| 203 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a BOM reading from robot source to robot dest, in the range 0-15, or -1 if it is unknown </dd></dl> |
|
| 204 |
|
|
| 205 |
</div> |
|
| 206 |
</div><p> |
|
| 207 |
<a class="anchor" name="g14e005f0b9582eca7e3585f247c4cd72"></a><!-- doxytag: member="wl_token_ring.h::wl_token_is_robot_in_ring" ref="g14e005f0b9582eca7e3585f247c4cd72" args="(int robot)" --> |
|
| 208 |
<div class="memitem"> |
|
| 209 |
<div class="memproto"> |
|
| 210 |
<table class="memname"> |
|
| 211 |
<tr> |
|
| 212 |
<td class="memname">int wl_token_is_robot_in_ring </td> |
|
| 213 |
<td>(</td> |
|
| 214 |
<td class="paramtype">int </td> |
|
| 215 |
<td class="paramname"> <em>robot</em> </td> |
|
| 216 |
<td> ) </td> |
|
| 217 |
<td width="100%"></td> |
|
| 218 |
</tr> |
|
| 219 |
</table> |
|
| 220 |
</div> |
|
| 221 |
<div class="memdoc"> |
|
| 222 |
|
|
| 223 |
<p> |
|
| 224 |
Return whether a given robot is in the token ring. |
|
| 225 |
<p> |
|
| 226 |
Returns true if the specified robot is in the token ring, false otherwise.<p> |
|
| 227 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 228 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 229 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the robot to check for whether it is in the token ring </td></tr> |
|
| 230 |
</table> |
|
| 231 |
</dl> |
|
| 232 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nonzero if the robot is in the token ring, zero otherwise </dd></dl> |
|
| 233 |
|
|
| 234 |
</div> |
|
| 235 |
</div><p> |
|
| 236 |
<a class="anchor" name="g37ab9fb00e9eef273b4d0fcda81a2620"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_begin" ref="g37ab9fb00e9eef273b4d0fcda81a2620" args="(void)" --> |
|
| 237 |
<div class="memitem"> |
|
| 238 |
<div class="memproto"> |
|
| 239 |
<table class="memname"> |
|
| 240 |
<tr> |
|
| 241 |
<td class="memname">void wl_token_iterator_begin </td> |
|
| 242 |
<td>(</td> |
|
| 243 |
<td class="paramtype">void </td> |
|
| 244 |
<td class="paramname"> </td> |
|
| 245 |
<td> ) </td> |
|
| 246 |
<td width="100%"></td> |
|
| 247 |
</tr> |
|
| 248 |
</table> |
|
| 249 |
</div> |
|
| 250 |
<div class="memdoc"> |
|
| 251 |
|
|
| 252 |
<p> |
|
| 253 |
Begin iterating through robots in the token ring. |
|
| 254 |
<p> |
|
| 255 |
Begins iterating through the robots in the token ring.<p> |
|
| 256 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f" title="Returns whether there are more robots to iterate through.">wl_token_iterator_has_next</a>, <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3" title="Returns the ID of the next robot in the token ring.">wl_token_iterator_next</a> </dd></dl> |
|
| 257 |
|
|
| 258 |
</div> |
|
| 259 |
</div><p> |
|
| 260 |
<a class="anchor" name="gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_has_next" ref="gbd7dc40ee796a67e1160b2b2b8e7d02f" args="(void)" --> |
|
| 261 |
<div class="memitem"> |
|
| 262 |
<div class="memproto"> |
|
| 263 |
<table class="memname"> |
|
| 264 |
<tr> |
|
| 265 |
<td class="memname">int wl_token_iterator_has_next </td> |
|
| 266 |
<td>(</td> |
|
| 267 |
<td class="paramtype">void </td> |
|
| 268 |
<td class="paramname"> </td> |
|
| 269 |
<td> ) </td> |
|
| 270 |
<td width="100%"></td> |
|
| 271 |
</tr> |
|
| 272 |
</table> |
|
| 273 |
</div> |
|
| 274 |
<div class="memdoc"> |
|
| 275 |
|
|
| 276 |
<p> |
|
| 277 |
Returns whether there are more robots to iterate through. |
|
| 278 |
<p> |
|
| 279 |
Returns true if there are more robots in the token ring to iterate through, and false otherwise.<p> |
|
| 280 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nonzero if there are more robots to iterate through, zero otherwise</dd></dl> |
|
| 281 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620" title="Begin iterating through robots in the token ring.">wl_token_iterator_begin</a>, <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3" title="Returns the ID of the next robot in the token ring.">wl_token_iterator_next</a> </dd></dl> |
|
| 282 |
|
|
| 283 |
</div> |
|
| 284 |
</div><p> |
|
| 285 |
<a class="anchor" name="gd9196324178877770d8ffc91d40893c3"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_next" ref="gd9196324178877770d8ffc91d40893c3" args="(void)" --> |
|
| 286 |
<div class="memitem"> |
|
| 287 |
<div class="memproto"> |
|
| 288 |
<table class="memname"> |
|
| 289 |
<tr> |
|
| 290 |
<td class="memname">int wl_token_iterator_next </td> |
|
| 291 |
<td>(</td> |
|
| 292 |
<td class="paramtype">void </td> |
|
| 293 |
<td class="paramname"> </td> |
|
| 294 |
<td> ) </td> |
|
| 295 |
<td width="100%"></td> |
|
| 296 |
</tr> |
|
| 297 |
</table> |
|
| 298 |
</div> |
|
| 299 |
<div class="memdoc"> |
|
| 300 |
|
|
| 301 |
<p> |
|
| 302 |
Returns the ID of the next robot in the token ring. |
|
| 303 |
<p> |
|
| 304 |
Returns the next robot ID in the token ring.<p> |
|
| 305 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the next robot ID in the token ring, or -1 if none exists</dd></dl> |
|
| 306 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620" title="Begin iterating through robots in the token ring.">wl_token_iterator_begin</a>, <a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f" title="Returns whether there are more robots to iterate through.">wl_token_iterator_has_next</a> </dd></dl> |
|
| 307 |
|
|
| 308 |
</div> |
|
| 309 |
</div><p> |
|
| 310 |
<a class="anchor" name="gbdb1e2258d1c69086692d2d31e02fb27"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_join" ref="gbdb1e2258d1c69086692d2d31e02fb27" args="(void)" --> |
|
| 311 |
<div class="memitem"> |
|
| 312 |
<div class="memproto"> |
|
| 313 |
<table class="memname"> |
|
| 314 |
<tr> |
|
| 315 |
<td class="memname">void wl_token_ring_join </td> |
|
| 316 |
<td>(</td> |
|
| 317 |
<td class="paramtype">void </td> |
|
| 318 |
<td class="paramname"> </td> |
|
| 319 |
<td> ) </td> |
|
| 320 |
<td width="100%"></td> |
|
| 321 |
</tr> |
|
| 322 |
</table> |
|
| 323 |
</div> |
|
| 324 |
<div class="memdoc"> |
|
| 325 |
|
|
| 326 |
<p> |
|
| 327 |
Join the token ring. |
|
| 328 |
<p> |
|
| 329 |
Causes the robot to join an existing token ring, or create one if no token ring exists. The token ring uses global and robot to robot packets, and does not rely on any PAN. |
|
| 330 |
</div> |
|
| 331 |
</div><p> |
|
| 332 |
<a class="anchor" name="g6c2dd8742e100f63d4fb002707d1e85a"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_leave" ref="g6c2dd8742e100f63d4fb002707d1e85a" args="(void)" --> |
|
| 333 |
<div class="memitem"> |
|
| 334 |
<div class="memproto"> |
|
| 335 |
<table class="memname"> |
|
| 336 |
<tr> |
|
| 337 |
<td class="memname">void wl_token_ring_leave </td> |
|
| 338 |
<td>(</td> |
|
| 339 |
<td class="paramtype">void </td> |
|
| 340 |
<td class="paramname"> </td> |
|
| 341 |
<td> ) </td> |
|
| 342 |
<td width="100%"></td> |
|
| 343 |
</tr> |
|
| 344 |
</table> |
|
| 345 |
</div> |
|
| 346 |
<div class="memdoc"> |
|
| 347 |
|
|
| 348 |
<p> |
|
| 349 |
Leave the token ring. |
|
| 350 |
<p> |
|
| 351 |
Causes the robot to leave the token ring. The robot stops alerting others of its location, but continues storing the locations of other robots. |
|
| 352 |
</div> |
|
| 353 |
</div><p> |
|
| 354 |
<a class="anchor" name="g7bfd97ec1f89b442b278bbcddc6b6ee1"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_register" ref="g7bfd97ec1f89b442b278bbcddc6b6ee1" args="(void)" --> |
|
| 355 |
<div class="memitem"> |
|
| 356 |
<div class="memproto"> |
|
| 357 |
<table class="memname"> |
|
| 358 |
<tr> |
|
| 359 |
<td class="memname">void wl_token_ring_register </td> |
|
| 360 |
<td>(</td> |
|
| 361 |
<td class="paramtype">void </td> |
|
| 362 |
<td class="paramname"> </td> |
|
| 363 |
<td> ) </td> |
|
| 364 |
<td width="100%"></td> |
|
| 365 |
</tr> |
|
| 366 |
</table> |
|
| 367 |
</div> |
|
| 368 |
<div class="memdoc"> |
|
| 369 |
|
|
| 370 |
<p> |
|
| 371 |
Register the token ring group with the wireless library. |
|
| 372 |
<p> |
|
| 373 |
Initialize the token ring packet group and register it with the wireless library. The robot will not join a token ring. |
|
| 374 |
</div> |
|
| 375 |
</div><p> |
|
| 376 |
<a class="anchor" name="g0c407d5c215a97d58c67006bcc6e53ce"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_set_bom_functions" ref="g0c407d5c215a97d58c67006bcc6e53ce" args="(void(*on_function)(void), void(*off_function)(void), int(*max_bom_function)(void))" --> |
|
| 377 |
<div class="memitem"> |
|
| 378 |
<div class="memproto"> |
|
| 379 |
<table class="memname"> |
|
| 380 |
<tr> |
|
| 381 |
<td class="memname">void wl_token_ring_set_bom_functions </td> |
|
| 382 |
<td>(</td> |
|
| 383 |
<td class="paramtype">void(*)(void) </td> |
|
| 384 |
<td class="paramname"> <em>on_function</em>, </td> |
|
| 385 |
</tr> |
|
| 386 |
<tr> |
|
| 387 |
<td class="paramkey"></td> |
|
| 388 |
<td></td> |
|
| 389 |
<td class="paramtype">void(*)(void) </td> |
|
| 390 |
<td class="paramname"> <em>off_function</em>, </td> |
|
| 391 |
</tr> |
|
| 392 |
<tr> |
|
| 393 |
<td class="paramkey"></td> |
|
| 394 |
<td></td> |
|
| 395 |
<td class="paramtype">int(*)(void) </td> |
|
| 396 |
<td class="paramname"> <em>max_bom_function</em></td><td> </td> |
|
| 397 |
</tr> |
|
| 398 |
<tr> |
|
| 399 |
<td></td> |
|
| 400 |
<td>)</td> |
|
| 401 |
<td></td><td></td><td width="100%"></td> |
|
| 402 |
</tr> |
|
| 403 |
</table> |
|
| 404 |
</div> |
|
| 405 |
<div class="memdoc"> |
|
| 406 |
|
|
| 407 |
<p> |
|
| 408 |
Set the functions called to turn the bom on and off. |
|
| 409 |
<p> |
|
| 410 |
Sets the functions that are called when the BOM ought to be turned on or off. This could be used for things such as charging stations, which have multiple BOMs.<p> |
|
| 411 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 412 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 413 |
<tr><td valign="top"></td><td valign="top"><em>on_function</em> </td><td>the function to be called when the BOM should be turned on </td></tr> |
|
| 414 |
<tr><td valign="top"></td><td valign="top"><em>off_function</em> </td><td>the function to be called when the BOM should be turned off </td></tr> |
|
| 415 |
<tr><td valign="top"></td><td valign="top"><em>max_bom_function</em> </td><td>the function to be called when a measurement of the maximum BOM reading is needed. </td></tr> |
|
| 416 |
</table> |
|
| 417 |
</dl> |
|
| 418 |
|
|
| 419 |
</div> |
|
| 420 |
</div><p> |
|
| 421 |
<a class="anchor" name="gde3dd682b6a757bab6ce4cbc9c518f8e"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_unregister" ref="gde3dd682b6a757bab6ce4cbc9c518f8e" args="(void)" --> |
|
| 422 |
<div class="memitem"> |
|
| 423 |
<div class="memproto"> |
|
| 424 |
<table class="memname"> |
|
| 425 |
<tr> |
|
| 426 |
<td class="memname">void wl_token_ring_unregister </td> |
|
| 427 |
<td>(</td> |
|
| 428 |
<td class="paramtype">void </td> |
|
| 429 |
<td class="paramname"> </td> |
|
| 430 |
<td> ) </td> |
|
| 431 |
<td width="100%"></td> |
|
| 432 |
</tr> |
|
| 433 |
</table> |
|
| 434 |
</div> |
|
| 435 |
<div class="memdoc"> |
|
| 436 |
|
|
| 437 |
<p> |
|
| 438 |
Unregister the token ring group with the wirelss library. |
|
| 439 |
<p> |
|
| 440 |
Removes the packet group from the wireless library. |
|
| 441 |
</div> |
|
| 442 |
</div><p> |
|
| 443 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:23 2007 for libwireless by |
|
| 444 |
<a href="http://www.doxygen.org/index.html"> |
|
| 445 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
| 446 |
</body> |
|
| 447 |
</html> |
|
| branches/battery/docs/libwireless/tabs.css | ||
|---|---|---|
| 1 |
/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ |
|
| 2 |
|
|
| 3 |
DIV.tabs |
|
| 4 |
{
|
|
| 5 |
float : left; |
|
| 6 |
width : 100%; |
|
| 7 |
background : url("tab_b.gif") repeat-x bottom;
|
|
| 8 |
margin-bottom : 4px; |
|
| 9 |
} |
|
| 10 |
|
|
| 11 |
DIV.tabs UL |
|
| 12 |
{
|
|
| 13 |
margin : 0px; |
|
| 14 |
padding-left : 10px; |
|
| 15 |
list-style : none; |
|
| 16 |
} |
|
| 17 |
|
|
| 18 |
DIV.tabs LI, DIV.tabs FORM |
|
| 19 |
{
|
|
| 20 |
display : inline; |
|
| 21 |
margin : 0px; |
|
| 22 |
padding : 0px; |
|
| 23 |
} |
|
| 24 |
|
|
| 25 |
DIV.tabs FORM |
|
| 26 |
{
|
|
| 27 |
float : right; |
|
| 28 |
} |
|
| 29 |
|
|
| 30 |
DIV.tabs A |
|
| 31 |
{
|
|
| 32 |
float : left; |
|
| 33 |
background : url("tab_r.gif") no-repeat right top;
|
|
| 34 |
border-bottom : 1px solid #84B0C7; |
|
| 35 |
font-size : x-small; |
|
| 36 |
font-weight : bold; |
|
| 37 |
text-decoration : none; |
|
| 38 |
} |
|
| 39 |
|
|
| 40 |
DIV.tabs A:hover |
|
| 41 |
{
|
|
| 42 |
background-position: 100% -150px; |
|
| 43 |
} |
|
| 44 |
|
|
| 45 |
DIV.tabs A:link, DIV.tabs A:visited, |
|
| 46 |
DIV.tabs A:active, DIV.tabs A:hover |
|
| 47 |
{
|
|
| 48 |
color: #1A419D; |
|
| 49 |
} |
|
| 50 |
|
|
| 51 |
DIV.tabs SPAN |
|
| 52 |
{
|
|
| 53 |
float : left; |
|
| 54 |
display : block; |
|
| 55 |
background : url("tab_l.gif") no-repeat left top;
|
|
| 56 |
padding : 5px 9px; |
|
| 57 |
white-space : nowrap; |
|
| 58 |
} |
|
| 59 |
|
|
| 60 |
DIV.tabs INPUT |
|
| 61 |
{
|
|
| 62 |
float : right; |
|
| 63 |
display : inline; |
|
| 64 |
font-size : 1em; |
|
| 65 |
} |
|
| 66 |
|
|
| 67 |
DIV.tabs TD |
|
| 68 |
{
|
|
| 69 |
font-size : x-small; |
|
| 70 |
font-weight : bold; |
|
| 71 |
text-decoration : none; |
|
| 72 |
} |
|
| 73 |
|
|
| 74 |
|
|
| 75 |
|
|
| 76 |
/* Commented Backslash Hack hides rule from IE5-Mac \*/ |
|
| 77 |
DIV.tabs SPAN {float : none;}
|
|
| 78 |
/* End IE5-Mac hack */ |
|
| 79 |
|
|
| 80 |
DIV.tabs A:hover SPAN |
|
| 81 |
{
|
|
| 82 |
background-position: 0% -150px; |
|
| 83 |
} |
|
| 84 |
|
|
| 85 |
DIV.tabs LI.current A |
|
| 86 |
{
|
|
| 87 |
background-position: 100% -150px; |
|
| 88 |
border-width : 0px; |
|
| 89 |
} |
|
| 90 |
|
|
| 91 |
DIV.tabs LI.current SPAN |
|
| 92 |
{
|
|
| 93 |
background-position: 0% -150px; |
|
| 94 |
padding-bottom : 6px; |
|
| 95 |
} |
|
| 96 |
|
|
| 97 |
DIV.nav |
|
| 98 |
{
|
|
| 99 |
background : none; |
|
| 100 |
border : none; |
|
| 101 |
border-bottom : 1px solid #84B0C7; |
|
| 102 |
} |
|
| branches/battery/docs/libwireless/hierarchy.html | ||
|---|---|---|
| 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"> |
|
| 3 |
<title>libwireless: Hierarchical Index</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 id="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul></div> |
|
| 15 |
<div class="tabs"> |
|
| 16 |
<ul> |
|
| 17 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 18 |
<li id="current"><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
|
| 19 |
<li><a href="functions.html"><span>Data Fields</span></a></li> |
|
| 20 |
</ul></div> |
|
| 21 |
<h1>libwireless Class Hierarchy</h1>This inheritance list is sorted roughly, but not completely, alphabetically:<ul> |
|
| 22 |
<li><a class="el" href="structnode__def.html">node_def</a> |
|
| 23 |
<li><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> |
|
| 24 |
<li><a class="el" href="structQueue.html">Queue</a> |
|
| 25 |
<li><a class="el" href="structSensorMatrix.html">SensorMatrix</a> |
|
| 26 |
</ul> |
|
| 27 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Oct 31 17:54:43 2007 for libwireless by |
|
| 28 |
<a href="http://www.doxygen.org/index.html"> |
|
| 29 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
| 30 |
</body> |
|
| 31 |
</html> |
|
| branches/battery/docs/libwireless/xbee_8h-source.html | ||
|---|---|---|
| 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: xbee.h Source File</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>xbee.h</h1><a href="xbee_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 |
|
| 17 |
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef XBEE_H</span> |
|
| 18 |
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_H</span> |
|
| 19 |
<a name="l00040"></a>00040 <span class="preprocessor"></span> |
|
| 20 |
<a name="l00045"></a>00045 <span class="preprocessor">#ifndef ROBOT</span> |
|
| 21 |
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#ifndef XBEE_PORT</span> |
|
| 22 |
<a name="l00047"></a><a class="code" href="xbee_8h.html#0ddad85671ebdb108b228835312d4f62">00047</a> <span class="preprocessor"></span><span class="preprocessor">#define XBEE_PORT "/dev/ttyUSB1"</span> |
|
| 23 |
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#endif</span> |
|
| 24 |
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_PORT2 "/dev/ttyUSB0"</span> |
|
| 25 |
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#endif</span> |
|
| 26 |
<a name="l00051"></a>00051 <span class="preprocessor"></span> |
|
| 27 |
<a name="l00061"></a>00061 <span class="comment">/*Definitions*/</span> |
|
| 28 |
<a name="l00063"></a><a class="code" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">00063</a> <span class="preprocessor">#define XBEE_PAN_DEFAULT 0xFFFF</span> |
|
| 29 |
<a name="l00064"></a>00064 <span class="preprocessor"></span> |
|
| 30 |
<a name="l00065"></a><a class="code" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">00065</a> <span class="preprocessor">#define XBEE_CHANNEL_DEFAULT 0</span> |
|
| 31 |
<a name="l00066"></a>00066 <span class="preprocessor"></span> |
|
| 32 |
<a name="l00067"></a><a class="code" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">00067</a> <span class="preprocessor">#define XBEE_BROADCAST 0xFFFF</span> |
|
| 33 |
<a name="l00068"></a>00068 <span class="preprocessor"></span> |
|
| 34 |
<a name="l00069"></a><a class="code" href="group__xbee.html#gbca7356c2b8183fd41b5ca9a82dd962b">00069</a> <span class="preprocessor">#define XBEE_OPTIONS_NONE 0x00</span> |
|
| 35 |
<a name="l00070"></a>00070 <span class="preprocessor"></span> |
|
| 36 |
<a name="l00071"></a><a class="code" href="group__xbee.html#gcf9509013302590dca5ce3db63c64609">00071</a> <span class="preprocessor">#define XBEE_OPTIONS_DISABLE_RESPONSE 0x01</span> |
|
| 37 |
<a name="l00072"></a>00072 <span class="preprocessor"></span> |
|
| 38 |
<a name="l00073"></a><a class="code" href="group__xbee.html#g57382f888360b5b19f0de3b6f1f7c5a3">00073</a> <span class="preprocessor">#define XBEE_OPTIONS_BROADCAST_ALL_PANS 0x04</span> |
|
| 39 |
<a name="l00074"></a>00074 <span class="preprocessor"></span> |
|
| 40 |
<a name="l00075"></a><a class="code" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">00075</a> <span class="preprocessor">#define XBEE_TX_STATUS 0x89</span> |
|
| 41 |
<a name="l00076"></a>00076 <span class="preprocessor"></span> |
|
| 42 |
<a name="l00077"></a><a class="code" href="group__xbee.html#gc2b1262a3a1eb4a9f7ead366af71c32c">00077</a> <span class="preprocessor">#define XBEE_RX 0x81</span> |
|
| 43 |
<a name="l00078"></a>00078 <span class="preprocessor"></span> |
|
| 44 |
<a name="l00080"></a>00080 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g334a723b79eccec83b17e25cde2e10f1" title="Initialize the XBee library.">xbee_lib_init</a>(<span class="keywordtype">void</span>); |
|
| 45 |
<a name="l00082"></a>00082 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a" title="Uninitialize the XBee library.">xbee_terminate</a>(<span class="keywordtype">void</span>); |
|
| 46 |
<a name="l00084"></a>00084 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d" title="Get a packet from the XBee.">xbee_get_packet</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* packet); |
|
| 47 |
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g3a3b8ce040002ab2b1a0923950b2f3c4" title="Send a packet to the XBee.">xbee_send_packet</a>(<span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest, |
|
| 48 |
<a name="l00087"></a>00087 <span class="keywordtype">char</span> options, <span class="keywordtype">char</span> frame); |
|
| 49 |
<a name="l00089"></a>00089 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g832f07915e1ffa8afefcd378deead1cd" title="Set the PAN ID for the XBee.">xbee_set_pan_id</a>(<span class="keywordtype">int</span> <span class="keywordtype">id</span>); |
|
| 50 |
<a name="l00091"></a>00091 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052" title="Get the XBee&#39;s PAN ID.">xbee_get_pan_id</a>(<span class="keywordtype">void</span>); |
|
| 51 |
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g33f2b13a8f46ee08f14bce90160a5623" title="Set the channel the XBee is currently using.">xbee_set_channel</a>(<span class="keywordtype">int</span> channel); |
|
| 52 |
<a name="l00095"></a>00095 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a" title="Get the channel the XBee is currently using.">xbee_get_channel</a>(<span class="keywordtype">void</span>); |
|
| 53 |
<a name="l00097"></a>00097 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309" title="Get the XBee&#39;s 16-bit address.">xbee_get_address</a>(<span class="keywordtype">void</span>); |
|
| 54 |
<a name="l00099"></a>00099 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a" title="Set the com port on a computer, undefined on the robot.">xbee_set_com_port</a>(<span class="keywordtype">char</span>* port); |
|
| 55 |
<a name="l00100"></a>00100 <span class="comment">//end defgroup</span> |
|
| 56 |
<a name="l00102"></a>00102 |
|
| 57 |
<a name="l00103"></a>00103 <span class="preprocessor">#endif</span> |
|
| 58 |
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:22 2007 for libwireless by |
|
| 59 |
<a href="http://www.doxygen.org/index.html"> |
|
| 60 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
| 61 |
</body> |
|
| 62 |
</html> |
|
| branches/battery/docs/libwireless/structQueue.html | ||
|---|---|---|
| 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: Queue Struct 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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 16 |
<div class="tabs"> |
|
| 17 |
<ul> |
|
| 18 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 19 |
<li><a href="functions.html"><span>Data Fields</span></a></li> |
|
| 20 |
</ul> |
|
| 21 |
</div> |
|
| 22 |
<h1>Queue Struct Reference<br> |
|
| 23 |
<small> |
|
| 24 |
[<a class="el" href="group__queue.html">Queue</a>, <a class="el" href="group__queue.html">Queue</a>]</small> |
|
| 25 |
</h1><!-- doxytag: class="Queue" --><code>#include <<a class="el" href="queue_8h-source.html">queue.h</a>></code> |
|
| 26 |
<p> |
|
| 27 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 28 |
<tr><td></td></tr> |
|
| 29 |
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> |
|
| 30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structnode__def.html">node_def</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structQueue.html#773cee3afdf5fbe12a225c48123b1e39">head</a></td></tr> |
|
| 31 |
|
|
| 32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structnode__def.html">node_def</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structQueue.html#85703d406e92d3aa92c3e9dbfd0e3007">tail</a></td></tr> |
|
| 33 |
|
|
| 34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structQueue.html#c7d9701d244e3ba255ef8556e0562dc6">size</a></td></tr> |
|
| 35 |
|
|
| 36 |
</table> |
|
| 37 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
| 38 |
Represents a queue, a first in, first out data structure. <hr><h2>Field Documentation</h2> |
|
| 39 |
<a class="anchor" name="773cee3afdf5fbe12a225c48123b1e39"></a><!-- doxytag: member="Queue::head" ref="773cee3afdf5fbe12a225c48123b1e39" args="" --> |
|
| 40 |
<div class="memitem"> |
|
| 41 |
<div class="memproto"> |
|
| 42 |
<table class="memname"> |
|
| 43 |
<tr> |
|
| 44 |
<td class="memname">struct <a class="el" href="structnode__def.html">node_def</a>* <a class="el" href="structQueue.html#773cee3afdf5fbe12a225c48123b1e39">Queue::head</a><code> [read]</code> </td> |
|
| 45 |
</tr> |
|
| 46 |
</table> |
|
| 47 |
</div> |
|
| 48 |
<div class="memdoc"> |
|
| 49 |
|
|
| 50 |
<p> |
|
| 51 |
The head of the queue, the next item to be removed. |
|
| 52 |
</div> |
|
| 53 |
</div><p> |
|
| 54 |
<a class="anchor" name="85703d406e92d3aa92c3e9dbfd0e3007"></a><!-- doxytag: member="Queue::tail" ref="85703d406e92d3aa92c3e9dbfd0e3007" args="" --> |
|
| 55 |
<div class="memitem"> |
|
| 56 |
<div class="memproto"> |
|
| 57 |
<table class="memname"> |
|
| 58 |
<tr> |
|
| 59 |
<td class="memname">struct <a class="el" href="structnode__def.html">node_def</a>* <a class="el" href="structQueue.html#85703d406e92d3aa92c3e9dbfd0e3007">Queue::tail</a><code> [read]</code> </td> |
|
| 60 |
</tr> |
|
| 61 |
</table> |
|
| 62 |
</div> |
|
| 63 |
<div class="memdoc"> |
|
| 64 |
|
|
| 65 |
<p> |
|
| 66 |
The tail of the queue, the last item added. |
|
| 67 |
</div> |
|
| 68 |
</div><p> |
|
| 69 |
<a class="anchor" name="c7d9701d244e3ba255ef8556e0562dc6"></a><!-- doxytag: member="Queue::size" ref="c7d9701d244e3ba255ef8556e0562dc6" args="" --> |
|
| 70 |
<div class="memitem"> |
|
| 71 |
<div class="memproto"> |
|
| 72 |
<table class="memname"> |
|
| 73 |
<tr> |
|
| 74 |
<td class="memname">int <a class="el" href="structQueue.html#c7d9701d244e3ba255ef8556e0562dc6">Queue::size</a> </td> |
|
| 75 |
</tr> |
|
| 76 |
</table> |
|
| 77 |
</div> |
|
| 78 |
<div class="memdoc"> |
|
| 79 |
|
|
| 80 |
<p> |
|
| 81 |
The number of elements in the queue. |
|
| 82 |
</div> |
|
| 83 |
</div><p> |
|
| 84 |
<hr>The documentation for this struct was generated from the following file:<ul> |
|
| 85 |
<li><a class="el" href="queue_8h-source.html">queue.h</a></ul> |
|
| 86 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:23 2007 for libwireless by |
|
| 87 |
<a href="http://www.doxygen.org/index.html"> |
|
| 88 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
| 89 |
</body> |
|
| 90 |
</html> |
|
| branches/battery/docs/libwireless/wireless_8h.html | ||
|---|---|---|
| 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 |
Copyright (c) 2007 Colony Project<p> |
|
| 80 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
|
| 81 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
|
| 82 |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p> |
|
| 83 |
Contains functions for the wireless library.<p> |
|
| 84 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
|
Also available in: Unified diff