eive-tmtc/README.md

# TMTC Commander EIVE

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](#venv) chapter describes how to set one up.

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

Run CLI mode

```sh
./tmtccli.py
```

Run GUI mode

```sh
./tmtcgui.py
```

# Run Linter

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

```sh
python3 -m pip install flake8
```

or on Windows

```sh
py -m pip install flake8
```

and then run the `lint.py` script

```sh
./lint.py
```

# <a id="venv"></a> Set up virtual environment

## Linux

1. Create virtual environment

```sh
python3 -m venv venv
```

2. Activate virtual environment

```sh
. venv/bin/activate
```

3. Install `tmtccmd` for virtual environment. `-e` for interactive installation.

```sh
cd tmtccmd
python3 -m pip install -e .[gui]
```

## Windows

1. Create virtual environment

```sh
py -m venv .
```

2. Activate virtual environment

```sh
venv\Scripts\activate.bat
```

3. Install `tmtccmd` for virtual environment. `-e` for interactive installation.

```sh
cd tmtccmd
py -m pip install -e .[gui]
```