Cyberglove's documentation
======================================

This package was created as part of two Bachelor theses at the LTD at FAU Erlangen-Nürnberg 2021-2022.
The application handles communication with the CyberGlove III, enables the user to calibrate the glove data and to evaluate the results.

Setting up the package
----------------------

:doc:`prerequisites`
    Checklist to be able to run the package.

:doc:`installation`
    How to install this package.

:doc:`configuration`
    Configure your system and the CyberGlove to get started.

:ref:`supported-operating-systems`
    Supported and tested operating system.

:ref:`dependencies`
    Supported project dependencies, like Python and pip-packages.

.. toctree::
   :maxdepth: 2
   :caption: Setup
   :hidden:

   prerequisites
   installation
   configuration

Using the package
-----------------

:doc:`glove`
   Module to connect and interact with the CyberGlove hardware.
:doc:`visualization`
   Module to visualize live-data with the OpenSim Python-API.
:doc:`calibration`
   Modules to calibrate the sensors of the data glove.
:doc:`helper`
   Module for helper-functions supporting the calibration modules.

.. toctree::
   :maxdepth: 4
   :caption: Code Documentation
   :hidden:

   code