root / branches / wireless / docs / libwireless / html / group__functions.html @ 1823
History | View | Annotate | Download (21.5 KB)
1 | 1584 | dsschult | <!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>Colony: Public API Functions</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.8 -->
|
||
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="files.html"><span>Files</span></a></li> |
||
14 | </ul>
|
||
15 | </div>
|
||
16 | </div>
|
||
17 | <div class="contents"> |
||
18 | <h1>Public API Functions<br> |
||
19 | <small>
|
||
20 | [<a class="el" href="group__wireless.html">Wireless</a>]</small> |
||
21 | </h1><table border="0" cellpadding="0" cellspacing="0"> |
||
22 | <tr><td></td></tr> |
||
23 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
24 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr> |
||
25 | |||
26 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize wireless. <a href="#g6a8d6179b1fe27f762937f0b47af2009"></a><br></td></tr> |
||
27 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#g223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr> |
||
28 | |||
29 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Terminate wireless. <a href="#g223f437c2bc8ab8a3ac2e0e06841120f"></a><br></td></tr> |
||
30 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gaa4e0d7014a74d0d59c08f9fbbf40bd7"></a><!-- doxytag: member="functions::wl_send" ref="gaa4e0d7014a74d0d59c08f9fbbf40bd7" args="(char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)" --> |
||
31 | int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)</td></tr> |
||
32 | |||
33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The core send function. This will take all possible arguments and send all types of packets. <br></td></tr> |
||
34 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#gd92093466d82f3f0c732ffe8323228d2">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
||
35 | |||
36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel. <a href="#gd92093466d82f3f0c732ffe8323228d2"></a><br></td></tr> |
||
37 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#g7886c2a37b7350211699dcabe48ff076">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
||
38 | |||
39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan. <a href="#g7886c2a37b7350211699dcabe48ff076"></a><br></td></tr> |
||
40 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbb08f7957bd0256c51f424fa770d3e60"></a><!-- doxytag: member="functions::wl_send_robot" ref="gbb08f7957bd0256c51f424fa770d3e60" args="(char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)" --> |
||
41 | int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#gbb08f7957bd0256c51f424fa770d3e60">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)</td></tr> |
||
42 | |||
43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel to a specific robot. <br></td></tr> |
||
44 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wl_send_basic</a> (char *data, uint8_t length)</td></tr> |
||
45 | |||
46 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="#ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><br></td></tr> |
||
47 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr> |
||
48 | |||
49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors. <a href="#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr> |
||
50 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#ga364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr> |
||
51 | |||
52 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Checks a specific packet for the acknowledgement status. <a href="#ga364aa4d9cc8c789f05401e8adf44785"></a><br></td></tr> |
||
53 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#g62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr> |
||
54 | |||
55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Resets acknowledgement statistics back to zero. <a href="#g62e126abfcd382ec02524dd2f45a8a7b"></a><br></td></tr> |
||
56 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#ga5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr> |
||
57 | |||
58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The main receive function. Dispatches packets for registered handlers and returns next basic packet if available. <a href="#ga5a965e3443e4b2b60243225c50ecca7"></a><br></td></tr> |
||
59 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#ge2509e2b6bc61faa26d87b1d87881817">wl_get_basic</a> (char *data, uint8_t length)</td></tr> |
||
60 | |||
61 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next basic packet if available. <a href="#ge2509e2b6bc61faa26d87b1d87881817"></a><br></td></tr> |
||
62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge91c1e1940dfbbd063fdcfb86049c64a"></a><!-- doxytag: member="functions::wl_dispatch" ref="ge91c1e1940dfbbd063fdcfb86049c64a" args="(void)" --> |
||
63 | int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#ge91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr> |
||
64 | |||
65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr> |
||
66 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functions.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr> |
||
67 | |||
68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Function to register new packet handlers (for non-default groups only). <a href="#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr> |
||
69 | </table>
|
||
70 | <hr><h2>Function Documentation</h2> |
||
71 | <a class="anchor" name="ga364aa4d9cc8c789f05401e8adf44785"></a><!-- doxytag: member="wireless.h::wl_ack_check" ref="ga364aa4d9cc8c789f05401e8adf44785" args="(uint8_t packet)" --> |
||
72 | <div class="memitem"> |
||
73 | <div class="memproto"> |
||
74 | <table class="memname"> |
||
75 | <tr>
|
||
76 | <td class="memname">int8_t wl_ack_check </td> |
||
77 | <td>(</td> |
||
78 | <td class="paramtype">uint8_t </td> |
||
79 | <td class="paramname"> <em>packet</em> </td> |
||
80 | <td> ) </td> |
||
81 | <td></td> |
||
82 | </tr>
|
||
83 | </table>
|
||
84 | </div>
|
||
85 | <div class="memdoc"> |
||
86 | |||
87 | <p>
|
||
88 | acknowledgement error check check if a specific packet has been lost note: buffer will overflow ever 255 packets<p>
|
||
89 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
90 | <table border="0" cellspacing="2" cellpadding="0"> |
||
91 | <tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>number</td></tr> |
||
92 | </table>
|
||
93 | </dl>
|
||
94 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>0=still sending,1=ack received,-1=ack failure </dd></dl> |
||
95 | |||
96 | </div>
|
||
97 | </div><p> |
||
98 | <a class="anchor" name="g11aeeac54834f0357794ae60a7513acf"></a><!-- doxytag: member="wireless.h::wl_ack_error" ref="g11aeeac54834f0357794ae60a7513acf" args="(void)" --> |
||
99 | <div class="memitem"> |
||
100 | <div class="memproto"> |
||
101 | <table class="memname"> |
||
102 | <tr>
|
||
103 | <td class="memname">int8_t wl_ack_error </td> |
||
104 | <td>(</td> |
||
105 | <td class="paramtype">void </td> |
||
106 | <td class="paramname"> </td> |
||
107 | <td> ) </td> |
||
108 | <td></td> |
||
109 | </tr>
|
||
110 | </table>
|
||
111 | </div>
|
||
112 | <div class="memdoc"> |
||
113 | |||
114 | <p>
|
||
115 | acknowledgment error check if any of the packets you have sent have been lost.<p>
|
||
116 | note that all other error checking will be handled by library, so your user behavior won't have to worry about it<p>
|
||
117 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>the # of packets lost (up to 255) </dd></dl> |
||
118 | |||
119 | </div>
|
||
120 | </div><p> |
||
121 | <a class="anchor" name="g62e126abfcd382ec02524dd2f45a8a7b"></a><!-- doxytag: member="wireless.h::wl_ack_reset" ref="g62e126abfcd382ec02524dd2f45a8a7b" args="(void)" --> |
||
122 | <div class="memitem"> |
||
123 | <div class="memproto"> |
||
124 | <table class="memname"> |
||
125 | <tr>
|
||
126 | <td class="memname">void wl_ack_reset </td> |
||
127 | <td>(</td> |
||
128 | <td class="paramtype">void </td> |
||
129 | <td class="paramname"> </td> |
||
130 | <td> ) </td> |
||
131 | <td></td> |
||
132 | </tr>
|
||
133 | </table>
|
||
134 | </div>
|
||
135 | <div class="memdoc"> |
||
136 | |||
137 | <p>
|
||
138 | acknowledgement reset reset the acknowledgement buffer |
||
139 | </div>
|
||
140 | </div><p> |
||
141 | <a class="anchor" name="ga5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless.h::wl_get" ref="ga5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" --> |
||
142 | <div class="memitem"> |
||
143 | <div class="memproto"> |
||
144 | <table class="memname"> |
||
145 | <tr>
|
||
146 | <td class="memname">int8_t wl_get </td> |
||
147 | <td>(</td> |
||
148 | <td class="paramtype">char * </td> |
||
149 | <td class="paramname"> <em>data</em>, </td> |
||
150 | </tr>
|
||
151 | <tr>
|
||
152 | <td class="paramkey"></td> |
||
153 | <td></td> |
||
154 | <td class="paramtype">uint8_t </td> |
||
155 | <td class="paramname"> <em>length</em></td><td> </td> |
||
156 | </tr>
|
||
157 | <tr>
|
||
158 | <td></td> |
||
159 | <td>)</td> |
||
160 | <td></td><td></td><td></td> |
||
161 | </tr>
|
||
162 | </table>
|
||
163 | </div>
|
||
164 | <div class="memdoc"> |
||
165 | |||
166 | <p>
|
||
167 | the main receive function (similar to wl_do)<p>
|
||
168 | when called, this function will receive the next packet on the default packet group it will also dispatch registered packet handler functions for any other packet groups it has received<p>
|
||
169 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
170 | <table border="0" cellspacing="2" cellpadding="0"> |
||
171 | <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>an already-initialized array to store the default group packet data in </td></tr> |
||
172 | <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the initialized data array</td></tr> |
||
173 | </table>
|
||
174 | </dl>
|
||
175 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (<0) </dd></dl> |
||
176 | |||
177 | </div>
|
||
178 | </div><p> |
||
179 | <a class="anchor" name="ge2509e2b6bc61faa26d87b1d87881817"></a><!-- doxytag: member="wireless.h::wl_get_basic" ref="ge2509e2b6bc61faa26d87b1d87881817" args="(char *data, uint8_t length)" --> |
||
180 | <div class="memitem"> |
||
181 | <div class="memproto"> |
||
182 | <table class="memname"> |
||
183 | <tr>
|
||
184 | <td class="memname">int8_t wl_get_basic </td> |
||
185 | <td>(</td> |
||
186 | <td class="paramtype">char * </td> |
||
187 | <td class="paramname"> <em>data</em>, </td> |
||
188 | </tr>
|
||
189 | <tr>
|
||
190 | <td class="paramkey"></td> |
||
191 | <td></td> |
||
192 | <td class="paramtype">uint8_t </td> |
||
193 | <td class="paramname"> <em>length</em></td><td> </td> |
||
194 | </tr>
|
||
195 | <tr>
|
||
196 | <td></td> |
||
197 | <td>)</td> |
||
198 | <td></td><td></td><td></td> |
||
199 | </tr>
|
||
200 | </table>
|
||
201 | </div>
|
||
202 | <div class="memdoc"> |
||
203 | |||
204 | <p>
|
||
205 | function to receive only packets on the default group this function is only meant to receive packets sent using <a class="el" href="group__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0" title="Default (i.e. basic) send wrapper.">wl_send_basic()</a><p> |
||
206 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
207 | <table border="0" cellspacing="2" cellpadding="0"> |
||
208 | <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>an already-initialized array to store the default group packet data in </td></tr> |
||
209 | <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the initialized data array</td></tr> |
||
210 | </table>
|
||
211 | </dl>
|
||
212 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (<0) </dd></dl> |
||
213 | |||
214 | </div>
|
||
215 | </div><p> |
||
216 | <a class="anchor" name="g6a8d6179b1fe27f762937f0b47af2009"></a><!-- doxytag: member="wireless.h::wl_init" ref="g6a8d6179b1fe27f762937f0b47af2009" args="(void)" --> |
||
217 | <div class="memitem"> |
||
218 | <div class="memproto"> |
||
219 | <table class="memname"> |
||
220 | <tr>
|
||
221 | <td class="memname">int8_t wl_init </td> |
||
222 | <td>(</td> |
||
223 | <td class="paramtype">void </td> |
||
224 | <td class="paramname"> </td> |
||
225 | <td> ) </td> |
||
226 | <td></td> |
||
227 | </tr>
|
||
228 | </table>
|
||
229 | </div>
|
||
230 | <div class="memdoc"> |
||
231 | |||
232 | <p>
|
||
233 | initialization function: set up xbee communication and packet handler infrastructure<p>
|
||
234 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl> |
||
235 | |||
236 | </div>
|
||
237 | </div><p> |
||
238 | <a class="anchor" name="g8af34a6265a5d6af3a1525bb51e61d54"></a><!-- doxytag: member="wireless.h::wl_register_handler" ref="g8af34a6265a5d6af3a1525bb51e61d54" args="(uint8_t group, void(*func)(void), uint8_t priority)" --> |
||
239 | <div class="memitem"> |
||
240 | <div class="memproto"> |
||
241 | <table class="memname"> |
||
242 | <tr>
|
||
243 | <td class="memname">int8_t wl_register_handler </td> |
||
244 | <td>(</td> |
||
245 | <td class="paramtype">uint8_t </td> |
||
246 | <td class="paramname"> <em>group</em>, </td> |
||
247 | </tr>
|
||
248 | <tr>
|
||
249 | <td class="paramkey"></td> |
||
250 | <td></td> |
||
251 | <td class="paramtype">void(*)(void) </td> |
||
252 | <td class="paramname"> <em>func</em>, </td> |
||
253 | </tr>
|
||
254 | <tr>
|
||
255 | <td class="paramkey"></td> |
||
256 | <td></td> |
||
257 | <td class="paramtype">uint8_t </td> |
||
258 | <td class="paramname"> <em>priority</em></td><td> </td> |
||
259 | </tr>
|
||
260 | <tr>
|
||
261 | <td></td> |
||
262 | <td>)</td> |
||
263 | <td></td><td></td><td></td> |
||
264 | </tr>
|
||
265 | </table>
|
||
266 | </div>
|
||
267 | <div class="memdoc"> |
||
268 | |||
269 | <p>
|
||
270 | function to register new packet handlers (for non-default groups only)<p>
|
||
271 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
272 | <table border="0" cellspacing="2" cellpadding="0"> |
||
273 | <tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group number of the packets to handle with this function </td></tr> |
||
274 | <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>the function pointer to the user-specified packet handler </td></tr> |
||
275 | <tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>flag to set the priority of the function handler</td></tr> |
||
276 | </table>
|
||
277 | </dl>
|
||
278 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl> |
||
279 | |||
280 | </div>
|
||
281 | </div><p> |
||
282 | <a class="anchor" name="ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><!-- doxytag: member="wireless.h::wl_send_basic" ref="ga8fb657e4d3bf7cb396f36e99fdd01a0" args="(char *data, uint8_t length)" --> |
||
283 | <div class="memitem"> |
||
284 | <div class="memproto"> |
||
285 | <table class="memname"> |
||
286 | <tr>
|
||
287 | <td class="memname">int8_t wl_send_basic </td> |
||
288 | <td>(</td> |
||
289 | <td class="paramtype">char * </td> |
||
290 | <td class="paramname"> <em>data</em>, </td> |
||
291 | </tr>
|
||
292 | <tr>
|
||
293 | <td class="paramkey"></td> |
||
294 | <td></td> |
||
295 | <td class="paramtype">uint8_t </td> |
||
296 | <td class="paramname"> <em>length</em></td><td> </td> |
||
297 | </tr>
|
||
298 | <tr>
|
||
299 | <td></td> |
||
300 | <td>)</td> |
||
301 | <td></td><td></td><td></td> |
||
302 | </tr>
|
||
303 | </table>
|
||
304 | </div>
|
||
305 | <div class="memdoc"> |
||
306 | |||
307 | <p>
|
||
308 | Default (i.e. basic) send wrapper.<p>
|
||
309 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
310 | <table border="0" cellspacing="2" cellpadding="0"> |
||
311 | <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>pointer to the byte array of data to be included in the packet </td></tr> |
||
312 | <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array</td></tr> |
||
313 | </table>
|
||
314 | </dl>
|
||
315 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl> |
||
316 | |||
317 | </div>
|
||
318 | </div><p> |
||
319 | <a class="anchor" name="gd92093466d82f3f0c732ffe8323228d2"></a><!-- doxytag: member="wireless.h::wl_send_global" ref="gd92093466d82f3f0c732ffe8323228d2" args="(char *data, uint8_t length, uint8_t group)" --> |
||
320 | <div class="memitem"> |
||
321 | <div class="memproto"> |
||
322 | <table class="memname"> |
||
323 | <tr>
|
||
324 | <td class="memname">int8_t wl_send_global </td> |
||
325 | <td>(</td> |
||
326 | <td class="paramtype">char * </td> |
||
327 | <td class="paramname"> <em>data</em>, </td> |
||
328 | </tr>
|
||
329 | <tr>
|
||
330 | <td class="paramkey"></td> |
||
331 | <td></td> |
||
332 | <td class="paramtype">uint8_t </td> |
||
333 | <td class="paramname"> <em>length</em>, </td> |
||
334 | </tr>
|
||
335 | <tr>
|
||
336 | <td class="paramkey"></td> |
||
337 | <td></td> |
||
338 | <td class="paramtype">uint8_t </td> |
||
339 | <td class="paramname"> <em>group</em></td><td> </td> |
||
340 | </tr>
|
||
341 | <tr>
|
||
342 | <td></td> |
||
343 | <td>)</td> |
||
344 | <td></td><td></td><td></td> |
||
345 | </tr>
|
||
346 | </table>
|
||
347 | </div>
|
||
348 | <div class="memdoc"> |
||
349 | |||
350 | <p>
|
||
351 | Wrapper for core send function that will send a global packet across the current channel.<p>
|
||
352 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
353 | <table border="0" cellspacing="2" cellpadding="0"> |
||
354 | <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>pointer to the byte array of data to be included in the packet </td></tr> |
||
355 | <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array </td></tr> |
||
356 | <tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet</td></tr> |
||
357 | </table>
|
||
358 | </dl>
|
||
359 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl> |
||
360 | |||
361 | </div>
|
||
362 | </div><p> |
||
363 | <a class="anchor" name="g7886c2a37b7350211699dcabe48ff076"></a><!-- doxytag: member="wireless.h::wl_send_pan" ref="g7886c2a37b7350211699dcabe48ff076" args="(char *data, uint8_t length, uint8_t group)" --> |
||
364 | <div class="memitem"> |
||
365 | <div class="memproto"> |
||
366 | <table class="memname"> |
||
367 | <tr>
|
||
368 | <td class="memname">int8_t wl_send_pan </td> |
||
369 | <td>(</td> |
||
370 | <td class="paramtype">char * </td> |
||
371 | <td class="paramname"> <em>data</em>, </td> |
||
372 | </tr>
|
||
373 | <tr>
|
||
374 | <td class="paramkey"></td> |
||
375 | <td></td> |
||
376 | <td class="paramtype">uint8_t </td> |
||
377 | <td class="paramname"> <em>length</em>, </td> |
||
378 | </tr>
|
||
379 | <tr>
|
||
380 | <td class="paramkey"></td> |
||
381 | <td></td> |
||
382 | <td class="paramtype">uint8_t </td> |
||
383 | <td class="paramname"> <em>group</em></td><td> </td> |
||
384 | </tr>
|
||
385 | <tr>
|
||
386 | <td></td> |
||
387 | <td>)</td> |
||
388 | <td></td><td></td><td></td> |
||
389 | </tr>
|
||
390 | </table>
|
||
391 | </div>
|
||
392 | <div class="memdoc"> |
||
393 | |||
394 | <p>
|
||
395 | Wrapper for core send function that will send a packet across the current channel on the current pan.<p>
|
||
396 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
397 | <table border="0" cellspacing="2" cellpadding="0"> |
||
398 | <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>pointer to the byte array of data to be included in the packet </td></tr> |
||
399 | <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array </td></tr> |
||
400 | <tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet</td></tr> |
||
401 | </table>
|
||
402 | </dl>
|
||
403 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl> |
||
404 | |||
405 | </div>
|
||
406 | </div><p> |
||
407 | <a class="anchor" name="g223f437c2bc8ab8a3ac2e0e06841120f"></a><!-- doxytag: member="wireless.h::wl_terminate" ref="g223f437c2bc8ab8a3ac2e0e06841120f" args="(void)" --> |
||
408 | <div class="memitem"> |
||
409 | <div class="memproto"> |
||
410 | <table class="memname"> |
||
411 | <tr>
|
||
412 | <td class="memname">int8_t wl_terminate </td> |
||
413 | <td>(</td> |
||
414 | <td class="paramtype">void </td> |
||
415 | <td class="paramname"> </td> |
||
416 | <td> ) </td> |
||
417 | <td></td> |
||
418 | </tr>
|
||
419 | </table>
|
||
420 | </div>
|
||
421 | <div class="memdoc"> |
||
422 | |||
423 | <p>
|
||
424 | termination function: end xbee communication, deregister all handlers, etc<p>
|
||
425 | <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl> |
||
426 | |||
427 | </div>
|
||
428 | </div><p> |
||
429 | </div>
|
||
430 | <hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:22:17 2009 for Colony by |
||
431 | <a href="http://www.doxygen.org/index.html"> |
||
432 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
||
433 | </body>
|
||
434 | </html> |