Revision 1581
editing wireless branch, added error codes and constants
group__wireless.html | ||
---|---|---|
20 | 20 |
<p> |
21 | 21 |
<table border="0" cellpadding="0" cellspacing="0"> |
22 | 22 |
<tr><td></td></tr> |
23 |
<tr><td colspan="2"><br><h2>Modules</h2></td></tr> |
|
24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html">Public Constants</a></td></tr> |
|
25 |
|
|
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html">Public API Functions</a></td></tr> |
|
27 |
|
|
28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html">Error Codes</a></td></tr> |
|
29 |
|
|
23 | 30 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
24 | 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr> |
25 | 32 |
|
... | ... | |
30 | 37 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr> |
31 | 38 |
|
32 | 39 |
<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> |
33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)</td></tr> |
|
34 |
|
|
35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The core send function. This will take all possible arguments and send all types of packets. <a href="#gaa4e0d7014a74d0d59c08f9fbbf40bd7"></a><br></td></tr> |
|
36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
37 |
|
|
38 |
<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> |
|
39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
40 |
|
|
41 |
<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> |
|
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)</td></tr> |
|
43 |
|
|
44 |
<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. <a href="#gbb08f7957bd0256c51f424fa770d3e60"></a><br></td></tr> |
|
45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wl_send_basic</a> (char *data, uint8_t length)</td></tr> |
|
46 |
|
|
47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="#ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><br></td></tr> |
|
48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr> |
|
49 |
|
|
50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors, and resets number to zero. <a href="#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr> |
|
51 | 40 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr> |
52 | 41 |
|
53 | 42 |
<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> |
... | ... | |
58 | 47 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr> |
59 | 48 |
|
60 | 49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr> |
50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gf0c80262c96d3410bf0f1266871ffe3e">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)</td></tr> |
|
51 |
|
|
52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g48e2d69b71010e23ca5c7b2de595ae4f">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
53 |
|
|
54 |
<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="#g48e2d69b71010e23ca5c7b2de595ae4f"></a><br></td></tr> |
|
55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaef3438cea00f6f3d3de16d54ec33d51">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
|
56 |
|
|
57 |
<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="#gaef3438cea00f6f3d3de16d54ec33d51"></a><br></td></tr> |
|
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4a728d521deae8f12b9d40a62027600b">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)</td></tr> |
|
59 |
|
|
60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g461b4558be666fefb9bf41edfd5ea500">wl_send_basic</a> (char *data, uint8_t length)</td></tr> |
|
61 |
|
|
62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="#g461b4558be666fefb9bf41edfd5ea500"></a><br></td></tr> |
|
63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr> |
|
64 |
|
|
65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors. <a href="#g11aeeac54834f0357794ae60a7513acf"></a><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__wireless.html#ga364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr> |
|
67 |
|
|
68 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks a specific packet for the acknowledgement status. <a href="#ga364aa4d9cc8c789f05401e8adf44785"></a><br></td></tr> |
|
69 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr> |
|
70 |
|
|
71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets acknowledgement statistics back to zero. <a href="#g62e126abfcd382ec02524dd2f45a8a7b"></a><br></td></tr> |
|
61 | 72 |
</table> |
62 | 73 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
63 |
Interface with the wireless library. |
|
64 |
<p> |
|
65 | 74 |
Interface with the wireless library. <hr><h2>Function Documentation</h2> |
66 |
<a class="anchor" name="g11aeeac54834f0357794ae60a7513acf"></a><!-- doxytag: member="wireless.h::wl_ack_error" ref="g11aeeac54834f0357794ae60a7513acf" args="(void)" -->
|
|
75 |
<a class="anchor" name="ga364aa4d9cc8c789f05401e8adf44785"></a><!-- doxytag: member="wireless_send.c::wl_ack_check" ref="ga364aa4d9cc8c789f05401e8adf44785" args="(uint8_t packet)" -->
|
|
67 | 76 |
<div class="memitem"> |
68 | 77 |
<div class="memproto"> |
69 | 78 |
<table class="memname"> |
70 | 79 |
<tr> |
80 |
<td class="memname">int8_t wl_ack_check </td> |
|
81 |
<td>(</td> |
|
82 |
<td class="paramtype">uint8_t </td> |
|
83 |
<td class="paramname"> <em>packet</em> </td> |
|
84 |
<td> ) </td> |
|
85 |
<td></td> |
|
86 |
</tr> |
|
87 |
</table> |
|
88 |
</div> |
|
89 |
<div class="memdoc"> |
|
90 |
|
|
91 |
<p> |
|
92 |
acknowledgement error check check if a specific packet has been lost note: buffer will overflow ever 255 packets<p> |
|
93 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
94 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
95 |
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>number</td></tr> |
|
96 |
</table> |
|
97 |
</dl> |
|
98 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0=still sending,1=ack received,-1=ack failure </dd></dl> |
|
99 |
|
|
100 |
</div> |
|
101 |
</div><p> |
|
102 |
<a class="anchor" name="g11aeeac54834f0357794ae60a7513acf"></a><!-- doxytag: member="wireless_send.c::wl_ack_error" ref="g11aeeac54834f0357794ae60a7513acf" args="(void)" --> |
|
103 |
<div class="memitem"> |
|
104 |
<div class="memproto"> |
|
105 |
<table class="memname"> |
|
106 |
<tr> |
|
71 | 107 |
<td class="memname">int8_t wl_ack_error </td> |
72 | 108 |
<td>(</td> |
73 | 109 |
<td class="paramtype">void </td> |
... | ... | |
80 | 116 |
<div class="memdoc"> |
81 | 117 |
|
82 | 118 |
<p> |
83 |
Returns the number of acknowledgment errors, and resets number to zero. |
|
84 |
<p> |
|
85 |
acknowledgment error you call this function periodically to check if any of the packets you have sent have been lost<p> |
|
119 |
acknowledgment error check if any of the packets you have sent have been lost.<p> |
|
86 | 120 |
note that all other error checking will be handled by library, so your user behavior won't have to worry about it<p> |
87 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>an error code (or maybe the # of packets you have lost) </dd></dl>
|
|
121 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the # of packets lost (up to 255) </dd></dl>
|
|
88 | 122 |
|
89 | 123 |
</div> |
90 | 124 |
</div><p> |
91 |
<a class="anchor" name="ga5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless.h::wl_get" ref="ga5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" -->
|
|
125 |
<a class="anchor" name="g62e126abfcd382ec02524dd2f45a8a7b"></a><!-- doxytag: member="wireless_send.c::wl_ack_reset" ref="g62e126abfcd382ec02524dd2f45a8a7b" args="(void)" -->
|
|
92 | 126 |
<div class="memitem"> |
93 | 127 |
<div class="memproto"> |
94 | 128 |
<table class="memname"> |
95 | 129 |
<tr> |
130 |
<td class="memname">void wl_ack_reset </td> |
|
131 |
<td>(</td> |
|
132 |
<td class="paramtype">void </td> |
|
133 |
<td class="paramname"> </td> |
|
134 |
<td> ) </td> |
|
135 |
<td></td> |
|
136 |
</tr> |
|
137 |
</table> |
|
138 |
</div> |
|
139 |
<div class="memdoc"> |
|
140 |
|
|
141 |
<p> |
|
142 |
acknowledgement reset reset the acknowledgement buffer |
|
143 |
</div> |
|
144 |
</div><p> |
|
145 |
<a class="anchor" name="ga5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless_receive.c::wl_get" ref="ga5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" --> |
|
146 |
<div class="memitem"> |
|
147 |
<div class="memproto"> |
|
148 |
<table class="memname"> |
|
149 |
<tr> |
|
96 | 150 |
<td class="memname">int8_t wl_get </td> |
97 | 151 |
<td>(</td> |
98 | 152 |
<td class="paramtype">char * </td> |
... | ... | |
114 | 168 |
<div class="memdoc"> |
115 | 169 |
|
116 | 170 |
<p> |
117 |
The main receive function. Dispatches packets for registered handlers and returns next basic packet if available. |
|
118 |
<p> |
|
119 | 171 |
the main receive function (similar to wl_do)<p> |
120 | 172 |
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> |
121 | 173 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
... | ... | |
128 | 180 |
|
129 | 181 |
</div> |
130 | 182 |
</div><p> |
131 |
<a class="anchor" name="ge2509e2b6bc61faa26d87b1d87881817"></a><!-- doxytag: member="wireless.h::wl_get_basic" ref="ge2509e2b6bc61faa26d87b1d87881817" args="(char *data, uint8_t length)" -->
|
|
183 |
<a class="anchor" name="ge2509e2b6bc61faa26d87b1d87881817"></a><!-- doxytag: member="wireless_receive.c::wl_get_basic" ref="ge2509e2b6bc61faa26d87b1d87881817" args="(char *data, uint8_t length)" -->
|
|
132 | 184 |
<div class="memitem"> |
133 | 185 |
<div class="memproto"> |
134 | 186 |
<table class="memname"> |
... | ... | |
154 | 206 |
<div class="memdoc"> |
155 | 207 |
|
156 | 208 |
<p> |
157 |
Returns the next basic packet if available. |
|
158 |
<p> |
|
159 |
function to receive only packets on the default group this function is only meant to receive packets sent using <a class="el" href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0" title="Default (i.e. basic) send wrapper.">wl_send_basic()</a><p> |
|
209 |
function to receive only packets on the default group this function is only meant to receive packets sent using <a class="el" href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0" title="Default (i.e. basic) send wrapper.">wl_send_basic()</a><p> |
|
160 | 210 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
161 | 211 |
<table border="0" cellspacing="2" cellpadding="0"> |
162 | 212 |
<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> |
... | ... | |
184 | 234 |
<div class="memdoc"> |
185 | 235 |
|
186 | 236 |
<p> |
187 |
Initialize wireless. |
|
188 |
<p> |
|
189 | 237 |
initialization function: set up xbee communication and packet handler infrastructure<p> |
190 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, <0 on failed registration (error codes TBD) </dd></dl>
|
|
238 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
|
|
191 | 239 |
|
192 | 240 |
</div> |
193 | 241 |
</div><p> |
... | ... | |
223 | 271 |
<div class="memdoc"> |
224 | 272 |
|
225 | 273 |
<p> |
226 |
Function to register new packet handlers (for non-default groups only). |
|
227 |
<p> |
|
228 | 274 |
function to register new packet handlers (for non-default groups only)<p> |
229 | 275 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
230 | 276 |
<table border="0" cellspacing="2" cellpadding="0"> |
231 | 277 |
<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> |
232 | 278 |
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>the function pointer to the user-specified packet handler </td></tr> |
233 |
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>flag to set the priority of the function handler: 0 for normal (put packet on buffer), 1 for high (handle packet immediately upon receiving)</td></tr>
|
|
279 |
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>flag to set the priority of the function handler</td></tr> |
|
234 | 280 |
</table> |
235 | 281 |
</dl> |
236 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, <0 on failed registration (error codes TBD) </dd></dl>
|
|
282 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
|
|
237 | 283 |
|
238 | 284 |
</div> |
239 | 285 |
</div><p> |
240 |
<a class="anchor" name="gaa4e0d7014a74d0d59c08f9fbbf40bd7"></a><!-- doxytag: member="wireless.h::wl_send" ref="gaa4e0d7014a74d0d59c08f9fbbf40bd7" args="(char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)" -->
|
|
286 |
<a class="anchor" name="gf0c80262c96d3410bf0f1266871ffe3e"></a><!-- doxytag: member="wireless_send.c::wl_send" ref="gf0c80262c96d3410bf0f1266871ffe3e" args="(char *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)" -->
|
|
241 | 287 |
<div class="memitem"> |
242 | 288 |
<div class="memproto"> |
243 | 289 |
<table class="memname"> |
244 | 290 |
<tr> |
245 |
<td class="memname">int8_t wl_send </td>
|
|
291 |
<td class="memname">int16_t wl_send </td>
|
|
246 | 292 |
<td>(</td> |
247 | 293 |
<td class="paramtype">char * </td> |
248 | 294 |
<td class="paramname"> <em>data</em>, </td> |
... | ... | |
268 | 314 |
<tr> |
269 | 315 |
<td class="paramkey"></td> |
270 | 316 |
<td></td> |
271 |
<td class="paramtype">uint8_t </td>
|
|
317 |
<td class="paramtype">uint16_t </td>
|
|
272 | 318 |
<td class="paramname"> <em>dest</em>, </td> |
273 | 319 |
</tr> |
274 | 320 |
<tr> |
... | ... | |
287 | 333 |
<div class="memdoc"> |
288 | 334 |
|
289 | 335 |
<p> |
290 |
The core send function. This will take all possible arguments and send all types of packets. |
|
291 |
<p> |
|
292 | 336 |
The core send function. This will take all possible arguments and send all types of packets.<p> |
293 | 337 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
294 | 338 |
<table border="0" cellspacing="2" cellpadding="0"> |
295 | 339 |
<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> |
296 | 340 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array </td></tr> |
297 | 341 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet </td></tr> |
298 |
<tr><td valign="top"></td><td valign="top"><em>scope</em> </td><td>flag for sending global packet, to your current PAN, or to a specific robot </td></tr>
|
|
342 |
<tr><td valign="top"></td><td valign="top"><em>scope</em> </td><td>flag for sending global packet or your current PAN </td></tr>
|
|
299 | 343 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>robot ID (for robot to robot packet) </td></tr> |
300 |
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>flag for using TCP or UDP</td></tr>
|
|
344 |
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>flag for using FAST or RELIABLE sending</td></tr>
|
|
301 | 345 |
</table> |
302 | 346 |
</dl> |
303 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl>
|
|
347 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
|
|
304 | 348 |
|
305 | 349 |
</div> |
306 | 350 |
</div><p> |
307 |
<a class="anchor" name="ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><!-- doxytag: member="wireless.h::wl_send_basic" ref="ga8fb657e4d3bf7cb396f36e99fdd01a0" args="(char *data, uint8_t length)" -->
|
|
351 |
<a class="anchor" name="g461b4558be666fefb9bf41edfd5ea500"></a><!-- doxytag: member="wireless_send.c::wl_send_basic" ref="g461b4558be666fefb9bf41edfd5ea500" args="(char *data, uint8_t length)" -->
|
|
308 | 352 |
<div class="memitem"> |
309 | 353 |
<div class="memproto"> |
310 | 354 |
<table class="memname"> |
311 | 355 |
<tr> |
312 |
<td class="memname">int8_t wl_send_basic </td>
|
|
356 |
<td class="memname">int16_t wl_send_basic </td>
|
|
313 | 357 |
<td>(</td> |
314 | 358 |
<td class="paramtype">char * </td> |
315 | 359 |
<td class="paramname"> <em>data</em>, </td> |
... | ... | |
330 | 374 |
<div class="memdoc"> |
331 | 375 |
|
332 | 376 |
<p> |
333 |
Default (i.e. basic) send wrapper. |
|
334 |
<p> |
|
335 | 377 |
Default (i.e. basic) send wrapper.<p> |
336 | 378 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
337 | 379 |
<table border="0" cellspacing="2" cellpadding="0"> |
... | ... | |
339 | 381 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array</td></tr> |
340 | 382 |
</table> |
341 | 383 |
</dl> |
342 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl>
|
|
384 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
|
|
343 | 385 |
|
344 | 386 |
</div> |
345 | 387 |
</div><p> |
346 |
<a class="anchor" name="gd92093466d82f3f0c732ffe8323228d2"></a><!-- doxytag: member="wireless.h::wl_send_global" ref="gd92093466d82f3f0c732ffe8323228d2" args="(char *data, uint8_t length, uint8_t group)" -->
|
|
388 |
<a class="anchor" name="g48e2d69b71010e23ca5c7b2de595ae4f"></a><!-- doxytag: member="wireless_send.c::wl_send_global" ref="g48e2d69b71010e23ca5c7b2de595ae4f" args="(char *data, uint8_t length, uint8_t group)" -->
|
|
347 | 389 |
<div class="memitem"> |
348 | 390 |
<div class="memproto"> |
349 | 391 |
<table class="memname"> |
350 | 392 |
<tr> |
351 |
<td class="memname">int8_t wl_send_global </td>
|
|
393 |
<td class="memname">int16_t wl_send_global </td>
|
|
352 | 394 |
<td>(</td> |
353 | 395 |
<td class="paramtype">char * </td> |
354 | 396 |
<td class="paramname"> <em>data</em>, </td> |
... | ... | |
375 | 417 |
<div class="memdoc"> |
376 | 418 |
|
377 | 419 |
<p> |
378 |
Wrapper for core send function that will send a global packet across the current channel. |
|
379 |
<p> |
|
380 | 420 |
Wrapper for core send function that will send a global packet across the current channel.<p> |
381 | 421 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
382 | 422 |
<table border="0" cellspacing="2" cellpadding="0"> |
... | ... | |
385 | 425 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet</td></tr> |
386 | 426 |
</table> |
387 | 427 |
</dl> |
388 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl>
|
|
428 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
|
|
389 | 429 |
|
390 | 430 |
</div> |
391 | 431 |
</div><p> |
392 |
<a class="anchor" name="g7886c2a37b7350211699dcabe48ff076"></a><!-- doxytag: member="wireless.h::wl_send_pan" ref="g7886c2a37b7350211699dcabe48ff076" args="(char *data, uint8_t length, uint8_t group)" -->
|
|
432 |
<a class="anchor" name="gaef3438cea00f6f3d3de16d54ec33d51"></a><!-- doxytag: member="wireless_send.c::wl_send_pan" ref="gaef3438cea00f6f3d3de16d54ec33d51" args="(char *data, uint8_t length, uint8_t group)" -->
|
|
393 | 433 |
<div class="memitem"> |
394 | 434 |
<div class="memproto"> |
395 | 435 |
<table class="memname"> |
396 | 436 |
<tr> |
397 |
<td class="memname">int8_t wl_send_pan </td>
|
|
437 |
<td class="memname">int16_t wl_send_pan </td>
|
|
398 | 438 |
<td>(</td> |
399 | 439 |
<td class="paramtype">char * </td> |
400 | 440 |
<td class="paramname"> <em>data</em>, </td> |
... | ... | |
421 | 461 |
<div class="memdoc"> |
422 | 462 |
|
423 | 463 |
<p> |
424 |
Wrapper for core send function that will send a packet across the current channel on the current pan. |
|
425 |
<p> |
|
426 | 464 |
Wrapper for core send function that will send a packet across the current channel on the current pan.<p> |
427 | 465 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
428 | 466 |
<table border="0" cellspacing="2" cellpadding="0"> |
... | ... | |
431 | 469 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet</td></tr> |
432 | 470 |
</table> |
433 | 471 |
</dl> |
434 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl>
|
|
472 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
|
|
435 | 473 |
|
436 | 474 |
</div> |
437 | 475 |
</div><p> |
438 |
<a class="anchor" name="gbb08f7957bd0256c51f424fa770d3e60"></a><!-- doxytag: member="wireless.h::wl_send_robot" ref="gbb08f7957bd0256c51f424fa770d3e60" args="(char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)" -->
|
|
476 |
<a class="anchor" name="g4a728d521deae8f12b9d40a62027600b"></a><!-- doxytag: member="wireless_send.c::wl_send_robot" ref="g4a728d521deae8f12b9d40a62027600b" args="(char *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)" -->
|
|
439 | 477 |
<div class="memitem"> |
440 | 478 |
<div class="memproto"> |
441 | 479 |
<table class="memname"> |
442 | 480 |
<tr> |
443 |
<td class="memname">int8_t wl_send_robot </td>
|
|
481 |
<td class="memname">int16_t wl_send_robot </td>
|
|
444 | 482 |
<td>(</td> |
445 | 483 |
<td class="paramtype">char * </td> |
446 | 484 |
<td class="paramname"> <em>data</em>, </td> |
... | ... | |
460 | 498 |
<tr> |
461 | 499 |
<td class="paramkey"></td> |
462 | 500 |
<td></td> |
463 |
<td class="paramtype">uint8_t </td>
|
|
501 |
<td class="paramtype">uint16_t </td>
|
|
464 | 502 |
<td class="paramname"> <em>dest</em>, </td> |
465 | 503 |
</tr> |
466 | 504 |
<tr> |
... | ... | |
479 | 517 |
<div class="memdoc"> |
480 | 518 |
|
481 | 519 |
<p> |
482 |
Wrapper for core send function that will send a packet across the current channel to a specific robot. |
|
483 |
<p> |
|
484 | 520 |
Wrapper for core send function that will send a packet across the current channel to a specific robot.<p> |
485 | 521 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
486 | 522 |
<table border="0" cellspacing="2" cellpadding="0"> |
... | ... | |
488 | 524 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array </td></tr> |
489 | 525 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet </td></tr> |
490 | 526 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>robot ID (for robot to robot packet) </td></tr> |
491 |
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>flag for using TCP or UDP</td></tr>
|
|
527 |
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>flag for using FAST or RELIABLE sending</td></tr>
|
|
492 | 528 |
</table> |
493 | 529 |
</dl> |
494 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl>
|
|
530 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
|
|
495 | 531 |
|
496 | 532 |
</div> |
497 | 533 |
</div><p> |
... | ... | |
512 | 548 |
<div class="memdoc"> |
513 | 549 |
|
514 | 550 |
<p> |
515 |
Terminate wireless. |
|
516 |
<p> |
|
517 | 551 |
termination function: end xbee communication, deregister all handlers, etc<p> |
518 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, <0 on failed termination (error codes TBD) </dd></dl>
|
|
552 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
|
|
519 | 553 |
|
520 | 554 |
</div> |
521 | 555 |
</div><p> |
522 | 556 |
</div> |
523 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by
|
|
557 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
524 | 558 |
<a href="http://www.doxygen.org/index.html"> |
525 | 559 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
526 | 560 |
</body> |
Also available in: Unified diff