.. include:: ./../../macros.txt
.. include:: ./../../units.txt

.. _FOXBMS_2_GUI:

foxBMS 2 GUI
============

This tool helps to

- view battery system parameters during operation and control the BMS and
- parse and visualize CAN logs generated by |foxbms|.

Using the GUI
-------------

In order to start the GUI run the helper script ``gui.bat``

.. code-block:: console

     C:\Users\vulpes\Documents\foxbms-2>tools\gui\gui.bat

and then the tool selection window opens.

.. _gui_entry_frame:
.. figure:: ../../../tools/gui/entry-frame.png
   :width: 50 %

   The GUI wrapper to start different sub-tools.

The tool implements two sub-tools that are available under the ``File`` menu.

.. _gui_entry_frame_select_sub_tool:
.. figure:: ../../../tools/gui/entry-frame-select-sub-tool.png
   :width: 50 %

Implementation
--------------

The details of the GUI implementation are explained in
:ref:`FOXBMS_2_GUI_IMPLEMENTATION_DETAILS`.