root / trunk / docs / libdragonfly / encoders_8h.html @ 1398
History | View | Annotate | Download (10.1 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>libdragonfly: encoders.h File Reference</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.9 -->
|
| 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 class="current"><a href="files.html"><span>Files</span></a></li> |
| 16 |
</ul>
|
| 17 |
</div>
|
| 18 |
<div class="tabs"> |
| 19 |
<ul>
|
| 20 |
<li><a href="files.html"><span>File List</span></a></li> |
| 21 |
<li><a href="globals.html"><span>Globals</span></a></li> |
| 22 |
</ul>
|
| 23 |
</div>
|
| 24 |
</div>
|
| 25 |
<div class="contents"> |
| 26 |
<h1>encoders.h File Reference</h1>Contains functions for reading encoder values. |
| 27 |
<a href="#_details">More...</a> |
| 28 |
<p>
|
| 29 |
|
| 30 |
<p>
|
| 31 |
<a href="encoders_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
| 32 |
<tr><td></td></tr> |
| 33 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g437ef08681e7210d6678427030446a54"></a><!-- doxytag: member="encoders.h::LEFT" ref="g437ef08681e7210d6678427030446a54" args="" --> |
| 35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g437ef08681e7210d6678427030446a54">LEFT</a> 0</td></tr> |
| 36 |
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Left wheel. <br></td></tr> |
| 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g80fb826a684cf3f0d306b22aa100ddac"></a><!-- doxytag: member="encoders.h::RIGHT" ref="g80fb826a684cf3f0d306b22aa100ddac" args="" --> |
| 39 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g80fb826a684cf3f0d306b22aa100ddac">RIGHT</a> 1</td></tr> |
| 40 |
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Right wheel. <br></td></tr> |
| 42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7c882763d1877f0000be3e73f93d08a"></a><!-- doxytag: member="encoders.h::ENCODER_MAGNET_FAILURE" ref="ga7c882763d1877f0000be3e73f93d08a" args="" --> |
| 43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#ga7c882763d1877f0000be3e73f93d08a">ENCODER_MAGNET_FAILURE</a> 1025</td></tr> |
| 44 |
|
| 45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Magnet misaligned - likely distance from encoder problem. <br></td></tr> |
| 46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g461113043ab113b6dc7d56619a1a15f4"></a><!-- doxytag: member="encoders.h::ENCODER_MISALIGNED" ref="g461113043ab113b6dc7d56619a1a15f4" args="" --> |
| 47 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g461113043ab113b6dc7d56619a1a15f4">ENCODER_MISALIGNED</a> 1027</td></tr> |
| 48 |
|
| 49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encoder misaligned - likely on XY plane. <br></td></tr> |
| 50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0a5cb25278a57b19a46264d134033f7b"></a><!-- doxytag: member="encoders.h::ENCODER_DATA_NOT_READY" ref="g0a5cb25278a57b19a46264d134033f7b" args="" --> |
| 51 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g0a5cb25278a57b19a46264d134033f7b">ENCODER_DATA_NOT_READY</a> 1026</td></tr> |
| 52 |
|
| 53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Not enough time has passed - encoders not initialized in hardware. <br></td></tr> |
| 54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5ff35c79ce306ac5c3580b96dea4e653"></a><!-- doxytag: member="encoders.h::ENCODER_DELAY" ref="g5ff35c79ce306ac5c3580b96dea4e653" args="" --> |
| 55 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g5ff35c79ce306ac5c3580b96dea4e653">ENCODER_DELAY</a> 20</td></tr> |
| 56 |
|
| 57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">delay_ms argument after a full read is complete <br></td></tr> |
| 58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9173b4a556a38fffd9336138830ebfa0"></a><!-- doxytag: member="encoders.h::OCF" ref="g9173b4a556a38fffd9336138830ebfa0" args="" --> |
| 59 |
#define </td><td class="memItemRight" valign="bottom"><b>OCF</b> _BV(4)</td></tr> |
| 60 |
|
| 61 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdfb416b9855f4d6cc2153044a681509e"></a><!-- doxytag: member="encoders.h::COF" ref="gdfb416b9855f4d6cc2153044a681509e" args="" --> |
| 62 |
#define </td><td class="memItemRight" valign="bottom"><b>COF</b> _BV(3)</td></tr> |
| 63 |
|
| 64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfbb57dfc13455b39716c3bb5c55eaa06"></a><!-- doxytag: member="encoders.h::LIN" ref="gfbb57dfc13455b39716c3bb5c55eaa06" args="" --> |
| 65 |
#define </td><td class="memItemRight" valign="bottom"><b>LIN</b> _BV(2)</td></tr> |
| 66 |
|
| 67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdc67b4ce01de99b63b3639f03c03a05b"></a><!-- doxytag: member="encoders.h::MagINCn" ref="gdc67b4ce01de99b63b3639f03c03a05b" args="" --> |
| 68 |
#define </td><td class="memItemRight" valign="bottom"><b>MagINCn</b> _BV(1)</td></tr> |
| 69 |
|
| 70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdc7fd147cd970830e275f0ed9ebff00a"></a><!-- doxytag: member="encoders.h::MagDECn" ref="gdc7fd147cd970830e275f0ed9ebff00a" args="" --> |
| 71 |
#define </td><td class="memItemRight" valign="bottom"><b>MagDECn</b> _BV(0)</td></tr> |
| 72 |
|
| 73 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6b20d41d6252e9871430c242cb1a56e7"></a><!-- doxytag: member="encoders.h::BUFFER_SIZE" ref="g6b20d41d6252e9871430c242cb1a56e7" args="" --> |
| 74 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g6b20d41d6252e9871430c242cb1a56e7">BUFFER_SIZE</a> 23</td></tr> |
| 75 |
|
| 76 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Buffer size. <br></td></tr> |
| 77 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 78 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf02e2149caeb6116f256783348031c86"></a><!-- doxytag: member="encoders.h::encoders_init" ref="gf02e2149caeb6116f256783348031c86" args="(void)" --> |
| 79 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#gf02e2149caeb6116f256783348031c86">encoders_init</a> (void)</td></tr> |
| 80 |
|
| 81 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize encoders. <br></td></tr> |
| 82 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g9abc8e86fe64bcf4c3862ed12d913530">encoder_read</a> (char encoder)</td></tr> |
| 83 |
|
| 84 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read instantaneous encoder value. <a href="group__encoders.html#g9abc8e86fe64bcf4c3862ed12d913530"></a><br></td></tr> |
| 85 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#gd73643bd46dbc459cc0dfa8dd90b4992">encoder_get_dx</a> (char encoder)</td></tr> |
| 86 |
|
| 87 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get total distance traveled. <a href="group__encoders.html#gd73643bd46dbc459cc0dfa8dd90b4992"></a><br></td></tr> |
| 88 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g7bef9844241df2154df77d10e5bf47c4">encoder_rst_dx</a> (char encoder)</td></tr> |
| 89 |
|
| 90 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset distance counter. <a href="group__encoders.html#g7bef9844241df2154df77d10e5bf47c4"></a><br></td></tr> |
| 91 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#g8ad080c3e41790edd7e7ccbc91060fec">encoder_get_tc</a> (void)</td></tr> |
| 92 |
|
| 93 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get time count: The number of encoder reads that have occurred. <a href="group__encoders.html#g8ad080c3e41790edd7e7ccbc91060fec"></a><br></td></tr> |
| 94 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga410e62db3c6fdc317130a8d5a238655"></a><!-- doxytag: member="encoders.h::encoder_rst_tc" ref="ga410e62db3c6fdc317130a8d5a238655" args="(void)" --> |
| 95 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#ga410e62db3c6fdc317130a8d5a238655">encoder_rst_tc</a> (void)</td></tr> |
| 96 |
|
| 97 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the time count. <br></td></tr> |
| 98 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoders.html#gd89387a19e48bee58885735099eabeed">encoder_wait</a> (int nReadings)</td></tr> |
| 99 |
|
| 100 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Waits for the next n encoder reading, then returns. <a href="group__encoders.html#gd89387a19e48bee58885735099eabeed"></a><br></td></tr> |
| 101 |
</table>
|
| 102 |
<hr><h2>Detailed Description</h2> |
| 103 |
Contains functions for reading encoder values. |
| 104 |
<p>
|
| 105 |
Contains high and low level functions for reading encoders including reading out total distance covered, and eventually velocity.<p>
|
| 106 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 107 |
</div>
|
| 108 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by |
| 109 |
<a href="http://www.doxygen.org/index.html"> |
| 110 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
| 111 |
</body>
|
| 112 |
</html>
|