This application can be used to test the EIVE On-Board Software. Furthermore, it can also be used to retrieve all sorts of telemetry data like housekeeping data.

It is recommended to use this application with a virtual environment. The virtual environemnt chapter describes how to set one up. The requirements describes how to install all required packages.

The configuration file can currently be found at tmtc_conf.json. It caches settings like the default communication interface or parameters like the TCP port when using the TCP communication interface.

Examples

Assuming you are running in a virtual environment and all package requirements were installed properly.

Run CLI mode

./tmtccli.py

Run GUI mode

./tmtcgui.py

Set up virtual environment

Linux

Create virtual environment
```
python3 -m venv venv
```
Activate virtual environment
```
. venv/bin/activate
```

Windows

Create virtual environment
```
py -m venv venv
```
Activate virtual environment
```
venv\Scripts\activate.bat
```

Install requirements

There are two ways to install the requirements. One is to install the primary dependency tmtccmd interactively. This is the recommended way

Assuming you are running in a virtual environment:

Install tmtccmd for virtual environment. -e for interactive installation.
```
cd tmtccmd
pip install -e .[gui]
```
You can also install the spacepackets package locally/interactively Normally, it will be installed as a tmtccmd dependency.
```
cd spacepackets
pip install -e .
```

Alternatively you can also install the packages from PyPI completely, but the risk of incompatibilities will be high there

pip install -r requirements.txt

Run Linter

Can be used to quickly check validity of script. Install flake8 first

python3 -m pip install flake8

or on Windows

py -m pip install flake8

and then run the lint.py script

./lint.py

Run Auto-Formatter

This repo is auto-formatted using black. Assuming black is installed, you can simply run

black .