Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / serial_8c.html @ 1485

History | View | Annotate | Download (10 KB)

1 241 bcoltin 
<!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>libdragonfly: serial.c File Reference</title>
4 1398 cmar 
<link href="tabs.css" rel="stylesheet" type="text/css">
5 241 bcoltin 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 1398 cmar 
<!-- Generated by Doxygen 1.5.9 -->
8 1145 deffi 
<div class="navigation" id="top">
9 
  <div class="tabs">
10 
    <ul>
11 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13 
      <li><a href="modules.html"><span>Modules</span></a></li>
14 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
16 
    </ul>
17 
  </div>
18 1398 cmar 
  <div class="tabs">
19 
    <ul>
20 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21 
      <li><a href="globals.html"><span>Globals</span></a></li>
22 
    </ul>
23 
  </div>
24 241 bcoltin 
</div>
25 1145 deffi 
<div class="contents">
26 1398 cmar 
<h1>serial.c File Reference</h1>Serial Input and Output.
27 
<a href="#_details">More...</a>
28 241 bcoltin 
<p>
29 
<code>#include &lt;avr/io.h&gt;</code><br>
30 
<code>#include &lt;stdio.h&gt;</code><br>
31 1398 cmar 
<code>#include &quot;<a class="el" href="serial_8h_source.html">serial.h</a>&quot;</code><br>
32 241 bcoltin 
<table border="0" cellpadding="0" cellspacing="0">
33 
<tr><td></td></tr>
34 
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
35 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d">usb_init</a> ()</td></tr>
36 

      

      

        37
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the USB.  <a href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d"></a><br></td></tr>


      

      

        38
        
        
        
        
        
<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> ()</td></tr>


      

      

        39
        
        
        
        
        

      

      

        40
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the XBee.  <a href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107"></a><br></td></tr>


      

      

        41
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g3ee898cfe59d05c428c56021c2ccf946">usb_putc</a> (char c)</td></tr>


      

      

        42
        
        
        
        
        

      

      

        43
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a character to USB.  <a href="group__usb.html#g3ee898cfe59d05c428c56021c2ccf946"></a><br></td></tr>


      

      

        44
        
        
        
        
        
<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>


      

      

        45
        
        
        
        
        

      

      

        46
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a character to the XBee.  <a href="group__xbee.html#g70c6b231330312d4f69b9a8afb5af989"></a><br></td></tr>


      

      

        47
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g6e101f68856f272f67923c4fb35a99e0">usb_puts</a> (char *s)</td></tr>


      

      

        48
        
        
        
        
        

      

      

        49
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a string to USB.  <a href="group__usb.html#g6e101f68856f272f67923c4fb35a99e0"></a><br></td></tr>


      

      

        50
        
            1371
        
        
            chihsiuh
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g774d8b902cae279696c53502168ade07">usb_puts_P</a> (PGM_P s)</td></tr>


      

      

        51
        
        
        
        
        

      

      

        52
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a string from program space to USB.  <a href="group__usb.html#g774d8b902cae279696c53502168ade07"></a><br></td></tr>


      

      

        53
        
            241
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g053a5d887edfe8e8be543ec53a3f60ae">usb_getc</a> (void)</td></tr>


      

      

        54
        
        
        
        
        

      

      

        55
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a character from USB.  <a href="group__usb.html#g053a5d887edfe8e8be543ec53a3f60ae"></a><br></td></tr>


      

      

        56
        
        
        
        
        
<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>


      

      

        57
        
        
        
        
        

      

      

        58
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a character from the XBee.  <a href="group__xbee.html#g1f468ae159ba5d97bdfb3f4855d15d88"></a><br></td></tr>


      

      

        59
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g6b1209b19e7fd2bbedc7407e0218453c">usb_getc_nb</a> (char *c)</td></tr>


      

      

        60
        
        
        
        
        

      

      

        61
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a character from USB without blocking.  <a href="group__usb.html#g6b1209b19e7fd2bbedc7407e0218453c"></a><br></td></tr>


      

      

        62
        
        
        
        
        
<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>


      

      

        63
        
        
        
        
        

      

      

        64
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a character from the XBee without blocking.  <a href="group__xbee.html#gfb7bd5dd535e8251bfff78854c6c15f2"></a><br></td></tr>


      

      

        65
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#gcd371dedbff10f0c52dca4b3b7af9e3d">usb_puti</a> (int value)</td></tr>


      

      

        66
        
        
        
        
        

      

      

        67
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print an integer to USB.  <a href="group__usb.html#gcd371dedbff10f0c52dca4b3b7af9e3d"></a><br></td></tr>


      

      

        68
        
            1145
        
        
            deffi
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g94d47853c33da12c71dec155f819cfeb">hex_digit</a> (uint8_t value)</td></tr>


      

      

        69
        
        
        
        
        

      

      

        70
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine a hexadecimal digit.  <a href="group__usb.html#g94d47853c33da12c71dec155f819cfeb"></a><br></td></tr>


      

      

        71
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g8e7e31f1e45721ac032267b13d0f759b">usb_puth16</a> (uint16_t value)</td></tr>


      

      

        72
        
        
        
        
        

      

      

        73
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a fixed width hexadecimal representation to USB.  <a href="group__usb.html#g8e7e31f1e45721ac032267b13d0f759b"></a><br></td></tr>


      

      

        74
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g21462df541911e0611416e85be6ea34d">usb_puth8</a> (uint8_t value)</td></tr>


      

      

        75
        
        
        
        
        

      

      

        76
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a fixed width hexadecimal representation to USB.  <a href="group__usb.html#g21462df541911e0611416e85be6ea34d"></a><br></td></tr>


      

      

        77
        
            241
        
        
            bcoltin
        
        
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>


      

      

        78
        
            1371
        
        
            chihsiuh
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">FILE *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8c.html#35b077273a23b9b3db50d2b7917b2e2f">usb_fd</a></td></tr>


      

      

        79
        
            241
        
        
            bcoltin
        
        

      

      

        80
        
            1371
        
        
            chihsiuh
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">FILE *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8c.html#8602b10219aef4996ecffdb348b73a10">xbee_fd</a></td></tr>


      

      

        81
        
            241
        
        
            bcoltin
        
        

      

      

        82
        
        
        
        
        
</table>


      

      

        83
        
            1398
        
        
            cmar
        
        
<hr><h2>Detailed Description</h2>


      

      

        84
        
            241
        
        
            bcoltin
        
        
Serial Input and Output.


      

      

        85
        
        
        
        
        
<p>


      

      

        86
        
        
        
        
        
Copyright (c) 2007 Colony Project<p>


      

      

        87
        
        
        
        
        
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>


      

      

        88
        
        
        
        
        
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>


      

      

        89
        
        
        
        
        
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>


      

      

        90
        
        
        
        
        
Implementation of functions for serial input and output.<p>


      

      

        91
        
        
        
        
        
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>


      

      

        92
        
            1371
        
        
            chihsiuh
        
        
<hr><h2>Variable Documentation</h2>


      

      

        93
        
        
        
        
        
<a class="anchor" name="35b077273a23b9b3db50d2b7917b2e2f"></a><!-- doxytag: member="serial.c::usb_fd" ref="35b077273a23b9b3db50d2b7917b2e2f" args="" -->


      

      

        94
        
        
        
        
        
<div class="memitem">


      

      

        95
        
        
        
        
        
<div class="memproto">


      

      

        96
        
        
        
        
        
      <table class="memname">


      

      

        97
        
        
        
        
        
        <tr>


      

      

        98
        
        
        
        
        
          <td class="memname">FILE* <a class="el" href="serial_8c.html#35b077273a23b9b3db50d2b7917b2e2f">usb_fd</a>          </td>


      

      

        99
        
        
        
        
        
        </tr>


      

      

        100
        
        
        
        
        
      </table>


      

      

        101
        
            1145
        
        
            deffi
        
        
</div>


      

      

        102
        
            1371
        
        
            chihsiuh
        
        
<div class="memdoc">


      

      

        103
        
        
        
        
        

      

      

        104
        
        
        
        
        
<p>


      

      

        105
        
        
        
        
        
For use with fprintf() and related stdio functions


      

      

        106
        
            1398
        
        
            cmar
        
        
<p>Referenced by <a class="el" href="serial_8c_source.html#l00055">usb_init()</a>.</p>


      

      

        107
        
            1371
        
        
            chihsiuh
        
        

      

      

        108
        
        
        
        
        
</div>


      

      

        109
        
        
        
        
        
</div><p>


      

      

        110
        
        
        
        
        
<a class="anchor" name="8602b10219aef4996ecffdb348b73a10"></a><!-- doxytag: member="serial.c::xbee_fd" ref="8602b10219aef4996ecffdb348b73a10" args="" -->


      

      

        111
        
        
        
        
        
<div class="memitem">


      

      

        112
        
        
        
        
        
<div class="memproto">


      

      

        113
        
        
        
        
        
      <table class="memname">


      

      

        114
        
        
        
        
        
        <tr>


      

      

        115
        
        
        
        
        
          <td class="memname">FILE* <a class="el" href="serial_8c.html#8602b10219aef4996ecffdb348b73a10">xbee_fd</a>          </td>


      

      

        116
        
        
        
        
        
        </tr>


      

      

        117
        
        
        
        
        
      </table>


      

      

        118
        
        
        
        
        
</div>


      

      

        119
        
        
        
        
        
<div class="memdoc">


      

      

        120
        
        
        
        
        

      

      

        121
        
        
        
        
        
<p>


      

      

        122
        
        
        
        
        
For use with fprintf() and related stdio functions


      

      

        123
        
            1398
        
        
            cmar
        
        
<p>Referenced by <a class="el" href="serial_8c_source.html#l00089">xbee_init()</a>.</p>


      

      

        124
        
            1371
        
        
            chihsiuh
        
        

      

      

        125
        
        
        
        
        
</div>


      

      

        126
        
        
        
        
        
</div><p>


      

      

        127
        
        
        
        
        
</div>


      

      

        128
        
            1398
        
        
            cmar
        
        
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;


      

      

        129
        
            241
        
        
            bcoltin
        
        
<a href="http://www.doxygen.org/index.html">


      

      

        130
        
            1398
        
        
            cmar
        
        
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


      

      

        131
        
            241
        
        
            bcoltin
        
        
</body>


      

      

        132
        
        
        
        
        
</html>