Document and refactor ground-station code #107
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains some suggested changes that I came up with while documenting the ground-station code. The current notable changes are:
commands.py
in the websocket module towebsocket_commands.py
in the telemetry module. This file only contains logic for parsing incoming commands for the Telemetry process so it seems fitting that the file should exist in the telemetry moduletelemetry.py
to match their name inmain.py
. This is mainly a nit but it also just clears up some initial confusingjson_packets.py
intostatus.py
- which contains the newly namedTelemetryStatus
class and its associated classes and enums to hold status of telemetry backend - anddata.py
which contains theTelemetryData
and the newly namedTelemetryDataPacket
classes.utils.py
and rename it toparsing_utils.py
On the subject of the last notable change, I was thinking of moving
parsing_utils.py
into thev1
directory as it's technically built on top of the v1 spec.