Skip to content

Add error and status code block types #29

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

Merged
linguini1 merged 1 commit into from
Aug 8, 2025
Merged

Add error and status code block types #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions radio-packet-format/sections/block_formats.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ \section{Block Formats} \label{sec:block-formats}
\input{sections/temperature.tex}
\input{sections/voltage.tex}
\input{sections/magnetic.tex}
\input{sections/status.tex}
\input{sections/error.tex}
30 changes: 30 additions & 0 deletions radio-packet-format/sections/error.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
\subsection{Error Message}

The error message block type reports information about failures in the telemetry system. The format of the error
message payload is described in figure \ref{format:error-message}.

\begin{figure}[H]
\centering
\begin{bytefield}[bitwidth=0.03\linewidth]{16}
\bitheader{0-15} \\
\wordbox{1}{Measurement Time} \\
\bitbox{3}{}
\bitbox{5}{PID}
\bitbox{8}{Error Code} \\
\end{bytefield}
\caption{Error message data block format}
\label{format:error-message}
\end{figure}

\blocktimestampexp

\paragraph{PID}

The PID (process ID) or originating process is a number that corresponds to the context that the error occurred in,
denoting which process, thread, or hardware component the error occurred in. A value of 0x00 represents a general error,
not specific to any context. Other values are left to the telemetry system to define.

\paragraph{Error Codes}

The error codes describe the specific type of error that has occurred. The value of 0x00 is defined as a general error,
with an unknown source. Other values are left to the telemetry system to define.
4 changes: 3 additions & 1 deletion radio-packet-format/sections/packet_layout.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,9 @@ \subsection{Block Header}
Coordinates (latitude and longitude) & 0x07 \\
Voltage & 0x08 \\
Magnetic field & 0x09 \\
Reserved for future use & 0x0A through 0xFF \\
Status message & 0x0A \\
Error message & 0x0B \\
Reserved for future use & 0x0C through 0xFF \\
\bottomrule
\end{tabular}
\caption{Block types}
Expand Down
46 changes: 46 additions & 0 deletions radio-packet-format/sections/status.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
\subsection{Status Message}

The status message block type reports information about the current state of the telemetry system in integer codes,
such as the current flight state or flight events that are detected. The format of the status message payload
is described in figure \ref{format:status-message}.

\begin{figure}[H]
\centering
\begin{bytefield}[bitwidth=0.03\linewidth]{16}
\bitheader{0-15} \\
\wordbox{1}{Measurement Time} \\
\bitbox{8}{Status Code} \\
\end{bytefield}
\caption{Status message data block format}
\label{format:status-message}
\end{figure}

\blocktimestampexp

\paragraph{Status Code}

A status code is an integer representing information about the rocket's state, the state of the telemetry system, or other information.
The measurement time describes a time that the status code was valid, such as when a state change or event occurs, or any time afterwards.
The same code can be transmitted multiple times to ensure that a receiver gets has an up to date picture of the telemetry system's
operation. For example, the state of the telemetry system could be transmitted periodically. The possible status codes are described in
\ref{table:status-message-codes}.

\begin{table}[H]
\centering
\begin{tabular}{@{}ll@{}}
\toprule
Status message & Value \\
\midrule
Systems nominal & 0x00 \\
Telemetry in idle state & 0x01 \\
Telemetry in airborne state & 0x02 \\
Telemetry in landed state & 0x03 \\
Rocket ascent detected & 0x04 \\
Rocket apogee detected & 0x05 \\
Rocket descent detected & 0x06 \\
Reserved for future use & 0x07 through 0xFF \\
\bottomrule
\end{tabular}
\caption{Status message codes}
\label{table:status-message-codes}
\end{table}
Loading