doc: change folder name from doc to docs

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

.github/workflows/generate_doc.yml

@@ -17,21 +17,21 @@ jobs:
         python-version: "3.x"
 
     - name: Install pip packages
-      working-directory: doc
+      working-directory: docs
       run: |
         pip install pip --upgrade
         pip install -r requirements.txt
 
     - name: Build doc
-      working-directory: doc
+      working-directory: docs
       run: |
         make html SPHINXOPTS='-W --keep-going'
 
     - name: Store the generated doc
       uses: actions/upload-artifact@v4
       with:
         name: html
-        path: doc/_build/html
+        path: docs/_build/html
 
   deploy-doc:
     runs-on: ubuntu-latest

docs/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f6456bd14fb9100f8ff53edb5f16c5ec
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/plugins/index.rst.txt

@@ -0,0 +1,68 @@
+.. _plugins:
+
+Plugins
+================================================================================
+
+What is a Scopy plugin ?
+
+General IIO plugins
+
+* ADC Plugin
+
+* DAC plugin
+
+* :ref:`Datalogger <datalogger>`
+
+* Debugger
+
+* :ref:`Register Map <registermap>`
+
+Application Specific plugins
+
+* ADALM2000 plugins :
+
+    * :ref:`Oscilloscope <oscilloscope>`
+    * :ref:`Spectrum Analyzer <spectrum_analyzer>`
+    * :ref:`Network Analyzer <network_analyzer>`
+    * :ref:`Signal Generator <signal_generator>`
+    * :ref:`Logic Analyzer <logic_analyzer>`
+    * :ref:`Pattern Generator <pattern_generator>`
+    * :ref:`Digital IO <digitalio>`
+    * :ref:`Voltmeter <voltmeter>`
+    * :ref:`Power Supply <power_supply>`
+
+
+* AD-SWIOT1L-SL
+
+    * :ref:`Config <config>`
+    * :ref:`AD74413R <ad74413r>`
+    * :ref:`MAX14906 <max14906>`
+    * :ref:`Faults <faults>`
+
+* PQM
+    * :ref:`RMS <rms>`
+    * :ref:`Harmonics <harmonics>`
+    * :ref:`Waveform <waveform>`
+    * :ref:`Settings <settings>`
+
+
+Each plugin:
+Description
+Compatible
+Description
+Usage
+Usecases
+
+
+Contents
+---------------------------------------------------------------------
+
+.. toctree::
+   :maxdepth: 3
+
+   datalogger/datalogger
+   registermap/registermap
+   m2k/index
+   pqm/index
+   swiot1l/index
+

docs/_build/html/_sources/plugins/swiot1l/config.rst.txt

@@ -0,0 +1,35 @@
+.. _config:
+
+Configuration
+============================================================================
+
+Overview
+--------------------------------------------------------------------
+
+.. image:: https://github.com/analogdevicesinc/scopy/blob/doc_resources/resources/swiot1l/config.png?raw=true
+   :align: center
+
+The Config Instrument is only available when the AD-SWIOT1L-SL system is
+in configuration mode. This mode allows the user to define, for each of
+the 4 physical channels, the device that will control the channel and
+the function defined for that device. The channel can also be disabled,
+in which case it will not be configured.
+
+ 1. Channel index
+ 2. Channel state (enabled/disabled)
+ 3. Chip configured on that channel
+ 4. Function selected (chip specific)
+ 5. Channel to chip mapping 
+
+    The AD-SWIOT1L-SL board image contains a mapping of the AD74413R and 
+    MAX14906 chips that highlights the connection between each chip and 
+    the corresponding configured channel pin.
+ 6. Mode switch
+
+    After configuring the system pressing the Apply button will switch the 
+    SWIOT1L to runtime mode. The device will briefly disconnect while the 
+    IIO Context is reconfigured and it will automatically reconnect to 
+    the AD-SWIOT1L-SL board.
+
+Upon successful connection a different set of instruments will be available 
+to operate and control the system.

docs/_build/html/_sources/plugins/swiot1l/index.rst.txt

@@ -0,0 +1,153 @@
+.. _swiot1l_index:
+
+
+AD-SWIOT1L-SL plugin
+================================================================================
+
+Overview
+---------------------------------------------------------------------
+
+The Scopy `AD-SWIOT1L-SL <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-swiot1l-sl.html>`_ plugin is responsible with the operation and
+control of the AD-SWIOT1L-SL platform. The Scopy AD-SWIOT1L-SL
+plugin, while based on the Scopy application infrastructure, is tailored
+to provide all the specific functionalities of this system.
+
+.. note::
+   For an overview of the AD-SWIOT1L-SL system, check the complete user guide: `AD-SWIOT1L-SL User <https://wiki.analog.com/resources/eval/user-guides/ad-swiot1l-sl>`_
+
+.. warning::
+   The Scopy application is in the process of a major rework so a mismatch
+   between some parts of the documentation and the actual application may
+   exist. The new Scopy version is not officially released, so the
+   installers for Scopy with AD-SWIOT1L-SL plugin will be available at the
+   links provided below.
+
+
+Software setup
+---------------------------------------------------------------------
+
+**Scopy for Windows**
+`Download: Installer for latest release (Windows 64/32-bit); Updated: November
+2023 <https://swdownloads.analog.com/cse/ad-swiot1l-sl/scopy-alpha-swiot1l/scopy-alpha-windows-setup.zip>`_
+
+**Scopy for Windows portable**
+`Download: Portable version for latest release (Windows 64/32-bit); Updated: November
+2023 <https://swdownloads.analog.com/cse/ad-swiot1l-sl/scopy-alpha-swiot1l/scopy-alpha-windows-portable.zip>`_
+
+**Scopy for Linux**
+`Download: Scopy Flatpak installer; Updated: November 2023 
+<https://swdownloads.analog.com/cse/ad-swiot1l-sl/scopy-alpha-swiot1l/scopy-alpha-linux.zip>`_
+
+**Scopy for OSX**
+`Download: Scopy MacOS installer
+<https://swdownloads.analog.com/cse/ad-swiot1l-sl/scopy-prealpha-swiot1l/scopy-prealpha-macos.zip>`_
+
+Software installation
+---------------------------------------------------------------------
+**Windows** 
+
+ Once you downloaded the installer, run it and follow all the required steps.
+ After completion, system reboot is required.
+
+**Linux** 
+
+ Setup Flatpak using `the setup guide <https://flatpak.org/setup/Ubuntu>`_ for your Linux distribution.
+
+ After Flatpak is setup get the **Scopy.flatpak** file from the downloaded archive and run:
+
+ **flatpak install scopy–flatpak.flatpak**
+
+**MacOS**
+
+ Double click the downloaded .dmg to make its content available. “Scopy” will 
+ show up in the Finder sidebar and a window showing the content should open up. 
+ Drag the application from the .dmg window into Applications to install and wait 
+ for the process to finish.
+
+.. warning::
+   The AD-SWIOT1L-SL system is not compatible with Scopy v1.4.1 or older
+
+Launching the application
+---------------------------------------------------------------------
+.. video:: https://github.com/analogdevicesinc/scopy/raw/doc_resources/resources/swiot1l/connect.mov
+
+Scopy is able to control and operate multiple devices. In order to use
+it for the AD-SWIOT1L-SL system, the user should click the “Add
+Device”(+) button displayed on the front page of the application.
+
+The video attached above demonstrates the process of connecting to the
+board. First it will scan the network in order to detect the device. If
+the device is connected to the network and able to be scanned, it will
+appear in the list as **ip:analog.local**. If the device is not
+available in the list, but the IP is known, the user can manually write
+the IP in the URI textbox and proceed forward.
+
+.. note::
+   The default static IP for all the boards is **169.254.97.40** .
+
+Once found and verified Scopy will present a list of compatible
+instruments. The list of instruments is explained below, but during this
+step the user can enable or disable Scopy functionalities for this
+board.
+
+Going forward the homepage of the board is displayed. The homepage
+displays some basic information about the board, including its network
+IP. It also contains three buttons. One will perform the connection to
+the device, the second one performs identification and will blink a led
+on the board and the third one will start a quick tutorial for Scopy
+first time users. The tutorial is recommended in addition to this user
+guide as it will highlight and explain the user interface controls for
+the SWIOT1L available instruments.
+
+.. video:: https://github.com/analogdevicesinc/scopy/raw/doc_resources/resources/swiot1l/tutorial-config.mov
+
+
+Power Supply Options
+---------------------------------------------------------------------
+.. image:: https://github.com/analogdevicesinc/scopy/blob/doc_resources/resources/swiot1l/ps-warning.png?raw=true
+   :align: center
+
+This warning may appear in any of the instruments that interact with
+AD-SWIOT1L-SL. The user should check the external power supply switch
+position and verify which option is used to power the system.
+
+.. note::
+   For more details on the power supply options, check the hardware user guide: `AD-SWIOT1L-SL Hardware User Guide <https://wiki.analog.com/resources/eval/user-guides/ad-swiot1l-sl/hardware>`_
+
+
+System operation modes
+---------------------------------------------------------------------
+**Configuration mode:** 
+   When the system is powered up it will enter the Configuration
+   mode. This mode allows the user to choose device and function
+   configuration for each of the 4 physical channels. When entering the
+   Configuration mode, everything is reset to default values. Other than
+   the initial state after power up, the user can enter this mode by using
+   the **Config** button available in all the runtime instruments of Scopy
+   (instruments: AD74413R, MAX14906, Faults).
+
+**Runtime mode:**
+   In order to enter the Runtime mode, the user needs to configure the required
+   channels and use the **Apply** button provided in the Config Instrument.
+   In this mode the physical channels are configured and can be used to
+   control or acquire data. If any changes are needed, the user can go back
+   into Configuration mode by using the **Config** button mentioned above.
+
+More details on switching through the board states are provided on
+specific instrument documentation.
+
+.. note::
+   Switching between operation modes might take some time depending on the
+   network status. When switching from one mode to another the board is
+   briefly disconnected from Scopy, that is because the IIO Context that it
+   relies on needs to be destroyed and recreated based on the selected
+   configuration.
+
+.. toctree::
+   :maxdepth: 3
+
+   config
+   ad74413r
+   max14906
+   faults
+   ../registermap/registermap