[docs] created files for later documentation topics

MitchiLaser · Feb 5, 2024 · 02e4a07 · 02e4a07
1 parent 4e10fa2
commit 02e4a07
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 0 deletions.
diff --git a/documentation/chap/firmware/chapter.tex b/documentation/chap/firmware/chapter.tex
@@ -0,0 +1,5 @@
+\chapter{Oscilloscope Firmware}
+
+\input{./chap/firmware/pc_link.tex}
+\input{./chap/firmware/scpi.tex}
+
diff --git a/documentation/chap/firmware/pc_link.tex b/documentation/chap/firmware/pc_link.tex
@@ -0,0 +1,3 @@
+\section{PC communication}
+
+\todo[inline]{write a chapter about the communication between the Raspberry Pi Pico and the PC: USB<->UART at extremely high baud rates}
diff --git a/documentation/chap/firmware/scpi.tex b/documentation/chap/firmware/scpi.tex
@@ -0,0 +1,5 @@
+\section{The SCPI Protocoll}
+
+\todo[inline]{explain the SCPI protocoll which will be evaluated on the Pico and used to transfer commands from the PC to the Oscilloscope}
+\todo[inline]{Explain how the state machine in the device looks like}
+
diff --git a/documentation/chap/hardware/chapter.tex b/documentation/chap/hardware/chapter.tex
@@ -5,3 +5,4 @@ \chapter{Hardware Design}
 \input{./chap/hardware/voltage_divider.tex}
 \input{./chap/hardware/op-amp.tex}
 \input{./chap/hardware/misc_electronics.tex}
+\input{./chap/hardware/schematics.tex}
diff --git a/documentation/chap/hardware/schematics.tex b/documentation/chap/hardware/schematics.tex
@@ -0,0 +1,4 @@
+\section{Designing the schematics}
+
+\todo[inline]{Explain how the schematics diagram works, how all values were calculated and why some test pins were placed on their locations. Maybe also write something about the pcb layout?}
+\todo[inline]{Design the PCB in a way that the backside has no electronic parts but a silk screen of all the schematics (mirrored) and all the test points should also be on this side}
diff --git a/documentation/main.tex b/documentation/main.tex
@@ -28,4 +28,5 @@
 
 	% main content
 	\include{./chap/hardware/chapter.tex}
+	\include{./chap/firmware/chapter.tex}
 \end{document}