Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / analog_8h.html @ 241

History | View | Annotate | Download (13.4 KB)

1 41 bcoltin 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 241 bcoltin 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 41 bcoltin 
<title>libdragonfly: analog.h File Reference</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 241 bcoltin 
<!-- Generated by Doxygen 1.5.3 -->
8 41 bcoltin 
<div class="tabs">
9 
  <ul>
10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 241 bcoltin 
    <li class="current"><a href="files.html"><span>Files</span></a></li>
13 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
14 
  </ul>
15 
</div>
16 41 bcoltin 
<h1>analog.h File Reference</h1>Contains functions and definitions for using the ADC. <a href="#_details">More...</a>
17 
<p>
18 

      

      

        19
        
        
        
        
        
<p>


      

      

        20
        
        
        
        
        
<a href="analog_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">


      

      

        21
        
        
        
        
        
<tr><td></td></tr>


      

      

        22
        
        
        
        
        
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>


      

      

        23
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g099995994c74b5fff8f7de4ff3eac550"></a><!-- doxytag: member="analog.h::AN0" ref="g099995994c74b5fff8f7de4ff3eac550" args="" -->


      

      

        24
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g099995994c74b5fff8f7de4ff3eac550">AN0</a>&nbsp;&nbsp;&nbsp;0x00</td></tr>


      

      

        25
        
        
        
        
        

      

      

        26
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 0. <br></td></tr>


      

      

        27
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4903de2a52966c8dc2c20faf565d451d"></a><!-- doxytag: member="analog.h::AN1" ref="g4903de2a52966c8dc2c20faf565d451d" args="" -->


      

      

        28
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g4903de2a52966c8dc2c20faf565d451d">AN1</a>&nbsp;&nbsp;&nbsp;0x01</td></tr>


      

      

        29
        
        
        
        
        

      

      

        30
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 1. <br></td></tr>


      

      

        31
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9b0754e893d69a1e69e856853f70da1f"></a><!-- doxytag: member="analog.h::AN2" ref="g9b0754e893d69a1e69e856853f70da1f" args="" -->


      

      

        32
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g9b0754e893d69a1e69e856853f70da1f">AN2</a>&nbsp;&nbsp;&nbsp;0x02</td></tr>


      

      

        33
        
        
        
        
        

      

      

        34
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 2. <br></td></tr>


      

      

        35
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9f593faa38f1023698d74f03a457abe3"></a><!-- doxytag: member="analog.h::AN3" ref="g9f593faa38f1023698d74f03a457abe3" args="" -->


      

      

        36
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g9f593faa38f1023698d74f03a457abe3">AN3</a>&nbsp;&nbsp;&nbsp;0x03</td></tr>


      

      

        37
        
        
        
        
        

      

      

        38
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 3. <br></td></tr>


      

      

        39
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdc95f1e9cdc00268d7bca5885052171f"></a><!-- doxytag: member="analog.h::AN4" ref="gdc95f1e9cdc00268d7bca5885052171f" args="" -->


      

      

        40
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gdc95f1e9cdc00268d7bca5885052171f">AN4</a>&nbsp;&nbsp;&nbsp;0x04</td></tr>


      

      

        41
        
        
        
        
        

      

      

        42
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 4. <br></td></tr>


      

      

        43
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g99ed455a0d536be03f12eba18ccff71b"></a><!-- doxytag: member="analog.h::AN5" ref="g99ed455a0d536be03f12eba18ccff71b" args="" -->


      

      

        44
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g99ed455a0d536be03f12eba18ccff71b">AN5</a>&nbsp;&nbsp;&nbsp;0x05</td></tr>


      

      

        45
        
        
        
        
        

      

      

        46
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 5. <br></td></tr>


      

      

        47
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd63d6861c3fa5e606de5c18ada3b4d10"></a><!-- doxytag: member="analog.h::AN6" ref="gd63d6861c3fa5e606de5c18ada3b4d10" args="" -->


      

      

        48
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gd63d6861c3fa5e606de5c18ada3b4d10">AN6</a>&nbsp;&nbsp;&nbsp;0x06</td></tr>


      

      

        49
        
        
        
        
        

      

      

        50
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 6. <br></td></tr>


      

      

        51
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g277d706ee82bd70459b63e85489c7074"></a><!-- doxytag: member="analog.h::AN7" ref="g277d706ee82bd70459b63e85489c7074" args="" -->


      

      

        52
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g277d706ee82bd70459b63e85489c7074">AN7</a>&nbsp;&nbsp;&nbsp;0x07</td></tr>


      

      

        53
        
        
        
        
        

      

      

        54
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 7. <br></td></tr>


      

      

        55
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g28b64348820dbb25c903d24f2e38a8a7"></a><!-- doxytag: member="analog.h::AN8" ref="g28b64348820dbb25c903d24f2e38a8a7" args="" -->


      

      

        56
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g28b64348820dbb25c903d24f2e38a8a7">AN8</a>&nbsp;&nbsp;&nbsp;0x08</td></tr>


      

      

        57
        
        
        
        
        

      

      

        58
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 8. <br></td></tr>


      

      

        59
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2fb7e4f4e0ea1f172eef79ed1f92e15f"></a><!-- doxytag: member="analog.h::AN9" ref="g2fb7e4f4e0ea1f172eef79ed1f92e15f" args="" -->


      

      

        60
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g2fb7e4f4e0ea1f172eef79ed1f92e15f">AN9</a>&nbsp;&nbsp;&nbsp;0x09</td></tr>


      

      

        61
        
        
        
        
        

      

      

        62
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 9. <br></td></tr>


      

      

        63
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc63caaf5f7a06a02522cb7f90d6c1959"></a><!-- doxytag: member="analog.h::AN10" ref="gc63caaf5f7a06a02522cb7f90d6c1959" args="" -->


      

      

        64
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gc63caaf5f7a06a02522cb7f90d6c1959">AN10</a>&nbsp;&nbsp;&nbsp;0x0a</td></tr>


      

      

        65
        
        
        
        
        

      

      

        66
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 10. <br></td></tr>


      

      

        67
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdfeb79b00aaef4734408a910838f7872"></a><!-- doxytag: member="analog.h::AN11" ref="gdfeb79b00aaef4734408a910838f7872" args="" -->


      

      

        68
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gdfeb79b00aaef4734408a910838f7872">AN11</a>&nbsp;&nbsp;&nbsp;0x0b</td></tr>


      

      

        69
        
        
        
        
        

      

      

        70
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 11. <br></td></tr>


      

      

        71
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7a50a07e69f38b6674b0494dfbc653f9"></a><!-- doxytag: member="analog.h::AN12" ref="g7a50a07e69f38b6674b0494dfbc653f9" args="" -->


      

      

        72
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g7a50a07e69f38b6674b0494dfbc653f9">AN12</a>&nbsp;&nbsp;&nbsp;0x0c</td></tr>


      

      

        73
        
        
        
        
        

      

      

        74
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 12. <br></td></tr>


      

      

        75
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf80851ae45ddfe4bfdfc10541c255ad"></a><!-- doxytag: member="analog.h::AN13" ref="gbf80851ae45ddfe4bfdfc10541c255ad" args="" -->


      

      

        76
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gbf80851ae45ddfe4bfdfc10541c255ad">AN13</a>&nbsp;&nbsp;&nbsp;0x0d</td></tr>


      

      

        77
        
        
        
        
        

      

      

        78
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 13. <br></td></tr>


      

      

        79
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g817772a1db513b734dfe4475c3616061"></a><!-- doxytag: member="analog.h::AN14" ref="g817772a1db513b734dfe4475c3616061" args="" -->


      

      

        80
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g817772a1db513b734dfe4475c3616061">AN14</a>&nbsp;&nbsp;&nbsp;0x0e</td></tr>


      

      

        81
        
        
        
        
        

      

      

        82
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 14. <br></td></tr>


      

      

        83
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g797adbadae057ff7aa766d84b4f180f9"></a><!-- doxytag: member="analog.h::AN15" ref="g797adbadae057ff7aa766d84b4f180f9" args="" -->


      

      

        84
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g797adbadae057ff7aa766d84b4f180f9">AN15</a>&nbsp;&nbsp;&nbsp;0x0f</td></tr>


      

      

        85
        
        
        
        
        

      

      

        86
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port 15. <br></td></tr>


      

      

        87
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3434ce39eaea22b46a0100b7fd3a6f47"></a><!-- doxytag: member="analog.h::EXT_MUX" ref="g3434ce39eaea22b46a0100b7fd3a6f47" args="" -->


      

      

        88
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g3434ce39eaea22b46a0100b7fd3a6f47">EXT_MUX</a>&nbsp;&nbsp;&nbsp;AN7</td></tr>


      

      

        89
        
        
        
        
        

      

      

        90
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">EXT_MUX analog port. <br></td></tr>


      

      

        91
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6538d2deb002b8441891dc4e15cd104"></a><!-- doxytag: member="analog.h::WHEEL_PORT" ref="ga6538d2deb002b8441891dc4e15cd104" args="" -->


      

      

        92
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#ga6538d2deb002b8441891dc4e15cd104">WHEEL_PORT</a>&nbsp;&nbsp;&nbsp;AN10</td></tr>


      

      

        93
        
        
        
        
        

      

      

        94
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port for the wheel. <br></td></tr>


      

      

        95
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gadcd026a2c91fe96c8134619c87bb72a"></a><!-- doxytag: member="analog.h::BATT_PORT" ref="gadcd026a2c91fe96c8134619c87bb72a" args="" -->


      

      

        96
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gadcd026a2c91fe96c8134619c87bb72a">BATT_PORT</a>&nbsp;&nbsp;&nbsp;AN11</td></tr>


      

      

        97
        
        
        
        
        

      

      

        98
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analog port for the battery voltage detector. <br></td></tr>


      

      

        99
        
        
        
        
        
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


      

      

        100
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a> (void)</td></tr>


      

      

        101
        
        
        
        
        

      

      

        102
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize analog ports.  <a href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918"></a><br></td></tr>


      

      

        103
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27">analog8</a> (int which)</td></tr>


      

      

        104
        
        
        
        
        

      

      

        105
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read an 8-bit number from an analog port.  <a href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27"></a><br></td></tr>


      

      

        106
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3">analog10</a> (int which)</td></tr>


      

      

        107
        
        
        
        
        

      

      

        108
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a 10-bit number from an analog port.  <a href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3"></a><br></td></tr>


      

      

        109
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g973e63eb508819a37efe3231b6a39550">wheel</a> (void)</td></tr>


      

      

        110
        
        
        
        
        

      

      

        111
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the position of the wheel.  <a href="group__analog.html#g973e63eb508819a37efe3231b6a39550"></a><br></td></tr>


      

      

        112
        
        
        
        
        
</table>


      

      

        113
        
        
        
        
        
<hr><a name="_details"></a><h2>Detailed Description</h2>


      

      

        114
        
        
        
        
        
Contains functions and definitions for using the ADC.


      

      

        115
        
        
        
        
        
<p>


      

      

        116
        
            241
        
        
            bcoltin
        
        
Copyright (c) 2007 Colony Project<p>


      

      

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


      

      

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


      

      

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


      

      

        120
        
            41
        
        
            bcoltin
        
        
Contains definitions and function prototypes for using the ADC to detect analog signals on pins AN0 - AN7. AN6 and AN7 are used for the wheel and battery.<p>


      

      

        121
        
        
        
        
        
The pins labeled E6 and E7 are external interrupt pins and are not related to analog.<p>


      

      

        122
        
            241
        
        
            bcoltin
        
        
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club, based on firefly code by Tom Lauwers </dd></dl>


      

      

        123
        
        
        
        
        
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by&nbsp;


      

      

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


      

      

        125
        
            241
        
        
            bcoltin
        
        
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>


      

      

        126
        
            41
        
        
            bcoltin
        
        
</body>


      

      

        127
        
        
        
        
        
</html>