TMTC commander for EIVE OBSW
Go to file
Robin Müller 1317441c03 Merge branch 'main' into mueller_add_sus_temps 2023-01-20 10:51:30 +01:00
.run move and improve syrlinks module 2023-01-18 15:43:02 +01:00
deps update .gitignore 2022-12-15 11:08:26 +01:00
eive_tmtc black 2023-01-20 10:35:30 +01:00
filetest add test files for SW update 2022-11-17 17:19:31 +01:00
template scex continued 2022-06-30 21:49:25 +02:00
.gitignore that was annoying 2022-11-29 16:53:29 +01:00
.gitmodules replace submodules with install scripts 2022-12-15 11:07:03 +01:00
CHANGELOG.md bump changelog 2023-01-18 16:31:47 +01:00
LICENSE added license files 2022-01-26 15:13:23 +01:00
MANIFEST.in add csvs to manifest file 2022-12-06 09:34:15 +01:00
NOTICE added license files 2022-01-26 15:13:23 +01:00
README.md update README 2022-12-15 11:02:54 +01:00
lint.py adaptions for windows in lint script 2022-03-01 17:13:20 +01:00
logo.png some small bugfixes 2020-12-17 18:00:32 +01:00
requirements.txt update requirements.txt 2022-12-12 14:46:42 +01:00
setup.cfg bump used tmtccmd version 2023-01-19 16:28:22 +01:00
setup.py added setup.cfg and setup.py file 2022-05-17 14:28:17 +02:00
tmtcc.py seq count filename correction 2022-12-15 11:10:33 +01:00
tmtcloop.py starting changing code to new API 2022-07-04 15:22:53 +02:00

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

  1. Create virtual environment

    python3 -m venv venv
    
  2. Activate virtual environment

    . venv/bin/activate
    

Windows

  1. Create virtual environment

    py -m venv venv
    
  2. 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:

  1. Install tmtccmd for virtual environment. -e for interactive installation.

    cd deps/tmtccmd
    pip install -e .[gui]
    

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 .