Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / group__wireless.html @ 1425

History | View | Annotate | Download (30.6 KB)

1 1425 cmar
<!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 19 bcoltin
<title>libwireless: Wireless</title>
6 1425 cmar
<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 1380 cmar
<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 241 bcoltin
</div>
21 1380 cmar
<div class="contents">
22 1425 cmar
<h1>Wireless</h1>
23
<p>Wireless definitions.
24
<a href="#_details">More...</a></p>
25 1380 cmar
<table border="0" cellpadding="0" cellspacing="0">
26 1425 cmar
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
27
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a></td></tr>
28
<tr><td colspan="2"><h2>Functions</h2></td></tr>
29
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaedd4562415e273ce6537f9c1a0f2701b">wl_init</a> (void)</td></tr>
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the wireless library.  <a href="#gaedd4562415e273ce6537f9c1a0f2701b"></a><br/></td></tr>
31
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga66075ff87a1c9f2c0d7938a26c7830f2">wl_terminate</a> (void)</td></tr>
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Uninitialize the wireless library.  <a href="#ga66075ff87a1c9f2c0d7938a26c7830f2"></a><br/></td></tr>
33
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703">wl_do</a> (void)</td></tr>
34
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform wireless library functionality.  <a href="#ga5c1f1a0e20fc718e59edc29246afd703"></a><br/></td></tr>
35
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga183343ed0594ec1c2b79bb4085d57107">wl_register_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr>
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register a packet group with the wireless library.  <a href="#ga183343ed0594ec1c2b79bb4085d57107"></a><br/></td></tr>
37
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gacdbedf6465798abc7af3bf5fea3d4dd7">wl_unregister_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr>
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregister a packet group with the wireless library.  <a href="#gacdbedf6465798abc7af3bf5fea3d4dd7"></a><br/></td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga6e841a6ef0504538d8650a0a2f5fa869">wl_send_robot_to_robot_global_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr>
40
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to a specific robot in any PAN.  <a href="#ga6e841a6ef0504538d8650a0a2f5fa869"></a><br/></td></tr>
41
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaf8fbadf62eeb754b98b200328fb7a8be">wl_send_robot_to_robot_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr>
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to a specific robot in our PAN.  <a href="#gaf8fbadf62eeb754b98b200328fb7a8be"></a><br/></td></tr>
43
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gada6b187ea58cee5aec18725bf7f24b9a">wl_send_global_packet</a> (char group, char type, char *data, int len, char frame)</td></tr>
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to all robots.  <a href="#gada6b187ea58cee5aec18725bf7f24b9a"></a><br/></td></tr>
45
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga0a1a0e4d885f0e0dde87160a16daa0aa">wl_send_pan_packet</a> (char group, char type, char *data, int len, char frame)</td></tr>
46
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to all robots in our PAN.  <a href="#ga0a1a0e4d885f0e0dde87160a16daa0aa"></a><br/></td></tr>
47
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga754445d2353a70963a489651cff554c1">wl_set_pan</a> (int pan)</td></tr>
48
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the PAN we are using.  <a href="#ga754445d2353a70963a489651cff554c1"></a><br/></td></tr>
49
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a> (void)</td></tr>
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the PAN we are using.  <a href="#ga4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br/></td></tr>
51
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga51d3fe958d44fd92f0e0830ced13139d">wl_set_channel</a> (int channel)</td></tr>
52
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the channel we are using.  <a href="#ga51d3fe958d44fd92f0e0830ced13139d"></a><br/></td></tr>
53
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a> (void)</td></tr>
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the channel we are using.  <a href="#ga2d65d3e35b193da4213755c4bf61ab6b"></a><br/></td></tr>
55
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga6c75a84ff5f9a2bdc156aba522d2adf7">wl_get_xbee_id</a> (void)</td></tr>
56
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the 16-bit address of the XBee module.  <a href="#ga6c75a84ff5f9a2bdc156aba522d2adf7"></a><br/></td></tr>
57
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga344dead0023100eb40f8670a92c9ce5c"></a><!-- doxytag: member="wireless::wl_set_com_port" ref="ga344dead0023100eb40f8670a92c9ce5c" args="(char *port)" -->
58
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr>
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br/></td></tr>
60 19 bcoltin
</table>
61 1425 cmar
<hr/><a name="_details"></a><h2>Detailed Description</h2>
62
<p>Wireless definitions. </p>
63
<p>Contains functions and definitions for dealing with wireless functionality.<br/>
64
<br/>
65
</p>
66
<p>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/>
67
<br/>
68
</p>
69
<p>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. </p>
70
<hr/><h2>Function Documentation</h2>
71
<a class="anchor" id="ga5c1f1a0e20fc718e59edc29246afd703"></a><!-- doxytag: member="wireless.h::wl_do" ref="ga5c1f1a0e20fc718e59edc29246afd703" args="(void)" -->
72 241 bcoltin
<div class="memitem">
73
<div class="memproto">
74
      <table class="memname">
75 19 bcoltin
        <tr>
76 1425 cmar
          <td class="memname">void wl_do </td>
77 241 bcoltin
          <td>(</td>
78
          <td class="paramtype">void&nbsp;</td>
79 1425 cmar
          <td class="paramname"></td>
80 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
81 1380 cmar
          <td></td>
82 19 bcoltin
        </tr>
83
      </table>
84 241 bcoltin
</div>
85
<div class="memdoc">
86 19 bcoltin
87 1425 cmar
<p>Perform wireless library functionality. </p>
88
<p>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. </p>
89 1380 cmar
90 1425 cmar
<p>References <a class="el" href="structPacketGroupHandler.html#a5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>, <a class="el" href="structPacketGroupHandler.html#a045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>, <a class="el" href="xbee_8c_source.html#l00725">xbee_get_packet()</a>, <a class="el" href="xbee_8h_source.html#l00074">XBEE_RX</a>, and <a class="el" href="xbee_8h_source.html#l00072">XBEE_TX_STATUS</a>.</p>
91 1395 cmar
92 1425 cmar
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00101">wl_basic_do_default()</a>.</p>
93
94 241 bcoltin
</div>
95 1425 cmar
</div>
96
<a class="anchor" id="ga2d65d3e35b193da4213755c4bf61ab6b"></a><!-- doxytag: member="wireless.h::wl_get_channel" ref="ga2d65d3e35b193da4213755c4bf61ab6b" args="(void)" -->
97 241 bcoltin
<div class="memitem">
98
<div class="memproto">
99
      <table class="memname">
100 60 bcoltin
        <tr>
101 1425 cmar
          <td class="memname">int wl_get_channel </td>
102 241 bcoltin
          <td>(</td>
103
          <td class="paramtype">void&nbsp;</td>
104 1425 cmar
          <td class="paramname"></td>
105 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
106 1380 cmar
          <td></td>
107 60 bcoltin
        </tr>
108
      </table>
109 241 bcoltin
</div>
110
<div class="memdoc">
111 60 bcoltin
112 1425 cmar
<p>Get the channel we are using. </p>
113
<p>Get the channel the XBee is part of.</p>
114
<dl class="return"><dt><b>Returns:</b></dt><dd>the channel the XBee is part of</dd></dl>
115
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#ga51d3fe958d44fd92f0e0830ced13139d" title="Set the channel we are using.">wl_set_channel</a> </dd></dl>
116 241 bcoltin
117 1380 cmar
<p>References <a class="el" href="xbee_8c_source.html#l00993">xbee_get_channel()</a>.</p>
118
119 241 bcoltin
</div>
120 1425 cmar
</div>
121
<a class="anchor" id="ga4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><!-- doxytag: member="wireless.h::wl_get_pan" ref="ga4e6b5c97d40a8e7557a1b4b90a7d34f7" args="(void)" -->
122 241 bcoltin
<div class="memitem">
123
<div class="memproto">
124
      <table class="memname">
125 60 bcoltin
        <tr>
126 1425 cmar
          <td class="memname">int wl_get_pan </td>
127 241 bcoltin
          <td>(</td>
128
          <td class="paramtype">void&nbsp;</td>
129 1425 cmar
          <td class="paramname"></td>
130 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
131 1380 cmar
          <td></td>
132 60 bcoltin
        </tr>
133
      </table>
134 241 bcoltin
</div>
135
<div class="memdoc">
136 60 bcoltin
137 1425 cmar
<p>Get the PAN we are using. </p>
138
<p>Get the PAN the XBee is currently part of.</p>
139
<dl class="return"><dt><b>Returns:</b></dt><dd>the PAN of the XBee</dd></dl>
140
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#ga754445d2353a70963a489651cff554c1" title="Set the PAN we are using.">wl_set_pan</a> </dd></dl>
141 241 bcoltin
142 1380 cmar
<p>References <a class="el" href="xbee_8c_source.html#l00955">xbee_get_pan_id()</a>.</p>
143
144 241 bcoltin
</div>
145 1425 cmar
</div>
146
<a class="anchor" id="ga6c75a84ff5f9a2bdc156aba522d2adf7"></a><!-- doxytag: member="wireless.h::wl_get_xbee_id" ref="ga6c75a84ff5f9a2bdc156aba522d2adf7" args="(void)" -->
147 241 bcoltin
<div class="memitem">
148
<div class="memproto">
149
      <table class="memname">
150 19 bcoltin
        <tr>
151 1425 cmar
          <td class="memname">int wl_get_xbee_id </td>
152 241 bcoltin
          <td>(</td>
153
          <td class="paramtype">void&nbsp;</td>
154 1425 cmar
          <td class="paramname"></td>
155 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
156 1380 cmar
          <td></td>
157 19 bcoltin
        </tr>
158
      </table>
159 241 bcoltin
</div>
160
<div class="memdoc">
161 19 bcoltin
162 1425 cmar
<p>Get the 16-bit address of the XBee module. </p>
163
<p>Returns the 16-bit address of the XBee module.</p>
164
<dl class="return"><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee module. </dd></dl>
165 241 bcoltin
166 1380 cmar
<p>References <a class="el" href="xbee_8c_source.html#l01007">xbee_get_address()</a>.</p>
167
168
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00367">wl_token_get_my_sensor_reading()</a>, <a class="el" href="wl__token__ring_8c_source.html#l00347">wl_token_get_sensor_reading()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p>
169
170 241 bcoltin
</div>
171 1425 cmar
</div>
172
<a class="anchor" id="gaedd4562415e273ce6537f9c1a0f2701b"></a><!-- doxytag: member="wireless.h::wl_init" ref="gaedd4562415e273ce6537f9c1a0f2701b" args="(void)" -->
173 241 bcoltin
<div class="memitem">
174
<div class="memproto">
175
      <table class="memname">
176 19 bcoltin
        <tr>
177 1425 cmar
          <td class="memname">int wl_init </td>
178 241 bcoltin
          <td>(</td>
179
          <td class="paramtype">void&nbsp;</td>
180 1425 cmar
          <td class="paramname"></td>
181 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
182 1380 cmar
          <td></td>
183 19 bcoltin
        </tr>
184
      </table>
185 241 bcoltin
</div>
186
<div class="memdoc">
187 19 bcoltin
188 1425 cmar
<p>Initialize the wireless library. </p>
189
<p>Initializes the wireless library. Must be called before any other function.</p>
190
<dl><dt><b>Parameters:</b></dt><dd>
191 737 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
192
    <tr><td valign="top"></td><td valign="top"><em>wl_port</em>&nbsp;</td><td>File descriptor for wireless port, or NULL for default. </td></tr>
193
  </table>
194 1425 cmar
  </dd>
195 737 bcoltin
</dl>
196
197 1380 cmar
<p>References <a class="el" href="wireless_8h_source.html#l00047">WL_MAX_PACKET_GROUPS</a>, and <a class="el" href="xbee_8c_source.html#l00206">xbee_lib_init()</a>.</p>
198
199 1425 cmar
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00020">wl_basic_init()</a>.</p>
200 1380 cmar
201 241 bcoltin
</div>
202 1425 cmar
</div>
203
<a class="anchor" id="ga183343ed0594ec1c2b79bb4085d57107"></a><!-- doxytag: member="wireless.h::wl_register_packet_group" ref="ga183343ed0594ec1c2b79bb4085d57107" args="(PacketGroupHandler *h)" -->
204 241 bcoltin
<div class="memitem">
205
<div class="memproto">
206
      <table class="memname">
207 19 bcoltin
        <tr>
208 1425 cmar
          <td class="memname">void wl_register_packet_group </td>
209 241 bcoltin
          <td>(</td>
210
          <td class="paramtype"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *&nbsp;</td>
211 1425 cmar
          <td class="paramname"> <em>h</em></td>
212 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
213 1380 cmar
          <td></td>
214 19 bcoltin
        </tr>
215
      </table>
216 241 bcoltin
</div>
217
<div class="memdoc">
218 19 bcoltin
219 1425 cmar
<p>Register a packet group with the wireless library. </p>
220
<p>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>
221
<dl><dt><b>Parameters:</b></dt><dd>
222 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
223
    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>the <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> to register </td></tr>
224
  </table>
225 1425 cmar
  </dd>
226 19 bcoltin
</dl>
227 241 bcoltin
228 1380 cmar
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, and <a class="el" href="wireless_8h_source.html#l00047">WL_MAX_PACKET_GROUPS</a>.</p>
229
230 1395 cmar
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, <a class="el" href="wl__error__group_8c_source.html#l00066">wl_error_register()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p>
231 1380 cmar
232 241 bcoltin
</div>
233 1425 cmar
</div>
234
<a class="anchor" id="gada6b187ea58cee5aec18725bf7f24b9a"></a><!-- doxytag: member="wireless.h::wl_send_global_packet" ref="gada6b187ea58cee5aec18725bf7f24b9a" args="(char group, char type, char *data, int len, char frame)" -->
235 241 bcoltin
<div class="memitem">
236
<div class="memproto">
237
      <table class="memname">
238 19 bcoltin
        <tr>
239 1425 cmar
          <td class="memname">int wl_send_global_packet </td>
240 241 bcoltin
          <td>(</td>
241
          <td class="paramtype">char&nbsp;</td>
242
          <td class="paramname"> <em>group</em>, </td>
243 19 bcoltin
        </tr>
244
        <tr>
245 241 bcoltin
          <td class="paramkey"></td>
246
          <td></td>
247
          <td class="paramtype">char&nbsp;</td>
248
          <td class="paramname"> <em>type</em>, </td>
249 19 bcoltin
        </tr>
250
        <tr>
251 241 bcoltin
          <td class="paramkey"></td>
252
          <td></td>
253
          <td class="paramtype">char *&nbsp;</td>
254
          <td class="paramname"> <em>data</em>, </td>
255 19 bcoltin
        </tr>
256
        <tr>
257 241 bcoltin
          <td class="paramkey"></td>
258
          <td></td>
259
          <td class="paramtype">int&nbsp;</td>
260
          <td class="paramname"> <em>len</em>, </td>
261 19 bcoltin
        </tr>
262
        <tr>
263 241 bcoltin
          <td class="paramkey"></td>
264
          <td></td>
265
          <td class="paramtype">char&nbsp;</td>
266
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
267 19 bcoltin
        </tr>
268
        <tr>
269 241 bcoltin
          <td></td>
270
          <td>)</td>
271 1380 cmar
          <td></td><td></td><td></td>
272 19 bcoltin
        </tr>
273
      </table>
274 241 bcoltin
</div>
275
<div class="memdoc">
276 19 bcoltin
277 1425 cmar
<p>Send a packet to all robots. </p>
278
<p>Send a packet to all XBees in all PANs.</p>
279
<dl><dt><b>Parameters:</b></dt><dd>
280 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
281
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group </td></tr>
282
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
283
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the packet data </td></tr>
284
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the packet length in bytes </td></tr>
285
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to see with a TX_STATUS response </td></tr>
286
  </table>
287 1425 cmar
  </dd>
288 19 bcoltin
</dl>
289 241 bcoltin
290 1380 cmar
<p>References <a class="el" href="xbee_8h_source.html#l00064">XBEE_BROADCAST</a>, and <a class="el" href="xbee_8h_source.html#l00070">XBEE_OPTIONS_BROADCAST_ALL_PANS</a>.</p>
291
292 1395 cmar
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00072">wl_basic_send_global_packet()</a>, <a class="el" href="wl__error__group_8c_source.html#l00123">wl_error_send_string()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00141">wl_token_ring_join()</a>.</p>
293 1380 cmar
294 241 bcoltin
</div>
295 1425 cmar
</div>
296
<a class="anchor" id="ga0a1a0e4d885f0e0dde87160a16daa0aa"></a><!-- doxytag: member="wireless.h::wl_send_pan_packet" ref="ga0a1a0e4d885f0e0dde87160a16daa0aa" args="(char group, char type, char *data, int len, char frame)" -->
297 241 bcoltin
<div class="memitem">
298
<div class="memproto">
299
      <table class="memname">
300 19 bcoltin
        <tr>
301 1425 cmar
          <td class="memname">void wl_send_pan_packet </td>
302 241 bcoltin
          <td>(</td>
303
          <td class="paramtype">char&nbsp;</td>
304
          <td class="paramname"> <em>group</em>, </td>
305 19 bcoltin
        </tr>
306
        <tr>
307 241 bcoltin
          <td class="paramkey"></td>
308
          <td></td>
309
          <td class="paramtype">char&nbsp;</td>
310
          <td class="paramname"> <em>type</em>, </td>
311 19 bcoltin
        </tr>
312
        <tr>
313 241 bcoltin
          <td class="paramkey"></td>
314
          <td></td>
315
          <td class="paramtype">char *&nbsp;</td>
316
          <td class="paramname"> <em>data</em>, </td>
317 19 bcoltin
        </tr>
318
        <tr>
319 241 bcoltin
          <td class="paramkey"></td>
320
          <td></td>
321
          <td class="paramtype">int&nbsp;</td>
322
          <td class="paramname"> <em>len</em>, </td>
323 19 bcoltin
        </tr>
324
        <tr>
325 241 bcoltin
          <td class="paramkey"></td>
326
          <td></td>
327
          <td class="paramtype">char&nbsp;</td>
328
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
329 19 bcoltin
        </tr>
330
        <tr>
331 241 bcoltin
          <td></td>
332
          <td>)</td>
333 1380 cmar
          <td></td><td></td><td></td>
334 19 bcoltin
        </tr>
335
      </table>
336 241 bcoltin
</div>
337
<div class="memdoc">
338 19 bcoltin
339 1425 cmar
<p>Send a packet to all robots in our PAN. </p>
340
<p>Send a packet to all XBee's in the same PAN.</p>
341
<dl><dt><b>Parameters:</b></dt><dd>
342 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
343
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group </td></tr>
344
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
345
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the packet data </td></tr>
346
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the packet length in bytes </td></tr>
347
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to see with a TX_STATUS response </td></tr>
348
  </table>
349 1425 cmar
  </dd>
350 19 bcoltin
</dl>
351 241 bcoltin
352 1380 cmar
<p>References <a class="el" href="xbee_8h_source.html#l00064">XBEE_BROADCAST</a>, and <a class="el" href="xbee_8h_source.html#l00066">XBEE_OPTIONS_NONE</a>.</p>
353
354 241 bcoltin
</div>
355 1425 cmar
</div>
356
<a class="anchor" id="ga6e841a6ef0504538d8650a0a2f5fa869"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_global_packet" ref="ga6e841a6ef0504538d8650a0a2f5fa869" args="(char group, char type, char *data, int len, int dest, char frame)" -->
357 241 bcoltin
<div class="memitem">
358
<div class="memproto">
359
      <table class="memname">
360 19 bcoltin
        <tr>
361 1425 cmar
          <td class="memname">int wl_send_robot_to_robot_global_packet </td>
362 241 bcoltin
          <td>(</td>
363
          <td class="paramtype">char&nbsp;</td>
364
          <td class="paramname"> <em>group</em>, </td>
365 19 bcoltin
        </tr>
366
        <tr>
367 241 bcoltin
          <td class="paramkey"></td>
368
          <td></td>
369
          <td class="paramtype">char&nbsp;</td>
370
          <td class="paramname"> <em>type</em>, </td>
371 19 bcoltin
        </tr>
372
        <tr>
373 241 bcoltin
          <td class="paramkey"></td>
374
          <td></td>
375
          <td class="paramtype">char *&nbsp;</td>
376
          <td class="paramname"> <em>data</em>, </td>
377 19 bcoltin
        </tr>
378
        <tr>
379 241 bcoltin
          <td class="paramkey"></td>
380
          <td></td>
381
          <td class="paramtype">int&nbsp;</td>
382
          <td class="paramname"> <em>len</em>, </td>
383 19 bcoltin
        </tr>
384
        <tr>
385 241 bcoltin
          <td class="paramkey"></td>
386
          <td></td>
387
          <td class="paramtype">int&nbsp;</td>
388
          <td class="paramname"> <em>dest</em>, </td>
389 19 bcoltin
        </tr>
390
        <tr>
391 241 bcoltin
          <td class="paramkey"></td>
392
          <td></td>
393
          <td class="paramtype">char&nbsp;</td>
394
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
395 19 bcoltin
        </tr>
396
        <tr>
397 241 bcoltin
          <td></td>
398
          <td>)</td>
399 1380 cmar
          <td></td><td></td><td></td>
400 19 bcoltin
        </tr>
401
      </table>
402 241 bcoltin
</div>
403
<div class="memdoc">
404 19 bcoltin
405 1425 cmar
<p>Send a packet to a specific robot in any PAN. </p>
406
<p>Send a packet to a specific XBee without specifying a PAN.</p>
407
<dl><dt><b>Parameters:</b></dt><dd>
408 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
409
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group </td></tr>
410
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
411
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the packet data </td></tr>
412
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the packet length in bytes </td></tr>
413
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>the 16-bit address of the XBee to send the packet to </td></tr>
414
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to see with a TX_STATUS response </td></tr>
415
  </table>
416 1425 cmar
  </dd>
417 19 bcoltin
</dl>
418 241 bcoltin
419 1380 cmar
<p>References <a class="el" href="xbee_8h_source.html#l00070">XBEE_OPTIONS_BROADCAST_ALL_PANS</a>.</p>
420
421 1395 cmar
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00061">wl_basic_send_robot_packet()</a>.</p>
422 1380 cmar
423 241 bcoltin
</div>
424 1425 cmar
</div>
425
<a class="anchor" id="gaf8fbadf62eeb754b98b200328fb7a8be"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_packet" ref="gaf8fbadf62eeb754b98b200328fb7a8be" args="(char group, char type, char *data, int len, int dest, char frame)" -->
426 241 bcoltin
<div class="memitem">
427
<div class="memproto">
428
      <table class="memname">
429 19 bcoltin
        <tr>
430 1425 cmar
          <td class="memname">int wl_send_robot_to_robot_packet </td>
431 241 bcoltin
          <td>(</td>
432
          <td class="paramtype">char&nbsp;</td>
433
          <td class="paramname"> <em>group</em>, </td>
434 19 bcoltin
        </tr>
435
        <tr>
436 241 bcoltin
          <td class="paramkey"></td>
437
          <td></td>
438
          <td class="paramtype">char&nbsp;</td>
439
          <td class="paramname"> <em>type</em>, </td>
440 19 bcoltin
        </tr>
441
        <tr>
442 241 bcoltin
          <td class="paramkey"></td>
443
          <td></td>
444
          <td class="paramtype">char *&nbsp;</td>
445
          <td class="paramname"> <em>data</em>, </td>
446 19 bcoltin
        </tr>
447
        <tr>
448 241 bcoltin
          <td class="paramkey"></td>
449
          <td></td>
450
          <td class="paramtype">int&nbsp;</td>
451
          <td class="paramname"> <em>len</em>, </td>
452 19 bcoltin
        </tr>
453
        <tr>
454 241 bcoltin
          <td class="paramkey"></td>
455
          <td></td>
456
          <td class="paramtype">int&nbsp;</td>
457
          <td class="paramname"> <em>dest</em>, </td>
458 19 bcoltin
        </tr>
459
        <tr>
460 241 bcoltin
          <td class="paramkey"></td>
461
          <td></td>
462
          <td class="paramtype">char&nbsp;</td>
463
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
464 19 bcoltin
        </tr>
465
        <tr>
466 241 bcoltin
          <td></td>
467
          <td>)</td>
468 1380 cmar
          <td></td><td></td><td></td>
469 19 bcoltin
        </tr>
470
      </table>
471 241 bcoltin
</div>
472
<div class="memdoc">
473 19 bcoltin
474 1425 cmar
<p>Send a packet to a specific robot in our PAN. </p>
475
<p>Send a packet to a specific XBee in the same PAN.</p>
476
<dl><dt><b>Parameters:</b></dt><dd>
477 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
478
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group </td></tr>
479
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
480
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the packet data </td></tr>
481
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the packet length in bytes </td></tr>
482
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>the 16-bit address of the XBee to send the packet to </td></tr>
483
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to see with a TX_STATUS response </td></tr>
484
  </table>
485 1425 cmar
  </dd>
486 19 bcoltin
</dl>
487 241 bcoltin
488 1380 cmar
<p>References <a class="el" href="xbee_8h_source.html#l00066">XBEE_OPTIONS_NONE</a>.</p>
489
490 241 bcoltin
</div>
491 1425 cmar
</div>
492
<a class="anchor" id="ga51d3fe958d44fd92f0e0830ced13139d"></a><!-- doxytag: member="wireless.h::wl_set_channel" ref="ga51d3fe958d44fd92f0e0830ced13139d" args="(int channel)" -->
493 241 bcoltin
<div class="memitem">
494
<div class="memproto">
495
      <table class="memname">
496 60 bcoltin
        <tr>
497 1425 cmar
          <td class="memname">int wl_set_channel </td>
498 241 bcoltin
          <td>(</td>
499
          <td class="paramtype">int&nbsp;</td>
500 1425 cmar
          <td class="paramname"> <em>channel</em></td>
501 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
502 1380 cmar
          <td></td>
503 60 bcoltin
        </tr>
504
      </table>
505 241 bcoltin
</div>
506
<div class="memdoc">
507 60 bcoltin
508 1425 cmar
<p>Set the channel we are using. </p>
509
<p>Set the channel the XBee is listening to.</p>
510
<dl><dt><b>Parameters:</b></dt><dd>
511 60 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
512
    <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>the new channel to join</td></tr>
513
  </table>
514 1425 cmar
  </dd>
515 60 bcoltin
</dl>
516 1425 cmar
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#ga2d65d3e35b193da4213755c4bf61ab6b" title="Get the channel we are using.">wl_get_channel</a> </dd></dl>
517 241 bcoltin
518 1380 cmar
<p>References <a class="el" href="xbee_8c_source.html#l00968">xbee_set_channel()</a>.</p>
519
520 241 bcoltin
</div>
521 1425 cmar
</div>
522
<a class="anchor" id="ga754445d2353a70963a489651cff554c1"></a><!-- doxytag: member="wireless.h::wl_set_pan" ref="ga754445d2353a70963a489651cff554c1" args="(int pan)" -->
523 241 bcoltin
<div class="memitem">
524
<div class="memproto">
525
      <table class="memname">
526 60 bcoltin
        <tr>
527 1425 cmar
          <td class="memname">int wl_set_pan </td>
528 241 bcoltin
          <td>(</td>
529
          <td class="paramtype">int&nbsp;</td>
530 1425 cmar
          <td class="paramname"> <em>pan</em></td>
531 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
532 1380 cmar
          <td></td>
533 60 bcoltin
        </tr>
534
      </table>
535 241 bcoltin
</div>
536
<div class="memdoc">
537 60 bcoltin
538 1425 cmar
<p>Set the PAN we are using. </p>
539
<p>Set the PAN for the XBee to join.</p>
540
<dl><dt><b>Parameters:</b></dt><dd>
541 60 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
542
    <tr><td valign="top"></td><td valign="top"><em>pan</em>&nbsp;</td><td>the new PAN</td></tr>
543
  </table>
544 1425 cmar
  </dd>
545 60 bcoltin
</dl>
546 1425 cmar
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#ga4e6b5c97d40a8e7557a1b4b90a7d34f7" title="Get the PAN we are using.">wl_get_pan</a> </dd></dl>
547 241 bcoltin
548 1380 cmar
<p>References <a class="el" href="xbee_8c_source.html#l00937">xbee_set_pan_id()</a>.</p>
549
550 241 bcoltin
</div>
551 1425 cmar
</div>
552
<a class="anchor" id="ga66075ff87a1c9f2c0d7938a26c7830f2"></a><!-- doxytag: member="wireless.h::wl_terminate" ref="ga66075ff87a1c9f2c0d7938a26c7830f2" args="(void)" -->
553 241 bcoltin
<div class="memitem">
554
<div class="memproto">
555
      <table class="memname">
556 19 bcoltin
        <tr>
557 1425 cmar
          <td class="memname">void wl_terminate </td>
558 241 bcoltin
          <td>(</td>
559
          <td class="paramtype">void&nbsp;</td>
560 1425 cmar
          <td class="paramname"></td>
561 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
562 1380 cmar
          <td></td>
563 19 bcoltin
        </tr>
564
      </table>
565 241 bcoltin
</div>
566
<div class="memdoc">
567 19 bcoltin
568 1425 cmar
<p>Uninitialize the wireless library. </p>
569
<p>Uninitializes the wireless library. </p>
570 1380 cmar
571 1425 cmar
<p>References <a class="el" href="structPacketGroupHandler.html#ac03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>, <a class="el" href="wireless_8h_source.html#l00047">WL_MAX_PACKET_GROUPS</a>, and <a class="el" href="xbee_8c_source.html#l00339">xbee_terminate()</a>.</p>
572
573 241 bcoltin
</div>
574 1425 cmar
</div>
575
<a class="anchor" id="gacdbedf6465798abc7af3bf5fea3d4dd7"></a><!-- doxytag: member="wireless.h::wl_unregister_packet_group" ref="gacdbedf6465798abc7af3bf5fea3d4dd7" args="(PacketGroupHandler *h)" -->
576 241 bcoltin
<div class="memitem">
577
<div class="memproto">
578
      <table class="memname">
579 19 bcoltin
        <tr>
580 1425 cmar
          <td class="memname">void wl_unregister_packet_group </td>
581 241 bcoltin
          <td>(</td>
582
          <td class="paramtype"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *&nbsp;</td>
583 1425 cmar
          <td class="paramname"> <em>h</em></td>
584 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
585 1380 cmar
          <td></td>
586 19 bcoltin
        </tr>
587
      </table>
588 241 bcoltin
</div>
589
<div class="memdoc">
590 19 bcoltin
591 1425 cmar
<p>Unregister a packet group with the wireless library. </p>
592
<p>Unregister a packet group from the wireless library.</p>
593
<dl><dt><b>Parameters:</b></dt><dd>
594 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
595
    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>the packet group to remove </td></tr>
596
  </table>
597 1425 cmar
  </dd>
598 19 bcoltin
</dl>
599 241 bcoltin
600 1425 cmar
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, and <a class="el" href="structPacketGroupHandler.html#ac03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>.</p>
601 1380 cmar
602
<p>Referenced by <a class="el" href="wl__error__group_8c_source.html#l00079">wl_error_unregister()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00196">wl_token_ring_unregister()</a>.</p>
603
604 241 bcoltin
</div>
605 1380 cmar
</div>
606 1425 cmar
</div>
607
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by&nbsp;
608 19 bcoltin
<a href="http://www.doxygen.org/index.html">
609 1425 cmar
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
610 19 bcoltin
</body>
611
</html>