Statistics
| Revision:

root / branches / wireless / docs / libwireless / html / wl__defs_8h.html @ 1823

History | View | Annotate | Download (14.9 KB)

1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
<head>
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>libwireless: wl_defs.h File Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
</head>
9
<body>
10
<!-- Generated by Doxygen 1.6.3 -->
11
<div class="navigation" id="top">
12
  <div class="tabs">
13
    <ul>
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17
      <li class="current"><a href="files.html"><span>Files</span></a></li>
18
    </ul>
19
  </div>
20
  <div class="tabs">
21
    <ul>
22
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
23
      <li><a href="globals.html"><span>Globals</span></a></li>
24
    </ul>
25
  </div>
26
</div>
27
<div class="contents">
28
<h1>wl_defs.h File Reference</h1>
29
<p>Definitions for Wireless.  
30
<a href="#_details">More...</a></p>
31
<code>#include &lt;stdint.h&gt;</code><br/>
32

    
33
<p><a href="wl__defs_8h_source.html">Go to the source code of this file.</a></p>
34
<table border="0" cellpadding="0" cellspacing="0">
35
<tr><td colspan="2"><h2>Defines</h2></td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bdbfcff81e33bd51a83eecd01aec257"></a><!-- doxytag: member="wl_defs.h::ROBOT" ref="a9bdbfcff81e33bd51a83eecd01aec257" args="" -->
37
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ROBOT</b></td></tr>
38
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ed8a396c873e705d5c8845ca793a8e9"></a><!-- doxytag: member="wl_defs.h::WL_DEBUG" ref="a3ed8a396c873e705d5c8845ca793a8e9" args="" -->
39
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_DEBUG</b></td></tr>
40
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2b8a799ce85bb21788e58e1c23c16fc0"></a><!-- doxytag: member="wl_defs.h::WL_SUCCESS" ref="ga2b8a799ce85bb21788e58e1c23c16fc0" args="" -->
41
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga2b8a799ce85bb21788e58e1c23c16fc0">WL_SUCCESS</a>&nbsp;&nbsp;&nbsp;INT8_C(0)</td></tr>
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Success. <br/></td></tr>
43
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga798466231ef137f248b55dbfbce36fd7"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_INIT_FAILED" ref="ga798466231ef137f248b55dbfbce36fd7" args="" -->
44
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga798466231ef137f248b55dbfbce36fd7">WL_ERROR_INIT_FAILED</a>&nbsp;&nbsp;&nbsp;INT8_C(-1)</td></tr>
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for init failure. <br/></td></tr>
46
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga63e64a790913362ecf505e1a7e8347b8"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_INIT_ALREADY_INITD" ref="ga63e64a790913362ecf505e1a7e8347b8" args="" -->
47
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga63e64a790913362ecf505e1a7e8347b8">WL_ERROR_INIT_ALREADY_INITD</a>&nbsp;&nbsp;&nbsp;INT8_C(-2)</td></tr>
48
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for duplicate init calls. <br/></td></tr>
49
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga099f03f9edae294ce4989433f73c141e"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_LIBRARY_NOT_INITD" ref="ga099f03f9edae294ce4989433f73c141e" args="" -->
50
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga099f03f9edae294ce4989433f73c141e">WL_ERROR_LIBRARY_NOT_INITD</a>&nbsp;&nbsp;&nbsp;INT8_C(-3)</td></tr>
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for not calling init. <br/></td></tr>
52
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga54de37a8427bf7372cfefa925cd0acf6"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_TERMINATION_FAILED" ref="ga54de37a8427bf7372cfefa925cd0acf6" args="" -->
53
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga54de37a8427bf7372cfefa925cd0acf6">WL_ERROR_TERMINATION_FAILED</a>&nbsp;&nbsp;&nbsp;INT8_C(-4)</td></tr>
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed termination. <br/></td></tr>
55
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga11477a5a024fd6898e4449bf08761207"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_FAILED_REGISTRATION" ref="ga11477a5a024fd6898e4449bf08761207" args="" -->
56
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga11477a5a024fd6898e4449bf08761207">WL_ERROR_FAILED_REGISTRATION</a>&nbsp;&nbsp;&nbsp;INT8_C(-5)</td></tr>
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed packet group registration. <br/></td></tr>
58
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2b221412880d805da1f9eb735ce7869f"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_FAILED_UNREGISTRATION" ref="ga2b221412880d805da1f9eb735ce7869f" args="" -->
59
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga2b221412880d805da1f9eb735ce7869f">WL_ERROR_FAILED_UNREGISTRATION</a>&nbsp;&nbsp;&nbsp;INT8_C(-6)</td></tr>
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed packet group registration. <br/></td></tr>
61
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga43f851eae7eed2576351d336001c21d2"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_ARGUMENT" ref="ga43f851eae7eed2576351d336001c21d2" args="" -->
62
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga43f851eae7eed2576351d336001c21d2">WL_ERROR_ARGUMENT</a>&nbsp;&nbsp;&nbsp;INT8_C(-7)</td></tr>
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error in arguments. <br/></td></tr>
64
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2a775d59e55e9435505b4a908c522a0a"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_SEND" ref="ga2a775d59e55e9435505b4a908c522a0a" args="" -->
65
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga2a775d59e55e9435505b4a908c522a0a">WL_ERROR_SEND</a>&nbsp;&nbsp;&nbsp;INT8_C(-10)</td></tr>
66
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for send failure. <br/></td></tr>
67
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4bffaed18853133c76af57b89771b234"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_BAD_GROUP" ref="ga4bffaed18853133c76af57b89771b234" args="" -->
68
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga4bffaed18853133c76af57b89771b234">WL_ERROR_BAD_GROUP</a>&nbsp;&nbsp;&nbsp;INT8_C(-11)</td></tr>
69
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad group number. <br/></td></tr>
70
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga76d08a0e32732a63dc93d2cdf95c8fd0"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_SCOPE" ref="ga76d08a0e32732a63dc93d2cdf95c8fd0" args="" -->
71
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga76d08a0e32732a63dc93d2cdf95c8fd0">WL_ERROR_SCOPE</a>&nbsp;&nbsp;&nbsp;INT8_C(-12)</td></tr>
72
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad scope. <br/></td></tr>
73
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9c528907279e6ace3aae7a7b19ad7687"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_ADDRESS" ref="ga9c528907279e6ace3aae7a7b19ad7687" args="" -->
74
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga9c528907279e6ace3aae7a7b19ad7687">WL_ERROR_ADDRESS</a>&nbsp;&nbsp;&nbsp;INT8_C(-13)</td></tr>
75
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad robot address. <br/></td></tr>
76
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga33881dd2ec8ad0c2f67e40491a2f7c1a"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_MODE" ref="ga33881dd2ec8ad0c2f67e40491a2f7c1a" args="" -->
77
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga33881dd2ec8ad0c2f67e40491a2f7c1a">WL_ERROR_MODE</a>&nbsp;&nbsp;&nbsp;INT8_C(-14)</td></tr>
78
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad mode. <br/></td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacad84a598557eaf3ae400f7fdb4cf6c0"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_TOO_SMALL" ref="gacad84a598557eaf3ae400f7fdb4cf6c0" args="" -->
80
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#gacad84a598557eaf3ae400f7fdb4cf6c0">WL_ERROR_TOO_SMALL</a>&nbsp;&nbsp;&nbsp;INT8_C(-15)</td></tr>
81
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for received paacket destination too small for received packet. <br/></td></tr>
82
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga39b25b343987ddbabbf378525ed17e8f"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_SENDING_BUFFER_FULL" ref="ga39b25b343987ddbabbf378525ed17e8f" args="" -->
83
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga39b25b343987ddbabbf378525ed17e8f">WL_ERROR_SENDING_BUFFER_FULL</a>&nbsp;&nbsp;&nbsp;INT8_C(-16)</td></tr>
84
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for sending buffer full (the packet was sent, but no retries will be made). <br/></td></tr>
85
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga95320a2338e465077c708a7b50b20c9a"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_XBEE_COMMAND" ref="ga95320a2338e465077c708a7b50b20c9a" args="" -->
86
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga95320a2338e465077c708a7b50b20c9a">WL_ERROR_XBEE_COMMAND</a>&nbsp;&nbsp;&nbsp;INT8_C(-17)</td></tr>
87
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed xbee command. <br/></td></tr>
88
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga029f22a1c6b7308a7a9db2ee7490a4f0"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_XBEE_COMMAND_16BIT" ref="ga029f22a1c6b7308a7a9db2ee7490a4f0" args="" -->
89
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga029f22a1c6b7308a7a9db2ee7490a4f0">WL_ERROR_XBEE_COMMAND_16BIT</a>&nbsp;&nbsp;&nbsp;0xFEFE</td></tr>
90
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed 16bit xbee command. <br/></td></tr>
91
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga35522d85bcb3ce7e1f0649ed8880a47a"></a><!-- doxytag: member="wl_defs.h::WL_ERROR_BAUD" ref="ga35522d85bcb3ce7e1f0649ed8880a47a" args="" -->
92
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga35522d85bcb3ce7e1f0649ed8880a47a">WL_ERROR_BAUD</a>&nbsp;&nbsp;&nbsp;INT8_C(-18)</td></tr>
93
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for bad baud rate. <br/></td></tr>
94
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab30af815d6e9494361629440f14e3716"></a><!-- doxytag: member="wl_defs.h::PACKET_BUFFER_SIZE" ref="gab30af815d6e9494361629440f14e3716" args="" -->
95
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>PACKET_BUFFER_SIZE</b>&nbsp;&nbsp;&nbsp;250</td></tr>
96
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeaadbf5f5646a5b3ec10510b93ce2968"></a><!-- doxytag: member="wl_defs.h::WL_DEBUG_PRINT" ref="aeaadbf5f5646a5b3ec10510b93ce2968" args="(s)" -->
97
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_DEBUG_PRINT</b>(s)</td></tr>
98
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43123ca6548aef1e17dc7cb1b215a6f5"></a><!-- doxytag: member="wl_defs.h::WL_DEBUG_PRINT_P" ref="a43123ca6548aef1e17dc7cb1b215a6f5" args="(s)" -->
99
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_DEBUG_PRINT_P</b>(s)</td></tr>
100
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29bb4a52f41ee104dbc7dc1db4d14695"></a><!-- doxytag: member="wl_defs.h::WL_DEBUG_PRINT_CHAR" ref="a29bb4a52f41ee104dbc7dc1db4d14695" args="(c)" -->
101
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_DEBUG_PRINT_CHAR</b>(c)</td></tr>
102
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5376a3f9ed20dca1ca62ab0082b17886"></a><!-- doxytag: member="wl_defs.h::WL_DEBUG_PRINT_INT" ref="a5376a3f9ed20dca1ca62ab0082b17886" args="(i)" -->
103
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_DEBUG_PRINT_INT</b>(i)</td></tr>
104
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a524777fa6c6079efd00632c2fc576edf"></a><!-- doxytag: member="wl_defs.h::WL_DEBUG_PRINT_HEX" ref="a524777fa6c6079efd00632c2fc576edf" args="(i)" -->
105
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_DEBUG_PRINT_HEX</b>(i)</td></tr>
106
</table>
107
<hr/><a name="_details"></a><h2>Detailed Description</h2>
108
<p>Definitions for Wireless. </p>
109
<p>Copyright (c) 2009 Colony Project</p>
110
<p>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>
111
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
112
<p>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>
113
<p>Contains definitions for wireless, debugging information, etc.</p>
114
<dl class="author"><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>
115
</div>
116
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
117
<a href="http://www.doxygen.org/index.html">
118
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
119
</body>
120
</html>