root / branches / wireless / docs / libwireless / html / wireless_8h.html @ 1581
History | View | Annotate | Download (13.1 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.h File Reference</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 class="current"><a href="files.html"><span>Files</span></a></li> |
| 14 |
</ul>
|
| 15 |
</div>
|
| 16 |
<div class="tabs"> |
| 17 |
<ul>
|
| 18 |
<li><a href="files.html"><span>File List</span></a></li> |
| 19 |
<li><a href="globals.html"><span>Globals</span></a></li> |
| 20 |
</ul>
|
| 21 |
</div>
|
| 22 |
</div>
|
| 23 |
<div class="contents"> |
| 24 |
<h1>wireless.h File Reference</h1>Contains definitions for using the wireless library. |
| 25 |
<a href="#_details">More...</a> |
| 26 |
<p>
|
| 27 |
<code>#include <stdint.h></code><br> |
| 28 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 29 |
<tr><td></td></tr> |
| 30 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3de33738fd3c7e77bffbcfaefc3e7645"></a><!-- doxytag: member="wireless.h::GLOBAL" ref="g3de33738fd3c7e77bffbcfaefc3e7645" args="" --> |
| 32 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g3de33738fd3c7e77bffbcfaefc3e7645">GLOBAL</a> UINT8_C(0)</td></tr> |
| 33 |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">global scope <br></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g11ed0d4e68673af6d575ed529ddf2130"></a><!-- doxytag: member="wireless.h::PAN" ref="g11ed0d4e68673af6d575ed529ddf2130" args="" --> |
| 36 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g11ed0d4e68673af6d575ed529ddf2130">PAN</a> UINT8_C(1)</td></tr> |
| 37 |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">local pan scope <br></td></tr> |
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc286e1243ab6be2c950c277e5e1377f9"></a><!-- doxytag: member="wireless.h::BROADCAST" ref="gc286e1243ab6be2c950c277e5e1377f9" args="" --> |
| 40 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gc286e1243ab6be2c950c277e5e1377f9">BROADCAST</a> UINT16_C(0xFFFF)</td></tr> |
| 41 |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">broadcast address <br></td></tr> |
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5bda06b0f5767eeca91b1383c0898c19"></a><!-- doxytag: member="wireless.h::RELIABLE" ref="g5bda06b0f5767eeca91b1383c0898c19" args="" --> |
| 44 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g5bda06b0f5767eeca91b1383c0898c19">RELIABLE</a> UINT8_C(0)</td></tr> |
| 45 |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">reliable (TCP) mode <br></td></tr> |
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8091c2bcff55cbe0a4a145fd5fb7c22d"></a><!-- doxytag: member="wireless.h::FAST" ref="g8091c2bcff55cbe0a4a145fd5fb7c22d" args="" --> |
| 48 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g8091c2bcff55cbe0a4a145fd5fb7c22d">FAST</a> UINT8_C(1)</td></tr> |
| 49 |
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">fast (UDP) mode <br></td></tr> |
| 51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3"></a><!-- doxytag: member="wireless.h::NORMAL_PRIORITY" ref="gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3" args="" --> |
| 52 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3">NORMAL_PRIORITY</a> UINT8_C(0)</td></tr> |
| 53 |
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">standard priority <br></td></tr> |
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ged801c122c559efe4677d351d07747b4"></a><!-- doxytag: member="wireless.h::HIGH_PRIORITY" ref="ged801c122c559efe4677d351d07747b4" args="" --> |
| 56 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ged801c122c559efe4677d351d07747b4">HIGH_PRIORITY</a> UINT8_C(1)</td></tr> |
| 57 |
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">high priority, handle immediately <br></td></tr> |
| 59 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr> |
| 61 |
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize wireless. <a href="group__wl__functions.html#g6a8d6179b1fe27f762937f0b47af2009"></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__wl__functions.html#g223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr> |
| 64 |
|
| 65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminate wireless. <a href="group__wl__functions.html#g223f437c2bc8ab8a3ac2e0e06841120f"></a><br></td></tr> |
| 66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><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)" --> |
| 67 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__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> |
| 68 |
|
| 69 |
<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> |
| 70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gd92093466d82f3f0c732ffe8323228d2">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
| 71 |
|
| 72 |
<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="group__wl__functions.html#gd92093466d82f3f0c732ffe8323228d2"></a><br></td></tr> |
| 73 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g7886c2a37b7350211699dcabe48ff076">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr> |
| 74 |
|
| 75 |
<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="group__wl__functions.html#g7886c2a37b7350211699dcabe48ff076"></a><br></td></tr> |
| 76 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><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)" --> |
| 77 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gbb08f7957bd0256c51f424fa770d3e60">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)</td></tr> |
| 78 |
|
| 79 |
<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> |
| 80 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wl_send_basic</a> (char *data, uint8_t length)</td></tr> |
| 81 |
|
| 82 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default (i.e. basic) send wrapper. <a href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><br></td></tr> |
| 83 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr> |
| 84 |
|
| 85 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of acknowledgment errors. <a href="group__wl__functions.html#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr> |
| 86 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr> |
| 87 |
|
| 88 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks a specific packet for the acknowledgement status. <a href="group__wl__functions.html#ga364aa4d9cc8c789f05401e8adf44785"></a><br></td></tr> |
| 89 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr> |
| 90 |
|
| 91 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets acknowledgement statistics back to zero. <a href="group__wl__functions.html#g62e126abfcd382ec02524dd2f45a8a7b"></a><br></td></tr> |
| 92 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr> |
| 93 |
|
| 94 |
<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="group__wl__functions.html#ga5a965e3443e4b2b60243225c50ecca7"></a><br></td></tr> |
| 95 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ge2509e2b6bc61faa26d87b1d87881817">wl_get_basic</a> (char *data, uint8_t length)</td></tr> |
| 96 |
|
| 97 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next basic packet if available. <a href="group__wl__functions.html#ge2509e2b6bc61faa26d87b1d87881817"></a><br></td></tr> |
| 98 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge91c1e1940dfbbd063fdcfb86049c64a"></a><!-- doxytag: member="wireless.h::wl_dispatch" ref="ge91c1e1940dfbbd063fdcfb86049c64a" args="(void)" --> |
| 99 |
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ge91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr> |
| 100 |
|
| 101 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr> |
| 102 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr> |
| 103 |
|
| 104 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to register new packet handlers (for non-default groups only). <a href="group__wl__functions.html#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr> |
| 105 |
</table>
|
| 106 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 107 |
Copyright (c) 2009 Colony Project<p>
|
| 108 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>
|
| 109 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
|
| 110 |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p>
|
| 111 |
Contains definitions for interfacing with the wireless library.<p>
|
| 112 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 113 |
</div>
|
| 114 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by |
| 115 |
<a href="http://www.doxygen.org/index.html"> |
| 116 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 117 |
</body>
|
| 118 |
</html>
|