Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / group__xbee.html @ 1427

History | View | Annotate | Download (20.5 KB)

1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
<head>
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>libwireless: XBee</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
</head>
9
<body>
10
<!-- Generated by Doxygen 1.6.1 -->
11
<div class="navigation" id="top">
12
  <div class="tabs">
13
    <ul>
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17
      <li><a href="files.html"><span>Files</span></a></li>
18
    </ul>
19
  </div>
20
</div>
21
<div class="contents">
22
<h1>XBee</h1>
23
<p>Interface with the XBee module.  
24
<a href="#_details">More...</a></p>
25
<table border="0" cellpadding="0" cellspacing="0">
26
<tr><td colspan="2"><h2>Defines</h2></td></tr>
27
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee::XBEE_PAN_DEFAULT" ref="gae6bb9bb274d6750f954762454807a5a7" args="" -->
28
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gae6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>
29
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unset PAN, uses XBee default. <br/></td></tr>
30
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee::XBEE_CHANNEL_DEFAULT" ref="ga35f8b9d8e01e788f1e29928cba29f215" args="" -->
31
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a>&nbsp;&nbsp;&nbsp;0</td></tr>
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unset channel, uses XBee default. <br/></td></tr>
33
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee::XBEE_BROADCAST" ref="ga93bbd21f7965e1697350f950cedff5c4" args="" -->
34
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Broadcast to all robots in the PAN. <br/></td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee::XBEE_OPTIONS_NONE" ref="gabca7356c2b8183fd41b5ca9a82dd962b" args="" -->
37
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gabca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a>&nbsp;&nbsp;&nbsp;0x00</td></tr>
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">No special options. <br/></td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee::XBEE_OPTIONS_DISABLE_RESPONSE" ref="gacf9509013302590dca5ce3db63c64609" args="" -->
40
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gacf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a>&nbsp;&nbsp;&nbsp;0x01</td></tr>
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br/></td></tr>
42
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="ga57382f888360b5b19f0de3b6f1f7c5a3" args="" -->
43
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a>&nbsp;&nbsp;&nbsp;0x04</td></tr>
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send the packet to all PANS. <br/></td></tr>
45
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee::XBEE_TX_STATUS" ref="ga7840d8b64c8bec12d8b8d32e845a638a" args="" -->
46
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a>&nbsp;&nbsp;&nbsp;0x89</td></tr>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A transmit status packet. <br/></td></tr>
48
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee::XBEE_RX" ref="gac2b1262a3a1eb4a9f7ead366af71c32c" args="" -->
49
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gac2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a>&nbsp;&nbsp;&nbsp;0x81</td></tr>
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A packet received from another XBee. <br/></td></tr>
51
<tr><td colspan="2"><h2>Functions</h2></td></tr>
52
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> (void)</td></tr>
53
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the XBee library.  <a href="#ga3d5fbb6aae8dda99240ec38108a645af"></a><br/></td></tr>
54
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> (void)</td></tr>
55
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Uninitialize the XBee library.  <a href="#ga9334ac71dca1ddd697b1a35a361ade6a"></a><br/></td></tr>
56
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *packet)</td></tr>
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a packet from the XBee.  <a href="#ga00fbdd9d849171588df736f8b608589d"></a><br/></td></tr>
58
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga7c44bc25fda954efde574ee8d735073c">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr>
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to the XBee.  <a href="#ga7c44bc25fda954efde574ee8d735073c"></a><br/></td></tr>
60
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gade50cbefd7ba8d7361ce2654a298748b">xbee_set_pan_id</a> (int id)</td></tr>
61
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the PAN ID for the XBee.  <a href="#gade50cbefd7ba8d7361ce2654a298748b"></a><br/></td></tr>
62
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga7755cd8db87703c9e9943153660b8052">xbee_get_pan_id</a> (void)</td></tr>
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's PAN ID.  <a href="#ga7755cd8db87703c9e9943153660b8052"></a><br/></td></tr>
64
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gab93170c493c5cdfd43a7b640c6ed1d14">xbee_set_channel</a> (int channel)</td></tr>
65
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the channel the XBee is currently using.  <a href="#gab93170c493c5cdfd43a7b640c6ed1d14"></a><br/></td></tr>
66
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> (void)</td></tr>
67
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the channel the XBee is currently using.  <a href="#ga133706db81f69ba0a3c169b7a3f42d2a"></a><br/></td></tr>
68
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga7c53e8a8492494a61ca306875d633309">xbee_get_address</a> (void)</td></tr>
69
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's 16-bit address.  <a href="#ga7c53e8a8492494a61ca306875d633309"></a><br/></td></tr>
70
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1e9e3c2abf0ff683ca8e591c3851cf0a"></a><!-- doxytag: member="xbee::xbee_set_com_port" ref="ga1e9e3c2abf0ff683ca8e591c3851cf0a" args="(char *port)" -->
71
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga1e9e3c2abf0ff683ca8e591c3851cf0a">xbee_set_com_port</a> (char *port)</td></tr>
72
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br/></td></tr>
73
</table>
74
<hr/><a name="_details"></a><h2>Detailed Description</h2>
75
<p>Interface with the XBee module. </p>
76
<hr/><h2>Function Documentation</h2>
77
<a class="anchor" id="ga7c53e8a8492494a61ca306875d633309"></a><!-- doxytag: member="xbee.h::xbee_get_address" ref="ga7c53e8a8492494a61ca306875d633309" args="(void)" -->
78
<div class="memitem">
79
<div class="memproto">
80
      <table class="memname">
81
        <tr>
82
          <td class="memname">unsigned int xbee_get_address </td>
83
          <td>(</td>
84
          <td class="paramtype">void&nbsp;</td>
85
          <td class="paramname"></td>
86
          <td>&nbsp;)&nbsp;</td>
87
          <td></td>
88
        </tr>
89
      </table>
90
</div>
91
<div class="memdoc">
92

    
93
<p>Get the XBee's 16-bit address. </p>
94
<p>Get the 16-bit address of the XBee. This is used to specify who to send messages to and who messages are from.</p>
95
<dl class="return"><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee. </dd></dl>
96

    
97
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00235">wl_get_xbee_id()</a>.</p>
98

    
99
</div>
100
</div>
101
<a class="anchor" id="ga133706db81f69ba0a3c169b7a3f42d2a"></a><!-- doxytag: member="xbee.h::xbee_get_channel" ref="ga133706db81f69ba0a3c169b7a3f42d2a" args="(void)" -->
102
<div class="memitem">
103
<div class="memproto">
104
      <table class="memname">
105
        <tr>
106
          <td class="memname">int xbee_get_channel </td>
107
          <td>(</td>
108
          <td class="paramtype">void&nbsp;</td>
109
          <td class="paramname"></td>
110
          <td>&nbsp;)&nbsp;</td>
111
          <td></td>
112
        </tr>
113
      </table>
114
</div>
115
<div class="memdoc">
116

    
117
<p>Get the channel the XBee is currently using. </p>
118
<p>Returns the channel which the XBee is currently using.</p>
119
<dl class="return"><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl>
120
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#gab93170c493c5cdfd43a7b640c6ed1d14" title="Set the channel the XBee is currently using.">xbee_set_channel</a> </dd></dl>
121

    
122
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00223">wl_get_channel()</a>.</p>
123

    
124
</div>
125
</div>
126
<a class="anchor" id="ga00fbdd9d849171588df736f8b608589d"></a><!-- doxytag: member="xbee.h::xbee_get_packet" ref="ga00fbdd9d849171588df736f8b608589d" args="(unsigned char *packet)" -->
127
<div class="memitem">
128
<div class="memproto">
129
      <table class="memname">
130
        <tr>
131
          <td class="memname">int xbee_get_packet </td>
132
          <td>(</td>
133
          <td class="paramtype">unsigned char *&nbsp;</td>
134
          <td class="paramname"> <em>dest</em></td>
135
          <td>&nbsp;)&nbsp;</td>
136
          <td></td>
137
        </tr>
138
      </table>
139
</div>
140
<div class="memdoc">
141

    
142
<p>Get a packet from the XBee. </p>
143
<p>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/>
144
<br/>
145
</p>
146
<p>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/>
147
<br/>
148
</p>
149
<p>For a status response packet:<br/>
150
 The first byte will be XBEE_TX_STATUS.<br/>
151
 The second byte will be the frame number.<br/>
152
 The third byte will be the result. 0 indicates success, and nonzero indicates that an error ocurred in transmitting the packet.<br/>
153
<br/>
154
</p>
155
<p>For a received packet:<br/>
156
 The first byte will be XBEE_RX.<br/>
157
 The second and third bytes will be the 16-bit address of the packet's sender.<br/>
158
 The fourth byte is the signal strength.<br/>
159
 The fifth byte is 1 if the packet were sent to a specific address, and 2 if it is a broadcast packet.<br/>
160
<br/>
161
</p>
162
<dl><dt><b>Parameters:</b></dt><dd>
163
  <table border="0" cellspacing="2" cellpadding="0">
164
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>set to the packet data </td></tr>
165
  </table>
166
  </dd>
167
</dl>
168
<dl class="return"><dt><b>Returns:</b></dt><dd>the length of the packet, or -1 if no packet is available </dd></dl>
169

    
170
<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>
171

    
172
</div>
173
</div>
174
<a class="anchor" id="ga7755cd8db87703c9e9943153660b8052"></a><!-- doxytag: member="xbee.h::xbee_get_pan_id" ref="ga7755cd8db87703c9e9943153660b8052" args="(void)" -->
175
<div class="memitem">
176
<div class="memproto">
177
      <table class="memname">
178
        <tr>
179
          <td class="memname">unsigned int xbee_get_pan_id </td>
180
          <td>(</td>
181
          <td class="paramtype">void&nbsp;</td>
182
          <td class="paramname"></td>
183
          <td>&nbsp;)&nbsp;</td>
184
          <td></td>
185
        </tr>
186
      </table>
187
</div>
188
<div class="memdoc">
189

    
190
<p>Get the XBee's PAN ID. </p>
191
<p>Get the PAN ID for the XBee.</p>
192
<dl class="return"><dt><b>Returns:</b></dt><dd>the personal area network id, or XBEE_PAN_DEFAULT if it has not yet been set. </dd></dl>
193

    
194
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00195">wl_get_pan()</a>.</p>
195

    
196
</div>
197
</div>
198
<a class="anchor" id="ga3d5fbb6aae8dda99240ec38108a645af"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="ga3d5fbb6aae8dda99240ec38108a645af" args="(void)" -->
199
<div class="memitem">
200
<div class="memproto">
201
      <table class="memname">
202
        <tr>
203
          <td class="memname">int xbee_lib_init </td>
204
          <td>(</td>
205
          <td class="paramtype">void&nbsp;</td>
206
          <td class="paramname"></td>
207
          <td>&nbsp;)&nbsp;</td>
208
          <td></td>
209
        </tr>
210
      </table>
211
</div>
212
<div class="memdoc">
213

    
214
<p>Initialize the XBee library. </p>
215
<p>Initializes the XBee library so that other functions may be used. </p>
216

    
217
<p>References <a class="el" href="xbee_8c_source.html#l00725">xbee_get_packet()</a>.</p>
218

    
219
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p>
220

    
221
</div>
222
</div>
223
<a class="anchor" id="ga7c44bc25fda954efde574ee8d735073c"></a><!-- doxytag: member="xbee.h::xbee_send_packet" ref="ga7c44bc25fda954efde574ee8d735073c" args="(char *packet, int len, int dest, char options, char frame)" -->
224
<div class="memitem">
225
<div class="memproto">
226
      <table class="memname">
227
        <tr>
228
          <td class="memname">int xbee_send_packet </td>
229
          <td>(</td>
230
          <td class="paramtype">char *&nbsp;</td>
231
          <td class="paramname"> <em>packet</em>, </td>
232
        </tr>
233
        <tr>
234
          <td class="paramkey"></td>
235
          <td></td>
236
          <td class="paramtype">int&nbsp;</td>
237
          <td class="paramname"> <em>len</em>, </td>
238
        </tr>
239
        <tr>
240
          <td class="paramkey"></td>
241
          <td></td>
242
          <td class="paramtype">int&nbsp;</td>
243
          <td class="paramname"> <em>dest</em>, </td>
244
        </tr>
245
        <tr>
246
          <td class="paramkey"></td>
247
          <td></td>
248
          <td class="paramtype">char&nbsp;</td>
249
          <td class="paramname"> <em>options</em>, </td>
250
        </tr>
251
        <tr>
252
          <td class="paramkey"></td>
253
          <td></td>
254
          <td class="paramtype">char&nbsp;</td>
255
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
256
        </tr>
257
        <tr>
258
          <td></td>
259
          <td>)</td>
260
          <td></td><td></td><td></td>
261
        </tr>
262
      </table>
263
</div>
264
<div class="memdoc">
265

    
266
<p>Send a packet to the XBee. </p>
267
<p>Send the specified packet.</p>
268
<dl><dt><b>Parameters:</b></dt><dd>
269
  <table border="0" cellspacing="2" cellpadding="0">
270
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>the packet data to send </td></tr>
271
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the number of bytes in the packet</td></tr>
272
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</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>
273
    <tr><td valign="top"></td><td valign="top"><em>options</em>&nbsp;</td><td>a combination of the flags XBEE_OPTIONS_NONE, XBEE_OPTIONS_DISABLE_RESPONSE and XBEE_OPTIONS_BROADCAST_ALL_PANS</td></tr>
274
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</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>
275
  </table>
276
  </dd>
277
</dl>
278

    
279
</div>
280
</div>
281
<a class="anchor" id="gab93170c493c5cdfd43a7b640c6ed1d14"></a><!-- doxytag: member="xbee.h::xbee_set_channel" ref="gab93170c493c5cdfd43a7b640c6ed1d14" args="(int channel)" -->
282
<div class="memitem">
283
<div class="memproto">
284
      <table class="memname">
285
        <tr>
286
          <td class="memname">int xbee_set_channel </td>
287
          <td>(</td>
288
          <td class="paramtype">int&nbsp;</td>
289
          <td class="paramname"> <em>channel</em></td>
290
          <td>&nbsp;)&nbsp;</td>
291
          <td></td>
292
        </tr>
293
      </table>
294
</div>
295
<div class="memdoc">
296

    
297
<p>Set the channel the XBee is currently using. </p>
298
<p>Set the channel the XBee is using.</p>
299
<dl><dt><b>Parameters:</b></dt><dd>
300
  <table border="0" cellspacing="2" cellpadding="0">
301
    <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>the channel the XBee will not use, between 0x0B and 0x1A</td></tr>
302
  </table>
303
  </dd>
304
</dl>
305
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#ga133706db81f69ba0a3c169b7a3f42d2a" title="Get the channel the XBee is currently using.">xbee_get_channel</a> </dd></dl>
306

    
307
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00209">wl_set_channel()</a>.</p>
308

    
309
</div>
310
</div>
311
<a class="anchor" id="gade50cbefd7ba8d7361ce2654a298748b"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="gade50cbefd7ba8d7361ce2654a298748b" args="(int id)" -->
312
<div class="memitem">
313
<div class="memproto">
314
      <table class="memname">
315
        <tr>
316
          <td class="memname">int xbee_set_pan_id </td>
317
          <td>(</td>
318
          <td class="paramtype">int&nbsp;</td>
319
          <td class="paramname"> <em>id</em></td>
320
          <td>&nbsp;)&nbsp;</td>
321
          <td></td>
322
        </tr>
323
      </table>
324
</div>
325
<div class="memdoc">
326

    
327
<p>Set the PAN ID for the XBee. </p>
328
<p>Sets the personal area network id.</p>
329
<dl><dt><b>Parameters:</b></dt><dd>
330
  <table border="0" cellspacing="2" cellpadding="0">
331
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>the new personal area network (PAN) id </td></tr>
332
  </table>
333
  </dd>
334
</dl>
335

    
336
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00181">wl_set_pan()</a>.</p>
337

    
338
</div>
339
</div>
340
<a class="anchor" id="ga9334ac71dca1ddd697b1a35a361ade6a"></a><!-- doxytag: member="xbee.h::xbee_terminate" ref="ga9334ac71dca1ddd697b1a35a361ade6a" args="(void)" -->
341
<div class="memitem">
342
<div class="memproto">
343
      <table class="memname">
344
        <tr>
345
          <td class="memname">void xbee_terminate </td>
346
          <td>(</td>
347
          <td class="paramtype">void&nbsp;</td>
348
          <td class="paramname"></td>
349
          <td>&nbsp;)&nbsp;</td>
350
          <td></td>
351
        </tr>
352
      </table>
353
</div>
354
<div class="memdoc">
355

    
356
<p>Uninitialize the XBee library. </p>
357
<p>Call when finished using the XBee library. This releases all sued resources. </p>
358

    
359
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00159">wl_terminate()</a>.</p>
360

    
361
</div>
362
</div>
363
</div>
364
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by&nbsp;
365
<a href="http://www.doxygen.org/index.html">
366
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
367
</body>
368
</html>