Skip to content
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.

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

Documentation: Release v0.3 #166

Merged
merged 1 commit into from
Aug 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
SRC=main
TARGET=slb-eps2-doc-v0.2
VERSION=v0.3
TARGET=slb-eps2-doc-$(VERSION)

ifndef BUILD_DIR
BUILD_DIR=build
Expand Down
18 changes: 14 additions & 4 deletions doc/chapters/firmware.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%
% firmware.tex
%
% Copyright (C) 2021 by SpaceLab.
% Copyright The EPS 2.0 Contributors.
%
% EPS 2.0 Documentation
%
Expand All @@ -16,15 +16,25 @@
% \author Gabriel Mariano Marcelino <[email protected]>
% \author Yan castro de Azeredo <[email protected]>
%
% \institution Universidade Federal de Santa Catarina (UFSC)
%
% \version 0.2.0
% \version 0.3.0
%
% \date 2021/03/07
%

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

\section{Product tree}

The product tree of the firmware part of the EPS 2.0 module is available in \autoref{fig:product-tree-fw}.

\begin{figure}[!ht]
\begin{center}
\includegraphics[width=\textwidth]{figures/product-tree-fw.pdf}
\caption{Product tree of the firmware of the EPS 2.0 module.}
\label{fig:product-tree-fw}
\end{center}
\end{figure}

\section{Dependencies}

\section{Tasks}
Expand Down
20 changes: 15 additions & 5 deletions doc/chapters/system_overview.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%
% system_overview.tex
%
% Copyright (C) 2021 by SpaceLab.
% Copyright The EPS 2.0 Contributors.
%
% EPS 2.0 Documentation
%
Expand All @@ -16,9 +16,7 @@
% \author Gabriel Mariano Marcelino <[email protected]>
% \author Yan Castro de Azeredo <[email protected]>
%
% \institution Universidade Federal de Santa Catarina (UFSC)
%
% \version 0.2.0
% \version 0.3.0
%
% \date 2021/02/10
%
Expand All @@ -30,6 +28,18 @@ \chapter{System Overview} \label{ch:system-overview}

The EPS 2.0 is compatible with GOMspace Solar Panels or with panels of similar characteristics. Algorithms are implemented for MPPT improving power generation, also through measurements the load output can be regulated for a more efficient power distribution to the nanosattelite.

\section{Product tree}

The product tree of the EPS 2.0 module is available in \autoref{fig:product-tree}.

\begin{figure}[!ht]
\begin{center}
\includegraphics[width=0.8\textwidth]{figures/product-tree.pdf}
\caption{Product tree of the EPS 2.0 module.}
\label{fig:product-tree}
\end{center}
\end{figure}

\section{MCU Block Diagram}

The \autoref{fig:mcu-block-diagram} presents a simplified view of the module subsystems and interfaces though the microcontroller perspective.
Expand Down Expand Up @@ -135,4 +145,4 @@ \section{Hard Code Versioning}
\end{tabular}
\caption{Hard code versioning table.}
\label{tab:versioning-resistors}
\end{table}
\end{table}
1 change: 1 addition & 0 deletions doc/figures/product-tree-fw.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile host="Electron" modified="2022-03-08T02:16:36.851Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/16.5.1 Chrome/96.0.4664.110 Electron/16.0.7 Safari/537.36" etag="92JprAwhbRCXx-RzHqel" version="16.5.1" type="device"><diagram id="0qJPchqlG3AJ2SKAlhdZ" name="Page-1">7V1bc9o4FP41mek+NGNJvj4SaJvuNlM20DZ5dEAFTw3OGJPL/vo1weZyDgTiWhdUpw/FsjHyp09H5yqfsfbk6VMa3o+vkiGPz6g1fDpjnTNKKfH9/L9Fy/OyhTCbLVtGaTQs2tYNveg/XjRaRes8GvLZ1oVZksRZdL/dOEimUz7IttrCNE0ety/7mcTbv3ofjjhq6A3CGLf+iIbZeNnKmGWtT1zyaDQufjo/FSzPTMLy6uLS2TgcJo8bTezDGWunSZItP02e2jxewFcCs/zexz1nVz1L+TQ75guP/6TvO+1Jr//t9vt/l0/O939Hf78v7vIQxvPiiTtp9MDTWdHn7LlEIk3m0yFf3IucsYvHcZTx3n04WJx9zAc/bxtnk7g4/TOK43YSJ+nLdxlnAz9HLG9PptlGu/Xyl7fPsjT5xTfOXFiB83IGP2XZZZ5m/GmjqXjqTzyZ8Cx9zi8pzjK3GIGChLZdHD+uR5SUozTeGMzye2FBotHq1muY8w8F0m9AnWLU+UM04Cah7lDdUGcI9X44+2US5sSydAPdRqC3Ou1aIXeHvufaGPKfL3+7IGctx2akHshXCD8D2itD3NmBeI9Q2zeI6BB111KNuotFeo96nvfJZNR91ah7CPWPcTgbGyxfPFc15j7C/FP381eDIfeVL6IBgvwzze9kvbsKZxlP/zIY/ED5elqaohj9Xhw+8HrB10vAr/VJdehjC7X748pozJWvqgTbp1etmyBguTLvxvmvX9yl+adRtkLAzJEgytdagm1Ww9lPlS+2BJus/W7PsZ8sk3G31UsdbLh+a133Fwtt/8ZkFYc46uUMNl973c8mY87U65XYeO23W/kTk5bJwNvqVUpswSLA+XTYWoSP8qNBHM5m0WAb4/WALARyDk/6fLN5cLs4OHfKw87T5snOc3n0FGU36yvzo9vi/ovP6y8tDsrv7B2TWTJPB/y1515el4XpiGevXFesf3y4FRrDI7wxgM6O8SvbUh6HWfSwHVDbNajFL3STKH+ydfSGAQerD3ixfO7iW2tq4Bv54EYM3GgJDLpRzoPweeOy+8UFs/0dtkHgw3G24nL5h+Ud1wReYfobnMYugobT2CmuCacp4LRHKnKaAk67UGgK4rTLJHC6/M2G06+GHDThNNvnqH6znA4OTA5BnC5/RyynsTur4TQO6GjCaQoyR/yqcpqRA5NDFKcDGZzG7sKG0zhgpiung5o4vQqTCea078ngNHa8NpzGEUlNOU2sugR1IElQBzKMRIo92w2pd0R6NWE10qhpVVL7cHo4clhNLCl2Ig4cNLTeEULXhdbObh317bSGbCOSPHqESDEVcUymofWOLAVdaA18eoRWdVQjulFLFq+lmIs47tXwekfOhya8JihDw6vIaxLAO0GFRhSvqRSTsQkrvs5rzfzVBOqqgXNOnPU/WlErASU4hMnSSpgUG7IJNL7Ocr082JCNflWlBEYaiQ3VdlG0tmXYkOUcbWj9elKkJrTGDr/KvN6bjCea144MI5JpE2/cy9HD3NMreQPl90DrrLJbzpWlKTgy7DxGEfUuwizjL0N1lUyjLEkRF083o9oFK636QmCGY1jtefryiNTq8enMaPzVF6cyHG655GE+AQxGXX15KsPRgC8fOrVCrjajGkKuvjyVYU/1FR9GocE8V1+WyrAb9arb7RuMuQbVqAz7+LrJ40KiW+1k+vJoJkt3DWpTGfY/9fnknqdhNk85rk81Xs/RoEq1XIA2xuR7EmeLrdX+AEVTg5JVG1v5P8JsMB4mI4MVHw1q+Gxs47aTySScDndJovTB6NVB/SZMNrZ4c4srze5ys8ugibBehrXxNdj7bV04D3JFKQcnjo2aC2hINJgM2BBeGghWKx4laZSNJ0YPgHJV1cZmcTdMw/zmL/urGr8+oCFR7xyysdF8zcPhSk01azNQAL96R5GNzedelq/P83uTcVfvK7Kx0dx7nmU8XwCsaz7jRitHGriNysjjptMimvCl12ihDJlMfw2cRs5r9jFch82fEOo9RmVynfq0BLnpNsVTHkx5KGPnmqQ8OKBkAyUqHJvygILkMG2npowHBxrIMlIjnT+0ZvRYUtuakRoUbLiwKO5YUkOyrUgumNRSNmFxzKwZ1YWDUE5VzSVDeRiCNk2BHZayaYpjZoGn8RwUlCGOOCgjm9ExsxpTEw4Sy62JhDg2IqjWHXdZio5pZvGk+TQUlduNuixHKzSz1tF8Gub62rm18Qf6JoqUctREM0sT/wBSClIUMQ1laIrlbzY0FGKteMF5sPlXDyed4LXb+nDLA0GWjJSt7VxtSgJN5KdAMSmKhajLcmhIGxoaJiYDQaY2FJNSNkt0zYzmaMJPgWJSFAtRl+XQsPF9n6Lve7XzpWhZKGeLTbfxfp+mMBTGQ9RnSURs/N8nKQ6JpHi0nK1Z3cb9faLiUBQPsTiUQ8TG5X2a4lBSaoScHX1Lv1TDwpMTh7IiL5KI2Li2T1Icoi2lRYlDKRtBe7Rh4SmykDnbuRFUDielbNvsYW/2h24vb6DnFi6B+hilk8ecAYi2p1uW5gLYmfJiWA9n1vf5LDOqBJkANcBWjzr2p1/3v/ZqBV3xNjm+dphj7/HHlHPDcPegmq687NvDztLL1heDIKeWdlTHnsFOmis76ZfoziTgtduAyDPTE3aw+LKc44ffrKzXa2gJLCmuWn0JZYCo6kv4ygEp5R7lNNuxcYcxssS3dRPifv1upAoyYS1/1iLndkvi7JY/vyFL2LGyRK+X3NiAQazqG8ps8Iay1QaTNcsSD1KeWq/2C8oecL0g2VO/G8usWaCZXwxsZ8CgeKy6nQETFDJ96ySAbzGRMwkEbn9QE6EP8pRqxVM07NVzkbdvJCqI8Faewvkjh6f1p4nKNWOOVj30ehlUAN4iuXIrv5XNAVji6ZGR2doIVH+Gp1mrfTmrNSGe79QkRgNgPzNoiCsSo7BfcsSowPRSWcu9Xq+Prm25JxYUtYIym99KVJTrIoepAlNQ38ZUXRUFW6t5gFjC4AJ/9EQgh3QOVROBKrHQzHT8a0JbyIHK2TYoOipJzZDipi+n8uZrYOJk8KveXA61bvoATG71Ib8Au+kvk8Ro0NW/VSSgCPQer3sDf81AV75/eYCz974Y9WovCLn6N4UEAh2/OucTlFw/qF+Xa54uigrcBg/uLH6souID7VrUxn3QvyFHUWnquEU6g+GQVvbJwRVIEgel7B0ZNMWzp8hBUTuKww5L2SoyaJwGJ8lBQeWKiIMyihVJ+aMoV7jmEhCH2LtKQPZr9he0KA7ZS7Q3lIBQ6JBR7jcgFnYcdPhDNOBG1d5A4NX7DkhZUrf5StJk8Gt+bzbwyv0HxGp2ERMZ24GBj+oV+khaitrMDnVZhvlJrEb3P00eCnt9AeyyFBOUWI3+f5o8FGWFoi7XbYY60dM4pV5E7z5/nV8n6Xt6d/se66HfWtf9vOXd9c1feqlESP/ZQcC9KhEs0CCuzBqfndBjTfRHp18r5L8dUakXck+m3bUTcm02VN4pLA8m2+2fwarkLKyIqCxmV6nzq/kpaLmHPSZuzRvy7BwkA0J5x5D1YGzvWFJTlaRmQHAFcMU/mtRwox1PkC2FSO39ni2VH6ZJkm1enq8146tkyBdX/A8=</diagram></mxfile>
Binary file added doc/figures/product-tree-fw.pdf
Binary file not shown.
Binary file added doc/figures/product-tree-fw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/figures/product-tree.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile host="Electron" modified="2022-03-08T02:01:50.830Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/16.5.1 Chrome/96.0.4664.110 Electron/16.0.7 Safari/537.36" etag="p8aay4hya1f7gZtaDp2_" version="16.5.1" type="device"><diagram id="4dr5Hj_RP-3o1C2o8Qpe" name="Page-1">7Vxdc5s4FP01nuk+tAMIMDzaJm48bXezdba7eeoQkG3GgDxCju38+hVG2FjCiUv4CnUeWrgIgc49ku49Eu6BUbD9jO3V4htyod9TJHfbA1ZPUWTZ0Oh/sWWXWPqKkRjm2HNZoaNh6j1DZpSYde25MDopSBDyibc6NTooDKFDTmw2xmhzWmyG/NOnruw5FAxTx/ZF67+eSxaJFQBJOl64hd58wR5NL5nJlcBOS7Oi0cJ20SZjAjc9MMIIkeQo2I6gH6OXApPcNz5z9fBmGIbkkhsmP93o+5fJYuTef1Fm5sNK+/n8UUlqebL9NWvxzd2UGpRP6VuTXYoFRuvQhXFtcg8MNwuPwOnKduKrG+p9aluQwGeXZ57vj5CP8P5eAIFjUMyoHYUkY5f2f9QeEYyWMHNlKJna/orYTtb0J4gJ3GZMrN2fIQogwTtahF1VDNYaxsKD+zZHn8qpnxYZd+rMZjMazQ9VH4GmBwzrX8AdCLjf2tjd0EaWCrvuGn1dFWGf7f/yYAcDTQVyObAfIGWwq43Drgqwjz0clA57u9jePOyaALuFnHVAm2gTD4Udwl5V24a9KWAvwA1DdxDPlfTM8e0o8pxThI/uiFGCW4/8Fx9/0tjZAysXH1vbTDFrl56EtCmZm+LTh+y14237s/S+sx6J0Bo78PWJjdh4DsnrIwJ0T+IA0b8Z/2k57kttGPqU0k+n0UOeT9kT7pBHW3agjyZzExVPi6Td7K7sZM9XpHMVyVxFCTBCRXuKHZpdnHXp40qkXUEKFaFr9bQD7aKdxLHFKEo7jasIXEY7ygN7lym2igtE518YqPkvfO69ZD4APC1PD5I3KLcPpLPHdeh9KSpoSx/gKVJ06NVBsaG36j5wrpOX1QfmwwmWb1X08KcHcN/ur6xn8lHsApOQQDyLgzlFGtEQDSNaie5TZw4fMT2ax0dpeEjLfJiMrD+EfvN+I0SNT4qMGiPEXB+JGoAFI29Ow3LJgjMv9JIYnffR2PNjH36wrHGX/XOIpBrzj6gVDH3kLGP3ePYc20Gp6DcrGShS23qHKBlMnQUM6FTjRB0Gvnnai6LB3Yi2VPpq79CadBh6XW0ael2AXoC7aPJ2EoIeI9JWJG9soM0Gri8NyC0JXLkwUCuau5lcPRWlbnwqlkoelYah/SuhXyJ0u0SwPjcc8vnTpYTmlx80frysitFmDYw2rox+idHt0hY4RUA3CzLaOBMoVExovV8DocV1itvBV4HT7zfKA5wi33xmk6PRW5iSHJeb1zSbzvOwN5/X5MjCFnzyHNhl2JvPaWRR5vp+/9e0wyNMX2kcc1G6mu4iArukWPGoG3Wu+OejLkpW93a07PLwYjQ/mYpy1T2MSJdBN5ufSrspVLUla+H3MhVdERVisJpWRGuRluRuakud5yCfg1fFwTrEILmbalDXOZjqKlVzsBb9Ri5/o2lBDp7l06uqYZojdo14Cp8ZavUQL31OpcRLI87miVevFK5eSup2LVfK3BbRQ778y6SWmiG1Aeogdfl7R7tF6nYtWQoDLL8yU5TUBr+aXxGpzTpSpZTDV1K/rCG1hdTc+nm/6M4SmdtaYtYU95p15F6KqHG/ldRv2uVfUqz8Kqm1S0ndKk7r3AdWalFO6/xybkXbpfhd+7VoWspVV63xa6vCaZ2wVb0iTUvgYC3jqqirDqIIBo/+TvwWYRJGBK+d+EOFkldcNFnNW3E5v7Y4VNhazFkaFv8WofkV3XSUu44M72pkqEpp5F+4FqURiLnxDzoQ2EHclZN/6bl0h5ED3TXu0k878H5tfrMBaE1O99t27qqEL/6Fy1ZzB+NBZDlw+ag+rpdrQqTHv3/kfDD6TxT/RpMiVTfHv7VLC/03h4YXd+lad8rluqA1Pbr4FM91+Yv88c5HAaOmBPSN8jc9Pf7kWVL8+Mtx4OZ/</diagram></mxfile>
Binary file added doc/figures/product-tree.pdf
Binary file not shown.
Binary file added doc/figures/product-tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 5 additions & 7 deletions doc/header/authorpage.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%
% authorpage.tex
%
% Copyright (C) 2021 SpaceLab.
% Copyright The EPS 2.0 Contributors.
%
% EPS 2.0 Documentation
%
Expand All @@ -16,9 +16,7 @@
% \author Gabriel Mariano Marcelino <[email protected]>
% \author Yan Castro de Azeredo <[email protected]>
%
% \institution Universidade Federal de Santa Catarina (UFSC)
%
% \version 0.2.0
% \version 0.3.0
%
% \date 2021/06/07
%
Expand All @@ -29,7 +27,7 @@

\textbf{\thetitle}

\textit{June, 2021}
\textit{March, 2022}

\vspace{1cm}

Expand Down Expand Up @@ -71,7 +69,7 @@
\midrule
0.1 & G. Marcelino & Document creation & 2020/11/05 \\
0.2 & Y. C. Azeredo, G. Marcelino & First stable hardware & 2021/06/28 \\
& & & \\
0.3 & G. Marcelino, TBD & TBD & TBD \\
& & & \\
\bottomrule[1.5pt]
\end{tabular}
Expand All @@ -86,4 +84,4 @@
\end{center}
\end{figure}

\textcopyright\ 2021 by SpaceLab. \thetitle. This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit \href{http://creativecommons.org/licenses/by-sa/4.0/}{http://creativecommons.org/licenses/by-sa/4.0/}.
\textcopyright\ 2022 by SpaceLab. \thetitle. This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit \href{http://creativecommons.org/licenses/by-sa/4.0/}{http://creativecommons.org/licenses/by-sa/4.0/}.
10 changes: 4 additions & 6 deletions doc/header/titlepage.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%
% titlepage.tex
%
% Copyright (C) 2021 by SpaceLab.
% Copyright The EPS 2.0 Contributors.
%
% EPS 2.0 Documentation
%
Expand All @@ -16,9 +16,7 @@
% \author Gabriel Mariano Marcelino <[email protected]>
% \author Yan Castro de Azeredo <[email protected]>
%
% \institution Universidade Federal de Santa Catarina (UFSC)
%
% \version 0.2.0
% \version 0.3.0
%
% \date 2020/06/07
%
Expand All @@ -28,7 +26,7 @@
\thispagestyle{empty}

\begin{flushleft}
SLB-EPS2-DOC-v0.2
SLB-EPS2-DOC-v0.3
\end{flushleft}

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

\begin{flushright}
June 2021
March 2022
\end{flushright}

\end{titlepage}
Binary file not shown.