================
Cabinet Test GUI
================

A graphical application can be used to exercise the following functionality on an SPS Cabinet:

* Power on/off TPMs in the station
* Initialise a station
* Select tests to execute from a list
* Start tests
* Stop tests
* Configure test parameters for individual tests (i.e duration)

.. image:: gui_screenshots/gui.png

The GUI is located in the :code:`cabinet_test_gui` directory.
To open the GUI, please ensure the testsuite has been deployed and you are in the correct python virtual environment.
See :doc:`../deployment`

And then run the following commands:

.. code-block::

    cd src/ska_low_sps_testsuite/cabinet_test_gui
    python cabinet_test_gui.py

The following arguments are supported:

.. code-block::

    Options:
      -h, --help           show this help message and exit
      -a, --admin          Disables protections, only use if know what you are doing
      -n, --network        Enables the network monitoring tab of the GUI
      -l LOG_LEVEL, --log_level LOG_LEVEL
                           Specifies the log level [default: STEP]

The Standard Workflow for using the GUI is:

.. toctree::
   :maxdepth: 2

   gui_station_config

.. toctree::
   :maxdepth: 2

   gui_adjust_test

.. toctree::
   :maxdepth: 2

   gui_run_tests

.. toctree::
   :maxdepth: 2

   gui_results

.. toctree::
   :maxdepth: 2

   gui_inspect_station

.. toctree::
   :maxdepth: 2

   gui_network_monitor