Document potential todos in the documentation
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful

Signed-off-by: Severin Kaderli <severin@kaderli.dev>
This commit is contained in:
Severin Kaderli 2022-12-14 22:34:56 +01:00
parent 8ba1a79f8b
commit 296172f130
Signed by: severinkaderli
GPG key ID: F419F8835B72F0C4
11 changed files with 36 additions and 4 deletions

View file

@ -1,2 +1,3 @@
\addchap{Abstract}
Here an abstract might be placed.
// TODO: Create an abstract

View file

@ -7,3 +7,7 @@ What many of those technologies have in common is that they work on top of radio
Other reseach projects in this area exists and some have covered the use of the magnetic fields emitted from CPUs as a communication channel \cite{MagneComm} and other cover the general use of magnetic induction communication in body area networks \cite{magneticInductionBAN}.
This thesis will research the concept of communication using magnetic induction and will create a prototype implementation of a protocol that works through attempted manipulation of magnetic fields using a CPU in a Laptop. A simple user interface in the form of a website is created that allows an user to send text over the protocol and an Android application is used for receiving the text over the protocol.
// TODO: Reword the introduction
// TODO: Add more glossary entries

View file

@ -8,8 +8,6 @@ The main thread and Web Workers can communicate together using messages. They ca
Web Workers are used in this project to put a load on the CPU to modify the magnetic field without locking up the website itself.
\section{Hamming Distance}
\section{CRC}
\label{section:crc}
\gls{crc}
@ -17,3 +15,5 @@ Web Workers are used in this project to put a load on the CPU to modify the magn
\section{Manchester Code}
\section{Hall Sensor}
// TODO: Write these sections

View file

@ -6,3 +6,5 @@ to have solved. These motivations are then later used to create and describe the
Alice wants to be able to receive a small piece of data over a website, similar
to a QR code, with her smartphone but without other people being able to see the
code over her shoulders. She also wants to be able to receive data to her smartphone while it has connection available e.g. when it's in airplane mode.
// TODO: Document other potential personas

View file

@ -72,3 +72,6 @@
\end{reqTblr}
\caption{Non Functional Requirement 02}
\end{table}
// TODO: Clarify speed values

View file

@ -123,3 +123,5 @@ When receiving a message, the currently received text is displayed on the screen
\caption{App - Receving Completed - Mockup}
\end{minipage}
\end{figure}
// TODO: Replace mockups here with the final interface

View file

@ -1,6 +1,6 @@
\chapter{Testing}
\section{Devices}
The following devices were used the development and testing of MagSend. While theoretically MagSend should work on other Laptops and Smartphones I have only tested in on specified devices. For each device the most important specifications are listed.
The following devices were used for the development and testing of MagSend. While theoretically MagSend should work on other Laptops and Smartphones I have only tested in on specified devices. For each device the most important specifications are listed.
\subsection{Laptop}
\begin{table}[H]
@ -25,3 +25,8 @@ The following devices were used the development and testing of MagSend. While th
\caption{Testing Device - Smartphone\cite{GalaxyS9+}}
\end{table}
\section{Test Cases}
// TODO: Test cases in tabular form
// TOOD: Explain problem of testing over video call

View file

@ -1 +1,3 @@
\chapter{Benchmarking}
// TODO: Benchmarking different speeds with different loads

View file

@ -1 +1,3 @@
\chapter{Materials \& Methods}
// TODO: Ask if this is still necessary?

View file

@ -1 +1,3 @@
\chapter{Future Work}
// TODO: Improve robustness, speed, ui and ux

View file

@ -47,3 +47,12 @@
\end{ganttchart}
\caption{Project Plan}
\end{sidewaysfigure}
// TODO: Actual plan
// TODO: First subject: Speakers
// TODO: Organization / Planning / Mockups / Experiments / Meetings / Sickness
// TODO: Explain problems, pain points / learnings