tmtc-for-fsfw-hosted-example/README.md

TMTC Client

to interface the Host OBSW based on FSFW.

commands assuming the use of linux:

Creating a virtual environment

⚠️ Note that you may have to install python-venv before you can create a virtual environment. For a debian based system that would be sudo apt install python3-venv

Note that when using the GUI in a virtualenv, you need to initialize the venv with system packages:

# Creates the virtual environment venv in the folder venv
# Add the --system-site-packages flag only if you plan on using the GUI
python3 -m venv venv --system-site-packages
# Activate venv
source ./venv/bin/activate

2. Install all dependencies

install dependencies

a: (recommended) installing them as classic python packets

pip install -r requirements.txt

b: (not recommended) installing them in editable mode instead

recommended if you actively develop the code in that repo.

pip install -e .

Execute

To run the tmtc Command Line Interface (CLI)

(venv) python main.py

In the program

• 1
• select localhost, port of your choice e.g. 7301. After the first run, a tmtc_config.json is present and stores the preset data. The OBSW tells you on which port it is listening when starting up.
• :p to print the command tree
• to execute commands from the tmtc CLI you look into the device tree and execute the respective command split by slashes.

test/ping # example to execute the ping command (PUS 17,1)

see below a screenshot to visualize the steps above.

In order for all of this to work, you must have your hosted OBSW running in another terminal listening to the correct port!