Skip to content
Snippets Groups Projects
Commit b516e905 authored by Robin Mueller's avatar Robin Mueller
Browse files

Update README.md

parent 23498f96
Branches
Tags
No related merge requests found
......@@ -30,9 +30,9 @@ Example to run Unit Test:
obsw_tmtc_client.py -m 5
```
Example to test service 3 with serial communication, printing all housekeeping packets,
and exporting to a log file. COM port needs to be typed in manually (or set with --COM \<COM PORT>):
COM port needs to be typed in manually (or set with --COM \<COM PORT>):
```shell script
obsw_tmtc_client.py -m 3 -s 3 -p --hk -c
obsw_tmtc_client.py -m 3 -s 3 --hk -c
```
## Modes
......@@ -61,9 +61,14 @@ Please ensure that python.exe UDP packets are not blocked in advanced firewall s
and create a rule to allow packets from port 2008.
## Serial Communication
Implemented.
Serial communication was implemented and is tested for Windwos 10.
It requires the PySerial package installed.
## Unit Test
## Module Test
Includes a moduel tester which sends TCs in a queue and automatically
analyzes the replies. This is the best way to test the functionality of the
software right now as a software internal TC injector has not been implemented
yet for the FSFW.
Some more information will follow on how to write Unit Tests.
## Developers Information
......@@ -71,6 +76,10 @@ Code Style: [PEP8](https://www.python.org/dev/peps/pep-0008/)
Can be enforced/checked by using Pylint as an external program in PyCharm.
Install it with pip and then install and set-up the Pylint plugin in PyCharm.
There are a lot of features which would be nice, for example a GUI.
The architecture of the program should allow extension like that without
too many issues, as the sending and telemetry listening are decoupled.
## Import run configurations in PyCharm
The PyCharm IDE can be used to comfortably manage a set of run configuations (for example tests for different
services). These configurations were shared through the version control system Git
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment