From 796c3df94bef89b73a76d1b4649f297f77899596 Mon Sep 17 00:00:00 2001 From: Martin Zietz Date: Sat, 27 Mar 2021 14:10:06 +0100 Subject: [PATCH] documentation --- .gitignore | 1 + Documentation/Chapters/03_Software.tex | 6 ++++-- Documentation/Chapters/04_Users Guide.tex | 10 +++++----- .../Helmholtz Cage Software Documentation.tex | 4 ---- Documentation/Preamble/TitlePage.tex | 14 +++++--------- 5 files changed, 15 insertions(+), 20 deletions(-) diff --git a/.gitignore b/.gitignore index 0d0cc32..f39bb04 100644 --- a/.gitignore +++ b/.gitignore @@ -103,3 +103,4 @@ ENV/ config.ini *.ini log.csv +Documentation/Helmholtz Cage Software Documentation.pdf diff --git a/Documentation/Chapters/03_Software.tex b/Documentation/Chapters/03_Software.tex index 0c6153c..9f3742d 100644 --- a/Documentation/Chapters/03_Software.tex +++ b/Documentation/Chapters/03_Software.tex @@ -1,6 +1,8 @@ -\chapter{Control Software}\label{chp:software} +\chapter{Software Implementation}\label{chp:software} \section{Program Structure} -To operate the test bench, a Python software with graphical \gls{ui} was developed. It controls the used PS2000B \gls{psu}s as well as the Arduino microcontroller inside the switch box. This chapter focuses on the overall implementation, More detailed information is provided in the form of comments in the source code, which is available on the \gls{irs} git server.\footnote{\url{https://egit.irs.uni-stuttgart.de/zietzm/Helmholtz_Test_Bench.git}} A users guide can be found in Section \ref{sec:software_guide}.\\ +\glsunset{psu} +\glsunset{irs} +To operate the test bench, a Python software with graphical \gls{ui} was developed. It controls the used PS2000B Power Supply Units (\gls{psu}) as well as the Arduino microcontroller inside the switch box. This chapter focuses on the overall implementation. More detailed information is provided in the form of comments in the source code, which is available on the \gls{irs} git server.\footnote{\url{https://egit.irs.uni-stuttgart.de/zietzm/Helmholtz_Test_Bench.git}} A users guide can be found in Section \ref{sec:software_guide}.\\ Software development and testing were done in Windows 10 and Python 3.7. Some aspects may need to be adapted to use the software on a different operating system or Python version. The code was tested with a \gls{psu} or the switch box individually. However, integrated verification with both \gls{psu}s and the switch box Arduino connected simultaneously was not possible up to this point, as some of the equipment was located inside the \gls{irs} cleanroom.\\ The program file architecture is shown in Figure \ref{fig:softwarelayout}. This is meant to give an overview of the structure, therefore it does not show all interactions between the files. \begin{figure}[hb] diff --git a/Documentation/Chapters/04_Users Guide.tex b/Documentation/Chapters/04_Users Guide.tex index 8be5a0a..5bbfd6c 100644 --- a/Documentation/Chapters/04_Users Guide.tex +++ b/Documentation/Chapters/04_Users Guide.tex @@ -1,5 +1,5 @@ \chapter{Operating Instructions}\label{chp:users_guide} -\section{Assembly Instructions} +\section{Test Bench Assembly Instructions} Because of the limited space available in the \gls{irs} cleanroom, the test bench may need to be disassembled and reassembled in the future. Instructions for this are provided here. Mentioned position numbers relate to those shown in Figure \ref{fig:assembly}. \begin{figure}[h] @@ -76,7 +76,7 @@ The used slot nuts are wedged in the structural profiles and will stay in place \subsection{Reassembly Procedure} \myparagraph{Notes:} -These instructions assume a disassembly according to Section \ref{sec:disassembly}. Most slot nuts should still be in place and simplify positioning the parts. However, the angle pieces do allow some tolerance, so care should still be taken to get the correct alignments. The desired dimensions are shown in the drawings in Appendix \ref{Drawings}. +These instructions assume a disassembly according to Section \ref{sec:disassembly}. Most slot nuts should still be in place and simplify positioning the parts. However, the angle pieces do allow some tolerance, so care should still be taken to get the correct alignments. \paragraph{Procedure:} \begin{enumerate} @@ -89,14 +89,14 @@ These instructions assume a disassembly according to Section \ref{sec:disassembl \begin{enumerate} \item Lift +X coil (A4) onto cross-member profiles (07); mind wire exit position (Fig. \ref{fig:cable_routing2}) \item If needed, adjust cross-member profile height; coil should be supported equally on upper and lower profiles without bending - \item Centre coil and secure with 3D-printed brackets (19) (see also Figure \ref{fig:bracket_vert}) + \item Centre coil and secure with 3D-printed brackets (19) \item Repeat for -X (A4)and Y-axis coils (A5) \end{enumerate} \item Install Z-axis coils (A6) \begin{enumerate} \item Attach lower coil support profiles (08) \item Lift -Z coil over X/Y coils onto support profiles; mind wire exit position (Fig. \ref{fig:cable_routing2}) - \item Centre coil and secure with 3D-printed brackets (20) (see also Figure \ref{fig:bracket_horiz}) + \item Centre coil and secure with 3D-printed brackets (20) \item Repeat for upper support profiles and +Z coil \end{enumerate} \item Make electrical connections @@ -372,7 +372,7 @@ Figure \ref{fig:settingspure} shows a screenshot of the \gls{ui} layout with the \begin{itemize} \setlength\itemsep{-0.2em} \item Used to calculate current needed to achieve desired field - \item Must be measured and tuned before test campaigns (see Chapter \ref{chp:measurements} for possible method) + \item Must be measured and tuned before test campaigns \end{itemize}\\[-4pt] Ambient Field: & -200 to \SI{200}{\micro\tesla} & Background magnetic field in the measurement area \vspace{-1.5mm} \begin{itemize} diff --git a/Documentation/Helmholtz Cage Software Documentation.tex b/Documentation/Helmholtz Cage Software Documentation.tex index ba808b7..6554144 100644 --- a/Documentation/Helmholtz Cage Software Documentation.tex +++ b/Documentation/Helmholtz Cage Software Documentation.tex @@ -129,10 +129,6 @@ \setlength{\parindent}{0mm} %\setlength{\unitlength}{1mm} -% "Teaches" LaTeX hyphenation of uncommon words -\hyphenation{La-ge-rung} -\hyphenation{Klink-ner} - %\sloppy % ******************************************************************** diff --git a/Documentation/Preamble/TitlePage.tex b/Documentation/Preamble/TitlePage.tex index d8919c2..07919ee 100644 --- a/Documentation/Preamble/TitlePage.tex +++ b/Documentation/Preamble/TitlePage.tex @@ -3,13 +3,8 @@ \begin{textblock*}{124mm}(51mm,47mm) \begin{center} \begin{Large} -\textbf{Aufbau eines Magnetfeldteststandes zur Verifikation von CubeSat Lagekontrollsystemen}\\[3mm] -\textbf{Construction of a CubeSat Magnetic Field Cage for the Verification of CubeSat Attitude Control Systems}\\[5mm] +\textbf{Helmholtz Test Bench Control Software Documentation}\\[5mm] \end{Large} -Bachelorarbeit von\\ -stud. aer. Martin Zietz\\ -IRS-20-S-093 - \end{center} \end{textblock*} @@ -17,9 +12,10 @@ IRS-20-S-093 \begin{textblock*}{124mm}(51mm,180mm) \begin{center} -Pr{\"u}ferin:\\ -Prof. Dr. Sabine Klinkner\\ -Betreuer:\\ +Author:\\ +Martin Zietz\\ + +Supervisors:\\ M.Sc. Markus T. Koller\\ M.Sc. Lukas-Maximilian Loidold\\ \end{center}