root / branches / wireless / docs / libdragonfly / html / group__xbee.html @ 1578
History | View | Annotate | Download (7.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: XBee Input / Output</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="pages.html"><span>Related Pages</span></a></li> |
| 13 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 14 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 15 |
<li><a href="files.html"><span>Files</span></a></li> |
| 16 |
</ul>
|
| 17 |
</div>
|
| 18 |
</div>
|
| 19 |
<div class="contents"> |
| 20 |
<h1>XBee Input / Output</h1>Functions for XBee input / output. |
| 21 |
<a href="#_details">More...</a> |
| 22 |
<p>
|
| 23 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 24 |
<tr><td></td></tr> |
| 25 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7125fc8f3df24a2db8e074983206b054"></a><!-- doxytag: member="xbee::XBEE_BAUD" ref="g7125fc8f3df24a2db8e074983206b054" args="" --> |
| 27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7125fc8f3df24a2db8e074983206b054">XBEE_BAUD</a> 9600</td></tr> |
| 28 |
|
| 29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">the XBee baud rate <br></td></tr> |
| 30 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gdde7e22c6728410a0d913b749bdcb20d">xbee_init</a> (void)</td></tr> |
| 32 |
|
| 33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee. <a href="#gdde7e22c6728410a0d913b749bdcb20d"></a><br></td></tr> |
| 34 |
<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> |
| 35 |
|
| 36 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a character to the XBee. <a href="#g70c6b231330312d4f69b9a8afb5af989"></a><br></td></tr> |
| 37 |
<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> |
| 38 |
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a character from the XBee. <a href="#g1f468ae159ba5d97bdfb3f4855d15d88"></a><br></td></tr> |
| 40 |
<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> |
| 41 |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a character from the XBee without blocking. <a href="#gfb7bd5dd535e8251bfff78854c6c15f2"></a><br></td></tr> |
| 43 |
</table>
|
| 44 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 45 |
Functions for XBee input / output. |
| 46 |
<p>
|
| 47 |
Low level functions for XBee input and output. <hr><h2>Function Documentation</h2> |
| 48 |
<a class="anchor" name="g1f468ae159ba5d97bdfb3f4855d15d88"></a><!-- doxytag: member="serial.h::xbee_getc" ref="g1f468ae159ba5d97bdfb3f4855d15d88" args="(void)" --> |
| 49 |
<div class="memitem"> |
| 50 |
<div class="memproto"> |
| 51 |
<table class="memname"> |
| 52 |
<tr>
|
| 53 |
<td class="memname">int xbee_getc </td> |
| 54 |
<td>(</td> |
| 55 |
<td class="paramtype">void </td> |
| 56 |
<td class="paramname"> </td> |
| 57 |
<td> ) </td> |
| 58 |
<td></td> |
| 59 |
</tr>
|
| 60 |
</table>
|
| 61 |
</div>
|
| 62 |
<div class="memdoc"> |
| 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 class="return" compact><dt><b>Returns:</b></dt><dd>the first character in the xbee buffer, -1 on error</dd></dl> |
| 69 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#gdde7e22c6728410a0d913b749bdcb20d" 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> |
| 70 |
|
| 71 |
</div>
|
| 72 |
</div><p> |
| 73 |
<a class="anchor" name="gfb7bd5dd535e8251bfff78854c6c15f2"></a><!-- doxytag: member="serial.h::xbee_getc_nb" ref="gfb7bd5dd535e8251bfff78854c6c15f2" args="(char *c)" --> |
| 74 |
<div class="memitem"> |
| 75 |
<div class="memproto"> |
| 76 |
<table class="memname"> |
| 77 |
<tr>
|
| 78 |
<td class="memname">int xbee_getc_nb </td> |
| 79 |
<td>(</td> |
| 80 |
<td class="paramtype">char * </td> |
| 81 |
<td class="paramname"> <em>c</em> </td> |
| 82 |
<td> ) </td> |
| 83 |
<td></td> |
| 84 |
</tr>
|
| 85 |
</table>
|
| 86 |
</div>
|
| 87 |
<div class="memdoc"> |
| 88 |
|
| 89 |
<p>
|
| 90 |
Read a character from the XBee without blocking. |
| 91 |
<p>
|
| 92 |
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>
|
| 93 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 94 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 95 |
<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> |
| 96 |
</table>
|
| 97 |
</dl>
|
| 98 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 if no character is available, 0 otherwise, positive for error</dd></dl> |
| 99 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#gdde7e22c6728410a0d913b749bdcb20d" 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> |
| 100 |
|
| 101 |
</div>
|
| 102 |
</div><p> |
| 103 |
<a class="anchor" name="gdde7e22c6728410a0d913b749bdcb20d"></a><!-- doxytag: member="serial.h::xbee_init" ref="gdde7e22c6728410a0d913b749bdcb20d" args="(void)" --> |
| 104 |
<div class="memitem"> |
| 105 |
<div class="memproto"> |
| 106 |
<table class="memname"> |
| 107 |
<tr>
|
| 108 |
<td class="memname">int xbee_init </td> |
| 109 |
<td>(</td> |
| 110 |
<td class="paramtype">void </td> |
| 111 |
<td class="paramname"> </td> |
| 112 |
<td> ) </td> |
| 113 |
<td></td> |
| 114 |
</tr>
|
| 115 |
</table>
|
| 116 |
</div>
|
| 117 |
<div class="memdoc"> |
| 118 |
|
| 119 |
<p>
|
| 120 |
Initialize the XBee. |
| 121 |
<p>
|
| 122 |
Initializes communication over the XBee. This must be called before any other xbee function may be used. |
| 123 |
</div>
|
| 124 |
</div><p> |
| 125 |
<a class="anchor" name="g70c6b231330312d4f69b9a8afb5af989"></a><!-- doxytag: member="serial.h::xbee_putc" ref="g70c6b231330312d4f69b9a8afb5af989" args="(char c)" --> |
| 126 |
<div class="memitem"> |
| 127 |
<div class="memproto"> |
| 128 |
<table class="memname"> |
| 129 |
<tr>
|
| 130 |
<td class="memname">int xbee_putc </td> |
| 131 |
<td>(</td> |
| 132 |
<td class="paramtype">char </td> |
| 133 |
<td class="paramname"> <em>c</em> </td> |
| 134 |
<td> ) </td> |
| 135 |
<td></td> |
| 136 |
</tr>
|
| 137 |
</table>
|
| 138 |
</div>
|
| 139 |
<div class="memdoc"> |
| 140 |
|
| 141 |
<p>
|
| 142 |
Print a character to the XBee. |
| 143 |
<p>
|
| 144 |
Sends a character to the XBee.<p>
|
| 145 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 146 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 147 |
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the character to send </td></tr> |
| 148 |
</table>
|
| 149 |
</dl>
|
| 150 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl> |
| 151 |
|
| 152 |
</div>
|
| 153 |
</div><p> |
| 154 |
</div>
|
| 155 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:59 2009 for Colony by |
| 156 |
<a href="http://www.doxygen.org/index.html"> |
| 157 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
| 158 |
</body>
|
| 159 |
</html>
|