From 54c1c7d61fc2c8d5a2b118e114afdff2ca567fa2 Mon Sep 17 00:00:00 2001 From: Michael Fatemi Date: Wed, 3 Mar 2021 10:23:21 -0500 Subject: [PATCH 1/4] Add packet formats for gs --> fs --- docs/programming/packets.mdx | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/programming/packets.mdx diff --git a/docs/programming/packets.mdx b/docs/programming/packets.mdx new file mode 100644 index 0000000..d9f0eb4 --- /dev/null +++ b/docs/programming/packets.mdx @@ -0,0 +1,24 @@ +--- +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,`
`valve_location: X,`
`actuation_type: X,`
`actuation_priority: X`| +|valve_request |`valve_type: X,`
`valve_location: X` | +|sensor_request |`sensor_type: X,`
`sensor_location: X` | + +## Packets FROM flight software TO ground software + From afc3acde5e0b6e709a81aef1394bff384be6c652 Mon Sep 17 00:00:00 2001 From: Michael Fatemi Date: Wed, 3 Mar 2021 10:32:41 -0500 Subject: [PATCH 2/4] Add packets from fs --> gs --- docs/programming/packets.mdx | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/programming/packets.mdx b/docs/programming/packets.mdx index d9f0eb4..50bc30f 100644 --- a/docs/programming/packets.mdx +++ b/docs/programming/packets.mdx @@ -22,3 +22,16 @@ Packets are used to communicate between the rocket and the ground station. They ## Packets FROM flight software TO ground software +| Header | Message Format | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| control_task_start | `task: stage \| pressure \| telemetry \| valve \| sensor` | +| stage_status | `stage: X`
`status: X` | +| abort_level | `level: AbortLevel` | +| abort_request_response | `successful: boolean
level: AbortLevel` | +| heartbeat | `timestamp: X` | +| sensor_data | `[type]: {`
` [location]: {`
` measured_value: X`
` normalized_value: X`
` status: X`
` }`
`}` | +| abort_alert | `level: none \| soft \| hard`
`dangerous_sensors?: [`
` type: X`
` location: X`
` normalized_value: X`
`]` | +| valve_actuation_response | `type: X`
`location: X`
`found: boolean`
`successful: boolean` | +| valve_request_response | `type: X`
`location: X`
`found: boolean`
`actuation_type?: X`
`actuation_priority?: X` | +| valve_data | `[type]: {`
` [location]: {`
` actuation_type: X`
` actuation_priority: X`
` }`
`}` | +| valve_actuated | `type: X`
`location: X` | From 32c988710809b0ca9749141f00db88b7d314bdd5 Mon Sep 17 00:00:00 2001 From: Michael Fatemi Date: Wed, 3 Mar 2021 10:42:50 -0500 Subject: [PATCH 3/4] Use better code format --- docs/programming/packets.mdx | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/programming/packets.mdx b/docs/programming/packets.mdx index 50bc30f..51a4437 100644 --- a/docs/programming/packets.mdx +++ b/docs/programming/packets.mdx @@ -12,26 +12,26 @@ Packets are used to communicate between the rocket and the ground station. They |Header |Message Format | |------------------------------------|-------------------| -|set_abort_level (To be implemented) |`Level: AbortLevel`| +|set_abort_level (To be implemented) | Level: AbortLevel| |soft_abort (deprecated) | | |undo_soft_abort (deprecated) | | |progress | | -|solenoid_actuate |`valve_type: X,`
`valve_location: X,`
`actuation_type: X,`
`actuation_priority: X`| -|valve_request |`valve_type: X,`
`valve_location: X` | -|sensor_request |`sensor_type: X,`
`sensor_location: X` | +|solenoid_actuate | valve_type: X,
valve_location: X,
actuation_type: X,
actuation_priority: X| +|valve_request | valve_type: X,
valve_location: X | +|sensor_request | sensor_type: X,
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`
`status: X` | -| abort_level | `level: AbortLevel` | -| abort_request_response | `successful: boolean
level: AbortLevel` | -| heartbeat | `timestamp: X` | -| sensor_data | `[type]: {`
` [location]: {`
` measured_value: X`
` normalized_value: X`
` status: X`
` }`
`}` | -| abort_alert | `level: none \| soft \| hard`
`dangerous_sensors?: [`
` type: X`
` location: X`
` normalized_value: X`
`]` | -| valve_actuation_response | `type: X`
`location: X`
`found: boolean`
`successful: boolean` | -| valve_request_response | `type: X`
`location: X`
`found: boolean`
`actuation_type?: X`
`actuation_priority?: X` | -| valve_data | `[type]: {`
` [location]: {`
` actuation_type: X`
` actuation_priority: X`
` }`
`}` | -| valve_actuated | `type: X`
`location: X` | +| control_task_start | task: stage \| pressure \| telemetry \| valve \| sensor | +| stage_status | stage: X
status: X | +| abort_level | level: AbortLevel | +| abort_request_response | successful: boolean
level: AbortLevel | +| heartbeat | timestamp: X | +| sensor_data | [type]: {
[location]: {
measured_value: X
normalized_value: X
status: X
}
} | +| abort_alert | level: none \| soft \| hard
dangerous_sensors?: [
type: X
location: X
normalized_value: X
] | +| valve_actuation_response | type: X
location: X
found: boolean
successful: boolean | +| valve_request_response | type: X
location: X
found: boolean
actuation_type?: X
actuation_priority?: X | +| valve_data | [type]: {
[location]: {
actuation_type: X
actuation_priority: X
}
} | +| valve_actuated | type: X
location: X | From 320709ceb33a73445419b21961ff12ca7d5c5cf6 Mon Sep 17 00:00:00 2001 From: Michael Fatemi Date: Wed, 3 Mar 2021 10:49:49 -0500 Subject: [PATCH 4/4] Update packets.mdx --- docs/programming/packets.mdx | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/programming/packets.mdx b/docs/programming/packets.mdx index 51a4437..c0a7c09 100644 --- a/docs/programming/packets.mdx +++ b/docs/programming/packets.mdx @@ -12,26 +12,26 @@ Packets are used to communicate between the rocket and the ground station. They |Header |Message Format | |------------------------------------|-------------------| -|set_abort_level (To be implemented) | Level: AbortLevel| +|set_abort_level (To be implemented) |`Level: AbortLevel`| |soft_abort (deprecated) | | |undo_soft_abort (deprecated) | | |progress | | -|solenoid_actuate | valve_type: X,
valve_location: X,
actuation_type: X,
actuation_priority: X| -|valve_request | valve_type: X,
valve_location: X | -|sensor_request | sensor_type: X,
sensor_location: X | +|solenoid_actuate |`valve_type: X,`
`valve_location: X,`
`actuation_type: X,`
`actuation_priority: X`| +|valve_request |`valve_type: X,`
`valve_location: X` | +|sensor_request |`sensor_type: X,`
`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
status: X | -| abort_level | level: AbortLevel | -| abort_request_response | successful: boolean
level: AbortLevel | -| heartbeat | timestamp: X | -| sensor_data | [type]: {
[location]: {
measured_value: X
normalized_value: X
status: X
}
} | -| abort_alert | level: none \| soft \| hard
dangerous_sensors?: [
type: X
location: X
normalized_value: X
] | -| valve_actuation_response | type: X
location: X
found: boolean
successful: boolean | -| valve_request_response | type: X
location: X
found: boolean
actuation_type?: X
actuation_priority?: X | -| valve_data | [type]: {
[location]: {
actuation_type: X
actuation_priority: X
}
} | -| valve_actuated | type: X
location: X | +| control_task_start | `task: stage \| pressure \| telemetry \| valve \| sensor` | +| stage_status | `stage: X`
`status: X` | +| abort_level | `level: AbortLevel` | +| abort_request_response | `successful: boolean
level: AbortLevel` | +| heartbeat | `timestamp: X` | +| sensor_data | `[type]: {`
  `[location]: {`
    `measured_value: X`
    `normalized_value: X`
    `status: X`
  `}`
`}` | +| abort_alert | `level: none \| soft \| hard`
`dangerous_sensors?: [`
  `type: X`
  `location: X`
  `normalized_value: X`
`]` | +| valve_actuation_response | `type: X`
`location: X`
`found: boolean`
`successful: boolean` | +| valve_request_response | `type: X`
`location: X`
`found: boolean`
`actuation_type?: X`
`actuation_priority?: X` | +| valve_data | `[type]: {`
  `[location]: {`
    `actuation_type: X`
    `actuation_priority: X`
  ` }`
`}` | +| valve_actuated | `type: X`
`location: X` |