TMTC commander for EIVE OBSW
Go to file
Robin Müller 6ea3312b62
EIVE/-/pipeline/pr-main This commit looks good Details
that should do the job
2023-11-28 14:20:04 +01:00
.run run configs 2023-09-06 10:44:25 +02:00
automation bump docker version 2023-06-19 17:16:23 +02:00
deps update .gitignore 2022-12-15 11:08:26 +01:00
eive_tmtc that should do the job 2023-11-28 14:20:04 +01:00
filetest remove sw update, add fake test files 2023-06-19 17:16:23 +02:00
misc move logo 2023-09-14 12:12:58 +02: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 Merge remote-tracking branch 'origin/main' into auto-switch-image-feature 2023-10-30 14:45:08 +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 README 2023-09-14 12:20:35 +02:00
pyproject.toml thats a lot of import fixes 2023-11-10 19:23:06 +01:00
release-checklist.md switch to ruff 2023-09-14 12:09:50 +02:00
requirements.txt update requirements.txt 2022-12-12 14:46:42 +01:00
tmtcc.py CFDP fixes 2023-11-13 09:05:34 +01: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 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

  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.

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 .