doc: add AD-SWIOT1L-SL plugin documentation on github docs.

Signed-off-by: AlexandraTrifan <[email protected]>

doc/plugins/index.rst

@@ -32,7 +32,13 @@ Application Specific plugins
     * :ref:`Power Supply <power_supply>`
 
 
-* SWIOT1L
+* AD-SWIOT1L-SL
+
+    * :ref:`Config <swiot_config>`
+    * :ref:`AD74413R <ad74413r>`
+    * :ref:`MAX14906 <max14906>`
+    * :ref:`Faults <faults>`
+
 * PQM
     * :ref:`RMS <rms>`
     * :ref:`Harmonics <harmonics>`
@@ -58,4 +64,5 @@ Contents
    registermap/registermap
    m2k/index
    pqm/index
+   swiot1l/index
 

doc/plugins/swiot1l/ad74413r.rst

@@ -0,0 +1,183 @@
+.. _ad74413r:
+
+
+AD74413R
+============================================================================
+
+Overview
+---------------------------------------------------------------------
+
+The AD74413R tool is only available in the runtime mode, along with the
+MAX14906 tool and the Faults tool. It represents the main interface for
+the AD74413R chip and it dynamically shows all the channels configured
+for that device. For each channel we can read/write data through this
+interface using the libiio library.
+
+The possible functions of an AD74413R channel are as follows: high_z,
+voltage_out, current_out, voltage_in, current_in_ext, current_in_loop,
+resistance, digital_input, digital_input_loop, current_in_ext_hart and
+current_in_loop_hart. For each selected function, one or two channels
+will be generated within the device context, which will be used for
+communication with the physical channel.
+
+Only the buffered input channel data can be displayed on the plot, and
+in the case where a function generates both an input and an output
+channel, the advanced menu will be associated with the output channel or
+both channels. The channels generated according to the selected function
+are as follow:
+
+.. list-table:: 
+   :widths: 50 50 50
+   :header-rows: 1
+
+   * - Function
+     - Input channel
+     - Output channel
+   * - high_z
+     - Voltage In
+     - -
+   * - voltage_out
+     - Current In
+     - Voltage Out
+   * - current_out
+     - Voltage In
+     - Current Out
+   * - voltage_in
+     - Voltage In
+     - -
+   * - current_in_ext
+     - Current In
+     - -
+   * - current_in_loop
+     - Current In
+     - Current Out
+   * - resistance
+     - Resistance
+     - -
+   * - digital_input
+     - Voltage In
+     - -
+   * - digital_input_loop
+     - Voltage In
+     - Current Out
+   * - current_in_ext_hart
+     - Current In
+     - -
+   * - current_in_loop_hart
+     - Current In
+     - Current Out
+
+Instrument Layout
+---------------------------------------------------------------------
+.. image:: https://github.com/analogdevicesinc/scopy/blob/doc_resources/resources/swiot1l/ad74413r.png?raw=true
+   :align: center
+
+1. Run button
+
+- The run button will start an acquisition task that will collect data
+  from the active input channels.
+- The acquisition task will stop upon user intervention.
+- The data acquisition frequency is set by the user through the settings menu.
+- All the data will be displayed on the plot.
+
+2. Single Button
+
+ The single button will start a single capture acquisition for all the active 
+ input channels. The acquisition task will stop once all the data is acquired 
+ and displayed on the plot.
+
+3. Settings Button
+
+ Show/Collapse the menu of general settings.
+
+4. Advanced Menu Button
+
+ Show/Collapse the advanced menu of the channels. Each channel is associated 
+ with an advanced menu through which various attributes can be modified.
+
+5. Menu Area
+
+ Here is displayed the menu of general settings, as well as the advanced 
+ menu for each channel.
+
+6. Channels list
+
+ The functions assigned to each channel are displayed here. The functions 
+ with indices from 1 to 4 are correlated with the physical channels 
+ on the board. 
+ 5 to 8 indices are correlated with the diagnostic channels. 
+ When a channel is selected, it is highlighted.
+
+7. Plot
+
+ Display data from all the active channels. Display the number 
+ of units per vertical division. Display the instant value
+ for all channels.
+
+8. Info button
+
+9. Print button
+
+ Save the plot with the data and channels into a PDF file.
+
+10. Config button
+
+ When pressing the config button, Scopy will switch the SWIOT1L mode to config.
+ The device will briefly disconnect and then reconnect. After that it will 
+ automatically display the Config Instrument.
+
+Channel item layout
+---------------------------------------------------------------------
+
+1. Enable button
+
+ Enable/Disable a channel. If a channel is disabled, it will no longer
+ be displayed on the plot and data will not be acquired for it.
+
+2. Channel function name
+
+3. Menu button
+
+ Show/Collapse the advanced menu of the selected channel.
+
+Plot Layout
+---------------------------------------------------------------------
+
+1. Drawing area for the curves
+
+ Each input channel has a corresponding curve on the plot.
+
+2. Curves handle area
+
+ Each curve is associated with a handle through which we can position the 
+ curves at different values on the Y-axis.
+
+3. Acquisition status
+
+ Display the number of acquired samples and the rate at which these samples 
+ are acquired. The samples per second (SPS) is calculated based in the 
+ frequency and the number of enabled channels.
+
+ If you hover the info button you will find all the necessary information. 
+
+
+General settings layout
+---------------------------------------------------------------------
+
+1. Acquisition settings section
+
+ Sampling frequency represents the frequency at which data is acquired. It is 
+ a property shared by all the available channels.
+ Available options: 10, 20, 1200, 4800. The plot timespan can be set 
+ between 100ms and 10s.
+
+2. Export section
+
+ It provides the possibility to export data corresponding to the activated 
+ input channels into a CSV file. You
+ can choose the channels for which data will be exported.
+
+3. Arrow button
+
+ The menu can be detached and reattached by pressing the arrow button 
+ in the top right corner.

doc/plugins/swiot1l/faults.rst

@@ -0,0 +1,80 @@
+.. _faults:
+
+
+Faults
+============================================================================
+
+Overview
+---------------------------------------------------------------------
+
+
+The Faults Instrument represents the diagnostic operation performed on
+the AD-SWIOT1L-SL device, more accurately the AD74413R and MAX14906
+chips. The numeric value from each device is extracted from specific
+registers and each bit represents a potential error or information about
+the chip. For more information on the faults meaning, consider checking
+the corresponding datasheets.
+
+Instrument layout
+---------------------------------------------------------------------
+.. image:: https://github.com/analogdevicesinc/scopy/blob/doc_resources/resources/swiot1l/faults.png?raw=true
+   :align: center
+
+
+1. Hexadecimal read Value
+
+ The last value read from each device, in hexadecimal.
+
+2. Reset Stored
+
+ Once a fault value is read twice consecutively, the stored bit is set 
+ for that fault (meaning the fault is persistent).
+ Pressing the RESET STORED button clears all persistent faults.
+
+3. Clear Selection
+
+ Each fault can be selected by clicking it. Scopy will display only the 
+ faults that are selected. Pressing the CLEAR SELECTION button clears 
+ all selected faults. This can also be achieved by individually 
+ deselecting each fault.
+
+4. Run/Single Buttons
+
+ The Single button performs 1 single read for both AD74413R and 
+ MAX14906 faults.
+ The Run button performs a polling operation on both AD74413R and 
+ MAX14906 every second.
+
+5. Faults Display
+
+ Check the “Faults” dedicated section of this page.
+
+6. Faults Explanations
+
+ Each fault is explained in this section. The first 4 faults from AD74413R
+ (VI_ERR_A, VI_ERR_B, VI_ERR_C and VI_ERR_D) have special meanings based on the
+ configuration of the channel. Only one of them will be shown when a specific
+ function is selected and all of them when no specific function is selected.
+ The explanations are highlighted for the faults that have the active bit set
+ (i.e. were active on the last read).
+
+Faults
+---------------------------------------------------------------------
+
+Each fault has 3 sections:
+ - **Stored Bit section:**
+
+ The stored bit represents whether that specific fault has been 
+ active twice consecutively, making it a persistent
+ bit. This can be cleared using the RESET STORED button.
+
+ - **Active Bit section:**
+
+ The active bit represents the value that was last read from the device.
+
+ - **Bit index:** 
+
+ The index bit is a notation for identifying faults.
+ It does not represent  the fault name. The name can be seen by 
+ hovering over the fault or by checking the “Faults Explanation” area 
+ corresponding to the index.