From 940653714257395373c9cc6ed6b705e322647b71 Mon Sep 17 00:00:00 2001 From: Adrian Suciu Date: Thu, 12 Sep 2024 12:35:54 +0300 Subject: [PATCH] adc: added doc initial revision Signed-off-by: Adrian Suciu --- docs/plugins/adc/adc.rst | 70 ++++++++++++++++++++++++++++++++++++++++ docs/plugins/index.rst | 3 +- 2 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 docs/plugins/adc/adc.rst diff --git a/docs/plugins/adc/adc.rst b/docs/plugins/adc/adc.rst new file mode 100644 index 000000000..bbf60a1d3 --- /dev/null +++ b/docs/plugins/adc/adc.rst @@ -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: + diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 255c827ef..9ffa27b9b 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -7,7 +7,7 @@ What is a Scopy plugin ? General IIO plugins -* ADC Plugin +* :ref: `ADC Plugin ` * DAC plugin @@ -60,6 +60,7 @@ Contents .. toctree:: :maxdepth: 3 + adc/adc datalogger/datalogger registermap/registermap m2k/index