#16: GUI Extensions
===================

The GUI Extensions
******************

The ``Karabo GUI`` can also be updated regularly with external widgets with
an external package.

The external package is referred to as ``GUIExtensions`` and targetting
non-generic and **tailored** controllers for the operators.
Examples of tailored widgets such as for the scantool (Karabacon), a scatter position
widget with ellipse, a beam position monitor and the adqDigitizer are shown below.

.. figure:: images/extensions_overview.png
   :align: center
   :alt: Overview of the GUI Extensions widgets
   :figclass: align-center

   Overview of the GUI Extensions widgets

The documentation can be found on the European XFEL readthedocs:

https://rtd.xfel.eu/docs/gui-extensions/en/latest/index.html

The development is independent of the Karabo release cycle and can offer
quick solutions for the operators on demand.
Regarding the client computers in the control room hutches and the Beschleuniger Kontroll Raum *BKR*
as well as the *exflgateway* the control deployment system will install the ``GUIExtensions``.

The extensions package can be updated via a dialog that can be launched with
the *menu bar* of the GUI application.

.. figure:: images/update_menu.png
   :align: center
   :alt: The menu bar with the ``Check for Updates`` option
   :figclass: align-center

   Check for external updates of the karaboGUI

Using the dialog is illustrated in the video below. The dialog shows the currently
installed version and the latest version available.
An update procedure will always update to the latest version, which is also
the recommended one.

.. figure:: images/update_extensions.gif
   :align: center
   :alt: Updating the karaboGUI Extensions
   :figclass: align-center

   Updating the karaboGUI Extensions Package

**The GUIExtensions package is mandatory for Scantool (Karabacon) usage and highly
recommended for the adqDigitizer.**

.. note::

   In order to update the package, the operating machine must be within the
   control or office network.

Another way to install or update the extensions package is to use the command line
after activating the conda environment.

.. code-block:: bash

   karabo-update-extensions -l      # Will install the latest available version
   karabo-update-extensions 0.4.0   # Specify a tag