Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add initial migration of test cases for m2k and swiot
Browse files Browse the repository at this point in the history
Signed-off-by: AlexandraTrifan <Alexandra.Trifan@analog.com>
AlexandraTrifan committed Jan 10, 2025
1 parent 24c97b1 commit e418616
Showing 5 changed files with 944 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/tests/plugins/index.rst
Original file line number Diff line number Diff line change
@@ -10,7 +10,13 @@ Contents
:includehidden:
:maxdepth: 3

swiot1l/swiot1l_tests
m2k/digital_io_tests
m2k/logic_analyzer_tests
m2k/power_supply_tests

..
add the path to each plugin test case here
example dac/dac_tests

122 changes: 122 additions & 0 deletions docs/tests/plugins/m2k/digital_io_tests.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
.. _digital_io_tests:

Digital IO - Test Suite
========================

.. note::

User guide: :ref:`Digital IO user guide<digitalio>`

The Digital IO tests are a set of tests that are run to verify the
Digital IO instrument of the ADALM2000 plugin in Scopy.

The following apply for all the test cases in this suite.
If the test case has special requirements, they will be listed in the test case section.

Setup environment:
------------------

.. _adalm2000_device_digital_setup:

**Adalm2000.Device:**
- Open Scopy.
- Connect the ADALM2000 device to the system.
- Connect the ADALM2000 device in Scopy using the USB/network backend.
- Connect loopback cables between DIO 0-7 and DIO 8-15 using the pinout diagram.

Depends on:
- Test TST.EMU.CONNECT
- Test TST.PREFS.RESET

Prerequisites:
- Scopy v2.0.0 or later with ADALM2000 plugin installed on the system.
- Tests listed as dependencies are successfully completed.
- Reset .ini files to default using the Preferences "Reset" button.

Test 1 - Check individual digital pin state
----------------------------------------------------

.. _TST.DIO.INDIVIDUAL:

UID:
TST.DIO.INDIVIDUAL

Description:
This test verifies that the individual digital pins are working correctly.

Preconditions:
- :ref:`Adalm2000.Device<adalm2000_device_digital_setup>`
- OS: ANY

Steps:
1. Open the DigitalIO instrument.
2. Set DIO 0-7 and DIO 8-15 as individual pins using the combo box.
3. Set DIO Channel 0 as **output**.
4. Set DIO Channel 7 as **input**.
5. Change the logic state of DIO 0 (0/1) multiple times and monitor DIO 7 state.
- **Expected Result**:
- When DIO 0 is set to logic 1, DIO 7 will be automatically set to logic 1
(the corresponding led will be turned on).
- When DIO 0 is set to logic 0, DIO 7 will be automatically set to logic 0
(the corresponding led will be turned off).
6. Connect DIO 0 to a the analog pin **1+** and DIO 7 to the positive power
supply **V+** using the pinout diagram attached in resources.
7. Set DIO 0 to logic 0 and open the :ref:`Voltmeter<voltmeter>` instrument.
Start the instrument and monitor the voltage value on Channel 1.

- **Expected Result**:
- The voltage displayed on the voltmeter is between -0.050V and 0.4V.
8. Set DIO 0 to logic 1 and monitor the voltage value on Channel 1. Start the instrument.
- **Expected Result**:
- The voltage displayed on the voltmeter is between 2.9V and 3.4V.
9. Open the `Power Supply instrument<power_supply>` and set the positive
power supply to a voltage level between 0V and 0.8V.
Monitor the DIO 7 logic state.

- **Expected Result**:
- DIO 7 indicates logic 0 level.
10. Open the `Power Supply instrument<power_supply>` and set the positive
power supply to a voltage level between 2V and 3.3V.
Monitor the DIO 7 logic state.

- **Expected Result**:
- DIO 7 indicates logic 1 level.
11. Repeat steps 6 to 11 using DIO 8 as **output** (for step 3) and
DIO 1 as **input** for (step 4).

- **Expected Result**:
- All the expected results in step 6 to 11 are met.

Test 2 - Checking grouped digital pin states
----------------------------------------------------

.. _TST.DIO.GROUP:

UID:
TST.DIO.GROUP

Description:
This test verifies that the grouped digital pins DIO 0-7 and DIO 8-15
are working correctly.

Preconditions:
- :ref:`Adalm2000.Device<adalm2000_device_digital_setup>`
- OS: ANY

Steps:
1. Open the DigitalIO instrument.
2. Set DIO 0-7 and DIO 8-15 as Group pins using the combo box.
3. Set DIO 0-7 as **output** and DIO 8-15 as **input**.
4. Set DIO 0-7 to value 0.
- **Expected Result**:
- DIO 8-15 value indicates the same value as DIO 0-7 group.
5. Set DIO 0-7 to value 128.
- **Expected Result**:
- DIO 8-15 value indicates the same value as DIO 0-7 group.
6. Set DIO 0-7 as **input** and DIO 8-15 as **output**.
7. Set DIO 8-15 to value 0.
- **Expected Result**:
- DIO 0-7 value indicates the same value as DIO 8-15 group.
8. Set DIO 8-15 to value 128.
- **Expected Result**:
- DIO 0-7 value indicates the same value as DIO 8-15 group.
600 changes: 600 additions & 0 deletions docs/tests/plugins/m2k/logic_analyzer_tests.rst

Large diffs are not rendered by default.

151 changes: 151 additions & 0 deletions docs/tests/plugins/m2k/power_supply_tests.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
.. _power_supply_tests:

Power Supply - Test Suite
=========================

.. note::

User guide :ref:`Power Supply user guide<power_supply>`

The Power Supply tests are a set of tests that are run to verify the Power Supply
instrument of the ADALM2000 plugin in Scopy.

The following apply for all the test cases in this suite.
If the test case has special requirements, they will be listed in the test case section.

Setup environment:
------------------

.. _adalm2000_device_setup:

**Adalm2000.Device:**
- Open Scopy.
- Connect the ADALM2000 device to the system.
- Connect the ADALM2000 device in Scopy using the USB/network backend.

Depends on:
- Test TST.EMU.CONNECT
- Test TST.PREFS.RESET

Prerequisites:
- Scopy v2.0.0 or later with ADALM2000 plugin installed on the system.
- Tests listed as dependencies are successfully completed.
- Reset .ini files to default using the Preferences "Reset" button.
- Connect **V+** to **1+** and **V-** to **1-** on the ADALM2000 device
using loopback cables.

Test 1 - Check positive voltage output
--------------------------------------

.. _TST.PS.POSITIVE:

UID:
TST.PS.POSITIVE

Description:
This test verifies that the positive voltage output is working correctly.

Preconditions:
- :ref:`Adalm2000.Device<adalm2000_device_setup>`
- OS: ANY

Steps:
1. Open the Power Supply instrument.
2. Set Tracking ratio control to Independent Controls.
3. Set the positive value to 3.3V and click enable.
4. Monitor the power supply output with voltmeter.
- **Expected Result**:
- The voltmeter reads values between 3.25V and 3.35V.
5. Change the power supply output value to 1.8V.
- **Expected Result**:
- The voltmeter reads values between 1.75V and 1.85V.
6. Change the power supply output value to 5V.
- **Expected Result**:
- The voltmeter reads values between 4.95V and 5.05V.

Test 2 - Check negative voltage output
--------------------------------------

.. _TST.PS.NEGATIVE:

UID:
TST.PS.NEGATIVE

Description:
This test verifies that the negative voltage output is working correctly.

Preconditions:
- :ref:`Adalm2000.Device<adalm2000_device_setup>`
- OS: ANY

Steps:
1. Open the Power Supply instrument.
2. Set Tracking ratio control to Independent Controls.
3. Set the negative value to -3.3V and click enable.
4. Monitor the power supply output with voltmeter.
- **Expected Result**:
- The voltmeter reads values between -3.25V and -3.35V.
5. Change the power supply output value to -1.8V.
- **Expected Result**:
- The voltmeter reads values between -1.75V and -1.85V.
6. Change the power supply output value to -5V.
- **Expected Result**:
- The voltmeter reads values between -4.95V and -5.05V.

Test 3 - Check fine tuning
---------------------------

.. _TST.PS.FINE_TUNING:

UID:
TST.PS.FINE_TUNING

Description:
This test verifies that the fine tuning of the power supply is working correctly.

Preconditions:
- :ref:`Adalm2000.Device<adalm2000_device_setup>`
- OS: ANY

Steps:
1. Open the Power Supply instrument.
2. Set Tracking ratio control to Independent Controls.
3. Set the knob to ±1V interval. No orange dot on the center.
4. Set value to 3V. Then use +/- sign to change value with ±1V interval.
- **Expected Result**:
- The value changes accordingly. Set Value ± 1V = the new value.
5. Set the knob to ±100mV interval. Orange dot seen on the center.
6. Set value to 300mV. Then use +/- sign to change value with ±100mV interval.
- **Expected Result**:
- The value changes accordingly. Set Value ± 100mV = the new value.

Test 4 - Check Tracking mode

.. _TST.PS.TRACKING:

UID:
TST.PS.TRACKING

Description:
This test verifies that the Tracking mode of the power supply is working correctly.

Preconditions:
- :ref:`Adalm2000.Device<adalm2000_device_setup>`
- OS: ANY

Steps:
1. Open the Power Supply instrument.
2. Set Tracking ratio control to Tracking.
3. Set the positive output to 5V. Set tracking ratio to 50%.
- Expected Result:
- The negative output value is automatically set to -2.5V.
4. Set the tracking ratio to 100%:
- Expected Result:
- The negative output value is automatically set to -5V.
5. Set the tracking ratio to 0%:
- Expected Result:
- The negative output value is automatically set to 0mV.
6. Set Tracking ratio control to Independent.
7. Set the positive output to 5V and verify the negative output:
- Expected Result:
- The negative output value does not change.
65 changes: 65 additions & 0 deletions docs/tests/plugins/swiot1l/swiot1l_tests.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
.. _swiot1l_tests:

SWIOT Plugin - Test Cases
=========================

The SWIOT plugin tests are a set of tests that are used to verify the functionality of the SWIOT plugin.
The tests are designed to be run in a specific order to ensure that the plugin is functioning correctly.
The tests are divided into two main categories: **CONFIG** AND **RUNTIME**.

The following apply for all the test cases in this suite.
If the test case has special requirements, they will be listed in the test case section.

Depends on:
- Test TST.EMU.CONNECT
- Test TST.PREFS.RESET

Prerequisites:
- Scopy v2.0.0 or later with SWIOT plugin installed on the system.
- Tests listed as dependencies are successfully completed.
- Reset .ini files to default using the Preferences "Reset" button.

Test 1 - TST.SWIOT.COMPAT
-------------------------

Title:
Test SWIOT plugin compatibility with device.

UID:
TST.SWIOT.COMPAT

Description:
This test verifies that the SWIOT plugin is compatible with the
selected device and that the plugin is able to correctly parse it.

Steps:
1. Open Scopy.
2. Start the IIO-EMU process and connect to **swiot_config**.
3. Open the SWIOT plugin - Config Instrument.
4. Select the device from the device list.

Test 2 - TST.SWIOT.CONFIG
-------------------------

Title:
Test SWIOT plugin configuration.

UID:
TST.SWIOT.CONFIG

Description:
This test verifies that the SWIOT plugin is able to configure the device
correctly.

Steps:
1. Open Scopy.
2. Start the IIO-EMU process and connect to **swiot_config**.
3. Open the SWIOT plugin - Config Instrument.
4. Configure the device with the following settings:
- **Setting 1**: Value 1
- **Setting 2**: Value 2
- **Setting 3**: Value 3




0 comments on commit e418616

Please sign in to comment.