eive-tmtc/README.md
2022-05-17 14:46:23 +02:00

1.5 KiB

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

./tmtccli.py

Run GUI mode

./tmtcgui.py

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

Set up virtual environment

Linux

  1. Create virtual environment
python3 -m venv venv
  1. Activate virtual environment
. venv/bin/activate
  1. Install tmtccmd for virtual environment. -e for interactive installation.
cd tmtccmd
python3 -m pip install -e .[gui]

Windows

  1. Create virtual environment
py -m venv .
  1. Activate virtual environment
venv\Scripts\activate.bat
  1. Install tmtccmd for virtual environment. -e for interactive installation.
cd tmtccmd
py -m pip install -e .[gui]