root / branches / wireless / docs / libwireless / html / group__wireless.html @ 1578
History | View | Annotate | Download (24.8 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>Colony: Wireless</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>Wireless</h1>Interface with the wireless library. |
| 19 |
<a href="#_details">More...</a> |
| 20 |
<p>
|
| 21 |
<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__wireless.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__wireless.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">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 |
|
| 32 |
<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 |
<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 |
|
| 53 |
<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> |
| 54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817">wl_get_basic</a> (char *data, uint8_t length)</td></tr> |
| 55 |
|
| 56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next basic packet if available. <a href="#ge2509e2b6bc61faa26d87b1d87881817"></a><br></td></tr> |
| 57 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge91c1e1940dfbbd063fdcfb86049c64a"></a><!-- doxytag: member="wireless::wl_dispatch" ref="ge91c1e1940dfbbd063fdcfb86049c64a" args="(void)" --> |
| 58 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr> |
| 59 |
|
| 60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr> |
| 61 |
</table>
|
| 62 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 63 |
Interface with the wireless library. |
| 64 |
<p>
|
| 65 |
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)" --> |
| 67 |
<div class="memitem"> |
| 68 |
<div class="memproto"> |
| 69 |
<table class="memname"> |
| 70 |
<tr>
|
| 71 |
<td class="memname">int8_t wl_ack_error </td> |
| 72 |
<td>(</td> |
| 73 |
<td class="paramtype">void </td> |
| 74 |
<td class="paramname"> </td> |
| 75 |
<td> ) </td> |
| 76 |
<td></td> |
| 77 |
</tr>
|
| 78 |
</table>
|
| 79 |
</div>
|
| 80 |
<div class="memdoc"> |
| 81 |
|
| 82 |
<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>
|
| 86 |
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> |
| 88 |
|
| 89 |
</div>
|
| 90 |
</div><p> |
| 91 |
<a class="anchor" name="ga5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless.h::wl_get" ref="ga5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" --> |
| 92 |
<div class="memitem"> |
| 93 |
<div class="memproto"> |
| 94 |
<table class="memname"> |
| 95 |
<tr>
|
| 96 |
<td class="memname">int8_t wl_get </td> |
| 97 |
<td>(</td> |
| 98 |
<td class="paramtype">char * </td> |
| 99 |
<td class="paramname"> <em>data</em>, </td> |
| 100 |
</tr>
|
| 101 |
<tr>
|
| 102 |
<td class="paramkey"></td> |
| 103 |
<td></td> |
| 104 |
<td class="paramtype">uint8_t </td> |
| 105 |
<td class="paramname"> <em>length</em></td><td> </td> |
| 106 |
</tr>
|
| 107 |
<tr>
|
| 108 |
<td></td> |
| 109 |
<td>)</td> |
| 110 |
<td></td><td></td><td></td> |
| 111 |
</tr>
|
| 112 |
</table>
|
| 113 |
</div>
|
| 114 |
<div class="memdoc"> |
| 115 |
|
| 116 |
<p>
|
| 117 |
The main receive function. Dispatches packets for registered handlers and returns next basic packet if available. |
| 118 |
<p>
|
| 119 |
the main receive function (similar to wl_do)<p>
|
| 120 |
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 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 122 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 123 |
<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> |
| 124 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the initialized data array</td></tr> |
| 125 |
</table>
|
| 126 |
</dl>
|
| 127 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (<0) </dd></dl> |
| 128 |
|
| 129 |
</div>
|
| 130 |
</div><p> |
| 131 |
<a class="anchor" name="ge2509e2b6bc61faa26d87b1d87881817"></a><!-- doxytag: member="wireless.h::wl_get_basic" ref="ge2509e2b6bc61faa26d87b1d87881817" args="(char *data, uint8_t length)" --> |
| 132 |
<div class="memitem"> |
| 133 |
<div class="memproto"> |
| 134 |
<table class="memname"> |
| 135 |
<tr>
|
| 136 |
<td class="memname">int8_t wl_get_basic </td> |
| 137 |
<td>(</td> |
| 138 |
<td class="paramtype">char * </td> |
| 139 |
<td class="paramname"> <em>data</em>, </td> |
| 140 |
</tr>
|
| 141 |
<tr>
|
| 142 |
<td class="paramkey"></td> |
| 143 |
<td></td> |
| 144 |
<td class="paramtype">uint8_t </td> |
| 145 |
<td class="paramname"> <em>length</em></td><td> </td> |
| 146 |
</tr>
|
| 147 |
<tr>
|
| 148 |
<td></td> |
| 149 |
<td>)</td> |
| 150 |
<td></td><td></td><td></td> |
| 151 |
</tr>
|
| 152 |
</table>
|
| 153 |
</div>
|
| 154 |
<div class="memdoc"> |
| 155 |
|
| 156 |
<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> |
| 160 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 161 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 162 |
<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> |
| 163 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the initialized data array</td></tr> |
| 164 |
</table>
|
| 165 |
</dl>
|
| 166 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (<0) </dd></dl> |
| 167 |
|
| 168 |
</div>
|
| 169 |
</div><p> |
| 170 |
<a class="anchor" name="g6a8d6179b1fe27f762937f0b47af2009"></a><!-- doxytag: member="wireless.c::wl_init" ref="g6a8d6179b1fe27f762937f0b47af2009" args="(void)" --> |
| 171 |
<div class="memitem"> |
| 172 |
<div class="memproto"> |
| 173 |
<table class="memname"> |
| 174 |
<tr>
|
| 175 |
<td class="memname">int8_t wl_init </td> |
| 176 |
<td>(</td> |
| 177 |
<td class="paramtype">void </td> |
| 178 |
<td class="paramname"> </td> |
| 179 |
<td> ) </td> |
| 180 |
<td></td> |
| 181 |
</tr>
|
| 182 |
</table>
|
| 183 |
</div>
|
| 184 |
<div class="memdoc"> |
| 185 |
|
| 186 |
<p>
|
| 187 |
Initialize wireless. |
| 188 |
<p>
|
| 189 |
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> |
| 191 |
|
| 192 |
</div>
|
| 193 |
</div><p> |
| 194 |
<a class="anchor" name="g8af34a6265a5d6af3a1525bb51e61d54"></a><!-- doxytag: member="wireless.c::wl_register_handler" ref="g8af34a6265a5d6af3a1525bb51e61d54" args="(uint8_t group, void(*func)(void), uint8_t priority)" --> |
| 195 |
<div class="memitem"> |
| 196 |
<div class="memproto"> |
| 197 |
<table class="memname"> |
| 198 |
<tr>
|
| 199 |
<td class="memname">int8_t wl_register_handler </td> |
| 200 |
<td>(</td> |
| 201 |
<td class="paramtype">uint8_t </td> |
| 202 |
<td class="paramname"> <em>group</em>, </td> |
| 203 |
</tr>
|
| 204 |
<tr>
|
| 205 |
<td class="paramkey"></td> |
| 206 |
<td></td> |
| 207 |
<td class="paramtype">void(*)(void) </td> |
| 208 |
<td class="paramname"> <em>func</em>, </td> |
| 209 |
</tr>
|
| 210 |
<tr>
|
| 211 |
<td class="paramkey"></td> |
| 212 |
<td></td> |
| 213 |
<td class="paramtype">uint8_t </td> |
| 214 |
<td class="paramname"> <em>priority</em></td><td> </td> |
| 215 |
</tr>
|
| 216 |
<tr>
|
| 217 |
<td></td> |
| 218 |
<td>)</td> |
| 219 |
<td></td><td></td><td></td> |
| 220 |
</tr>
|
| 221 |
</table>
|
| 222 |
</div>
|
| 223 |
<div class="memdoc"> |
| 224 |
|
| 225 |
<p>
|
| 226 |
Function to register new packet handlers (for non-default groups only). |
| 227 |
<p>
|
| 228 |
function to register new packet handlers (for non-default groups only)<p>
|
| 229 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 230 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 231 |
<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 |
<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> |
| 234 |
</table>
|
| 235 |
</dl>
|
| 236 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, <0 on failed registration (error codes TBD) </dd></dl> |
| 237 |
|
| 238 |
</div>
|
| 239 |
</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)" --> |
| 241 |
<div class="memitem"> |
| 242 |
<div class="memproto"> |
| 243 |
<table class="memname"> |
| 244 |
<tr>
|
| 245 |
<td class="memname">int8_t wl_send </td> |
| 246 |
<td>(</td> |
| 247 |
<td class="paramtype">char * </td> |
| 248 |
<td class="paramname"> <em>data</em>, </td> |
| 249 |
</tr>
|
| 250 |
<tr>
|
| 251 |
<td class="paramkey"></td> |
| 252 |
<td></td> |
| 253 |
<td class="paramtype">uint8_t </td> |
| 254 |
<td class="paramname"> <em>length</em>, </td> |
| 255 |
</tr>
|
| 256 |
<tr>
|
| 257 |
<td class="paramkey"></td> |
| 258 |
<td></td> |
| 259 |
<td class="paramtype">uint8_t </td> |
| 260 |
<td class="paramname"> <em>group</em>, </td> |
| 261 |
</tr>
|
| 262 |
<tr>
|
| 263 |
<td class="paramkey"></td> |
| 264 |
<td></td> |
| 265 |
<td class="paramtype">uint8_t </td> |
| 266 |
<td class="paramname"> <em>scope</em>, </td> |
| 267 |
</tr>
|
| 268 |
<tr>
|
| 269 |
<td class="paramkey"></td> |
| 270 |
<td></td> |
| 271 |
<td class="paramtype">uint8_t </td> |
| 272 |
<td class="paramname"> <em>dest</em>, </td> |
| 273 |
</tr>
|
| 274 |
<tr>
|
| 275 |
<td class="paramkey"></td> |
| 276 |
<td></td> |
| 277 |
<td class="paramtype">uint8_t </td> |
| 278 |
<td class="paramname"> <em>mode</em></td><td> </td> |
| 279 |
</tr>
|
| 280 |
<tr>
|
| 281 |
<td></td> |
| 282 |
<td>)</td> |
| 283 |
<td></td><td></td><td></td> |
| 284 |
</tr>
|
| 285 |
</table>
|
| 286 |
</div>
|
| 287 |
<div class="memdoc"> |
| 288 |
|
| 289 |
<p>
|
| 290 |
The core send function. This will take all possible arguments and send all types of packets. |
| 291 |
<p>
|
| 292 |
The core send function. This will take all possible arguments and send all types of packets.<p>
|
| 293 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 294 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 295 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>pointer to the byte array of data to be included in the packet </td></tr> |
| 296 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array </td></tr> |
| 297 |
<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> |
| 299 |
<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> |
| 301 |
</table>
|
| 302 |
</dl>
|
| 303 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl> |
| 304 |
|
| 305 |
</div>
|
| 306 |
</div><p> |
| 307 |
<a class="anchor" name="ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><!-- doxytag: member="wireless.h::wl_send_basic" ref="ga8fb657e4d3bf7cb396f36e99fdd01a0" args="(char *data, uint8_t length)" --> |
| 308 |
<div class="memitem"> |
| 309 |
<div class="memproto"> |
| 310 |
<table class="memname"> |
| 311 |
<tr>
|
| 312 |
<td class="memname">int8_t wl_send_basic </td> |
| 313 |
<td>(</td> |
| 314 |
<td class="paramtype">char * </td> |
| 315 |
<td class="paramname"> <em>data</em>, </td> |
| 316 |
</tr>
|
| 317 |
<tr>
|
| 318 |
<td class="paramkey"></td> |
| 319 |
<td></td> |
| 320 |
<td class="paramtype">uint8_t </td> |
| 321 |
<td class="paramname"> <em>length</em></td><td> </td> |
| 322 |
</tr>
|
| 323 |
<tr>
|
| 324 |
<td></td> |
| 325 |
<td>)</td> |
| 326 |
<td></td><td></td><td></td> |
| 327 |
</tr>
|
| 328 |
</table>
|
| 329 |
</div>
|
| 330 |
<div class="memdoc"> |
| 331 |
|
| 332 |
<p>
|
| 333 |
Default (i.e. basic) send wrapper. |
| 334 |
<p>
|
| 335 |
Default (i.e. basic) send wrapper.<p>
|
| 336 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 337 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 338 |
<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> |
| 339 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array</td></tr> |
| 340 |
</table>
|
| 341 |
</dl>
|
| 342 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl> |
| 343 |
|
| 344 |
</div>
|
| 345 |
</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)" --> |
| 347 |
<div class="memitem"> |
| 348 |
<div class="memproto"> |
| 349 |
<table class="memname"> |
| 350 |
<tr>
|
| 351 |
<td class="memname">int8_t wl_send_global </td> |
| 352 |
<td>(</td> |
| 353 |
<td class="paramtype">char * </td> |
| 354 |
<td class="paramname"> <em>data</em>, </td> |
| 355 |
</tr>
|
| 356 |
<tr>
|
| 357 |
<td class="paramkey"></td> |
| 358 |
<td></td> |
| 359 |
<td class="paramtype">uint8_t </td> |
| 360 |
<td class="paramname"> <em>length</em>, </td> |
| 361 |
</tr>
|
| 362 |
<tr>
|
| 363 |
<td class="paramkey"></td> |
| 364 |
<td></td> |
| 365 |
<td class="paramtype">uint8_t </td> |
| 366 |
<td class="paramname"> <em>group</em></td><td> </td> |
| 367 |
</tr>
|
| 368 |
<tr>
|
| 369 |
<td></td> |
| 370 |
<td>)</td> |
| 371 |
<td></td><td></td><td></td> |
| 372 |
</tr>
|
| 373 |
</table>
|
| 374 |
</div>
|
| 375 |
<div class="memdoc"> |
| 376 |
|
| 377 |
<p>
|
| 378 |
Wrapper for core send function that will send a global packet across the current channel. |
| 379 |
<p>
|
| 380 |
Wrapper for core send function that will send a global packet across the current channel.<p>
|
| 381 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 382 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 383 |
<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> |
| 384 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array </td></tr> |
| 385 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet</td></tr> |
| 386 |
</table>
|
| 387 |
</dl>
|
| 388 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl> |
| 389 |
|
| 390 |
</div>
|
| 391 |
</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)" --> |
| 393 |
<div class="memitem"> |
| 394 |
<div class="memproto"> |
| 395 |
<table class="memname"> |
| 396 |
<tr>
|
| 397 |
<td class="memname">int8_t wl_send_pan </td> |
| 398 |
<td>(</td> |
| 399 |
<td class="paramtype">char * </td> |
| 400 |
<td class="paramname"> <em>data</em>, </td> |
| 401 |
</tr>
|
| 402 |
<tr>
|
| 403 |
<td class="paramkey"></td> |
| 404 |
<td></td> |
| 405 |
<td class="paramtype">uint8_t </td> |
| 406 |
<td class="paramname"> <em>length</em>, </td> |
| 407 |
</tr>
|
| 408 |
<tr>
|
| 409 |
<td class="paramkey"></td> |
| 410 |
<td></td> |
| 411 |
<td class="paramtype">uint8_t </td> |
| 412 |
<td class="paramname"> <em>group</em></td><td> </td> |
| 413 |
</tr>
|
| 414 |
<tr>
|
| 415 |
<td></td> |
| 416 |
<td>)</td> |
| 417 |
<td></td><td></td><td></td> |
| 418 |
</tr>
|
| 419 |
</table>
|
| 420 |
</div>
|
| 421 |
<div class="memdoc"> |
| 422 |
|
| 423 |
<p>
|
| 424 |
Wrapper for core send function that will send a packet across the current channel on the current pan. |
| 425 |
<p>
|
| 426 |
Wrapper for core send function that will send a packet across the current channel on the current pan.<p>
|
| 427 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 428 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 429 |
<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> |
| 430 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array </td></tr> |
| 431 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet</td></tr> |
| 432 |
</table>
|
| 433 |
</dl>
|
| 434 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl> |
| 435 |
|
| 436 |
</div>
|
| 437 |
</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)" --> |
| 439 |
<div class="memitem"> |
| 440 |
<div class="memproto"> |
| 441 |
<table class="memname"> |
| 442 |
<tr>
|
| 443 |
<td class="memname">int8_t wl_send_robot </td> |
| 444 |
<td>(</td> |
| 445 |
<td class="paramtype">char * </td> |
| 446 |
<td class="paramname"> <em>data</em>, </td> |
| 447 |
</tr>
|
| 448 |
<tr>
|
| 449 |
<td class="paramkey"></td> |
| 450 |
<td></td> |
| 451 |
<td class="paramtype">uint8_t </td> |
| 452 |
<td class="paramname"> <em>length</em>, </td> |
| 453 |
</tr>
|
| 454 |
<tr>
|
| 455 |
<td class="paramkey"></td> |
| 456 |
<td></td> |
| 457 |
<td class="paramtype">uint8_t </td> |
| 458 |
<td class="paramname"> <em>group</em>, </td> |
| 459 |
</tr>
|
| 460 |
<tr>
|
| 461 |
<td class="paramkey"></td> |
| 462 |
<td></td> |
| 463 |
<td class="paramtype">uint8_t </td> |
| 464 |
<td class="paramname"> <em>dest</em>, </td> |
| 465 |
</tr>
|
| 466 |
<tr>
|
| 467 |
<td class="paramkey"></td> |
| 468 |
<td></td> |
| 469 |
<td class="paramtype">uint8_t </td> |
| 470 |
<td class="paramname"> <em>mode</em></td><td> </td> |
| 471 |
</tr>
|
| 472 |
<tr>
|
| 473 |
<td></td> |
| 474 |
<td>)</td> |
| 475 |
<td></td><td></td><td></td> |
| 476 |
</tr>
|
| 477 |
</table>
|
| 478 |
</div>
|
| 479 |
<div class="memdoc"> |
| 480 |
|
| 481 |
<p>
|
| 482 |
Wrapper for core send function that will send a packet across the current channel to a specific robot. |
| 483 |
<p>
|
| 484 |
Wrapper for core send function that will send a packet across the current channel to a specific robot.<p>
|
| 485 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 486 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 487 |
<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> |
| 488 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the data array </td></tr> |
| 489 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group of the packet </td></tr> |
| 490 |
<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> |
| 492 |
</table>
|
| 493 |
</dl>
|
| 494 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for OK, or error code (TBD) </dd></dl> |
| 495 |
|
| 496 |
</div>
|
| 497 |
</div><p> |
| 498 |
<a class="anchor" name="g223f437c2bc8ab8a3ac2e0e06841120f"></a><!-- doxytag: member="wireless.c::wl_terminate" ref="g223f437c2bc8ab8a3ac2e0e06841120f" args="(void)" --> |
| 499 |
<div class="memitem"> |
| 500 |
<div class="memproto"> |
| 501 |
<table class="memname"> |
| 502 |
<tr>
|
| 503 |
<td class="memname">int8_t wl_terminate </td> |
| 504 |
<td>(</td> |
| 505 |
<td class="paramtype">void </td> |
| 506 |
<td class="paramname"> </td> |
| 507 |
<td> ) </td> |
| 508 |
<td></td> |
| 509 |
</tr>
|
| 510 |
</table>
|
| 511 |
</div>
|
| 512 |
<div class="memdoc"> |
| 513 |
|
| 514 |
<p>
|
| 515 |
Terminate wireless. |
| 516 |
<p>
|
| 517 |
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> |
| 519 |
|
| 520 |
</div>
|
| 521 |
</div><p> |
| 522 |
</div>
|
| 523 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by |
| 524 |
<a href="http://www.doxygen.org/index.html"> |
| 525 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 526 |
</body>
|
| 527 |
</html>
|