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 environment 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

./tmtcc.py

Run GUI mode

./tmtcc.py -g

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.

Installing via PyPI

It is recommended to install eive-tmtc itself interactively, which also installs all required dependencies.

pip install -e .

If you only want to install all dependencies:

pip install -r requirements.txt

Install interactively

Clone the dependency first inside the deps folder

cd deps
./install_tmtccmd.sh

Then you can install tmtccmd interactively

cd tmtccmd
pip install -e .

Run Linter

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

python3 -m pip install ruff

or on Windows

py -m pip install ruff

and then run it

ruff .

Run Auto-Formatter

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

black .

2.1 KiB Raw Blame History