From 296172f1302ce1741aaef69a1238e869a52cfcec Mon Sep 17 00:00:00 2001 From: Severin Kaderli Date: Wed, 14 Dec 2022 22:34:56 +0100 Subject: [PATCH] Document potential todos in the documentation Signed-off-by: Severin Kaderli --- documentation/thesis/content/00_abstract.tex | 3 ++- documentation/thesis/content/01_introduction.tex | 4 ++++ documentation/thesis/content/02_preliminaries.tex | 4 ++-- documentation/thesis/content/03_personas.tex | 2 ++ documentation/thesis/content/04_requirements.tex | 3 +++ documentation/thesis/content/05_solution.tex | 2 ++ documentation/thesis/content/06_testing.tex | 7 ++++++- documentation/thesis/content/07_benchmarking.tex | 2 ++ documentation/thesis/content/08_materials_methods.tex | 2 ++ documentation/thesis/content/09_future_work.tex | 2 ++ documentation/thesis/content/10_project_management.tex | 9 +++++++++ 11 files changed, 36 insertions(+), 4 deletions(-) diff --git a/documentation/thesis/content/00_abstract.tex b/documentation/thesis/content/00_abstract.tex index c393af1..de6956f 100644 --- a/documentation/thesis/content/00_abstract.tex +++ b/documentation/thesis/content/00_abstract.tex @@ -1,2 +1,3 @@ \addchap{Abstract} -Here an abstract might be placed. + +// TODO: Create an abstract diff --git a/documentation/thesis/content/01_introduction.tex b/documentation/thesis/content/01_introduction.tex index 59f4f91..c127bc9 100644 --- a/documentation/thesis/content/01_introduction.tex +++ b/documentation/thesis/content/01_introduction.tex @@ -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 diff --git a/documentation/thesis/content/02_preliminaries.tex b/documentation/thesis/content/02_preliminaries.tex index 558c69b..7203192 100644 --- a/documentation/thesis/content/02_preliminaries.tex +++ b/documentation/thesis/content/02_preliminaries.tex @@ -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 diff --git a/documentation/thesis/content/03_personas.tex b/documentation/thesis/content/03_personas.tex index c28a9d3..eb38e4f 100644 --- a/documentation/thesis/content/03_personas.tex +++ b/documentation/thesis/content/03_personas.tex @@ -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 diff --git a/documentation/thesis/content/04_requirements.tex b/documentation/thesis/content/04_requirements.tex index 9997071..ae94c80 100644 --- a/documentation/thesis/content/04_requirements.tex +++ b/documentation/thesis/content/04_requirements.tex @@ -72,3 +72,6 @@ \end{reqTblr} \caption{Non Functional Requirement 02} \end{table} + + +// TODO: Clarify speed values diff --git a/documentation/thesis/content/05_solution.tex b/documentation/thesis/content/05_solution.tex index 6be07f1..e081de0 100644 --- a/documentation/thesis/content/05_solution.tex +++ b/documentation/thesis/content/05_solution.tex @@ -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 diff --git a/documentation/thesis/content/06_testing.tex b/documentation/thesis/content/06_testing.tex index 372c289..bfa31aa 100644 --- a/documentation/thesis/content/06_testing.tex +++ b/documentation/thesis/content/06_testing.tex @@ -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 diff --git a/documentation/thesis/content/07_benchmarking.tex b/documentation/thesis/content/07_benchmarking.tex index afd3a86..429e7e7 100644 --- a/documentation/thesis/content/07_benchmarking.tex +++ b/documentation/thesis/content/07_benchmarking.tex @@ -1 +1,3 @@ \chapter{Benchmarking} + +// TODO: Benchmarking different speeds with different loads diff --git a/documentation/thesis/content/08_materials_methods.tex b/documentation/thesis/content/08_materials_methods.tex index f8c8690..8435d6f 100644 --- a/documentation/thesis/content/08_materials_methods.tex +++ b/documentation/thesis/content/08_materials_methods.tex @@ -1 +1,3 @@ \chapter{Materials \& Methods} + +// TODO: Ask if this is still necessary? diff --git a/documentation/thesis/content/09_future_work.tex b/documentation/thesis/content/09_future_work.tex index a6cd135..17e8384 100644 --- a/documentation/thesis/content/09_future_work.tex +++ b/documentation/thesis/content/09_future_work.tex @@ -1 +1,3 @@ \chapter{Future Work} + +// TODO: Improve robustness, speed, ui and ux diff --git a/documentation/thesis/content/10_project_management.tex b/documentation/thesis/content/10_project_management.tex index 58e8700..07aad1a 100644 --- a/documentation/thesis/content/10_project_management.tex +++ b/documentation/thesis/content/10_project_management.tex @@ -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