deploy: 76a3290

Author: finger563

.nojekyll

@@ -0,0 +1,2 @@
+```{include} ../../../components/adc/example/README.md
+```

_images/complex-hfsm.png

@@ -0,0 +1,12 @@
+ADC Types
+*********
+
+Simple container for data associated with an ADC channel configuration,
+including the unit, the channel, and the attenuation desired.
+
+.. ---------------------------- API Reference ----------------------------------
+
+API Reference
+-------------
+
+.. include-build-file:: inc/adc_types.inc

_sources/adc/adc_example.md.txt

@@ -0,0 +1,18 @@
+ADS1x15 I2C ADC
+***************
+
+The `ADS1x15` provides a class for communicating with the ADS1x15 (ADS1015 and
+ADS1115) family of I2C ADC chips with configurable gain and sampling rate.
+
+.. ------------------------------- Example -------------------------------------
+
+.. toctree::
+
+   ads1x15_example
+
+.. ---------------------------- API Reference ----------------------------------
+
+API Reference
+-------------
+
+.. include-build-file:: inc/ads1x15.inc

_sources/adc/adc_types.rst.txt

@@ -0,0 +1,2 @@
+```{include} ../../../components/ads1x15/example/README.md
+```

_sources/adc/ads1x15.rst.txt

@@ -0,0 +1,23 @@
+ADS7138 I2C ADC
+***************
+
+The `Ads7138` class implements support for the Texas Instruments ADS7138 12-bit
+8-channel ADC. The ADS7138 is a 12-bit, 8-channel, low-power, successive
+approximation register (SAR) analog-to-digital converter (ADC) which can
+configure any of its 8 channels as single-ended analog inputs, digital inputs,
+or digital outputs. It has an operating mode that allows the user to configure
+the device for a single conversion, or to automatically convert on a
+continuous basis.
+
+.. ------------------------------- Example -------------------------------------
+
+.. toctree::
+
+   ads7138_example
+
+.. ---------------------------- API Reference ----------------------------------
+
+API Reference
+-------------
+
+.. include-build-file:: inc/ads7138.inc

_sources/adc/ads1x15_example.md.txt

@@ -0,0 +1,2 @@
+```{include} ../../../components/ads7138/example/README.md
+```

_sources/adc/ads7138.rst.txt

@@ -0,0 +1,23 @@
+Continuous ADC
+**************
+
+The `ContinuousAdc` provides a mechanism for high-frequency, continuous,
+deterministic sampling of analog voltages for multiple channels (potentially
+across multiple ADC units, depending on the ESP32 chip used). It does this be
+enabling the continuous ADC DMA mode and then running its own task which
+retrieves the data and filters it. When the user calls `get_mv(adc_channel_t)`,
+it simply returns the most recent filtered value for that channel, if it was
+configured.
+
+.. ------------------------------- Example -------------------------------------
+
+.. toctree::
+
+   adc_example
+
+.. ---------------------------- API Reference ----------------------------------
+
+API Reference
+-------------
+
+.. include-build-file:: inc/continuous_adc.inc

_sources/adc/ads7138_example.md.txt

@@ -0,0 +1,14 @@
+ADC APIs
+********
+
+.. toctree::
+    :maxdepth: 1
+
+    ads1x15
+    ads7138
+    oneshot_adc
+    continuous_adc
+    tla2528
+    adc_types
+
+Code examples for the ADC API are provided in the respective component folders.