Line No. | Rev | Author | Line |
---|---|---|---|
1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
3 | <title>Procyon AVRlib: TI ADS7828 I2C A/D Converter Driver (ads7828.c)</title> |
||
4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
5 | </head><body> |
||
6 | <!-- Generated by Doxygen 1.4.2 --> |
||
7 | <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
8 | <h1>TI ADS7828 I2C A/D Converter Driver (ads7828.c)<br> |
||
9 | <small> |
||
10 | [<a class="el" href="group__driver__hw.html">Drivers (for external hardware)</a>]</small> |
||
11 | </h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
||
12 | <div class="fragment"><pre class="fragment"><span class="preprocessor"> #include "<a class="code" href="ads7828_8h.html">ads7828.h</a>"</span> |
||
13 | </pre></div> <dl compact><dt><b>Overview</b></dt><dd>This library provides high-level functions for accessing the Texas Instruments ADS7828 I2C A/D Converter.</dd></dl> |
||
14 | The basic specs of the ADS7828 are:<ul> |
||
15 | <li>12-bit results</li><li>8 input channels</li><li>up to 50KHz conversion rate</li><li>External reference or internal 2.5V reference </li></ul> |
||
16 | |||
17 | <p> |
||
18 | <table border="0" cellpadding="0" cellspacing="0"> |
||
19 | <tr><td></td></tr> |
||
20 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
21 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="ads7828::ADS7828_I2C_ADDR"></a> |
||
22 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga5">ADS7828_I2C_ADDR</a> 0x90</td></tr> |
||
23 | |||
24 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Base I2C address of ADS7828 devices. <br></td></tr> |
||
25 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="ads7828::ADS7828_CMD_PD0"></a> |
||
26 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga6">ADS7828_CMD_PD0</a> 0x04</td></tr> |
||
27 | |||
28 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Power-down bit 0. <br></td></tr> |
||
29 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7" doxytag="ads7828::ADS7828_CMD_PD1"></a> |
||
30 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga7">ADS7828_CMD_PD1</a> 0x08</td></tr> |
||
31 | |||
32 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Power-down bit 1. <br></td></tr> |
||
33 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga8" doxytag="ads7828::ADS7828_CMD_C0"></a> |
||
34 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga8">ADS7828_CMD_C0</a> 0x10</td></tr> |
||
35 | |||
36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Channel Select bit 0. <br></td></tr> |
||
37 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga9" doxytag="ads7828::ADS7828_CMD_C1"></a> |
||
38 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga9">ADS7828_CMD_C1</a> 0x20</td></tr> |
||
39 | |||
40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Channel Select bit 1. <br></td></tr> |
||
41 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga10" doxytag="ads7828::ADS7828_CMD_C2"></a> |
||
42 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga10">ADS7828_CMD_C2</a> 0x40</td></tr> |
||
43 | |||
44 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Channel Select bit 2. <br></td></tr> |
||
45 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga11" doxytag="ads7828::ADS7828_CMD_SD"></a> |
||
46 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga11">ADS7828_CMD_SD</a> 0x80</td></tr> |
||
47 | |||
48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Single-ended/Differential Select bit. <br></td></tr> |
||
49 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga12" doxytag="ads7828::ADS7828_CMD_CH0"></a> |
||
50 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga12">ADS7828_CMD_CH0</a> 0x00</td></tr> |
||
51 | |||
52 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Convert Channel 0. <br></td></tr> |
||
53 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga13" doxytag="ads7828::ADS7828_CMD_CH1"></a> |
||
54 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga13">ADS7828_CMD_CH1</a> 0x04</td></tr> |
||
55 | |||
56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Convert Channel 1. <br></td></tr> |
||
57 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga14" doxytag="ads7828::ADS7828_CMD_CH2"></a> |
||
58 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga14">ADS7828_CMD_CH2</a> 0x01</td></tr> |
||
59 | |||
60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Convert Channel 2. <br></td></tr> |
||
61 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga15" doxytag="ads7828::ADS7828_CMD_CH3"></a> |
||
62 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga15">ADS7828_CMD_CH3</a> 0x05</td></tr> |
||
63 | |||
64 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Convert Channel 3. <br></td></tr> |
||
65 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga16" doxytag="ads7828::ADS7828_CMD_CH4"></a> |
||
66 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga16">ADS7828_CMD_CH4</a> 0x02</td></tr> |
||
67 | |||
68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Convert Channel 4. <br></td></tr> |
||
69 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga17" doxytag="ads7828::ADS7828_CMD_CH5"></a> |
||
70 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga17">ADS7828_CMD_CH5</a> 0x06</td></tr> |
||
71 | |||
72 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Convert Channel 5. <br></td></tr> |
||
73 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga18" doxytag="ads7828::ADS7828_CMD_CH6"></a> |
||
74 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga18">ADS7828_CMD_CH6</a> 0x03</td></tr> |
||
75 | |||
76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Convert Channel 6. <br></td></tr> |
||
77 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga19" doxytag="ads7828::ADS7828_CMD_CH7"></a> |
||
78 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga19">ADS7828_CMD_CH7</a> 0x07</td></tr> |
||
79 | |||
80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Convert Channel 7. <br></td></tr> |
||
81 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga20" doxytag="ads7828::ADS7828_CMD_PDMODE0"></a> |
||
82 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga20">ADS7828_CMD_PDMODE0</a> 0x00</td></tr> |
||
83 | |||
84 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Power-down Mode 0. <br></td></tr> |
||
85 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga21" doxytag="ads7828::ADS7828_CMD_PDMODE1"></a> |
||
86 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga21">ADS7828_CMD_PDMODE1</a> 0x04</td></tr> |
||
87 | |||
88 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Power-down Mode 1. <br></td></tr> |
||
89 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga22" doxytag="ads7828::ADS7828_CMD_PDMODE2"></a> |
||
90 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga22">ADS7828_CMD_PDMODE2</a> 0x08</td></tr> |
||
91 | |||
92 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Power-down Mode 2. <br></td></tr> |
||
93 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga23" doxytag="ads7828::ADS7828_CMD_PDMODE3"></a> |
||
94 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga23">ADS7828_CMD_PDMODE3</a> 0x0C</td></tr> |
||
95 | |||
96 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ADS7828 Power-down Mode 3. <br></td></tr> |
||
97 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
98 | <tr><td class="memItemLeft" nowrap align="right" valign="top">u08 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga0">ads7828Init</a> (u08 i2cAddr)</td></tr> |
||
99 | |||
100 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga1">ads7828SetReference</a> (u08 ref)</td></tr> |
||
101 | |||
102 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="ads7828::ads7828Convert"></a> |
||
103 | u16 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga2">ads7828Convert</a> (u08 i2cAddr, u08 channel)</td></tr> |
||
104 | |||
105 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Begin single-ended conversion on given logical channel#, and return result. <br></td></tr> |
||
106 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="ads7828::ads7828ConvertDiff"></a> |
||
107 | u16 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga3">ads7828ConvertDiff</a> (u08 i2cAddr, u08 channel)</td></tr> |
||
108 | |||
109 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Begin differential conversion on given channel pair, and return result. <br></td></tr> |
||
110 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga4" doxytag="ads7828::ads7828ConvertRaw"></a> |
||
111 | u16 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ads7828.html#ga4">ads7828ConvertRaw</a> (u08 i2cAddr, u08 channel)</td></tr> |
||
112 | |||
113 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Begin conversion on given raw channel#, and return result. <br></td></tr> |
||
114 | </table> |
||
115 | <hr><h2>Function Documentation</h2> |
||
116 | <a class="anchor" name="ga0" doxytag="ads7828.h::ads7828Init"></a><p> |
||
117 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
118 | <tr> |
||
119 | <td class="mdRow"> |
||
120 | <table cellpadding="0" cellspacing="0" border="0"> |
||
121 | <tr> |
||
122 | <td class="md" nowrap valign="top">u08 ads7828Init </td> |
||
123 | <td class="md" valign="top">( </td> |
||
124 | <td class="md" nowrap valign="top">u08 </td> |
||
125 | <td class="mdname1" valign="top" nowrap> <em>i2cAddr</em> </td> |
||
126 | <td class="md" valign="top"> ) </td> |
||
127 | <td class="md" nowrap></td> |
||
128 | </tr> |
||
129 | </table> |
||
130 | </td> |
||
131 | </tr> |
||
132 | </table> |
||
133 | <table cellspacing="5" cellpadding="0" border="0"> |
||
134 | <tr> |
||
135 | <td> |
||
136 | |
||
137 | </td> |
||
138 | <td> |
||
139 | |||
140 | <p> |
||
141 | Initialize the ADS7828 chip. Returns: TRUE if successful, FALSE if unsuccessful (chip not present). |
||
142 | <p> |
||
143 | Definition at line <a class="el" href="ads7828_8c-source.html#l00033">33</a> of file <a class="el" href="ads7828_8c-source.html">ads7828.c</a>. </td> |
||
144 | </tr> |
||
145 | </table> |
||
146 | <a class="anchor" name="ga1" doxytag="ads7828.h::ads7828SetReference"></a><p> |
||
147 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
148 | <tr> |
||
149 | <td class="mdRow"> |
||
150 | <table cellpadding="0" cellspacing="0" border="0"> |
||
151 | <tr> |
||
152 | <td class="md" nowrap valign="top">void ads7828SetReference </td> |
||
153 | <td class="md" valign="top">( </td> |
||
154 | <td class="md" nowrap valign="top">u08 </td> |
||
155 | <td class="mdname1" valign="top" nowrap> <em>ref</em> </td> |
||
156 | <td class="md" valign="top"> ) </td> |
||
157 | <td class="md" nowrap></td> |
||
158 | </tr> |
||
159 | </table> |
||
160 | </td> |
||
161 | </tr> |
||
162 | </table> |
||
163 | <table cellspacing="5" cellpadding="0" border="0"> |
||
164 | <tr> |
||
165 | <td> |
||
166 | |
||
167 | </td> |
||
168 | <td> |
||
169 | |||
170 | <p> |
||
171 | Set the voltage reference to use for A/D conversion.<ul> |
||
172 | <li>ref = 0 => External reference voltage on Ref pin.</li><li>ref = 1 => Internal 2.5V reference voltage (Ref pin left open). </li></ul> |
||
173 | |||
174 | <p> |
||
175 | Definition at line <a class="el" href="ads7828_8c-source.html#l00080">80</a> of file <a class="el" href="ads7828_8c-source.html">ads7828.c</a>. </td> |
||
176 | </tr> |
||
177 | </table> |
||
178 | <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:09 2006 for Procyon AVRlib by |
||
179 | <a href="http://www.doxygen.org/index.html"> |
||
180 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
181 | </body> |
||
182 | </html> |
Powered by WebSVN v2.8.3