root / trunk / docs / libdragonfly / group__xbee.html @ 87
History | View | Annotate | Download (8.48 KB)
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
3 |
<title>libdragonfly: XBee Input / Output</title> |
4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.4.6 -->
|
8 |
<div class="tabs"> |
9 |
<ul>
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
12 |
<li><a href="files.html"><span>Files</span></a></li> |
13 |
</ul></div> |
14 |
<h1>XBee Input / Output</h1>Functions for XBee input / output. |
15 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
16 |
<tr><td></td></tr> |
17 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
18 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7125fc8f3df24a2db8e074983206b054"></a><!-- doxytag: member="xbee::XBEE_BAUD" ref="g7125fc8f3df24a2db8e074983206b054" args="" --> |
19 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7125fc8f3df24a2db8e074983206b054">XBEE_BAUD</a> 9600</td></tr> |
20 |
|
21 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">the XBee baud rate <br></td></tr> |
22 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
23 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107">xbee_init</a> (void)</td></tr> |
24 |
|
25 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee. <a href="#g964a1e8461e9c1187e5d69f521e5e107"></a><br></td></tr> |
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g70c6b231330312d4f69b9a8afb5af989">xbee_putc</a> (char c)</td></tr> |
27 |
|
28 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a character to the XBee. <a href="#g70c6b231330312d4f69b9a8afb5af989"></a><br></td></tr> |
29 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g1f468ae159ba5d97bdfb3f4855d15d88">xbee_getc</a> (void)</td></tr> |
30 |
|
31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a character from the XBee. <a href="#g1f468ae159ba5d97bdfb3f4855d15d88"></a><br></td></tr> |
32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gfb7bd5dd535e8251bfff78854c6c15f2">xbee_getc_nb</a> (char *c)</td></tr> |
33 |
|
34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a character from the XBee without blocking. <a href="#gfb7bd5dd535e8251bfff78854c6c15f2"></a><br></td></tr> |
35 |
</table>
|
36 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
37 |
Functions for XBee input / output. |
38 |
<p>
|
39 |
Low level functions for XBee input and output. <hr><h2>Function Documentation</h2> |
40 |
<a class="anchor" name="g1f468ae159ba5d97bdfb3f4855d15d88"></a><!-- doxytag: member="serial.h::xbee_getc" ref="g1f468ae159ba5d97bdfb3f4855d15d88" args="(void)" --><p> |
41 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
42 |
<tr>
|
43 |
<td class="mdRow"> |
44 |
<table cellpadding="0" cellspacing="0" border="0"> |
45 |
<tr>
|
46 |
<td class="md" nowrap valign="top">int xbee_getc </td> |
47 |
<td class="md" valign="top">( </td> |
48 |
<td class="md" nowrap valign="top">void </td> |
49 |
<td class="mdname1" valign="top" nowrap> </td> |
50 |
<td class="md" valign="top"> ) </td> |
51 |
<td class="md" nowrap></td> |
52 |
</tr>
|
53 |
</table>
|
54 |
</td>
|
55 |
</tr>
|
56 |
</table>
|
57 |
<table cellspacing="5" cellpadding="0" border="0"> |
58 |
<tr>
|
59 |
<td>
|
60 |
|
61 |
</td>
|
62 |
<td>
|
63 |
|
64 |
<p>
|
65 |
Read a character from the XBee. |
66 |
<p>
|
67 |
Returns the first character in the buffer received from USB. This function blocks execution until a character has been received. xbee_init must be called before this function may be used.<p>
|
68 |
<dl compact><dt><b>Returns:</b></dt><dd>the first character in the xbee buffer</dd></dl> |
69 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107">xbee_init</a>, <a class="el" href="group__xbee.html#gfb7bd5dd535e8251bfff78854c6c15f2">xbee_getc_nb</a> </dd></dl> |
70 |
</td>
|
71 |
</tr>
|
72 |
</table>
|
73 |
<a class="anchor" name="gfb7bd5dd535e8251bfff78854c6c15f2"></a><!-- doxytag: member="serial.h::xbee_getc_nb" ref="gfb7bd5dd535e8251bfff78854c6c15f2" args="(char *c)" --><p> |
74 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
75 |
<tr>
|
76 |
<td class="mdRow"> |
77 |
<table cellpadding="0" cellspacing="0" border="0"> |
78 |
<tr>
|
79 |
<td class="md" nowrap valign="top">int xbee_getc_nb </td> |
80 |
<td class="md" valign="top">( </td> |
81 |
<td class="md" nowrap valign="top">char * </td> |
82 |
<td class="mdname1" valign="top" nowrap> <em>c</em> </td> |
83 |
<td class="md" valign="top"> ) </td> |
84 |
<td class="md" nowrap></td> |
85 |
</tr>
|
86 |
</table>
|
87 |
</td>
|
88 |
</tr>
|
89 |
</table>
|
90 |
<table cellspacing="5" cellpadding="0" border="0"> |
91 |
<tr>
|
92 |
<td>
|
93 |
|
94 |
</td>
|
95 |
<td>
|
96 |
|
97 |
<p>
|
98 |
Read a character from the XBee without blocking. |
99 |
<p>
|
100 |
Non blocking version of xbee_getc. If a character is present in the buffer, it is returned, otherwise -1 is returned immediately. xbee_init must be called before this function can be used.<p>
|
101 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
102 |
<table border="0" cellspacing="2" cellpadding="0"> |
103 |
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the received character. This will be set if a character has been received.</td></tr> |
104 |
</table>
|
105 |
</dl>
|
106 |
<dl compact><dt><b>Returns:</b></dt><dd>-1 if no character is available, 0 otherwise</dd></dl> |
107 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107">xbee_init</a>, <a class="el" href="group__xbee.html#g1f468ae159ba5d97bdfb3f4855d15d88">xbee_getc</a> </dd></dl> |
108 |
</td>
|
109 |
</tr>
|
110 |
</table>
|
111 |
<a class="anchor" name="g964a1e8461e9c1187e5d69f521e5e107"></a><!-- doxytag: member="serial.h::xbee_init" ref="g964a1e8461e9c1187e5d69f521e5e107" args="(void)" --><p> |
112 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
113 |
<tr>
|
114 |
<td class="mdRow"> |
115 |
<table cellpadding="0" cellspacing="0" border="0"> |
116 |
<tr>
|
117 |
<td class="md" nowrap valign="top">void xbee_init </td> |
118 |
<td class="md" valign="top">( </td> |
119 |
<td class="md" nowrap valign="top">void </td> |
120 |
<td class="mdname1" valign="top" nowrap> </td> |
121 |
<td class="md" valign="top"> ) </td> |
122 |
<td class="md" nowrap></td> |
123 |
</tr>
|
124 |
</table>
|
125 |
</td>
|
126 |
</tr>
|
127 |
</table>
|
128 |
<table cellspacing="5" cellpadding="0" border="0"> |
129 |
<tr>
|
130 |
<td>
|
131 |
|
132 |
</td>
|
133 |
<td>
|
134 |
|
135 |
<p>
|
136 |
Initialize the XBee. |
137 |
<p>
|
138 |
Initializes communication over the XBee. This must be called before any other xbee function may be used. </td>
|
139 |
</tr>
|
140 |
</table>
|
141 |
<a class="anchor" name="g70c6b231330312d4f69b9a8afb5af989"></a><!-- doxytag: member="serial.h::xbee_putc" ref="g70c6b231330312d4f69b9a8afb5af989" args="(char c)" --><p> |
142 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
143 |
<tr>
|
144 |
<td class="mdRow"> |
145 |
<table cellpadding="0" cellspacing="0" border="0"> |
146 |
<tr>
|
147 |
<td class="md" nowrap valign="top">int xbee_putc </td> |
148 |
<td class="md" valign="top">( </td> |
149 |
<td class="md" nowrap valign="top">char </td> |
150 |
<td class="mdname1" valign="top" nowrap> <em>c</em> </td> |
151 |
<td class="md" valign="top"> ) </td> |
152 |
<td class="md" nowrap></td> |
153 |
</tr>
|
154 |
</table>
|
155 |
</td>
|
156 |
</tr>
|
157 |
</table>
|
158 |
<table cellspacing="5" cellpadding="0" border="0"> |
159 |
<tr>
|
160 |
<td>
|
161 |
|
162 |
</td>
|
163 |
<td>
|
164 |
|
165 |
<p>
|
166 |
Print a character to the XBee. |
167 |
<p>
|
168 |
Sends a character to the XBee.<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>c</em> </td><td>the character to send </td></tr> |
172 |
</table>
|
173 |
</dl>
|
174 |
<dl compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl> |
175 |
</td>
|
176 |
</tr>
|
177 |
</table>
|
178 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 26 17:39:31 2007 for libdragonfly by |
179 |
<a href="http://www.doxygen.org/index.html"> |
180 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
181 |
</body>
|
182 |
</html>
|