Merge pull request #3 from thomasnonis/develop

Report revision

Report/README.md

@@ -0,0 +1,17 @@
+# TU Delft - Report/Thesis Template
+
+This template aims to simplify and improve the (Xe)LaTeX report/thesis template by Delft University of Technology with the following three main design principles:
+
+* **Simplicity First:** A class file that has been reduced by nearly 70% to simplify customization;
+* **Effortless:** A careful selection of common packages to get started immediately;
+* **Complete:** Ready-to-go when it comes to the document and file structure.
+
+This template works with _pdfLaTeX_, _XeLaTeX_ and _LuaLaTeX_. In order to adhere to the TU Delft house style, either _XeLaTeX_ or _LuaLaTeX_ is required, as it supports TrueType and OpenType fonts. _BibLaTeX_ is used for the bibliography with as backend _biber_. Please visit https://dzwaneveld.github.io/report/ for the full documentation.
+
+<p align="center">
+  <img align="centre" src="https://github.com/dzwaneveld/TU-Delft-Unofficial-Report-Template/blob/master/figures/template.png" alt="Preview of the Template" width="85%" />
+</p>
+
+## License
+
+This [report/thesis template](https://github.com/dzwaneveld/TU-Delft-Unofficial-Report-Template) by Daan Zwaneveld is licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/). No attribution is required in PDF outputs created using this template.

Report/TODO.md

@@ -0,0 +1 @@
+Search for %TODO

Report/frontmatter/title-report.tex

@@ -0,0 +1,47 @@
+\begin{titlepage}
+
+\begin{center}
+
+%% Print the title
+{\makeatletter
+\largetitlestyle\fontsize{35}{35}\selectfont\@title
+\makeatother}
+
+%% Print the subtitle
+{\makeatletter
+\ifdefvoid{\@subtitle}{}{\bigskip\bigskip\qquad \; \titlestyle\fontsize{15}{15}\selectfont\@subtitle}
+\makeatother}
+
+\bigskip
+\bigskip
+
+by
+
+\bigskip
+\bigskip
+
+%% Print table with names and student numbers
+\setlength\extrarowheight{2pt}
+\begin{tabular}{lc}
+    Student Name & Student Number \\\midrule
+    Lisa Santarossa & 209386\\
+    Thomas Nonis & 209445\\
+    Tommaso Canova & 209270\\
+    Simone Tollardo & 209002\\
+    Gabriele Berretta & 209466 \\
+\end{tabular}
+
+\vfill
+
+%% Print some more information at the bottom
+\begin{tabular}{ll}
+    Docente: & Michele Corrà \\
+    Dipartimento: & Dipartimento di Ingegneria e Scienza dell'Informazione
+\end{tabular}
+
+\bigskip
+\bigskip
+
+\end{center}
+
+\end{titlepage}

Report/frontmatter/title-thesis.tex

@@ -0,0 +1,38 @@
+\begin{titlepage}
+
+\begin{center}
+
+%% Print the title
+{\makeatletter
+\largetitlestyle\fontsize{45}{45}\selectfont\@title
+\makeatother}
+
+%% Print the subtitle
+{\makeatletter
+\ifdefvoid{\@subtitle}{}{\bigskip\titlestyle\fontsize{30}{30}\selectfont\@subtitle}
+\makeatother}
+
+\bigskip
+\bigskip
+
+by
+
+\bigskip
+\bigskip
+
+%% Print the name of the author
+{\makeatletter
+\largetitlestyle\fontsize{25}{25}\selectfont\@author
+\makeatother}
+
+\bigskip
+\bigskip
+
+\vfill
+
+\bigskip
+\bigskip
+
+\end{center}
+
+\end{titlepage}

Report/layout/tudelft-report.cls

@@ -0,0 +1,207 @@
+% This template aims to simplify and improve the (Xe)LaTeX template provided
+% by the TU Delft. Original template by TU Delft. Rewritten template by Daan
+% Zwaneveld (https://dzwaneveld.github.io)
+%
+% This template by Daan Zwaneveld is licensed under CC BY-NC 4.0. To view a
+% copy of this license, visit https://creativecommons.org/licenses/by-nc/4.0/.
+% No attribution is required in PDF outputs created using this template.
+
+%% Class is based on the default book class and options will be passed
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesClass{layout/tudelft-report}[23-05-2022 v1.5.3 TU Delft Report Class]
+
+\DeclareOption*{\PassOptionsToClass{\CurrentOption}{book}}
+\ProcessOptions\relax
+\LoadClass[10pt,oneside]{book}
+
+%% Main packages in the document --- Some are imported later in the class file
+\RequirePackage{mathtools}  % Mathematical tools to use with amsmath
+\RequirePackage{amssymb}    % Extended symbol collection
+\RequirePackage{siunitx}    % Comprehensive (SI) units package
+
+\RequirePackage{tabularx}   % Tabulars with adjustable-width columns
+\RequirePackage{booktabs}   % Publication quality tables
+\RequirePackage{longtable}  % Allow tables to flow over page boundaries
+\RequirePackage{multirow}   % Create tabular cells spanning multiple rows
+
+\RequirePackage{graphicx}   % Enhanced support for images
+\RequirePackage{float}      % Improved interface for floating objects
+\RequirePackage[labelfont=bf,justification=centering,footnotesize]{caption} % Captions
+\RequirePackage{subcaption} % Support for sub-captions
+\RequirePackage{pdfpages}   % Include PDF documents
+
+\RequirePackage[pdfusetitle,hidelinks]{hyperref} % Extensive support for hypertext
+\RequirePackage[noabbrev]{cleveref} % Intelligent cross-referencing
+\RequirePackage{xcolor}     % Driver-independent color extensions
+\RequirePackage{tikz}       % Create PostScript and PDF graphics
+\RequirePackage{xspace}     % Define commands that appear not to eat spaces
+\RequirePackage{microtype}  % Refinements towards typographical perfection
+
+\RequirePackage{geometry}   % Customize document dimensions
+\RequirePackage{titlesec}   % Select alternative section titles
+\RequirePackage{titletoc}   % Alternative headings for toc
+\RequirePackage{fancyhdr}   % Control of page headers and footers
+\RequirePackage{enumitem}   % Control layout of itemize, enumerate, description
+\RequirePackage{etoolbox}   % Toolbox of programming facilities
+\RequirePackage{iftex}      % Adds if-else statements to support multiple compilers
+\RequirePackage{datetime}   % Change format of \today
+
+%% Defining commands for the cover image, subtitle, subject, affiliation and table of authors
+\newcommand*\subtitle[1]{\def\@subtitle{#1}}
+\newcommand*\subject[1]{\def\@subject{#1}}
+\newcommand*\affiliation[1]{\def\@affiliation{#1}}
+\newcommand*\coverimage[1]{\def\@coverimage{#1}}
+\newcommand*\covertable[1]{\def\@covertable{#1}}
+
+%% Scaling the margins to be slightly smaller than default (.7)
+\geometry{a4paper,hscale=0.75,vscale=0.8}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%% I. Loading the fonts %%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\ifPDFTeX
+    %% pdfLaTeX is available for compatibility and uses a Paletino-like font
+    \RequirePackage[T1]{fontenc}  % Selecting T1 font encoding
+    \RequirePackage{newpxtext}    % Palatino-like font...
+    \RequirePackage{newpxmath}    % ...with support for mathematics
+
+    %% Another font can be used as the regular and large title style font if desired
+    \def\titlestyle{\normalfont}
+    \def\largetitlestyle{\normalfont}
+
+    %% Warning when using pdfLaTeX
+    \@latex@warning@no@line{You are using pdfLaTeX as the compiler. You can safely ignore this warning or consider changing the compiler to XeLaTeX or LuaLaTeX to adhere to the TU Delft house style.}
+\else
+    %% If XeLaTeX or LuaLaTeX is set as the compiler, the TU Delft house style fonts are used
+    \RequirePackage{fontspec} % Advanced font selection
+
+    %% Adding Arial as the main font and TU Delft Ultralight and Georgia as supplementary fonts
+    \setmainfont{Arial}
+    \setmathsf{Arial}
+    \setmathtt{Arial}
+
+    \def\titlestyle{\normalfont} % Customize the regular title style font
+    \newfontfamily\largetitlestyle[Path=layout/tudelft/]{TUDelft-UltraLight.ttf}
+    \newfontfamily\quotefont{Georgia}
+
+    %% Changing the quote environment to use Georgia
+    \AtBeginEnvironment{quote}{\quotefont}
+\fi
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%% II. Adjusting the layout of the titles %%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%% Formatting chapter titles and spacing
+\titleformat{\chapter}[display]
+    {\flushright}
+    {\fontsize{40}{40}\selectfont\largetitlestyle\thechapter}
+    {0pt}
+    {\Huge\titlestyle}
+\titlespacing*{\chapter}{0pt}{0pt}{0\baselineskip}
+
+%% Formatting section titles and spacing
+\titleformat{\section}
+    {\Large\titlestyle\bfseries}
+    {\thesection.}
+    {5pt}
+    {}
+\titlespacing*{\section}{0pt}{\baselineskip}{0pt}
+
+%% Formatting subsections titles and spacing
+\titleformat{\subsection}
+    {\large\titlestyle\bfseries}
+    {\thesubsection.}
+    {5pt}
+    {}
+\titlespacing*{\subsection}{0pt}{\baselineskip}{0pt}
+
+%% Formatting subsubsections titles and spacing
+\titleformat{\subsubsection}
+    {\titlestyle\bfseries}
+    {}
+    {0pt}
+    {}
+\titlespacing*{\subsubsection}{0pt}{\bigskipamount}{0pt}
+
+%% Reducing the vertical white space between chapters in the table of contents
+\dottedcontents{chapter}[1.5em]{\vspace{0.5\baselineskip}\bfseries}{1.5em}{0pt}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%% III. Adjusting the header and footer %%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%% Changing the header and footer of 'plain' pages
+\fancypagestyle{plain}{%
+    \fancyhf{}
+    \renewcommand{\headrulewidth}{0pt}
+    \fancyfoot[C]{\titlestyle\thepage}}
+
+%% Changing the header and footer of 'fancy' pages (based on twoside option)
+\if@twoside
+    \fancyhf{}
+    \fancyhead[LE,RO]{\titlestyle\thepage}
+    \fancyhead[RE]{\titlestyle\nouppercase{\leftmark}}
+    \fancyhead[LO]{\titlestyle\nouppercase{\rightmark}}
+    \RequirePackage{emptypage} % Remove header and footer on empty pages
+\else
+    \fancyhf{}
+    \fancyhead[R]{\titlestyle\thepage}
+    \fancyhead[L]{\titlestyle\nouppercase{\rightmark}}
+\fi
+
+\pagestyle{fancy} % Setting the package defaults and the additional changes as the style
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%% IV. Creating the cover page %%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\newcommand*\makecover{
+    %% Use the Tikz library positioning and clear the page header and footer
+    \usetikzlibrary{positioning}
+    \thispagestyle{empty}
+
+    %% Constructing the cover page (cover image, name of university, logo and title text respectively)
+    \begin{tikzpicture}[overlay,remember picture]
+
+    \node[above=0,inner sep=0] at (current page.south) {\includegraphics[width=\paperwidth]{\@coverimage}};
+
+    % \node[above=10mm] at (current page.south) {%
+    %     \includegraphics[width=0.35\linewidth]{layout/UniTN-black.png}};
+
+    % \node[above=20mm] at (current page.center) {{\color{black}\titlestyle\fontsize{20}{20}\selectfont{Anno Accademico 2021-2022}}};
+
+    % \node[below=2cm,fill=black!100,minimum width={\paperwidth},inner ysep=25pt,opacity=0.8,text opacity=1] at (current page.north) {%
+    %     \begin{minipage}{0.9\paperwidth}
+    %         \begin{center}
+    %         \titlestyle\fontsize{25}{25}\selectfont\color{title}
+    %         \ifdefvoid{\@subtitle}{}{\@subtitle \\[1ex]}%
+    %         \color{white}\titlestyle\fontsize{25}{25}\selectfont
+    %         \ifdefvoid{\@subject}{}{\@subject \\[1ex]}
+    %         \color{white}\titlestyle\fontsize{30}{30}\selectfont
+    %         \@title \\[0.5ex]
+    %         \end{center}
+    %     \end{minipage}};
+
+    \end{tikzpicture}
+    \newpage
+}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%% V. Setting up listings %%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\RequirePackage{listings} % Typeset source code listings
+
+\lstset{
+  basicstyle=\ttfamily\footnotesize,  % Style of the font that is used for the code
+  backgroundcolor=\color{gray!10},    % Background color
+  keywordstyle=\color{red!75!black},  % Keyword style
+  stringstyle=\color{green!40!black}, % String style
+  commentstyle=\color{blue!30!black}, % Comment style
+  numbers=left,                       % Add line numbers on the left side
+  numbersep=5pt,                      % Decrease distance between line numbers and code
+  numberstyle=\tiny,                  % Line number style
+  breaklines=true,                    % Line break automatically
+}

Report/mainmatter/1-Abstract.tex

@@ -0,0 +1,66 @@
+\chapter{Abstract}
+
+La seconda parte del corso di Progettazione e Prototipazione di Sistemi
+Elettronici prevede la completa progettazione di una scheda elettronica
+che, nel nostro caso, ha come scopo quello di orientare in maniera
+ottimale un pannello fotovoltaico verso la posizione del sole nel
+cielo.\\
+Per rendere più funzionale possibile la scheda \textit{Solar Azimuth and eLevation Motorized lOcator} (``\emph{SALMO}'') si è deciso di
+rendere il tutto indipendente dalla posizione geografica, dall'orientamento del pannello fotovoltaico ed ovviamente
+% //TODO : rivedere
+dall'orario e dal giorno dell'anno. Il movimento del pannello è stato
+progettato in modo che la sua posizione sia sempre il più possibile
+perpendicolare ai raggi solari affinché la potenza generata dal pannello
+possa essere sempre massima.\\
+Per raggiungere l'obiettivo sono state stilate le seguenti specifiche:
+due motori passo-passo unipolari per il movimento sui due assi (Azimuth
+e Elevation), \emph{GPS} per rilevare la posizione geografica,
+magnetometro ed accelerometro per il feedback della posizione del
+pannello, circuiti di misura per tensione e corrente del pannello,
+display \textit{OLED} per la visualizzazione dei dati mediante interfaccia utente
+ed ovviamente un pannello fotovoltaico.
+La progettazione della scheda è stata svolta in maniera precisa,
+rigorosa ed organizzata, seguendo quindi dei passi ben definiti in modo
+che ogni membro del team potesse lavorare parallelamente agli altri ed
+allo stesso tempo contribuire al lavoro di tutti senza perdere step
+fondamentali.\\
+Inizialmente, facendo uso dei datasheet, abbiamo studiato
+approfonditamente le caratteristiche del microcontrollore \emph{RP2040}
+e dei componenti principali della scheda, al fine di poter progettare la
+\emph{PCB} in maniera più consapevole. Ogni studente del corso ha poi
+esposto alcune caratteristiche del microcontrollore, a partire dalla
+memoria fino alla struttura fisica passando per le varie interfacce di
+comunicazione, \emph{l'ADC}, i \emph{GPIO} e l'alimentazione.\\
+Ogni gruppo ha poi concordato con il professore il progetto da
+realizzare, fissando delle scadenze per la consegna dei vari schematici
+ed infine per la \emph{BOM}.\\
+Sono state decise inoltre delle specifiche di progetto uguali per ogni
+gruppo, come ad esempio le dimensioni della scheda (10x6 cm) ed il
+regolatore di tensione, in modo da avere delle BOM più uniformi
+possibili, senza decine di componenti alternativi non necessari. Dopo
+l'avvio vero e proprio del progetto in autonomia, le lezioni svolte in
+classe o in laboratorio erano principalmente volte alla correzione, alla
+revisione ed al debugging, facendo sì che ogni dubbio potesse essere
+chiarito immediatamente.\\
+Finito lo sbroglio circuitale siamo passati alla generazione e all'invio
+dei file gerber al Professore, che ha successivamente provveduto a
+spedire questi ultimi al produttore. Analogamente, dopo aver completato
+la \emph{BOM}, questa è stata inviata al Professore per il conseguente
+acquisto del materiale necessario. In seguito all'arrivo delle
+\emph{PCB} e dei componenti essenziali, abbiamo iniziato l'assemblaggio
+sfruttando la strumentazione offerta dal laboratorio di elettronica
+presente all'interno del FabLab. Dopo aver completato l'assemblaggio,
+realizzato gran parte del firmware, e svolto test a freddo prima (senza
+alimentazione) ed a caldo successivamente (con +5V USB e +12V), possiamo
+affermare che, benché ci siano ancora dei componenti mancanti, il
+prototipo è completamente funzionante (a meno di un piccolo errore, vedasi
+cap. \protect\hyperlink{led-rgb}{\underline{LED RGB}} ).
+Tutto il progetto della \emph{PCB} è stato svolto utilizzando il
+software open-source \emph{KiCad 6.0}, mentre per la progettazione del firmware
+abbiamo utilizzato l'\emph{IDE VS Code} e la compilazione manuale via
+\emph{CMake}.\\
+Per la gestione dell'intero progetto abbiamo deciso di avvalerci di un
+\emph{VCS (Version Control System)}: git.\\
+La repository è hostata su GitHub e può essere visionata cliccando sul
+seguente link:\\
+\href{https://github.com/thomasnonis/ppse-2021}{\underline{https://github.com/thomasnonis/ppse-2021}}.