root / branches / lib_additions / docs / libwireless / group__xbee.html @ 79
History | View | Annotate | Download (22 KB)
| 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: XBee</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><a href="files.html"><span>Files</span></a></li> |
| 14 |
</ul></div> |
| 15 |
<h1>XBee</h1>Interface with the XBee module. |
| 16 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 17 |
<tr><td></td></tr> |
| 18 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 19 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" --> |
| 20 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a> 0xFFFF</td></tr> |
| 21 |
|
| 22 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset PAN, uses XBee default. <br></td></tr> |
| 23 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee::XBEE_CHANNEL_DEFAULT" ref="g35f8b9d8e01e788f1e29928cba29f215" args="" --> |
| 24 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a> 0</td></tr> |
| 25 |
|
| 26 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset channel, uses XBee default. <br></td></tr> |
| 27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee::XBEE_BROADCAST" ref="g93bbd21f7965e1697350f950cedff5c4" args="" --> |
| 28 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a> 0xFFFF</td></tr> |
| 29 |
|
| 30 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Broadcast to all robots in the PAN. <br></td></tr> |
| 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee::XBEE_OPTIONS_NONE" ref="gbca7356c2b8183fd41b5ca9a82dd962b" args="" --> |
| 32 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gbca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a> 0x00</td></tr> |
| 33 |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">No special options. <br></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee::XBEE_OPTIONS_DISABLE_RESPONSE" ref="gcf9509013302590dca5ce3db63c64609" args="" --> |
| 36 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gcf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a> 0x01</td></tr> |
| 37 |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br></td></tr> |
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="g57382f888360b5b19f0de3b6f1f7c5a3" args="" --> |
| 40 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a> 0x04</td></tr> |
| 41 |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the packet to all PANS. <br></td></tr> |
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee::XBEE_TX_STATUS" ref="g7840d8b64c8bec12d8b8d32e845a638a" args="" --> |
| 44 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a> 0x89</td></tr> |
| 45 |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A transmit status packet. <br></td></tr> |
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee::XBEE_RX" ref="gc2b1262a3a1eb4a9f7ead366af71c32c" args="" --> |
| 48 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gc2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a> 0x81</td></tr> |
| 49 |
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A packet received from another XBee. <br></td></tr> |
| 51 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g334a723b79eccec83b17e25cde2e10f1">xbee_lib_init</a> (void)</td></tr> |
| 53 |
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="#g334a723b79eccec83b17e25cde2e10f1"></a><br></td></tr> |
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> (void)</td></tr> |
| 56 |
|
| 57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></td></tr> |
| 58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *packet)</td></tr> |
| 59 |
|
| 60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr> |
| 61 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3a3b8ce040002ab2b1a0923950b2f3c4">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr> |
| 62 |
|
| 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="#g3a3b8ce040002ab2b1a0923950b2f3c4"></a><br></td></tr> |
| 64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g832f07915e1ffa8afefcd378deead1cd">xbee_set_pan_id</a> (int id)</td></tr> |
| 65 |
|
| 66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="#g832f07915e1ffa8afefcd378deead1cd"></a><br></td></tr> |
| 67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee_get_pan_id</a> (void)</td></tr> |
| 68 |
|
| 69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="#g7755cd8db87703c9e9943153660b8052"></a><br></td></tr> |
| 70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g33f2b13a8f46ee08f14bce90160a5623">xbee_set_channel</a> (int channel)</td></tr> |
| 71 |
|
| 72 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel the XBee is currently using. <a href="#g33f2b13a8f46ee08f14bce90160a5623"></a><br></td></tr> |
| 73 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> (void)</td></tr> |
| 74 |
|
| 75 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel the XBee is currently using. <a href="#g133706db81f69ba0a3c169b7a3f42d2a"></a><br></td></tr> |
| 76 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee_get_address</a> (void)</td></tr> |
| 77 |
|
| 78 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's 16-bit address. <a href="#g7c53e8a8492494a61ca306875d633309"></a><br></td></tr> |
| 79 |
</table>
|
| 80 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 81 |
Interface with the XBee module. |
| 82 |
<p>
|
| 83 |
Interface with the XBee module. <hr><h2>Function Documentation</h2> |
| 84 |
<a class="anchor" name="g7c53e8a8492494a61ca306875d633309"></a><!-- doxytag: member="xbee.h::xbee_get_address" ref="g7c53e8a8492494a61ca306875d633309" args="(void)" --><p> |
| 85 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 86 |
<tr>
|
| 87 |
<td class="mdRow"> |
| 88 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 89 |
<tr>
|
| 90 |
<td class="md" nowrap valign="top">unsigned int xbee_get_address </td> |
| 91 |
<td class="md" valign="top">( </td> |
| 92 |
<td class="md" nowrap valign="top">void </td> |
| 93 |
<td class="mdname1" valign="top" nowrap> </td> |
| 94 |
<td class="md" valign="top"> ) </td> |
| 95 |
<td class="md" nowrap></td> |
| 96 |
</tr>
|
| 97 |
</table>
|
| 98 |
</td>
|
| 99 |
</tr>
|
| 100 |
</table>
|
| 101 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 102 |
<tr>
|
| 103 |
<td>
|
| 104 |
|
| 105 |
</td>
|
| 106 |
<td>
|
| 107 |
|
| 108 |
<p>
|
| 109 |
Get the XBee's 16-bit address. |
| 110 |
<p>
|
| 111 |
Get the 16-bit address of the XBee. This is used to specify who to send messages to and who messages are from.<p>
|
| 112 |
<dl compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee. </dd></dl> |
| 113 |
</td>
|
| 114 |
</tr>
|
| 115 |
</table>
|
| 116 |
<a class="anchor" name="g133706db81f69ba0a3c169b7a3f42d2a"></a><!-- doxytag: member="xbee.h::xbee_get_channel" ref="g133706db81f69ba0a3c169b7a3f42d2a" args="(void)" --><p> |
| 117 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 118 |
<tr>
|
| 119 |
<td class="mdRow"> |
| 120 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 121 |
<tr>
|
| 122 |
<td class="md" nowrap valign="top">int xbee_get_channel </td> |
| 123 |
<td class="md" valign="top">( </td> |
| 124 |
<td class="md" nowrap valign="top">void </td> |
| 125 |
<td class="mdname1" valign="top" nowrap> </td> |
| 126 |
<td class="md" valign="top"> ) </td> |
| 127 |
<td class="md" nowrap></td> |
| 128 |
</tr>
|
| 129 |
</table>
|
| 130 |
</td>
|
| 131 |
</tr>
|
| 132 |
</table>
|
| 133 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 134 |
<tr>
|
| 135 |
<td>
|
| 136 |
|
| 137 |
</td>
|
| 138 |
<td>
|
| 139 |
|
| 140 |
<p>
|
| 141 |
Get the channel the XBee is currently using. |
| 142 |
<p>
|
| 143 |
Returns the channel which the XBee is currently using.<p>
|
| 144 |
<dl compact><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl> |
| 145 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g33f2b13a8f46ee08f14bce90160a5623">xbee_set_channel</a> </dd></dl> |
| 146 |
</td>
|
| 147 |
</tr>
|
| 148 |
</table>
|
| 149 |
<a class="anchor" name="g00fbdd9d849171588df736f8b608589d"></a><!-- doxytag: member="xbee.h::xbee_get_packet" ref="g00fbdd9d849171588df736f8b608589d" args="(unsigned char *packet)" --><p> |
| 150 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 151 |
<tr>
|
| 152 |
<td class="mdRow"> |
| 153 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 154 |
<tr>
|
| 155 |
<td class="md" nowrap valign="top">int xbee_get_packet </td> |
| 156 |
<td class="md" valign="top">( </td> |
| 157 |
<td class="md" nowrap valign="top">unsigned char * </td> |
| 158 |
<td class="mdname1" valign="top" nowrap> <em>dest</em> </td> |
| 159 |
<td class="md" valign="top"> ) </td> |
| 160 |
<td class="md" nowrap></td> |
| 161 |
</tr>
|
| 162 |
</table>
|
| 163 |
</td>
|
| 164 |
</tr>
|
| 165 |
</table>
|
| 166 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 167 |
<tr>
|
| 168 |
<td>
|
| 169 |
|
| 170 |
</td>
|
| 171 |
<td>
|
| 172 |
|
| 173 |
<p>
|
| 174 |
Get a packet from the XBee. |
| 175 |
<p>
|
| 176 |
Reads a packet received from the XBee. This function is non-blocking. The resulting packet is stored in dest. Only returns transmission response packets and received packets. The returned packet does not include header information or the checksum. This method also handles special packets dealt with by the XBee library, and so should be called frequently while the XBee is in use.<br>
|
| 177 |
<br>
|
| 178 |
<p>
|
| 179 |
The first byte of the packet will be either XBEE_TX_STATUS or XBEE_RX to indicated a response to a sent message or a received message, respectively.<br>
|
| 180 |
<br>
|
| 181 |
<p>
|
| 182 |
For a status response packet:<br>
|
| 183 |
The first byte will be XBEE_TX_STATUS.<br>
|
| 184 |
The second byte will be the frame number.<br>
|
| 185 |
The third byte will be the result. 0 indicates success, and nonzero indicates that an error ocurred in transmitting the packet.<br>
|
| 186 |
<br>
|
| 187 |
<p>
|
| 188 |
For a received packet:<br>
|
| 189 |
The first byte will be XBEE_RX.<br>
|
| 190 |
The second and third bytes will be the 16-bit address of the packet's sender.<br>
|
| 191 |
The fourth byte is the signal strength.<br>
|
| 192 |
The fifth byte is 1 if the packet were sent to a specific address, and 2 if it is a broadcast packet.<br>
|
| 193 |
<br>
|
| 194 |
<p>
|
| 195 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 196 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 197 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>set to the packet data </td></tr> |
| 198 |
</table>
|
| 199 |
</dl>
|
| 200 |
<dl compact><dt><b>Returns:</b></dt><dd>the length of the packet, or -1 if no packet is available </dd></dl> |
| 201 |
</td>
|
| 202 |
</tr>
|
| 203 |
</table>
|
| 204 |
<a class="anchor" name="g7755cd8db87703c9e9943153660b8052"></a><!-- doxytag: member="xbee.h::xbee_get_pan_id" ref="g7755cd8db87703c9e9943153660b8052" args="(void)" --><p> |
| 205 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 206 |
<tr>
|
| 207 |
<td class="mdRow"> |
| 208 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 209 |
<tr>
|
| 210 |
<td class="md" nowrap valign="top">unsigned int xbee_get_pan_id </td> |
| 211 |
<td class="md" valign="top">( </td> |
| 212 |
<td class="md" nowrap valign="top">void </td> |
| 213 |
<td class="mdname1" valign="top" nowrap> </td> |
| 214 |
<td class="md" valign="top"> ) </td> |
| 215 |
<td class="md" nowrap></td> |
| 216 |
</tr>
|
| 217 |
</table>
|
| 218 |
</td>
|
| 219 |
</tr>
|
| 220 |
</table>
|
| 221 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 222 |
<tr>
|
| 223 |
<td>
|
| 224 |
|
| 225 |
</td>
|
| 226 |
<td>
|
| 227 |
|
| 228 |
<p>
|
| 229 |
Get the XBee's PAN ID. |
| 230 |
<p>
|
| 231 |
Get the PAN ID for the XBee.<p>
|
| 232 |
<dl compact><dt><b>Returns:</b></dt><dd>the personal area network id, or XBEE_PAN_DEFAULT if it has not yet been set. </dd></dl> |
| 233 |
</td>
|
| 234 |
</tr>
|
| 235 |
</table>
|
| 236 |
<a class="anchor" name="g334a723b79eccec83b17e25cde2e10f1"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g334a723b79eccec83b17e25cde2e10f1" args="(void)" --><p> |
| 237 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 238 |
<tr>
|
| 239 |
<td class="mdRow"> |
| 240 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 241 |
<tr>
|
| 242 |
<td class="md" nowrap valign="top">void xbee_lib_init </td> |
| 243 |
<td class="md" valign="top">( </td> |
| 244 |
<td class="md" nowrap valign="top">void </td> |
| 245 |
<td class="mdname1" valign="top" nowrap> </td> |
| 246 |
<td class="md" valign="top"> ) </td> |
| 247 |
<td class="md" nowrap></td> |
| 248 |
</tr>
|
| 249 |
</table>
|
| 250 |
</td>
|
| 251 |
</tr>
|
| 252 |
</table>
|
| 253 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 254 |
<tr>
|
| 255 |
<td>
|
| 256 |
|
| 257 |
</td>
|
| 258 |
<td>
|
| 259 |
|
| 260 |
<p>
|
| 261 |
Initialize the XBee library. |
| 262 |
<p>
|
| 263 |
Initializes the XBee library so that other functions may be used.<p>
|
| 264 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 265 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 266 |
<tr><td valign="top"></td><td valign="top"><em>pan_id</em> </td><td>the PAN to join initially. Use XBEE_PAN_DEFAULT to leave the PAN as it is initially. </td></tr> |
| 267 |
</table>
|
| 268 |
</dl>
|
| 269 |
</td>
|
| 270 |
</tr>
|
| 271 |
</table>
|
| 272 |
<a class="anchor" name="g3a3b8ce040002ab2b1a0923950b2f3c4"></a><!-- doxytag: member="xbee.h::xbee_send_packet" ref="g3a3b8ce040002ab2b1a0923950b2f3c4" args="(char *packet, int len, int dest, char options, char frame)" --><p> |
| 273 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 274 |
<tr>
|
| 275 |
<td class="mdRow"> |
| 276 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 277 |
<tr>
|
| 278 |
<td class="md" nowrap valign="top">void xbee_send_packet </td> |
| 279 |
<td class="md" valign="top">( </td> |
| 280 |
<td class="md" nowrap valign="top">char * </td> |
| 281 |
<td class="mdname" nowrap> <em>packet</em>, </td> |
| 282 |
</tr>
|
| 283 |
<tr>
|
| 284 |
<td class="md" nowrap align="right"></td> |
| 285 |
<td class="md"></td> |
| 286 |
<td class="md" nowrap>int </td> |
| 287 |
<td class="mdname" nowrap> <em>len</em>, </td> |
| 288 |
</tr>
|
| 289 |
<tr>
|
| 290 |
<td class="md" nowrap align="right"></td> |
| 291 |
<td class="md"></td> |
| 292 |
<td class="md" nowrap>int </td> |
| 293 |
<td class="mdname" nowrap> <em>dest</em>, </td> |
| 294 |
</tr>
|
| 295 |
<tr>
|
| 296 |
<td class="md" nowrap align="right"></td> |
| 297 |
<td class="md"></td> |
| 298 |
<td class="md" nowrap>char </td> |
| 299 |
<td class="mdname" nowrap> <em>options</em>, </td> |
| 300 |
</tr>
|
| 301 |
<tr>
|
| 302 |
<td class="md" nowrap align="right"></td> |
| 303 |
<td class="md"></td> |
| 304 |
<td class="md" nowrap>char </td> |
| 305 |
<td class="mdname" nowrap> <em>frame</em></td> |
| 306 |
</tr>
|
| 307 |
<tr>
|
| 308 |
<td class="md"></td> |
| 309 |
<td class="md">) </td> |
| 310 |
<td class="md" colspan="2"></td> |
| 311 |
</tr>
|
| 312 |
</table>
|
| 313 |
</td>
|
| 314 |
</tr>
|
| 315 |
</table>
|
| 316 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 317 |
<tr>
|
| 318 |
<td>
|
| 319 |
|
| 320 |
</td>
|
| 321 |
<td>
|
| 322 |
|
| 323 |
<p>
|
| 324 |
Send a packet to the XBee. |
| 325 |
<p>
|
| 326 |
Send the specified packet.<p>
|
| 327 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 328 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 329 |
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>the packet data to send </td></tr> |
| 330 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the number of bytes in the packet</td></tr> |
| 331 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the ID of the XBee to send the packet to, or XBEE_BROADCAST to send the message to all robots in the PAN.</td></tr> |
| 332 |
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>a combination of the flags XBEE_OPTIONS_NONE, XBEE_OPTIONS_DISABLE_RESPONSE and XBEE_OPTIONS_BROADCAST_ALL_PANS</td></tr> |
| 333 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to associate this packet with. This will be used to identify the response when the XBee alerts us as to whether or not our message was received. </td></tr> |
| 334 |
</table>
|
| 335 |
</dl>
|
| 336 |
</td>
|
| 337 |
</tr>
|
| 338 |
</table>
|
| 339 |
<a class="anchor" name="g33f2b13a8f46ee08f14bce90160a5623"></a><!-- doxytag: member="xbee.h::xbee_set_channel" ref="g33f2b13a8f46ee08f14bce90160a5623" args="(int channel)" --><p> |
| 340 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 341 |
<tr>
|
| 342 |
<td class="mdRow"> |
| 343 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 344 |
<tr>
|
| 345 |
<td class="md" nowrap valign="top">void xbee_set_channel </td> |
| 346 |
<td class="md" valign="top">( </td> |
| 347 |
<td class="md" nowrap valign="top">int </td> |
| 348 |
<td class="mdname1" valign="top" nowrap> <em>channel</em> </td> |
| 349 |
<td class="md" valign="top"> ) </td> |
| 350 |
<td class="md" nowrap></td> |
| 351 |
</tr>
|
| 352 |
</table>
|
| 353 |
</td>
|
| 354 |
</tr>
|
| 355 |
</table>
|
| 356 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 357 |
<tr>
|
| 358 |
<td>
|
| 359 |
|
| 360 |
</td>
|
| 361 |
<td>
|
| 362 |
|
| 363 |
<p>
|
| 364 |
Set the channel the XBee is currently using. |
| 365 |
<p>
|
| 366 |
Set the channel the XBee is using.<p>
|
| 367 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 368 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 369 |
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>the channel the XBee will not use, between 0x0B and 0x1A</td></tr> |
| 370 |
</table>
|
| 371 |
</dl>
|
| 372 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> </dd></dl> |
| 373 |
</td>
|
| 374 |
</tr>
|
| 375 |
</table>
|
| 376 |
<a class="anchor" name="g832f07915e1ffa8afefcd378deead1cd"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="g832f07915e1ffa8afefcd378deead1cd" args="(int id)" --><p> |
| 377 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 378 |
<tr>
|
| 379 |
<td class="mdRow"> |
| 380 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 381 |
<tr>
|
| 382 |
<td class="md" nowrap valign="top">void xbee_set_pan_id </td> |
| 383 |
<td class="md" valign="top">( </td> |
| 384 |
<td class="md" nowrap valign="top">int </td> |
| 385 |
<td class="mdname1" valign="top" nowrap> <em>id</em> </td> |
| 386 |
<td class="md" valign="top"> ) </td> |
| 387 |
<td class="md" nowrap></td> |
| 388 |
</tr>
|
| 389 |
</table>
|
| 390 |
</td>
|
| 391 |
</tr>
|
| 392 |
</table>
|
| 393 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 394 |
<tr>
|
| 395 |
<td>
|
| 396 |
|
| 397 |
</td>
|
| 398 |
<td>
|
| 399 |
|
| 400 |
<p>
|
| 401 |
Set the PAN ID for the XBee. |
| 402 |
<p>
|
| 403 |
Sets the personal area network id.<p>
|
| 404 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 405 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 406 |
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the new personal area network (PAN) id </td></tr> |
| 407 |
</table>
|
| 408 |
</dl>
|
| 409 |
</td>
|
| 410 |
</tr>
|
| 411 |
</table>
|
| 412 |
<a class="anchor" name="g9334ac71dca1ddd697b1a35a361ade6a"></a><!-- doxytag: member="xbee.h::xbee_terminate" ref="g9334ac71dca1ddd697b1a35a361ade6a" args="(void)" --><p> |
| 413 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 414 |
<tr>
|
| 415 |
<td class="mdRow"> |
| 416 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 417 |
<tr>
|
| 418 |
<td class="md" nowrap valign="top">void xbee_terminate </td> |
| 419 |
<td class="md" valign="top">( </td> |
| 420 |
<td class="md" nowrap valign="top">void </td> |
| 421 |
<td class="mdname1" valign="top" nowrap> </td> |
| 422 |
<td class="md" valign="top"> ) </td> |
| 423 |
<td class="md" nowrap></td> |
| 424 |
</tr>
|
| 425 |
</table>
|
| 426 |
</td>
|
| 427 |
</tr>
|
| 428 |
</table>
|
| 429 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 430 |
<tr>
|
| 431 |
<td>
|
| 432 |
|
| 433 |
</td>
|
| 434 |
<td>
|
| 435 |
|
| 436 |
<p>
|
| 437 |
Uninitialize the XBee library. |
| 438 |
<p>
|
| 439 |
Call when finished using the XBee library. This releases all sued resources. </td>
|
| 440 |
</tr>
|
| 441 |
</table>
|
| 442 |
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 24 14:12:31 2007 for libwireless by |
| 443 |
<a href="http://www.doxygen.org/index.html"> |
| 444 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
| 445 |
</body>
|
| 446 |
</html>
|