Skip to content

Add packet formats for gs --> fs #2

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.

Sign up for GitHub

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

Open
myfatemi04 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add packet formats for gs --> fs #2

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54c1c7d
Add packet formats for gs --> fs
myfatemi04 Mar 3, 2021
afc3acd
Add packets from fs --> gs
myfatemi04 Mar 3, 2021
32c9887
Use better code format
myfatemi04 Mar 3, 2021
320709c
Update packets.mdx
myfatemi04 Mar 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/programming/packets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Packets
---

# Telemetry Packet Format

Packets are used to communicate between the rocket and the ground station. They convey information about the state of the rocket, alert the ground station of any updates, and enable the ground station to make adjustments to the rocket before launch.

*Important Note*: Packets can only be sent to the rocket BEFORE launch, not AFTER. This is to comply with regulations.

## Packets FROM ground software TO flight software

|Header |Message Format |
|------------------------------------|-------------------|
|set_abort_level (To be implemented) |`Level: AbortLevel`|
|soft_abort (deprecated) | |
|undo_soft_abort (deprecated) | |
|progress | |
|solenoid_actuate |`valve_type: X,`<br/>`valve_location: X,`<br/>`actuation_type: X,`<br/>`actuation_priority: X`|
|valve_request |`valve_type: X,`<br/>`valve_location: X` |
|sensor_request |`sensor_type: X,`<br/>`sensor_location: X` |

## Packets FROM flight software TO ground software

| Header | Message Format |
|--------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| control_task_start | `task: stage \| pressure \| telemetry \| valve \| sensor` |
| stage_status | `stage: X`<br>`status: X` |
| abort_level | `level: AbortLevel` |
| abort_request_response | `successful: boolean<br>level: AbortLevel` |
| heartbeat | `timestamp: X` |
| sensor_data | `[type]: {`<br>&nbsp;&nbsp;`[location]: {`<br>&nbsp;&nbsp;&nbsp;&nbsp;`measured_value: X`<br>&nbsp;&nbsp;&nbsp;&nbsp;`normalized_value: X`<br>&nbsp;&nbsp;&nbsp;&nbsp;`status: X`<br>&nbsp;&nbsp;`}`<br>`}` |
| abort_alert | `level: none \| soft \| hard`<br>`dangerous_sensors?: [`<br>&nbsp;&nbsp;`type: X`<br>&nbsp;&nbsp;`location: X`<br>&nbsp;&nbsp;`normalized_value: X`<br>`]` |
| valve_actuation_response | `type: X`<br>`location: X`<br>`found: boolean`<br>`successful: boolean` |
| valve_request_response | `type: X`<br>`location: X`<br>`found: boolean`<br>`actuation_type?: X`<br>`actuation_priority?: X` |
| valve_data | `[type]: {`<br>&nbsp;&nbsp;`[location]: {`<br>&nbsp;&nbsp;&nbsp;&nbsp;`actuation_type: X`<br>&nbsp;&nbsp;&nbsp;&nbsp;`actuation_priority: X`<br>&nbsp;&nbsp;` }`<br>`}` |
| valve_actuated | `type: X`<br>`location: X` |