aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/adc.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/adc.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'docs/source/adc.rst')
-rw-r--r--docs/source/adc.rst88
1 files changed, 0 insertions, 88 deletions
diff --git a/docs/source/adc.rst b/docs/source/adc.rst
deleted file mode 100644
index 18c54ab..0000000
--- a/docs/source/adc.rst
+++ /dev/null
@@ -1,88 +0,0 @@
-.. _adc:
-
-=====
- ADC
-=====
-
-Analog-Digital Conversion is the process of reading a physical voltage
-as a number. The Maple has a large number of pins which are capable of
-taking 12-bit ADC measurements, which means that voltages from 0 to
-3.3V are read as numbers from 0 to 4095. This corresponds to a
-theoretical sensitivity of just under 1 millivolt. In reality, a
-number of factors introduce noise and bias into this reading, and a
-number of techniques must be used to get good precision and accuracy.
-
-.. contents:: Contents
- :local:
-
-.. _adc-noise-bias:
-
-Noise and Bias
---------------
-
-.. FIXME [0.0.12, Maple Native]
-
-The biggest issues with analog to digital conversion are noise and
-bias. With the Maple line, we have tried to isolate the ADC pins and
-traces from strong noise sources, but there are always trade-offs
-between noise, additional functionality, cost, and package size.
-We've tried to enable good analog performance by isolating as many ADC
-pins as possible from digital noise on each board.
-
-More information on these isolated pins is available in each board's
-hardware documentation:
-
-* :ref:`Maple <maple-adc-bank>`
-* :ref:`Maple RET6 Edition <maple-ret6-adc-bank>`
-* :ref:`Maple Mini <maple-mini-adc-bank>`
-
-.. :ref:`Maple Native <maple-native-adc-bank>`
-
-That said, there are a number of more general things you can do to try
-to get good readings. If your input voltage changes relatively
-slowly, a number of samples can be taken in succession and averaged
-together, or the same voltage can even be sampled by multiple ADC pins
-at the same time.
-
-Another important factor when taking a voltage reading is the
-reference voltages that the sample is being compared against. For
-Maple, the high reference is |vdda| and the low reference is ground.
-This means that noise or fluctuations on either |vdda| or ground will
-affect the measurement. It also means that the voltage you are trying
-to sample must be between ground and 3.3 V.
-
-.. _adc-range:
-
-In the case of a variable reading, it is best if the voltage varies
-over the entire range of 0 through 3.3 V; otherwise, only a fraction
-of the sensitivity is being used. Some basic tools to accomplish this
-are `resistor dividers
-<http://en.wikipedia.org/wiki/Voltage_divider>`_ and `Zener diodes
-<http://en.wikipedia.org/wiki/Voltage_source#Zener_voltage_source>`_\
-. However, `operational amplifiers
-<http://en.wikipedia.org/wiki/Operational_amplifier>`_ and other
-powered components can also be used if greater precision is required.
-
-.. _adc-function-reference:
-
-Function Reference
-------------------
-
-* :ref:`lang-analogread`
-* :ref:`lang-pinmode`
-
-.. _adc-recommended-reading:
-
-Recommended Reading
--------------------
-
-* `Wikipedia: Analog-to-Digital Converter
- <http://en.wikipedia.org/wiki/Analog-to-digital_converter>`_
-* `Arduino Analog Input Tutorial
- <http://arduino.cc/en/Tutorial/AnalogInputPins>`_
-* ST documentation:
-
- * `Application Note on ADC Modes
- <http://www.st.com/stonline/products/literature/an/16840.pdf>`_ (PDF)
- * `Application Note on ADC Oversampling
- <http://www.st.com/stonline/products/literature/an/14183.pdf>`_ (PDF)