root / trunk / docs / libwireless / group__xbee.html @ 1395
History | View | Annotate | Download (20.7 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>libwireless: XBee</title> |
| 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.9 -->
|
| 8 |
<div class="navigation" id="top"> |
| 9 |
<div class="tabs"> |
| 10 |
<ul>
|
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 12 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 13 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 14 |
<li><a href="files.html"><span>Files</span></a></li> |
| 15 |
</ul>
|
| 16 |
</div>
|
| 17 |
</div>
|
| 18 |
<div class="contents"> |
| 19 |
<h1>XBee</h1>Interface with the XBee module. |
| 20 |
<a href="#_details">More...</a> |
| 21 |
<p>
|
| 22 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 23 |
<tr><td></td></tr> |
| 24 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 25 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" --> |
| 26 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a> 0xFFFF</td></tr> |
| 27 |
|
| 28 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset PAN, uses XBee default. <br></td></tr> |
| 29 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee::XBEE_CHANNEL_DEFAULT" ref="g35f8b9d8e01e788f1e29928cba29f215" args="" --> |
| 30 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a> 0</td></tr> |
| 31 |
|
| 32 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset channel, uses XBee default. <br></td></tr> |
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee::XBEE_BROADCAST" ref="g93bbd21f7965e1697350f950cedff5c4" args="" --> |
| 34 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a> 0xFFFF</td></tr> |
| 35 |
|
| 36 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Broadcast to all robots in the PAN. <br></td></tr> |
| 37 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee::XBEE_OPTIONS_NONE" ref="gbca7356c2b8183fd41b5ca9a82dd962b" args="" --> |
| 38 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gbca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a> 0x00</td></tr> |
| 39 |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">No special options. <br></td></tr> |
| 41 |
<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="" --> |
| 42 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gcf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a> 0x01</td></tr> |
| 43 |
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br></td></tr> |
| 45 |
<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="" --> |
| 46 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a> 0x04</td></tr> |
| 47 |
|
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the packet to all PANS. <br></td></tr> |
| 49 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee::XBEE_TX_STATUS" ref="g7840d8b64c8bec12d8b8d32e845a638a" args="" --> |
| 50 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a> 0x89</td></tr> |
| 51 |
|
| 52 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A transmit status packet. <br></td></tr> |
| 53 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee::XBEE_RX" ref="gc2b1262a3a1eb4a9f7ead366af71c32c" args="" --> |
| 54 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gc2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a> 0x81</td></tr> |
| 55 |
|
| 56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A packet received from another XBee. <br></td></tr> |
| 57 |
<tr><td colspan="2"><br><h2>Functions</h2></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#g3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> (void)</td></tr> |
| 59 |
|
| 60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="#g3d5fbb6aae8dda99240ec38108a645af"></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#g9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> (void)</td></tr> |
| 62 |
|
| 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></td></tr> |
| 64 |
<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> |
| 65 |
|
| 66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr> |
| 67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr> |
| 68 |
|
| 69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="#g7c44bc25fda954efde574ee8d735073c"></a><br></td></tr> |
| 70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee_set_pan_id</a> (int id)</td></tr> |
| 71 |
|
| 72 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="#gde50cbefd7ba8d7361ce2654a298748b"></a><br></td></tr> |
| 73 |
<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> |
| 74 |
|
| 75 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="#g7755cd8db87703c9e9943153660b8052"></a><br></td></tr> |
| 76 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee_set_channel</a> (int channel)</td></tr> |
| 77 |
|
| 78 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel the XBee is currently using. <a href="#gb93170c493c5cdfd43a7b640c6ed1d14"></a><br></td></tr> |
| 79 |
<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> |
| 80 |
|
| 81 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel the XBee is currently using. <a href="#g133706db81f69ba0a3c169b7a3f42d2a"></a><br></td></tr> |
| 82 |
<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> |
| 83 |
|
| 84 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's 16-bit address. <a href="#g7c53e8a8492494a61ca306875d633309"></a><br></td></tr> |
| 85 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1e9e3c2abf0ff683ca8e591c3851cf0a"></a><!-- doxytag: member="xbee::xbee_set_com_port" ref="g1e9e3c2abf0ff683ca8e591c3851cf0a" args="(char *port)" --> |
| 86 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee_set_com_port</a> (char *port)</td></tr> |
| 87 |
|
| 88 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr> |
| 89 |
</table>
|
| 90 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 91 |
Interface with the XBee module. <hr><h2>Function Documentation</h2> |
| 92 |
<a class="anchor" name="g7c53e8a8492494a61ca306875d633309"></a><!-- doxytag: member="xbee.h::xbee_get_address" ref="g7c53e8a8492494a61ca306875d633309" args="(void)" --> |
| 93 |
<div class="memitem"> |
| 94 |
<div class="memproto"> |
| 95 |
<table class="memname"> |
| 96 |
<tr>
|
| 97 |
<td class="memname">unsigned int xbee_get_address </td> |
| 98 |
<td>(</td> |
| 99 |
<td class="paramtype">void </td> |
| 100 |
<td class="paramname"> </td> |
| 101 |
<td> ) </td> |
| 102 |
<td></td> |
| 103 |
</tr>
|
| 104 |
</table>
|
| 105 |
</div>
|
| 106 |
<div class="memdoc"> |
| 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 class="return" compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee. </dd></dl> |
| 113 |
|
| 114 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00235">wl_get_xbee_id()</a>.</p> |
| 115 |
|
| 116 |
</div>
|
| 117 |
</div><p> |
| 118 |
<a class="anchor" name="g133706db81f69ba0a3c169b7a3f42d2a"></a><!-- doxytag: member="xbee.h::xbee_get_channel" ref="g133706db81f69ba0a3c169b7a3f42d2a" args="(void)" --> |
| 119 |
<div class="memitem"> |
| 120 |
<div class="memproto"> |
| 121 |
<table class="memname"> |
| 122 |
<tr>
|
| 123 |
<td class="memname">int xbee_get_channel </td> |
| 124 |
<td>(</td> |
| 125 |
<td class="paramtype">void </td> |
| 126 |
<td class="paramname"> </td> |
| 127 |
<td> ) </td> |
| 128 |
<td></td> |
| 129 |
</tr>
|
| 130 |
</table>
|
| 131 |
</div>
|
| 132 |
<div class="memdoc"> |
| 133 |
|
| 134 |
<p>
|
| 135 |
Get the channel the XBee is currently using. |
| 136 |
<p>
|
| 137 |
Returns the channel which the XBee is currently using.<p>
|
| 138 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl> |
| 139 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14" title="Set the channel the XBee is currently using.">xbee_set_channel</a> </dd></dl> |
| 140 |
|
| 141 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00223">wl_get_channel()</a>.</p> |
| 142 |
|
| 143 |
</div>
|
| 144 |
</div><p> |
| 145 |
<a class="anchor" name="g00fbdd9d849171588df736f8b608589d"></a><!-- doxytag: member="xbee.h::xbee_get_packet" ref="g00fbdd9d849171588df736f8b608589d" args="(unsigned char *packet)" --> |
| 146 |
<div class="memitem"> |
| 147 |
<div class="memproto"> |
| 148 |
<table class="memname"> |
| 149 |
<tr>
|
| 150 |
<td class="memname">int xbee_get_packet </td> |
| 151 |
<td>(</td> |
| 152 |
<td class="paramtype">unsigned char * </td> |
| 153 |
<td class="paramname"> <em>dest</em> </td> |
| 154 |
<td> ) </td> |
| 155 |
<td></td> |
| 156 |
</tr>
|
| 157 |
</table>
|
| 158 |
</div>
|
| 159 |
<div class="memdoc"> |
| 160 |
|
| 161 |
<p>
|
| 162 |
Get a packet from the XBee. |
| 163 |
<p>
|
| 164 |
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>
|
| 165 |
<br>
|
| 166 |
<p>
|
| 167 |
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>
|
| 168 |
<br>
|
| 169 |
<p>
|
| 170 |
For a status response packet:<br>
|
| 171 |
The first byte will be XBEE_TX_STATUS.<br>
|
| 172 |
The second byte will be the frame number.<br>
|
| 173 |
The third byte will be the result. 0 indicates success, and nonzero indicates that an error ocurred in transmitting the packet.<br>
|
| 174 |
<br>
|
| 175 |
<p>
|
| 176 |
For a received packet:<br>
|
| 177 |
The first byte will be XBEE_RX.<br>
|
| 178 |
The second and third bytes will be the 16-bit address of the packet's sender.<br>
|
| 179 |
The fourth byte is the signal strength.<br>
|
| 180 |
The fifth byte is 1 if the packet were sent to a specific address, and 2 if it is a broadcast packet.<br>
|
| 181 |
<br>
|
| 182 |
<p>
|
| 183 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 184 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 185 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>set to the packet data </td></tr> |
| 186 |
</table>
|
| 187 |
</dl>
|
| 188 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the packet, or -1 if no packet is available </dd></dl> |
| 189 |
|
| 190 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>, and <a class="el" href="xbee_8c_source.html#l00206">xbee_lib_init()</a>.</p> |
| 191 |
|
| 192 |
</div>
|
| 193 |
</div><p> |
| 194 |
<a class="anchor" name="g7755cd8db87703c9e9943153660b8052"></a><!-- doxytag: member="xbee.h::xbee_get_pan_id" ref="g7755cd8db87703c9e9943153660b8052" args="(void)" --> |
| 195 |
<div class="memitem"> |
| 196 |
<div class="memproto"> |
| 197 |
<table class="memname"> |
| 198 |
<tr>
|
| 199 |
<td class="memname">unsigned int xbee_get_pan_id </td> |
| 200 |
<td>(</td> |
| 201 |
<td class="paramtype">void </td> |
| 202 |
<td class="paramname"> </td> |
| 203 |
<td> ) </td> |
| 204 |
<td></td> |
| 205 |
</tr>
|
| 206 |
</table>
|
| 207 |
</div>
|
| 208 |
<div class="memdoc"> |
| 209 |
|
| 210 |
<p>
|
| 211 |
Get the XBee's PAN ID. |
| 212 |
<p>
|
| 213 |
Get the PAN ID for the XBee.<p>
|
| 214 |
<dl class="return" 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> |
| 215 |
|
| 216 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00195">wl_get_pan()</a>.</p> |
| 217 |
|
| 218 |
</div>
|
| 219 |
</div><p> |
| 220 |
<a class="anchor" name="g3d5fbb6aae8dda99240ec38108a645af"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g3d5fbb6aae8dda99240ec38108a645af" args="(void)" --> |
| 221 |
<div class="memitem"> |
| 222 |
<div class="memproto"> |
| 223 |
<table class="memname"> |
| 224 |
<tr>
|
| 225 |
<td class="memname">int xbee_lib_init </td> |
| 226 |
<td>(</td> |
| 227 |
<td class="paramtype">void </td> |
| 228 |
<td class="paramname"> </td> |
| 229 |
<td> ) </td> |
| 230 |
<td></td> |
| 231 |
</tr>
|
| 232 |
</table>
|
| 233 |
</div>
|
| 234 |
<div class="memdoc"> |
| 235 |
|
| 236 |
<p>
|
| 237 |
Initialize the XBee library. |
| 238 |
<p>
|
| 239 |
Initializes the XBee library so that other functions may be used. |
| 240 |
<p>References <a class="el" href="xbee_8c_source.html#l00725">xbee_get_packet()</a>.</p> |
| 241 |
|
| 242 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p> |
| 243 |
|
| 244 |
</div>
|
| 245 |
</div><p> |
| 246 |
<a class="anchor" name="g7c44bc25fda954efde574ee8d735073c"></a><!-- doxytag: member="xbee.h::xbee_send_packet" ref="g7c44bc25fda954efde574ee8d735073c" args="(char *packet, int len, int dest, char options, char frame)" --> |
| 247 |
<div class="memitem"> |
| 248 |
<div class="memproto"> |
| 249 |
<table class="memname"> |
| 250 |
<tr>
|
| 251 |
<td class="memname">int xbee_send_packet </td> |
| 252 |
<td>(</td> |
| 253 |
<td class="paramtype">char * </td> |
| 254 |
<td class="paramname"> <em>packet</em>, </td> |
| 255 |
</tr>
|
| 256 |
<tr>
|
| 257 |
<td class="paramkey"></td> |
| 258 |
<td></td> |
| 259 |
<td class="paramtype">int </td> |
| 260 |
<td class="paramname"> <em>len</em>, </td> |
| 261 |
</tr>
|
| 262 |
<tr>
|
| 263 |
<td class="paramkey"></td> |
| 264 |
<td></td> |
| 265 |
<td class="paramtype">int </td> |
| 266 |
<td class="paramname"> <em>dest</em>, </td> |
| 267 |
</tr>
|
| 268 |
<tr>
|
| 269 |
<td class="paramkey"></td> |
| 270 |
<td></td> |
| 271 |
<td class="paramtype">char </td> |
| 272 |
<td class="paramname"> <em>options</em>, </td> |
| 273 |
</tr>
|
| 274 |
<tr>
|
| 275 |
<td class="paramkey"></td> |
| 276 |
<td></td> |
| 277 |
<td class="paramtype">char </td> |
| 278 |
<td class="paramname"> <em>frame</em></td><td> </td> |
| 279 |
</tr>
|
| 280 |
<tr>
|
| 281 |
<td></td> |
| 282 |
<td>)</td> |
| 283 |
<td></td><td></td><td></td> |
| 284 |
</tr>
|
| 285 |
</table>
|
| 286 |
</div>
|
| 287 |
<div class="memdoc"> |
| 288 |
|
| 289 |
<p>
|
| 290 |
Send a packet to the XBee. |
| 291 |
<p>
|
| 292 |
Send the specified packet.<p>
|
| 293 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 294 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 295 |
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>the packet data to send </td></tr> |
| 296 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the number of bytes in the packet</td></tr> |
| 297 |
<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> |
| 298 |
<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> |
| 299 |
<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> |
| 300 |
</table>
|
| 301 |
</dl>
|
| 302 |
|
| 303 |
</div>
|
| 304 |
</div><p> |
| 305 |
<a class="anchor" name="gb93170c493c5cdfd43a7b640c6ed1d14"></a><!-- doxytag: member="xbee.h::xbee_set_channel" ref="gb93170c493c5cdfd43a7b640c6ed1d14" args="(int channel)" --> |
| 306 |
<div class="memitem"> |
| 307 |
<div class="memproto"> |
| 308 |
<table class="memname"> |
| 309 |
<tr>
|
| 310 |
<td class="memname">int xbee_set_channel </td> |
| 311 |
<td>(</td> |
| 312 |
<td class="paramtype">int </td> |
| 313 |
<td class="paramname"> <em>channel</em> </td> |
| 314 |
<td> ) </td> |
| 315 |
<td></td> |
| 316 |
</tr>
|
| 317 |
</table>
|
| 318 |
</div>
|
| 319 |
<div class="memdoc"> |
| 320 |
|
| 321 |
<p>
|
| 322 |
Set the channel the XBee is currently using. |
| 323 |
<p>
|
| 324 |
Set the channel the XBee is using.<p>
|
| 325 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 326 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 327 |
<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> |
| 328 |
</table>
|
| 329 |
</dl>
|
| 330 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a" title="Get the channel the XBee is currently using.">xbee_get_channel</a> </dd></dl> |
| 331 |
|
| 332 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00209">wl_set_channel()</a>.</p> |
| 333 |
|
| 334 |
</div>
|
| 335 |
</div><p> |
| 336 |
<a class="anchor" name="gde50cbefd7ba8d7361ce2654a298748b"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="gde50cbefd7ba8d7361ce2654a298748b" args="(int id)" --> |
| 337 |
<div class="memitem"> |
| 338 |
<div class="memproto"> |
| 339 |
<table class="memname"> |
| 340 |
<tr>
|
| 341 |
<td class="memname">int xbee_set_pan_id </td> |
| 342 |
<td>(</td> |
| 343 |
<td class="paramtype">int </td> |
| 344 |
<td class="paramname"> <em>id</em> </td> |
| 345 |
<td> ) </td> |
| 346 |
<td></td> |
| 347 |
</tr>
|
| 348 |
</table>
|
| 349 |
</div>
|
| 350 |
<div class="memdoc"> |
| 351 |
|
| 352 |
<p>
|
| 353 |
Set the PAN ID for the XBee. |
| 354 |
<p>
|
| 355 |
Sets the personal area network id.<p>
|
| 356 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 357 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 358 |
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the new personal area network (PAN) id </td></tr> |
| 359 |
</table>
|
| 360 |
</dl>
|
| 361 |
|
| 362 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00181">wl_set_pan()</a>.</p> |
| 363 |
|
| 364 |
</div>
|
| 365 |
</div><p> |
| 366 |
<a class="anchor" name="g9334ac71dca1ddd697b1a35a361ade6a"></a><!-- doxytag: member="xbee.h::xbee_terminate" ref="g9334ac71dca1ddd697b1a35a361ade6a" args="(void)" --> |
| 367 |
<div class="memitem"> |
| 368 |
<div class="memproto"> |
| 369 |
<table class="memname"> |
| 370 |
<tr>
|
| 371 |
<td class="memname">void xbee_terminate </td> |
| 372 |
<td>(</td> |
| 373 |
<td class="paramtype">void </td> |
| 374 |
<td class="paramname"> </td> |
| 375 |
<td> ) </td> |
| 376 |
<td></td> |
| 377 |
</tr>
|
| 378 |
</table>
|
| 379 |
</div>
|
| 380 |
<div class="memdoc"> |
| 381 |
|
| 382 |
<p>
|
| 383 |
Uninitialize the XBee library. |
| 384 |
<p>
|
| 385 |
Call when finished using the XBee library. This releases all sued resources. |
| 386 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00159">wl_terminate()</a>.</p> |
| 387 |
|
| 388 |
</div>
|
| 389 |
</div><p> |
| 390 |
</div>
|
| 391 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by |
| 392 |
<a href="http://www.doxygen.org/index.html"> |
| 393 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
| 394 |
</body>
|
| 395 |
</html>
|