add documentation

2022-04-05 20:04:11 +02:00 · 2022-04-05 20:04:11 +02:00 · 275c84b48f
commit 275c84b48f
parent c35537036b
6 changed files with 1592 additions and 0 deletions
--- a/Documentation/bib/book.bib
+++ b/Documentation/bib/book.bib
@ -0,0 +1,9 @@
+@book{example-book,
+  title      = {{Example Book}},
+  author     = {Lastname, Surname},
+  isbn       = {123456789},
+  address    = {Germany},
+  publisher  = {Goverment},
+  year       = {2019},
+  edition    = {Second}
+}
--- a/Documentation/bib/online.bib
+++ b/Documentation/bib/online.bib
@ -0,0 +1,23 @@
+@online{pio-install,
+  author  = {PlatformIO},
+  title   = {Installation},
+  urldate = {2022-03-24},
+  year    = {2022},
+  url     = {https://docs.platformio.org/en/latest//core/installation.html}
+}
+
+@online{pio-about,
+  author  = {PlatformIO},
+  title   = {What is PlatformIO},
+  urldate = {2022-03-24},
+  year    = {2022},
+  url     = {https://docs.platformio.org/en/latest//what-is-platformio.html}
+}
+
+@online{vscode-about,
+  author  = {Visual Studio Code},
+  title   = {Getting Started},
+  urldate = {2022-03-24},
+  year    = {2022},
+  url     = {https://docs.platformio.org/en/latest//what-is-platformio.html}
+}
--- a/Documentation/firststeps/firststeps.tex
+++ b/Documentation/firststeps/firststeps.tex
@ -0,0 +1,21 @@
+\section{PlatformIO Core}
+
+There are several ways to compile and upload code to a Mikrocontroller. The first Tests where written and compiled in the Arduino IDE\footnote{\href{https://www.arduino.cc/en/software}{https://www.arduino.cc/en/software}}. Because references and cross-platform developing was not easy with this approach, developing in this project will be done with the help of PlatformIO.
+
+``PlatformIO is a must-have tool for professional embedded systems engineers who develop solutions on more than one specific platform. In addition, by having a decentralized architecture, PlatformIO offers both new and existing developers a quick integration path for developing commercial-ready products, and reduces the overall time-to-market. [...] The build system structure automatically tags software dependencies and applies them using a modular hierarchy that takes away the usual complexity and pain. Developers no longer have to manually find and assemble an environment of toolchains, compilers, and library dependencies to develop applications for a specific target. With PlatformIO, clicking the compile button will bring in all necessary dependencies automatically.'
+
+\cite[cf.][]{pio-about}
+
+\subsubsection{Install}
+
+A dependency of PlatformIO is Python\footnote{\href{https://www.python.org/}{https://www.python.org/}}. To install the latest version of python, follow the installation instructions on their \href{https://www.python.org/}{website}.
+
+PlatformIO can now simply installed by downloading a script called ``get-platformio.py'' and executing it. On Apple MacOS\footnote{\href{https://en.wikipedia.org/wiki/MacOS}{https://en.wikipedia.org/wiki/MacOS}} it can simply be installed with the help of Homebrew Packages Manager\footnote{\href{https://brew.sh/}{https://brew.sh/}}.
+
+\subsubsection{Configure IDE}
+
+Developing and writing code for this project will be done in Visual Studio Code\footnote{\href{https://code.visualstudio.com/}{https://code.visualstudio.com/}}.
+
+``Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux. It comes with built-in support for JavaScript, TypeScript and Node.js and has a rich ecosystem of extensions for other languages (such as C++, C\#, Java, Python, PHP, Go) and runtimes (such as .NET and Unity).''
+
+\cite[][]{vscode-about}
--- a/Documentation/images/hs-esslingen.eps
+++ b/Documentation/images/hs-esslingen.eps
--- a/Documentation/main.tex
+++ b/Documentation/main.tex
@ -0,0 +1,111 @@
+\documentclass[
+   a4paper,
+   oneside,
+   parskip=half,
+   listof=entryprefix,
+   listof=totoc,
+   index=totoc,
+   bibliography=totoc
+]{scrartcl}
+
+\usepackage{silence}
+\WarningFilter{biblatex}{File 'british-iso.lbx'}
+\WarningFilter{biblatex}{'\mainlang'}
+
+\usepackage[utf8]{inputenc}
+\usepackage[british]{babel}
+\usepackage[T1]{fontenc}
+
+\usepackage{pdfpages,graphicx,subcaption,lastpage}
+\graphicspath{ {./images} }
+
+\usepackage{geometry}
+\geometry{a4paper, top=2.5cm, left=2.5cm, right=2.5cm, bottom=2.5cm}
+\usepackage{float,listings,xcolor,csquotes,microtype,scrlayer-scrpage,etoolbox}
+\usepackage[official]{eurosym}
+
+\definecolor{codegreen}{rgb}{0,0.6,0}
+\definecolor{codegray}{rgb}{0.5,0.5,0.5}
+\definecolor{codepurple}{rgb}{0.58,0,0.82}
+\definecolor{backcolour}{rgb}{0.95,0.95,0.92}
+\definecolor{weborange}{rgb}{1,0.65,0}
+
+\lstdefinestyle{mystyle}{
+    backgroundcolor=\color{backcolour},   
+    commentstyle=\color{codegreen},
+    keywordstyle=\color{magenta},
+    numberstyle=\tiny\color{codegray},
+    stringstyle=\color{codepurple},
+    emph={int,char,double,float,unsigned,void,bool},
+    emphstyle={\color{weborange}},
+    basicstyle=\ttfamily\footnotesize,
+    breakatwhitespace=false,
+    breaklines=true,
+    captionpos=b,
+    keepspaces=true,
+    numbers=left,
+    numbersep=5pt,
+    showspaces=false,
+    showstringspaces=false,
+    showtabs=false,
+    tabsize=2,
+    firstnumber=1,
+}
+\lstset{style=mystyle}
+
+\setuptoc{toc}{totoc}
+
+\usepackage[
+   backend=biber,
+   urldate=long,
+   style=iso-authoryear,
+   natbib=true,
+   useauthor=true,
+   mincitenames=1,
+   maxcitenames=3
+]{biblatex}
+\addbibresource{bib/online.bib}
+\addbibresource{bib/book.bib}
+
+
+\DeclareNameAlias{default}{family-given/given-family}
+
+\renewcommand*{\finalnamedelim}{\addspace{}und\space}
+\AtEveryCite{
+   \renewcommand*{\multinamedelim}{,\space}
+   \renewcommand*{\nameyeardelim}{\space}
+}
+
+\AtBeginBibliography{
+   \renewcommand*{\multinamedelim}{,\space}
+}
+\AfterTOCHead[lof]{\appto\autodot{:}}
+
+\definecolor{must-have-brown}{RGB}{51, 22, 18}
+\definecolor{should-have-red}{RGB}{229, 24, 31}
+\definecolor{could-have-orange}{RGB}{246, 121, 28}
+\definecolor{wont-have-blue}{RGB}{32, 169, 215}
+\newcommand{\morequirement}[1]{\paragraph{#1}\hfill\textbf{\textcolor{must-have-brown}{must-have}}\\}
+\newcommand{\srequirement}[1]{\paragraph{#1}\hfill\textbf{\textcolor{should-have-red}{should-have}}\\}
+\newcommand{\corequirement}[1]{\paragraph{#1}\hfill\textbf{\textcolor{could-have-orange}{could-have}}\\}
+\newcommand{\wrequirement}[1]{\paragraph{#1}\hfill\textbf{\textcolor{wont-have-blue}{won't-have}}\\}
+
+\ihead{Example Header}
+\chead{}
+\ohead{Surname Lastname}
+\ofoot{Seite~\thepage{}/\pageref{LastPage}}
+\cfoot{}
+\title{Example Title}
+\usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black,filecolor=black,urlcolor=black]{hyperref}
+
+\begin{document}
+
+    \include{titlepage/titlepage}
+    \tableofcontents
+    \newpage
+    \listoffigures
+    \include{firststeps/firststeps}
+
+    \printbibliography[title=Literaturverzeichnis]
+
+\end{document}
--- a/Documentation/titlepage/titlepage.tex
+++ b/Documentation/titlepage/titlepage.tex
@ -0,0 +1,28 @@
+\newcommand{\HRule}[2]{\noindent\rule[#1]{\linewidth}{#2}}
+\newcommand{\vlinespace}[1]{\vspace*{#1\baselineskip}}
+\newcommand{\titleemph}[1]{\textbf{#1}}
+\begin{titlepage}
+    \sffamily
+    \hfill
+    \includegraphics[width=5cm]{hs-esslingen}
+    \HRule{13pt}{1pt}
+    \centering
+    \Large
+    \vlinespace{5}\\
+    Student research project\\
+    \huge
+    \textbf{IoT Firewall\\for ESP8266/ESP32}\\
+    \Large
+    \vlinespace{5}
+    Software Engineering course\\
+    of the Faculty of Information Technology\\
+    in the 6th semester\\
+    \vlinespace{6}
+    \huge
+    \textbf{Florian Hoss}\\
+    \Large
+    \vfill
+    \raggedright{}
+    \HRule{13pt}{1pt} \\
+    \titleemph{Dozent:} Prof. Dr. rer. nat. Tobias Heer
+\end{titlepage}