Skip to content

Commit

Permalink
adc: added doc initial revision
Browse files Browse the repository at this point in the history
Signed-off-by: Adrian Suciu <[email protected]>
  • Loading branch information
adisuciu committed Sep 12, 2024
1 parent 72b2819 commit 9406537
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 1 deletion.
70 changes: 70 additions & 0 deletions docs/plugins/adc/adc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
.. _adc:

ADC plugin
================================================================================

Description:

The ADC plugin is used to interface with IIO ADCs that implement an IIO buffer mechanism. The plugin implements two instruments for data acquisition and visualization in time and frequency domain.

Compatible:

The plugin is compatible with contexts that have at least an IIO device that implements an IIO buffer interface.

Usage:

Time:

Plot
Plot Controls
- buffersize
- plot size
- rolling mode
- XMode
- sampling rate (autoread)
- autoscale
- XY
- Plot/Curve settings

Channel controls
- Y-Axis controls
- Measurements
- Scaling (autoread)
- Curve
- Attributes
- Plot


Device controls:
- Attributes

Cursors

Frequency
Plot
Plot Controls
- buffersize
- XMode
- Sampling rate
- Frequency offset
- YAxis
- Power offset
- Window
- Window correction
- Plot/Curve settings

Channel Controls
- Y-Axis
- Marker
- Marker types
- Curve
- Attributes
- Plot

Complex mode


Preferences:

Usecases:

3 changes: 2 additions & 1 deletion docs/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ What is a Scopy plugin ?

General IIO plugins

* ADC Plugin
* :ref: `ADC Plugin <adc>`

* DAC plugin

Expand Down Expand Up @@ -60,6 +60,7 @@ Contents
.. toctree::
:maxdepth: 3

adc/adc
datalogger/datalogger
registermap/registermap
m2k/index
Expand Down

0 comments on commit 9406537

Please sign in to comment.