doc: Added pqm documentation.

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

doc/plugins/index.rst

@@ -34,6 +34,10 @@ Application Specific plugins
 
 * SWIOT1L
 * PQM
+    * :ref:`RMS <rms>`
+    * :ref:`Harmonics <harmonics>`
+    * :ref:`Waveform <waveform>`
+    * :ref:`Settings <settings>`
 
 
 Each plugin:
@@ -53,4 +57,5 @@ Contents
    datalogger/datalogger
    registermap/registermap
    m2k/index
+   pqm/index
 

doc/plugins/pqm/harmonics.rst

@@ -0,0 +1,41 @@
+.. _harmonics:
+
+Harmonics
+================================================================================
+
+The main purpose of this instrument is to display and graphically represent the voltage and current harmonics or inter harmonics. Each time new data is available, the tool updates accordingly.
+
+The instrument contains 3 sections: 
+
+#. Total Harmonic Distortion (THD). 
+#. Harmonics table.
+#. Harmonics plot.
+
+.. image:: ../../resources/pqm/harmonics.png
+    :align: center
+
+User Guide 
+-------------------------------------------------------------------------------------------
+
+#. From the menu on the left, you can select the desired instrument. To the right of the name, there is a button that allows you to start or stop data acquisition.
+#. Clicking the settings button brings up the settings menu.
+#. Settings menu.
+#. By pressing the "Single" button, a single batch of data is acquired.
+#. By pressing the "Run" button, continuous data acquisition starts.
+
+.. topic:: Settings menu
+
+    .. image:: ../../resources/pqm/harmonicsSettings.png
+        :alt: alternate text
+        :align: right
+
+    #. Harmonics type: Select the type of harmonics (harmonics or inter harmonics).
+    #. Active channel: Select active phase to display on the plot. 
+        * At any given time, only the values of a single phase can be displayed on the plot. 
+        * The active phase on the plot can also be changed by clicking on the cells in the table. 
+        * Additionally, if only certain values from a row are selected, only those values will be displayed on the plot.
+
+    In the next image, you can see that the plot displays only the harmonic values with degree ranging from 3 to 14.
+
+    .. image:: ../../resources/pqm/harmonicsRange.png
+        :align: center

doc/plugins/pqm/index.rst

@@ -0,0 +1,17 @@
+.. _pqm_index:
+
+
+PQM
+---------------------------------------------------------------------
+
+This document describes how Scopy adds support for the PQM board, which contains as main components an ADE9430 and a MAX32650 (MCU). The device is exposed through an IIO context, from which we receive and send our necessary information.
+
+The plugin contains 4 instruments: 
+
+.. toctree::
+   :maxdepth: 3
+
+   rms
+   harmonics
+   waveform
+   settings

doc/plugins/pqm/rms.rst

@@ -0,0 +1,22 @@
+.. _rms:
+
+RMS  
+================================================================================
+
+The main purpose of this instrument is to display and graphically represent the RMS and the angle of each phase (for both voltage and current). At the same time, information such as voltage and current unbalance or flicker data can also be inferred from here. Each time new data is available, the tool updates accordingly.
+
+The instrument is divided into two sections: 
+
+#. Voltage: Shows the details of the voltage (left side).
+#. Current: Shows the details of the current (right side).
+
+.. image:: ../../resources/pqm/rms.png
+    :align: center
+
+User Guide 
+-------------------------------------------------------------------------------------------
+
+#. From the menu on the left, you can select the desired instrument. To the right of the name, there is a button that allows you to start or stop data acquisition.
+#. By pressing the "Single" button, a single batch of data is acquired.
+#. By pressing the "Run" button, continuous data acquisition starts.
+

doc/plugins/pqm/settings.rst

@@ -0,0 +1,20 @@
+.. _settings:
+
+System settings
+================================================================================
+
+The user can use this instrument to read or modify various parameters of the device.
+
+.. image:: ../../resources/pqm/settings.png
+    :align: center
+
+User Guide 
+-------------------------------------------------------------------------------------------
+
+#. From the menu on the left, you can select the desired instrument.
+#. System time: The current time is set on the device, as it does not have internal time management mechanisms.
+#. Logging: Various data can be saved on an integrated SD card. This section is used to set the time interval for data acquisition to the SD card.
+#. Config values: In this section, most of the device's exposed parameters can be read and written.
+#. Calibrate: This section is responsible for calibrating the device. However, the calibration mechanism is currently not implemented.
+
+

doc/plugins/pqm/waveform.rst

@@ -0,0 +1,32 @@
+.. _waveform:
+
+Waveform
+================================================================================
+
+The main purpose of this instrument is to display the waveform of the voltage and current for each phase. In one second, 10 cycles should be displayed at a frequency of 50 Hz, or 12 cycles at a frequency of 60 Hz.
+
+The instrument is divided into two sections: 
+
+#. Voltage plot: Shows voltage waveforms (top).
+#. Current plot: Shows current waveforms (bottom).
+
+.. image:: ../../resources/pqm/waveform.png
+    :align: center
+
+User Guide 
+-------------------------------------------------------------------------------------------
+
+#. From the menu on the left, you can select the desired instrument. To the right of the name, there is a button that allows you to start or stop data acquisition.
+#. Clicking the settings button brings up the settings menu.
+#. By pressing the "Single" button, a single batch of data is acquired.
+#. By pressing the "Run" button, continuous data acquisition starts.
+
+.. topic:: Settings menu
+
+	.. image:: ../../resources/pqm/waveformSettings.png
+		:alt: waveform settings
+		:align: right
+
+	#. Timespan: The time interval for displaying data on the plot can be set to a value between 20 ms and 10 seconds.
+	#. Triggered by: If we are in trigger mode for displaying data on the plot, we can select which phase will be used as the basis for the display (by default is the phase Ua). This menu option becomes inactive when rolling mode is activated or data acquisition starts.
+	#. Rolling mode: This switch is used to activate/deactivate rolling mode (by default is off).