aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/analogreference.rst
blob: 9a25169d13949b41a500d6f4609210b885c9b540 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.. _arduino-analogreference:

analogReference(type)
=====================

Description
-----------

Configures the reference voltage used for analog input (i.e. the
value used as the top of the input range). The options are:




-  DEFAULT: the default analog reference of 5 volts (on 5V Arduino
   boards) or 3.3 volts (on 3.3V Arduino boards)
-  INTERNAL: an built-in reference, equal to 1.1 volts on the
   ATmega168 or ATmega328 and 2.56 volts on the ATmega8.
-  EXTERNAL: the voltage applied to the AREF pin is used as the
   reference.



Parameters
----------

type: which type of reference to use (DEFAULT, INTERNAL, or
EXTERNAL).



Returns
-------

None.



Warning
-------

**If you're using an external reference voltage (applied to the AREF pin), you must set the analog reference to EXTERNAL before calling analogRead().**
Otherwise, you will short together the active reference voltage
(internally generated) and the AREF pin, possibly damaging the
microcontroller on your Arduino board.



Alternatively, you can connect the external reference voltage to
the AREF pin through a 5K resistor, allowing you to switch between
external and internal reference voltages. Note that the resistor
will alter the voltage that gets used as the reference because
there is an internal 32K resistor on the AREF pin. The two act as a
voltage divider, so, for example, 2.5V applied through the resistor
will yield 2.5 \* 32 / (32 + 5) = ~2.2V at the AREF pin.



See also
--------


-  `Description of the analog input pins <http://arduino.cc/en/Tutorial/AnalogInputPins>`_
-  `analogRead <http://arduino.cc/en/Reference/AnalogRead>`_\ ()