diff --git a/Documentation/Chapters/04_Users Guide.tex b/Documentation/Chapters/04_Users Guide.tex index 0170793..d194c80 100644 --- a/Documentation/Chapters/04_Users Guide.tex +++ b/Documentation/Chapters/04_Users Guide.tex @@ -118,8 +118,8 @@ These instructions assume a disassembly according to Section \ref{sec:disassembl \section{Software Users Guide}\label{sec:software_guide} \subsection{Installation} \begin{enumerate} - \item Download latest release: \url{https://egit.irs.uni-stuttgart.de/zietzm/Helmholtz_Test_Bench_Releases/releases} - \item Unpack ZIP-folder and run "Helmholtz Cage Control.exe" + \item Download latest release: \url{https://egit.irs.uni-stuttgart.de/eive/Helmholtz_Test_Bench/releases} + \item Unpack ZIP-folder and run "Release{\textbackslash}Helmholtz Control.exe" \item Setup hardware and program according to Section \ref{sec:software_init} \end{enumerate} @@ -232,7 +232,7 @@ The manual input mode is used to set static currents or magnetic fields on the t \item For magnetic fields, choose whether ambient field should be compensated by (un)ticking the checkbox \item Press "Execute" button, devices will now implement set values \item Check console output to see if any errors occurred - \item Monitor behaviour in status display and on devices + \item Monitor behavior in status display and on devices \item When finished, press "Power Down All" button to remove currents from the test bench \end{enumerate} @@ -240,9 +240,9 @@ The manual input mode is used to set static currents or magnetic fields on the t This mode is used to run timed sequences of magnetic fields. These have to be defined in a \gls{csv} file of the following form: \begin{itemize} \item \textit{Column separator:} Semicolon (;) - \item \textit{Decimal:} Comma (,) + \item \textit{Decimal:} Comma (,) or Period (.) \item \textit{Line terminator:} Tested with Windows standard (\code{\textbackslash r\textbackslash n}), other options may work as well - \item \textit{Columns:} Time in seconds; X-axis, Y-axis and Z-axis flux density in Tesla + \item \textit{Columns:} Time in seconds; X-axis, Y-axis and Z-axis flux density in Tesla \end{itemize} An example for the \gls{csv} file structure is given below: %[caption=Example \gls{csv} file] @@ -285,10 +285,23 @@ The \gls{ui} layout is shown in Figure \ref{fig:csvmodepure}, its main elements \end{enumerate} \subsubsection*{Data Logging Configuration Page}\label{sec:logging_guide} -The application has the ability to log test bench data to a \gls{csv} file. The data is temporarily stored internally and must be saved to an external file by user request.\\ -An example of a log file is given in Appendix \ref{app:example_files}. The first three columns are time stamps: date, system time and time since the start of logging in seconds. The other columns contain the data, as selected by the user. All dynamic values from the status display can be logged, see Table \ref{tab:status_contents} for explanations. Each type of data is logged for all three axes. The units for numerical values are Volt, Ampere and Tesla.\\ -There are two options as for when and how often data is logged. The first option logs a row of data in a regular time interval specified by the user. The second option logs, whenever a significant command is sent to the test bench, for example when a new field vector is commanded. Both options can be used simultaneously.\\ -The logging configuration \gls{ui} is shown in Figure \ref{fig:loggingpure}. Its elements are listed below. +The application has the ability to log test bench data to a \gls{csv} file. +The data is temporarily stored internally and must be saved to an external file by user request. +The logging output is highly customizable using the options shown in Figure \ref{fig:loggingpure}. + +An example of a log file is given in Appendix \ref{app:example_files}. +Unless explicitly disabled, the first three columns are time stamps: date, system time and time since the start of logging in seconds. +All dynamic values from the status display as well as the magnetometer status can be logged, see Table \ref{tab:status_contents} for explanations. +Each type of data is logged for all three axes by default, but this can also be specified. +The units for numerical values are Volt, Ampere and Tesla. + +There are two options as for when and how often data is logged. +The first option logs a row of data in a regular time interval specified by the user. +The second option logs, whenever a significant command is sent to the test bench, for example when a new field vector is commanded. +Both options can be used simultaneously. + +The logging configuration \gls{ui} is shown in Figure \ref{fig:loggingpure}. +Its elements are listed below. \begin{figure}[h] \centering @@ -309,7 +322,8 @@ The logging configuration \gls{ui} is shown in Figure \ref{fig:loggingpure}. Its \item \textbf{"Datapoints logged" counter:} Displays the current number of logged data rows \item \textbf{"Log in regular intervals" controls:} Enable checkbox to periodically log data, set interval (in seconds) in the entry field to the right \item \textbf{"Log whenever test bench is commanded" checkbox:} Enable, to log data on significant changes to the test bench (e.g. a new field vector is commanded) - \item \textbf{Data selection checkboxes:} Select what data to log, explanations are given in Table \ref{tab:status_contents} + \item \textbf{Data selection checkboxes:} Select what data to log, explanations for most options are given in Table \ref{tab:status_contents}. + In addition, the Log X/Y/Z-Axis Data checkboxes specify whether the selected logging variables will be included for the respective axis. \end{itemize} \textbf{To collect and save log data:} \begin{enumerate} @@ -351,11 +365,10 @@ Figure \ref{fig:settingspure} shows a screenshot of the \gls{ui} layout with the \item Opens dialogue to let user choose new file path and name (must be *.ini) \item Reinitializes test bench devices with current settings \end{itemize} - \item \textbf{"\gls{psu} Serial Port" entries:} Input \gls{com} ports for both \gls{psu}s here + \item \textbf{"Serial Port" entries:} Input \gls{com} ports for both \gls{psu}s and the switch box here \begin{itemize} - \item Use Windows device manager to find correct port names (connect \gls{psu}s separately to differentiate between devices) + \item Use Windows device manager to find correct port names (connect devices separately to differentiate between devices) \item Test bench X- and Y-axes need to be connected to channel 1 and 2 of one \gls{psu}, Z-axis to channel 1 of the other - \item \textit{Note: Switch box Arduino should be found automatically} \end{itemize} \item \textbf{Program constant entry fields:} Set constants here, details are listed in Table \ref{tab:settings_entries} \item \textbf{"Update and Reinitialize" button:} Implements any changed settings in the program and on test bench devices, needs to be pressed for changes to take effect @@ -419,7 +432,7 @@ Figure \ref{fig:settingspure} shows a screenshot of the \gls{ui} layout with the \item If program has not been configured before: \begin{enumerate} \setcounter{enumii}{2} - \item Use Windows device manager to find correct serial \gls{com} ports for \gls{psu}s (connect /disconnect in turn to differentiate between devices) + \item Use Windows device manager to find correct serial \gls{com} ports for \gls{psu}s and Arduino (connect /disconnect in turn to differentiate between devices) \item Enter \gls{com} port names in application (switch box should be found automatically) \item Press "Update and Reinitialize" button \end{enumerate} @@ -435,6 +448,7 @@ Figure \ref{fig:settingspure} shows a screenshot of the \gls{ui} layout with the \setcounter{enumii}{5} \item Check console print to see if all devices were found, otherwise check physical connections and \gls{com} port settings \end{enumerate} + \item If using a magnetometer, the listening port is open and the adapter script can now be started \item Test configuration \begin{enumerate} \item Go to manual mode (Menu$\rightarrow$Static Manual Input) @@ -444,6 +458,7 @@ Figure \ref{fig:settingspure} shows a screenshot of the \gls{ui} layout with the \item Current should be activated on correct \gls{psu} channel \item For negative currents, corresponding status \gls{led} on switch box should light up and relay actuation be audible as clicking sound \end{itemize} + \item If using a magnetometer: Check the device output in either of the calibration-views \end{enumerate} \item Go back to the settings page (Menu$\rightarrow$Settings...) \item Change program constants as needed (e.g. enter measured ambient field), see Section \ref{sec:settings_guide} diff --git a/Documentation/Helmholtz Cage Software Documentation.pdf b/Documentation/Helmholtz Cage Software Documentation.pdf index 63c39e8..a46246a 100644 Binary files a/Documentation/Helmholtz Cage Software Documentation.pdf and b/Documentation/Helmholtz Cage Software Documentation.pdf differ diff --git a/Documentation/media/config_mode_pure.png b/Documentation/media/config_mode_pure.png index c4f8d3f..1a78f25 100644 Binary files a/Documentation/media/config_mode_pure.png and b/Documentation/media/config_mode_pure.png differ diff --git a/Documentation/media/logging_mode_pure.png b/Documentation/media/logging_mode_pure.png index 111f90c..7c32aa6 100644 Binary files a/Documentation/media/logging_mode_pure.png and b/Documentation/media/logging_mode_pure.png differ