Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document and refactor ground-station code #107

Merged
merged 8 commits into from
Aug 7, 2024
Merged

Document and refactor ground-station code #107

merged 8 commits into from
Aug 7, 2024

Conversation

EliasJRH
Copy link
Contributor

@EliasJRH EliasJRH commented Jul 25, 2024

This PR contains some suggested changes that I came up with while documenting the ground-station code. The current notable changes are:

  • Move commands.py in the websocket module to websocket_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 module
  • Rename the queue variable names in telemetry.py to match their name in main.py. This is mainly a nit but it also just clears up some initial confusing
  • Split json_packets.py into status.py - which contains the newly named TelemetryStatus class and its associated classes and enums to hold status of telemetry backend - and data.py which contains the TelemetryData and the newly named TelemetryDataPacket classes.
  • Remove some functions from utils.py and rename it to parsing_utils.py

On the subject of the last notable change, I was thinking of moving parsing_utils.py into the v1 directory as it's technically built on top of the v1 spec.

linguini1
linguini1 previously approved these changes Jul 26, 2024
Copy link
Collaborator

@linguini1 linguini1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Call it websocket_commands instead of telemetry_websocket_commands just because its already in the telemetry directory.
Then imports look like telemetry.websocket_commands

@EliasJRH
Copy link
Contributor Author

Nit: Call it websocket_commands instead of telemetry_websocket_commands just because its already in the telemetry directory. Then imports look like telemetry.websocket_commands

I like this, while we're at it I don't think it'd be a bad idea to do the same for other similarly named files

@EliasJRH EliasJRH requested a review from linguini1 August 7, 2024 01:42
@EliasJRH EliasJRH marked this pull request as ready for review August 7, 2024 01:43
@linguini1 linguini1 merged commit 3047978 into main Aug 7, 2024
4 checks passed
@linguini1 linguini1 deleted the eh/document branch August 7, 2024 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants