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: ads7828.h Source File</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>ads7828.h</h1><a href="ads7828_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file ads7828.h \brief TI ADS7828 12-bit 8ch A/D Converter Driver Library. */</span> |
||
9 | 00002 <span class="comment">//*****************************************************************************</span> |
||
10 | 00003 <span class="comment">//</span> |
||
11 | 00004 <span class="comment">// File Name : 'ads7828.h'</span> |
||
12 | 00005 <span class="comment">// Title : TI ADS7828 12-bit 8ch A/D Converter Driver Library</span> |
||
13 | 00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2004</span> |
||
14 | 00007 <span class="comment">// Created : 2004.02.10</span> |
||
15 | 00008 <span class="comment">// Revised : 2004.02.19</span> |
||
16 | 00009 <span class="comment">// Version : 0.1</span> |
||
17 | 00010 <span class="comment">// Target MCU : Atmel AVR Series</span> |
||
18 | 00011 <span class="comment">// Editor Tabs : 4</span> |
||
19 | 00012 <span class="comment">//</span> |
||
20 | 00013 <span class="comment">// NOTE: This code is currently below version 1.0, and therefore is considered</span> |
||
21 | 00014 <span class="comment">// to be lacking in some functionality or documentation, or may not be fully</span> |
||
22 | 00015 <span class="comment">// tested. Nonetheless, you can expect most functions to work.</span> |
||
23 | 00016 <span class="comment">//</span> |
||
24 | 00017 <span class="comment">// This code is distributed under the GNU Public License</span> |
||
25 | 00018 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span> |
||
26 | 00019 <span class="comment">//</span><span class="comment"></span> |
||
27 | 00020 <span class="comment">/// \ingroup driver_hw</span> |
||
28 | 00021 <span class="comment">/// \defgroup ads7828 TI ADS7828 I2C A/D Converter Driver (ads7828.c)</span> |
||
29 | 00022 <span class="comment">/// \code #include "ads7828.h" \endcode</span> |
||
30 | 00023 <span class="comment">/// \par Overview</span> |
||
31 | 00024 <span class="comment">/// This library provides high-level functions for accessing the Texas</span> |
||
32 | 00025 <span class="comment">/// Instruments ADS7828 I2C A/D Converter.</span> |
||
33 | 00026 <span class="comment">///</span> |
||
34 | 00027 <span class="comment">/// The basic specs of the ADS7828 are:</span> |
||
35 | 00028 <span class="comment">/// - 12-bit results</span> |
||
36 | 00029 <span class="comment">/// - 8 input channels</span> |
||
37 | 00030 <span class="comment">/// - up to 50KHz conversion rate</span> |
||
38 | 00031 <span class="comment">/// - External reference or internal 2.5V reference</span> |
||
39 | 00032 <span class="comment"></span><span class="comment">//</span> |
||
40 | 00033 <span class="comment">//*****************************************************************************</span><span class="comment"></span> |
||
41 | 00034 <span class="comment">//@{</span> |
||
42 | 00035 <span class="comment"></span> |
||
43 | 00036 <span class="preprocessor">#ifndef ADS7828_H</span> |
||
44 | 00037 <span class="preprocessor"></span><span class="preprocessor">#define ADS7828_H</span> |
||
45 | 00038 <span class="preprocessor"></span> |
||
46 | 00039 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span> |
||
47 | 00040 |
||
48 | 00041 <span class="comment">// constants/macros/typdefs</span> |
||
49 | <a name="l00042"></a><a class="code" href="group__ads7828.html#ga5">00042</a> <span class="preprocessor">#define ADS7828_I2C_ADDR 0x90 </span><span class="comment">///< Base I2C address of ADS7828 devices</span> |
||
50 | 00043 <span class="comment"></span> |
||
51 | 00044 <span class="comment">// command register bit defines</span> |
||
52 | <a name="l00045"></a><a class="code" href="group__ads7828.html#ga6">00045</a> <span class="preprocessor">#define ADS7828_CMD_PD0 0x04 </span><span class="comment">///< ADS7828 Power-down bit 0</span> |
||
53 | <a name="l00046"></a><a class="code" href="group__ads7828.html#ga7">00046</a> <span class="comment"></span>#define ADS7828_CMD_PD1 0x08 <span class="comment">///< ADS7828 Power-down bit 1</span> |
||
54 | <a name="l00047"></a><a class="code" href="group__ads7828.html#ga8">00047</a> <span class="comment"></span>#define ADS7828_CMD_C0 0x10 <span class="comment">///< ADS7828 Channel Select bit 0</span> |
||
55 | <a name="l00048"></a><a class="code" href="group__ads7828.html#ga9">00048</a> <span class="comment"></span>#define ADS7828_CMD_C1 0x20 <span class="comment">///< ADS7828 Channel Select bit 1</span> |
||
56 | <a name="l00049"></a><a class="code" href="group__ads7828.html#ga10">00049</a> <span class="comment"></span>#define ADS7828_CMD_C2 0x40 <span class="comment">///< ADS7828 Channel Select bit 2</span> |
||
57 | <a name="l00050"></a><a class="code" href="group__ads7828.html#ga11">00050</a> <span class="comment"></span>#define ADS7828_CMD_SD 0x80 <span class="comment">///< ADS7828 Single-ended/Differential Select bit</span> |
||
58 | 00051 <span class="comment"></span> |
||
59 | 00052 <span class="comment">// single-ended channel order defines</span> |
||
60 | <a name="l00053"></a><a class="code" href="group__ads7828.html#ga12">00053</a> <span class="preprocessor">#define ADS7828_CMD_CH0 0x00 </span><span class="comment">///< ADS7828 Convert Channel 0</span> |
||
61 | <a name="l00054"></a><a class="code" href="group__ads7828.html#ga13">00054</a> <span class="comment"></span>#define ADS7828_CMD_CH1 0x04 <span class="comment">///< ADS7828 Convert Channel 1</span> |
||
62 | <a name="l00055"></a><a class="code" href="group__ads7828.html#ga14">00055</a> <span class="comment"></span>#define ADS7828_CMD_CH2 0x01 <span class="comment">///< ADS7828 Convert Channel 2</span> |
||
63 | <a name="l00056"></a><a class="code" href="group__ads7828.html#ga15">00056</a> <span class="comment"></span>#define ADS7828_CMD_CH3 0x05 <span class="comment">///< ADS7828 Convert Channel 3</span> |
||
64 | <a name="l00057"></a><a class="code" href="group__ads7828.html#ga16">00057</a> <span class="comment"></span>#define ADS7828_CMD_CH4 0x02 <span class="comment">///< ADS7828 Convert Channel 4</span> |
||
65 | <a name="l00058"></a><a class="code" href="group__ads7828.html#ga17">00058</a> <span class="comment"></span>#define ADS7828_CMD_CH5 0x06 <span class="comment">///< ADS7828 Convert Channel 5</span> |
||
66 | <a name="l00059"></a><a class="code" href="group__ads7828.html#ga18">00059</a> <span class="comment"></span>#define ADS7828_CMD_CH6 0x03 <span class="comment">///< ADS7828 Convert Channel 6</span> |
||
67 | <a name="l00060"></a><a class="code" href="group__ads7828.html#ga19">00060</a> <span class="comment"></span>#define ADS7828_CMD_CH7 0x07 <span class="comment">///< ADS7828 Convert Channel 7</span> |
||
68 | 00061 <span class="comment"></span> |
||
69 | 00062 <span class="comment">// power-down mode defines</span> |
||
70 | <a name="l00063"></a><a class="code" href="group__ads7828.html#ga20">00063</a> <span class="preprocessor">#define ADS7828_CMD_PDMODE0 0x00 </span><span class="comment">///< ADS7828 Power-down Mode 0</span> |
||
71 | <a name="l00064"></a><a class="code" href="group__ads7828.html#ga21">00064</a> <span class="comment"></span>#define ADS7828_CMD_PDMODE1 0x04 <span class="comment">///< ADS7828 Power-down Mode 1</span> |
||
72 | <a name="l00065"></a><a class="code" href="group__ads7828.html#ga22">00065</a> <span class="comment"></span>#define ADS7828_CMD_PDMODE2 0x08 <span class="comment">///< ADS7828 Power-down Mode 2</span> |
||
73 | <a name="l00066"></a><a class="code" href="group__ads7828.html#ga23">00066</a> <span class="comment"></span>#define ADS7828_CMD_PDMODE3 0x0C <span class="comment">///< ADS7828 Power-down Mode 3</span> |
||
74 | 00067 <span class="comment"></span> |
||
75 | 00068 <span class="comment">// functions</span> |
||
76 | 00069 <span class="comment"></span> |
||
77 | 00070 <span class="comment">//! Initialize the ADS7828 chip.</span> |
||
78 | 00071 <span class="comment">/// Returns:</span> |
||
79 | 00072 <span class="comment">/// TRUE if successful, </span> |
||
80 | 00073 <span class="comment">/// FALSE if unsuccessful (chip not present).</span> |
||
81 | 00074 <span class="comment"></span>u08 <a class="code" href="group__ads7828.html#ga0">ads7828Init</a>(u08 i2cAddr); |
||
82 | 00075 <span class="comment"></span> |
||
83 | 00076 <span class="comment">//! Set the voltage reference to use for A/D conversion.</span> |
||
84 | 00077 <span class="comment">/// - ref = 0 => External reference voltage on Ref pin.</span> |
||
85 | 00078 <span class="comment">/// - ref = 1 => Internal 2.5V reference voltage (Ref pin left open).</span> |
||
86 | 00079 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group__ads7828.html#ga1">ads7828SetReference</a>(u08 ref); |
||
87 | 00080 <span class="comment"></span> |
||
88 | 00081 <span class="comment">//! Begin single-ended conversion on given logical channel#, and return result.</span> |
||
89 | 00082 <span class="comment"></span>u16 <a class="code" href="group__ads7828.html#ga2">ads7828Convert</a>(u08 i2cAddr, u08 channel); |
||
90 | 00083 <span class="comment"></span> |
||
91 | 00084 <span class="comment">//! Begin differential conversion on given channel pair, and return result.</span> |
||
92 | 00085 <span class="comment"></span>u16 <a class="code" href="group__ads7828.html#ga3">ads7828ConvertDiff</a>(u08 i2cAddr, u08 channel); |
||
93 | 00086 <span class="comment"></span> |
||
94 | 00087 <span class="comment">//! Begin conversion on given raw channel#, and return result.</span> |
||
95 | 00088 <span class="comment"></span>u16 <a class="code" href="group__ads7828.html#ga4">ads7828ConvertRaw</a>(u08 i2cAddr, u08 channel); |
||
96 | 00089 |
||
97 | 00090 <span class="preprocessor">#endif</span> |
||
98 | 00091 <span class="preprocessor"></span><span class="comment">//@}</span> |
||
99 | </span></pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:06 2006 for Procyon AVRlib by |
||
100 | <a href="http://www.doxygen.org/index.html"> |
||
101 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
102 | </body> |
||
103 | </html> |
Powered by WebSVN v2.8.3