/trunk/docs/libdragonfly/group__xbee.html - Annotate - Colony - Robotics Club

root / trunk / docs / libdragonfly / group__xbee.html @ 1469

History | View | Annotate | Download (8.27 KB)

-            bcoltin
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-            bcoltin
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
-            bcoltin
+<title>libdragonfly: XBee Input / Output</title>
-            cmar
+<link href="tabs.css" rel="stylesheet" type="text/css">
-            bcoltin
+<link href="doxygen.css" rel="stylesheet" type="text/css">
 </head><body>
-            cmar
+<!-- Generated by Doxygen 1.5.9 -->
-            deffi
+<div class="navigation" id="top">
   <div class="tabs">
     <ul>
       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
       <li><a href="modules.html"><span>Modules</span></a></li>
       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
   </div>
-            bcoltin
+</div>
-            deffi
+<div class="contents">
-            bcoltin
+<h1>XBee Input / Output</h1>Functions for XBee input / output.
-            cmar
+<a href="#_details">More...</a>
 <p>
 <table border="0" cellpadding="0" cellspacing="0">
-            bcoltin
+<tr><td></td></tr>
 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7125fc8f3df24a2db8e074983206b054"></a><!-- doxytag: member="xbee::XBEE_BAUD" ref="g7125fc8f3df24a2db8e074983206b054" args="" -->
 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7125fc8f3df24a2db8e074983206b054">XBEE_BAUD</a>&nbsp;&nbsp;&nbsp;9600</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the XBee baud rate <br></td></tr>
 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107">xbee_init</a> (void)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the XBee.  <a href="#g964a1e8461e9c1187e5d69f521e5e107"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g70c6b231330312d4f69b9a8afb5af989">xbee_putc</a> (char c)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a character to the XBee.  <a href="#g70c6b231330312d4f69b9a8afb5af989"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g1f468ae159ba5d97bdfb3f4855d15d88">xbee_getc</a> (void)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a character from the XBee.  <a href="#g1f468ae159ba5d97bdfb3f4855d15d88"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gfb7bd5dd535e8251bfff78854c6c15f2">xbee_getc_nb</a> (char *c)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a character from the XBee without blocking.  <a href="#gfb7bd5dd535e8251bfff78854c6c15f2"></a><br></td></tr>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
 Functions for XBee input / output.
 <p>
 Low level functions for XBee input and output. <hr><h2>Function Documentation</h2>
-            bcoltin
+<a class="anchor" name="g1f468ae159ba5d97bdfb3f4855d15d88"></a><!-- doxytag: member="serial.h::xbee_getc" ref="g1f468ae159ba5d97bdfb3f4855d15d88" args="(void)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
-            bcoltin
+        <tr>
-            bcoltin
+          <td class="memname">int xbee_getc           </td>
           <td>(</td>
           <td class="paramtype">void&nbsp;</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-            cmar
+          <td></td>
-            bcoltin
+        </tr>
       </table>
-            bcoltin
+</div>
 <div class="memdoc">
             bcoltin
 <p>
 Read a character from the XBee.
 <p>
 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>
-            bcoltin
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>the first character in the xbee buffer</dd></dl>
 <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>
-            cmar
+<p>Referenced by <a class="el" href="serial_8c_source.html#l00089">xbee_init()</a>.</p>
             deffi
-            bcoltin
+</div>
 </div><p>
 <a class="anchor" name="gfb7bd5dd535e8251bfff78854c6c15f2"></a><!-- doxytag: member="serial.h::xbee_getc_nb" ref="gfb7bd5dd535e8251bfff78854c6c15f2" args="(char *c)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
-            bcoltin
+        <tr>
-            bcoltin
+          <td class="memname">int xbee_getc_nb           </td>
           <td>(</td>
           <td class="paramtype">char *&nbsp;</td>
           <td class="paramname"> <em>c</em>          </td>
           <td>&nbsp;)&nbsp;</td>
-            cmar
+          <td></td>
-            bcoltin
+        </tr>
       </table>
-            bcoltin
+</div>
 <div class="memdoc">
             bcoltin
 <p>
 Read a character from the XBee without blocking.
 <p>
 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>
 <dl compact><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>the received character. This will be set if a character has been received.</td></tr>
   </table>
 </dl>
-            bcoltin
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 if no character is available, 0 otherwise</dd></dl>
 <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>
 </div>
 </div><p>
 <a class="anchor" name="g964a1e8461e9c1187e5d69f521e5e107"></a><!-- doxytag: member="serial.h::xbee_init" ref="g964a1e8461e9c1187e5d69f521e5e107" args="(void)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
-            bcoltin
+        <tr>
-            bcoltin
+          <td class="memname">void xbee_init           </td>
           <td>(</td>
           <td class="paramtype">void&nbsp;</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-            cmar
+          <td></td>
-            bcoltin
+        </tr>
       </table>
-            bcoltin
+</div>
 <div class="memdoc">
             bcoltin
 <p>
 Initialize the XBee.
 <p>
-            bcoltin
+Initializes communication over the XBee. This must be called before any other xbee function may be used.
-            cmar
+<p>References <a class="el" href="serial_8c_source.html#l00048">xbee_fd</a>, <a class="el" href="serial_8c_source.html#l00206">xbee_getc()</a>, and <a class="el" href="serial_8c_source.html#l00139">xbee_putc()</a>.</p>
             deffi
-            cmar
+<p>Referenced by <a class="el" href="dragonfly__lib_8c_source.html#l00068">dragonfly_init()</a>.</p>
             deffi
-            bcoltin
+</div>
 </div><p>
 <a class="anchor" name="g70c6b231330312d4f69b9a8afb5af989"></a><!-- doxytag: member="serial.h::xbee_putc" ref="g70c6b231330312d4f69b9a8afb5af989" args="(char c)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
-            bcoltin
+        <tr>
-            bcoltin
+          <td class="memname">int xbee_putc           </td>
           <td>(</td>
           <td class="paramtype">char&nbsp;</td>
           <td class="paramname"> <em>c</em>          </td>
           <td>&nbsp;)&nbsp;</td>
-            cmar
+          <td></td>
-            bcoltin
+        </tr>
       </table>
-            bcoltin
+</div>
 <div class="memdoc">
             bcoltin
 <p>
 Print a character to the XBee.
 <p>
 Sends a character to the XBee.<p>
 <dl compact><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>the character to send </td></tr>
   </table>
 </dl>
-            bcoltin
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl>
-            cmar
+<p>Referenced by <a class="el" href="serial_8c_source.html#l00089">xbee_init()</a>.</p>
             deffi
-            bcoltin
+</div>
 </div><p>
-            deffi
+</div>
-            cmar
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;
-            bcoltin
+<a href="http://www.doxygen.org/index.html">
-            cmar
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
-            bcoltin
+</body>
 </html>

Project

General

Profile

Colony

root / trunk / docs / libdragonfly / group__xbee.html @ 1469