Merge pull request #267 from spacelab-ufsc/dev

Dev: Release v0.7
spacelab-ufsc · Jun 9, 2021 · ce71309 · ce71309
2 parents b43ffbf + 2e8d4d2
commit ce71309
Show file tree

Hide file tree

Showing 275 changed files with 666,440 additions and 899,627 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -1,5 +1,5 @@
 SRC=main
-TARGET=slb-obdh2-doc-v0.6
+TARGET=slb-obdh2-doc-v0.7
 
 ifndef BUILD_DIR
 	BUILD_DIR=build

diff --git a/doc/chapters/assembly.tex b/doc/chapters/assembly.tex
@@ -1,7 +1,7 @@
 %
 % assembly.tex
 %
-% Copyright (C) 2020 by Universidade Federal de Santa Catarina.
+% Copyright (C) 2021 by Universidade Federal de Santa Catarina.
 %
 % OBDH 2.0 Documentation
 %
@@ -17,9 +17,9 @@
 %
 % \institution Universidade Federal de Santa Catarina (UFSC)
 %
-% \version 0.1.0
+% \version 0.7.0
 %
-% \date 12/05/2020
+% \date 2020/05/12
 %
 
 \chapter{Board Assembly} \label{ch:assembly}
@@ -52,7 +52,7 @@ \section{Custom Configuration}
     \centering
     \begin{tabular}{cllll}
         \toprule[1.5pt]
-        \textit{Label} & \textit{Interface} \\
+        \textbf{Label} & \textbf{Interface} \\
         \midrule
         J\_PC1            & I2C0\_SDA \\
         J\_PC2            & I2C0\_SCL \\

diff --git a/doc/chapters/firmware.tex b/doc/chapters/firmware.tex
@@ -1,7 +1,7 @@
 %
 % firmware.tex
 %
-% Copyright (C) 2020 by Universidade Federal de Santa Catarina.
+% Copyright (C) 2021 by Universidade Federal de Santa Catarina.
 %
 % OBDH 2.0 Documentation
 %
@@ -17,7 +17,7 @@
 %
 % \institution Universidade Federal de Santa Catarina (UFSC)
 %
-% \version 0.5.0
+% \version 0.7.0
 %
 % \date 2019/10/30
 %
@@ -32,16 +32,12 @@ \section{Dependencies}
     \centering
     \begin{tabular}{L{5cm}R{4cm}}
         \toprule[1.5pt]
-        \textit{Library}        & \textit{Version} \\
+        \textbf{Library}        & \textbf{Version} \\
         \midrule
             MSP430 DriverLib    & v2.91.11.01 \\
             FreeRTOS            & v10.2.1 \\
             NGHam protocol      & - \\
             libcsp              & v1.5.16 \\
-            FatFS               & R0.14 \\
-            Reliance Edge       & v2.4 \\
-            FreeMODBUS          & v1.6 \\
-            JSMN                & v1.1.0 \\
         \bottomrule[1.5pt]
     \end{tabular}
     \caption{External libraries and dependencies of the firmware.}
@@ -56,23 +52,24 @@ \section{Tasks}
     \centering
     \begin{tabular}{lccccc}
         \toprule[1.5pt]
-        \textit{Name}          & \textit{Priority} & \textit{Initial delay [ms]} & \textit{Period [ms]} & \textit{Stack [bytes]} \\
+        \textbf{Name}          & \textbf{Priority} & \textbf{Initial delay [ms]} & \textbf{Period [ms]} & \textbf{Stack [bytes]} \\
         \midrule
-        Startup (boot)         & Highest           & 0                           & Aperiodic            & 500                    \\
-        Deployment hibernation & Highest           & 0                           & Aperiodic            & TBD                    \\
-        Antenna deployment     & Highest           & 0                           & Aperiodic            & TBD                    \\
-        Watchdog reset         & Lowest            & 0                           & 100                  & 128                    \\
-        Heartbeat              & Lowest            & 0                           & 500                  & 128                    \\
-        Beacon                 & Medium            & 1000                        & 60000                & 2000                   \\
-        Uplink                 & Low               & 1000                        & 10000                & 500                    \\
-        EPS reading            & Medium            & 5000                        & 60000                & TBD                    \\
-        EDC reading            & High              & 5000                        & 1000                 & TBD                    \\
-        Payload X reading      & Medium            & 5000                        & 5000                 & TBD                    \\
-        TTC writing            & Medium            & 5000                        & 10000                & TBD                    \\
-        Radio periodoc reset   & Medium            & 600000                      & 600000               & 128                    \\
-        System reset           & High              & 0                           & 36000000             & 128                    \\
-        Read temperature       & Medium            & 0                           & 60000                & 128                    \\
-        CSP Server             & Lowest            & 0                           & 500                  & 1024                   \\
+        Startup (boot)         & Highest & 0      & Aperiodic & 350  \\
+        Deployment hibernation & Highest & 0      & Aperiodic & TBD  \\
+        Antenna deployment     & Highest & 0      & Aperiodic & TBD  \\
+        Watchdog reset         & Lowest  & 0      & 100       & 150  \\
+        Heartbeat              & Lowest  & 0      & 500       & 160  \\
+        Beacon                 & Medium  & 1000   & 60000     & 2000 \\
+        Uplink                 & Low     & 1000   & 10000     & 500  \\
+        EPS reading            & Medium  & 5000   & 60000     & 384  \\
+        EDC reading            & High    & 5000   & 60000     & 128  \\
+        Payload X reading      & Medium  & 5000   & 5000      & TBD  \\
+        TTC writing            & Medium  & 5000   & 10000     & TBD  \\
+        Radio periodoc reset   & Medium  & 600000 & 600000    & 128  \\
+        System reset           & High    & 0      & 36000000  & 128  \\
+        Read sensors           & Medium  & 0      & 60000     & 140  \\
+        CSP Server             & Lowest  & 0      & 500       & 1024 \\
+        Data log               & Medium  & 0      & 600000    & 225  \\
         \bottomrule[1.5pt]
     \end{tabular}
     \caption{Firmware tasks.}
@@ -135,14 +132,19 @@ \subsection{System reset}
 
 This task resets the microcontroller by software at every 10 hours. This can be useful to cleanup possible wrong values in variables, repeat the antenna deployment routine (limited to $n$ times), cleanup the RAM memory, etc.
 
-\subsection{Read temperature}
+\subsection{Read sensors}
 
-This task reads the internal temperature of the microcontroller of the OBDH at every 60 seconds.
+This task reads the internal sensors of the OBDH at every 60 seconds.
 
 \subsection{CSP Server}
 
 .
 
+
+\subsection{Data log}
+
+This tasks saves the housekeeping data of the satellite in the flash memory at every 10 minutes.
+
 \section{Variables and Parameters}
 
 The internal variables and parameters of the OBDH firmware can be seen in \autoref{tab:vars-and-pars}.
@@ -232,7 +234,7 @@ \subsection{Beacon}
         Last reset cause   & Last reset cause ID    & 1 \\
         System time        & System time in ticks   & 4 \\
         Radio temperature  & Raw radio temperature  & 4 \\
-        Last TC RSSI       & Raw RSSI value         & 2??? \\
+        Last TC RSSI       & Raw RSSI value         & 2 \\
         Last received TC   & Last received TC ID    & 1 \\
         Battery 1 voltage  & Raw battery 1 voltage  & 2 \\
         Battery 2 voltage  & Raw battery 2 voltage  & 2 \\
@@ -511,9 +513,9 @@ \section{Hardware Abstraction Layer (HAL)}
 
 The DriverLib is meant to provide a ``software'' layer to the programmer in order to facilitate higher level of programming compared to direct register accesses. By using the high level software APIs provided by DriverLib, users can create powerful and intuitive code which is highly portable between not only devices within the MSP430 platform, but between different families in the MSP430/MSP432 platforms.
 
-\section{File System}
+\section{Memory Management}
 
-As file system, the Reliance Edge library is used \cite{reliance_edge} (version 2.4). Reliance Edge is a failsafe filesystem with an small footprint, targeting critical embedded systems with fewer resources. It works with a broad array of storage media including: eMMC, SD/MMC, NVRAM, USB mass storage and SATA (or PATA) disk.
+.
 
 \section{Protocols}
 

diff --git a/doc/chapters/hardware.tex b/doc/chapters/hardware.tex
@@ -18,7 +18,7 @@
 %
 % \institution Universidade Federal de Santa Catarina (UFSC)
 %
-% \version 0.5.0
+% \version 0.7.0
 %
 % \date 2019/10/20
 %
@@ -111,7 +111,7 @@ \subsection{PC-104} \label{sec:pc104}
     \centering
     \begin{tabular}{cllll}
         \toprule[1.5pt]
-        \textit{Pin [A-B]} & \textit{H1A}     & \textit{H1B}     & \textit{H2A}  & \textit{H2B}  \\
+        \textbf{Pin [A-B]} & \textbf{H1A}     & \textbf{H1B}     & \textbf{H2A}  & \textbf{H2B}  \\
         \midrule
         1-2                & -                & -                & -             & -             \\
         3-4                & -                & -                & GPIO\_4       & GPIO\_5       \\
@@ -153,7 +153,7 @@ \subsection{Antenna Module}
     \centering
     \begin{tabular}{cllll}
         \toprule[1.5pt]
-        \textit{Pin} & \textit{Row} \\
+        \textbf{Pin} & \textbf{Row} \\
         \midrule
         1            & VCC\_3V3\_ANT  \\
         2            & VCC\_3V3\_ANT  \\
@@ -193,7 +193,7 @@ \subsection{Programmer and Debug} \label{sec:programer-and-debug}
     \centering
     \begin{tabular}{cllll}
         \toprule[1.5pt]
-        \textit{Pin [A-B]} & \textit{Row A} & \textit{Row B} \\
+        \textbf{Pin [A-B]} & \textbf{Row A} & \textbf{Row B} \\
         \midrule
         1-2                & TDO\_TDI       & VCC\_3V3       \\
         3-4                & -              & -              \\
@@ -212,7 +212,7 @@ \subsection{Programmer and Debug} \label{sec:programer-and-debug}
     \centering
     \begin{tabular}{cllll}
         \toprule[1.5pt]
-        \textit{Pin} & \textit{Row} \\
+        \textbf{Pin} & \textbf{Row} \\
         \midrule
         1            & VCC\_3V3       \\
         2            & TDO\_TDI       \\
@@ -260,7 +260,7 @@ \subsection{Daughterboard} \label{sec:daughterboard-interface}
     \centering
     \begin{tabular}{cllll}
         \toprule[1.5pt]
-        \textit{Pin [A-B]} & \textit{Row A} & \textit{Row B} \\
+        \textbf{Pin [A-B]} & \textbf{Row A} & \textbf{Row B} \\
         \midrule
         1-2                & VCC\_3V3       & GND            \\
         3-4                & VCC\_3V3\_ANT  & GND            \\
@@ -306,7 +306,7 @@ \section{Microcontroller}
     \centering
     \begin{tabular}{cllllllll}
         \toprule[1.5pt]
-        \textit{Flash} & \textit{SRAM} & \textit{Timers} & \textit{USCI} & \textit{ADC} & \textit{DAC} & \textit{GPIO} \\
+        \textbf{Flash} & \textbf{SRAM} & \textbf{Timers} & \textbf{USCI} & \textbf{ADC} & \textbf{DAC} & \textbf{GPIO} \\
         \midrule
         512KB  & 64KB  & 2  & 6 (SPI / I2C / UART)  & 12  & 2  & 74           \\
         \bottomrule[1.5pt]
@@ -331,9 +331,9 @@ \subsection{Interfaces Configuration}
     \centering
     \begin{tabular}{lrrrrl}
         \toprule[1.5pt]
-        \textit{Interface} & \textit{Protocol (Index)} & \textit{Mode} & \textit{Word Length} & \textit{Data Rate} & \textit{Configuration} \\
+        \textbf{Interface} & \textbf{Protocol (Index)} & \textbf{Mode} & \textbf{Word Length} & \textbf{Data Rate} & \textbf{Configuration} \\
         \midrule
-        USCI\_A0           & SPI                       & Master        & 8 bits               & 400 kbps           & Phase: High \\
+        USCI\_A0           & SPI                       & Master        & 8 bits               & 1 Mbps             & Phase: High \\
                            &                           &               &                      &                    & Polarity: Low \\
         USCI\_A1           & UART1                     & -             & 8 bits               & 115200 bps         & Stop bits: 1 \\
                            &                           &               &                      &                    & Parity: None \\
@@ -366,7 +366,7 @@ \subsection{Pinout}
 
 \begin{longtable}{lcl}
     \toprule[1.5pt]
-    \textit{Pin Code} & \textit{Pin Number} & \textit{Signal}       \\
+    \textbf{Pin Code} & \textbf{Pin Number} & \textbf{Signal}       \\
     \midrule
     P1.0              & 34                  & MAIN\_RADIO\_ENABLE   \\
     P1.1              & 35                  & MAIN\_RADIO\_GPIO0    \\

diff --git a/doc/figures/obdh2-pcb-3d.png b/doc/figures/obdh2-pcb-3d.png
diff --git a/doc/header/authorpage.tex b/doc/header/authorpage.tex
@@ -17,7 +17,7 @@
 %
 % \institution Universidade Federal de Santa Catarina (UFSC)
 %
-% \version 0.6.0
+% \version 0.7.0
 %
 % \date 2019/07/18
 %
@@ -28,7 +28,7 @@
 
 \textbf{\thetitle}
 
-\textit{January, 2021}
+\textit{June, 2021}
 
 \vspace{1cm}
 
@@ -64,8 +64,8 @@
             \midrule
             0.1     & Gabriel M. Marcelino        & Document creation     & 10/2019    \\
             0.5     & Gabriel M. Marcelino        & First stable hardware & 08/2020    \\
-            0.6     & A. M. P. Mattos, G. M. Marcelino, Y. A. Azeredo & TBC & TBD      \\
-                    &                             &                       &            \\
+            0.6     & A. M. P. Mattos, G. M. Marcelino, Y. A. Azeredo & First hardware integration & 04/2021  \\
+            0.7     & A. M. P. Mattos, G. M. Marcelino, Y. A. Azeredo & General firmware and hardware improvements & 06/2021      \\
                     &                             &                       &            \\
             \bottomrule[1.5pt]
         \end{tabular}

diff --git a/doc/header/titlepage.tex b/doc/header/titlepage.tex
@@ -17,7 +17,7 @@
 %
 % \institution Universidade Federal de Santa Catarina (UFSC)
 %
-% \version 0.6.0
+% \version 0.7.0
 %
 % \date 2019/07/18
 %
@@ -27,7 +27,7 @@
 \thispagestyle{empty}
 
 \begin{flushleft}
-SLB-OBDH2-DOC-v0.6
+SLB-OBDH2-DOC-v0.7
 \end{flushleft}
 
 \vspace{1cm}
@@ -54,7 +54,7 @@
 \vfill
 
 \begin{flushright}
-January 2021
+June 2021
 \end{flushright}
 
 \end{titlepage}
diff --git a/doc/slb-obdh2-doc-v0.6.pdf → doc/slb-obdh2-doc-v0.7.pdf b/doc/slb-obdh2-doc-v0.6.pdf → doc/slb-obdh2-doc-v0.7.pdf