Revision 241
Updated libdragonfly documentation.
| group__xbee.html | ||
|---|---|---|
| 1 | 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">
|
|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
| 3 | 3 |
<title>libdragonfly: XBee Input / Output</title> |
| 4 | 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 | 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 | 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.4.6 -->
|
|
| 7 |
<!-- Generated by Doxygen 1.5.3 -->
|
|
| 8 | 8 |
<div class="tabs"> |
| 9 | 9 |
<ul> |
| 10 | 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 11 | 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 | 12 |
<li><a href="files.html"><span>Files</span></a></li> |
| 13 |
</ul></div> |
|
| 13 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 14 | 16 |
<h1>XBee Input / Output</h1>Functions for XBee input / output. |
| 15 | 17 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 16 | 18 |
<tr><td></td></tr> |
| ... | ... | |
| 37 | 39 |
Functions for XBee input / output. |
| 38 | 40 |
<p> |
| 39 | 41 |
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"> |
|
| 42 |
<a class="anchor" name="g1f468ae159ba5d97bdfb3f4855d15d88"></a><!-- doxytag: member="serial.h::xbee_getc" ref="g1f468ae159ba5d97bdfb3f4855d15d88" args="(void)" --> |
|
| 43 |
<div class="memitem"> |
|
| 44 |
<div class="memproto"> |
|
| 45 |
<table class="memname"> |
|
| 45 | 46 |
<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>
|
|
| 47 |
<td class="memname">int xbee_getc </td>
|
|
| 48 |
<td>(</td>
|
|
| 49 |
<td class="paramtype">void </td>
|
|
| 50 |
<td class="paramname"> </td>
|
|
| 51 |
<td> ) </td> |
|
| 52 |
<td width="100%"></td>
|
|
| 52 | 53 |
</tr> |
| 53 | 54 |
</table> |
| 54 |
</td> |
|
| 55 |
</tr> |
|
| 56 |
</table> |
|
| 57 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 58 |
<tr> |
|
| 59 |
<td> |
|
| 60 |
|
|
| 61 |
</td> |
|
| 62 |
<td> |
|
| 55 |
</div> |
|
| 56 |
<div class="memdoc"> |
|
| 63 | 57 |
|
| 64 | 58 |
<p> |
| 65 | 59 |
Read a character from the XBee. |
| 66 | 60 |
<p> |
| 67 | 61 |
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"> |
|
| 62 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the first character in the xbee buffer</dd></dl> |
|
| 63 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107" title="Initialize the XBee.">xbee_init</a>, <a class="el" href="group__xbee.html#gfb7bd5dd535e8251bfff78854c6c15f2" title="Read a character from the XBee without blocking.">xbee_getc_nb</a> </dd></dl> |
|
| 64 |
|
|
| 65 |
</div> |
|
| 66 |
</div><p> |
|
| 67 |
<a class="anchor" name="gfb7bd5dd535e8251bfff78854c6c15f2"></a><!-- doxytag: member="serial.h::xbee_getc_nb" ref="gfb7bd5dd535e8251bfff78854c6c15f2" args="(char *c)" --> |
|
| 68 |
<div class="memitem"> |
|
| 69 |
<div class="memproto"> |
|
| 70 |
<table class="memname"> |
|
| 78 | 71 |
<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>
|
|
| 72 |
<td class="memname">int xbee_getc_nb </td>
|
|
| 73 |
<td>(</td>
|
|
| 74 |
<td class="paramtype">char * </td>
|
|
| 75 |
<td class="paramname"> <em>c</em> </td>
|
|
| 76 |
<td> ) </td> |
|
| 77 |
<td width="100%"></td>
|
|
| 85 | 78 |
</tr> |
| 86 | 79 |
</table> |
| 87 |
</td> |
|
| 88 |
</tr> |
|
| 89 |
</table> |
|
| 90 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 91 |
<tr> |
|
| 92 |
<td> |
|
| 93 |
|
|
| 94 |
</td> |
|
| 95 |
<td> |
|
| 80 |
</div> |
|
| 81 |
<div class="memdoc"> |
|
| 96 | 82 |
|
| 97 | 83 |
<p> |
| 98 | 84 |
Read a character from the XBee without blocking. |
| ... | ... | |
| 103 | 89 |
<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 | 90 |
</table> |
| 105 | 91 |
</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"> |
|
| 92 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 if no character is available, 0 otherwise</dd></dl> |
|
| 93 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107" title="Initialize the XBee.">xbee_init</a>, <a class="el" href="group__xbee.html#g1f468ae159ba5d97bdfb3f4855d15d88" title="Read a character from the XBee.">xbee_getc</a> </dd></dl> |
|
| 94 |
|
|
| 95 |
</div> |
|
| 96 |
</div><p> |
|
| 97 |
<a class="anchor" name="g964a1e8461e9c1187e5d69f521e5e107"></a><!-- doxytag: member="serial.h::xbee_init" ref="g964a1e8461e9c1187e5d69f521e5e107" args="(void)" --> |
|
| 98 |
<div class="memitem"> |
|
| 99 |
<div class="memproto"> |
|
| 100 |
<table class="memname"> |
|
| 116 | 101 |
<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>
|
|
| 102 |
<td class="memname">void xbee_init </td>
|
|
| 103 |
<td>(</td>
|
|
| 104 |
<td class="paramtype">void </td>
|
|
| 105 |
<td class="paramname"> </td>
|
|
| 106 |
<td> ) </td> |
|
| 107 |
<td width="100%"></td>
|
|
| 123 | 108 |
</tr> |
| 124 | 109 |
</table> |
| 125 |
</td> |
|
| 126 |
</tr> |
|
| 127 |
</table> |
|
| 128 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 129 |
<tr> |
|
| 130 |
<td> |
|
| 131 |
|
|
| 132 |
</td> |
|
| 133 |
<td> |
|
| 110 |
</div> |
|
| 111 |
<div class="memdoc"> |
|
| 134 | 112 |
|
| 135 | 113 |
<p> |
| 136 | 114 |
Initialize the XBee. |
| 137 | 115 |
<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"> |
|
| 116 |
Initializes communication over the XBee. This must be called before any other xbee function may be used. |
|
| 117 |
</div> |
|
| 118 |
</div><p> |
|
| 119 |
<a class="anchor" name="g70c6b231330312d4f69b9a8afb5af989"></a><!-- doxytag: member="serial.h::xbee_putc" ref="g70c6b231330312d4f69b9a8afb5af989" args="(char c)" --> |
|
| 120 |
<div class="memitem"> |
|
| 121 |
<div class="memproto"> |
|
| 122 |
<table class="memname"> |
|
| 146 | 123 |
<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>
|
|
| 124 |
<td class="memname">int xbee_putc </td>
|
|
| 125 |
<td>(</td>
|
|
| 126 |
<td class="paramtype">char </td>
|
|
| 127 |
<td class="paramname"> <em>c</em> </td>
|
|
| 128 |
<td> ) </td> |
|
| 129 |
<td width="100%"></td>
|
|
| 153 | 130 |
</tr> |
| 154 | 131 |
</table> |
| 155 |
</td> |
|
| 156 |
</tr> |
|
| 157 |
</table> |
|
| 158 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 159 |
<tr> |
|
| 160 |
<td> |
|
| 161 |
|
|
| 162 |
</td> |
|
| 163 |
<td> |
|
| 132 |
</div> |
|
| 133 |
<div class="memdoc"> |
|
| 164 | 134 |
|
| 165 | 135 |
<p> |
| 166 | 136 |
Print a character to the XBee. |
| ... | ... | |
| 171 | 141 |
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the character to send </td></tr> |
| 172 | 142 |
</table> |
| 173 | 143 |
</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
|
|
| 144 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl>
|
|
| 145 |
|
|
| 146 |
</div>
|
|
| 147 |
</div><p>
|
|
| 148 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by
|
|
| 179 | 149 |
<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>
|
|
| 150 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
| 181 | 151 |
</body> |
| 182 | 152 |
</html> |
Also available in: Unified diff