Skip to content

Commit

Permalink
doc: Initial list of parameters and variables #41
Browse files Browse the repository at this point in the history
  • Loading branch information
mgm8 committed May 13, 2021
1 parent eb72c1a commit 4fdc72c
Show file tree
Hide file tree
Showing 6 changed files with 103 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
SRC=main
TARGET=slb-ttc2-doc-v0.0
TARGET=slb-ttc2-doc-v0.1

ifndef BUILD_DIR
BUILD_DIR=build
Expand Down
93 changes: 93 additions & 0 deletions doc/chapters/firmware.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
%
% firmware.tex
%
% Copyright (C) 2021 by SpaceLab.
%
% TTC 2.0 Documentation
%
% This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
% International License. To view a copy of this license,
% visit http://creativecommons.org/licenses/by-sa/4.0/.
%

%
% \brief Firmware project chapter.
%
% \author Gabriel Mariano Marcelino <[email protected]>
%
% \institution Universidade Federal de Santa Catarina (UFSC)
%
% \version 0.0.1
%
% \date 2021/05/12
%

\chapter{Firmware} \label{ch:firmware}

.

\section{Variables and Parameters}

A list of all the variables of TTC with their identification number (ID) and variable type that can be read from the sensors and peripherals is seen in the \autoref{tab:ttc2-variables}.

\begin{longtable}[c]{cL{0.72\textwidth}lc}
\toprule[1.5pt]
\textbf{ID} & \textbf{Name/Description} & \textbf{Type} & \textbf{Access} \\
\midrule
0 & Device ID (0xCC2A or 0xCC2B) & uint16 & R \\
1 & Hardware version & uint8 & R \\
2 & Firmware version (ex.: ``v1.2.3''' = 0x00010203) & uint32 & R \\
3 & Time counter in millseconds & uint32 & R \\
4 & Reset counter & uint16 & R \\
\multirow{18}{*}{5} & Last reset cause: & \multirow{18}{*}{uint8} & \multirow{18}{*}{R} \\
& - 0x00 = No interrupt pending & & \\
& - 0x02 = Brownout (BOR) & & \\
& - 0x04 = RST/NMI (BOR) & & \\
& - 0x06 = PMMSWBOR (BOR) & & \\
& - 0x08 = Wakeup from LPMx.5 (BOR) & & \\
& - 0x0A = Security violation (BOR) & & \\
& - 0x0C = SVSL (POR) & & \\
& - 0x0E = SVSH (POR) & & \\
& - 0x10 = SVML\_OVP (POR) & & \\
& - 0x12 = SVMH\_OVP (POR) & & \\
& - 0x14 = PMMSWPOR (POR) & & \\
& - 0x16 = WDT time out (PUC) & & \\
& - 0x18 = WDT password violation (PUC) & & \\
& - 0x1A = Flash password violation (PUC) & & \\
& - 0x1C = Reserved & & \\
& - 0x1E = PERF peripheral/configuration area fetch (PUC) & & \\
& - 0x20 = PMM password violation (PUC) & & \\
& - 0x22 to 0x3E = Reserved & & \\
6 & Input voltage of the $\mu$C in mV & uint16 & R \\
7 & Input current of the $\mu$C in mA & uint16 & R \\
8 & Temperature of the $\mu$C in K & uint16 & R \\
9 & Input voltage of the radio in mV & uint16 & R \\
10 & Input current of the radio in mA & uint16 & R \\
11 & Temperature of the radio in K & uint16 & R \\
12 & Last valid command (uplink packet ID) & uint8 & R \\
13 & RSSI of the last valid telecommand & uint16 & R \\
14 & Temperature of the antenna module in K & uint16 & R \\
\multirow{17}{*}{15} & Antenna module status bits: & \multirow{17}{*}{uint16} & \multirow{17}{*}{R} \\
& - Bit 15: The antenna 1 is deployed (0) or not (1) & & \\
& - Bit 14: Cause of the latest activation stop for antenna 1 & & \\
& - Bit 13: The antenna 1 deployment is active (1) or not (0) & & \\
& - Bit 11: The antenna 2 is deployed (0) or not (1) & & \\
& - Bit 10: Cause of the latest activation stop for antenna 2 & & \\
& - Bit 9: The antenna 2 deployment is active (1) or not (0) & & \\
& - Bit 8: The antenna is ignoring the deployment switches (1) or not (0) & & \\
& - Bit 7: The antenna 3 is deployed (0) or not (1) & & \\
& - Bit 6: Cause of the latest activation stop for antenna 3 & & \\
& - Bit 5: The antenna 3 deployment is active (1) or not (0) & & \\
& - Bit 4: The antenna system independent burn is active (1) or not (0) & & \\
& - Bit 3: The antenna 4 is deployed (0) or not (1) & & \\
& - Bit 2: Cause of the latest activation stop for antenna 4 & & \\
& - Bit 1: The antenna 4 deployment is active (1) or not (0) & & \\
& - Bit 0: The antenna system is armed (1) or not (0) & & \\
16 & Antenna deployment status (0=never executed, 1=executed) & uint8 & R \\
17 & Antenna deployment hibernation (0=never executed, 1=executed) & uint8 & R \\
18 & TX packet counter & uint32 & R \\
19 & RX packet counter (valid packets) & uint32 & R \\
\bottomrule[1.5pt]
\caption{Variables and parameters of the TTC 2.0.}
\label{tab:ttc2-variables}
\end{longtable}
6 changes: 3 additions & 3 deletions doc/header/authorpage.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
%
% \institution Universidade Federal de Santa Catarina (UFSC)
%
% \version 0.0.0
% \version 0.0.1
%
% \date 2021/04/01
%
Expand All @@ -28,7 +28,7 @@

\textbf{\thetitle}

\textit{April, 2021}
\textit{May, 2021}

\vspace{1cm}

Expand Down Expand Up @@ -64,7 +64,7 @@
\textbf{Version} & \textbf{Author} & \textbf{Changes} & \textbf{Date} \\
\midrule
0.0 & G. M. Marcelino & Document creation & 2021/04/01 \\
& & & \\
0.1 & G. M. Marcelino & First release & TBD \\
& & & \\
& & & \\
\bottomrule[1.5pt]
Expand Down
6 changes: 3 additions & 3 deletions doc/header/titlepage.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
%
% \institution Universidade Federal de Santa Catarina (UFSC)
%
% \version 0.0.0
% \version 0.0.1
%
% \date 2021/04/01
%
Expand All @@ -27,7 +27,7 @@
\thispagestyle{empty}

\begin{flushleft}
SLB-TTC2-DOC-v0.0
SLB-TTC2-DOC-v0.1
\end{flushleft}

\vspace{1cm}
Expand All @@ -54,7 +54,7 @@
\vfill

\begin{flushright}
April 2021
May 2021
\end{flushright}

\end{titlepage}
5 changes: 3 additions & 2 deletions doc/main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
%
% \institution Universidade Federal de Santa Catarina (UFSC)
%
% \version 0.0.0
% \version 0.0.1
%
% \date 2021/04/01
%
Expand Down Expand Up @@ -53,7 +53,7 @@
\addcontentsline{toc}{chapter}{List of Figures}

\listoftables
\addcontentsline{toc}{chapter}{Lista of Tables}
\addcontentsline{toc}{chapter}{List of Tables}

\printnomenclature
\addcontentsline{toc}{chapter}{Nomenclature}
Expand All @@ -66,6 +66,7 @@

\input{chapters/introduction}
\input{chapters/hardware}
\input{chapters/firmware}
\input{chapters/references}

\end{document}
Binary file not shown.

0 comments on commit 4fdc72c

Please sign in to comment.