summaryrefslogtreecommitdiff
path: root/docs/library/machine.ADC.rst
blob: 1404b454ae7f51e7a4d93dac2917c2b98f2b25b3 (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
.. currentmodule:: machine
.. _machine.ADC:

class ADC -- analog to digital conversion
=========================================

The ADC class provides an interface to analog-to-digital convertors, and
represents a single endpoint that can sample a continuous voltage and
convert it to a discretised value.

Example usage::

   import machine

   adc = machine.ADC(pin)   # create an ADC object acting on a pin
   val = adc.read_u16()     # read a raw analog value in the range 0-65535

Constructors
------------

.. class:: ADC(id)

   Access the ADC associated with a source identified by *id*.  This
   *id* may be an integer (usually specifying a channel number), a
   :ref:`Pin <machine.Pin>` object, or other value supported by the
   underlying machine.

Methods
-------

.. method:: ADC.read_u16()

   Take an analog reading and return an integer in the range 0-65535.
   The return value represents the raw reading taken by the ADC, scaled
   such that the minimum value is 0 and the maximum value is 65535.