feat(docs): Add procedure for data saving export (#90)

Co-authored-by: HELIOS <[email protected]>

src/dacs-sw/data-saving-and-export/sections/deinstallation.tex

@@ -8,6 +8,46 @@
   ID & CK 1 & CK 2 & CK 3 & Description \\ \hline
 
   \procedureItem{
-    REPLACE ME
+    After ROS has been stopped, navigate to the \texttt{catkin\_ws/src/rosbags} folder and to the following:
+    \begin{itemize}
+      \item select all files (CTRL-A), right-click and select Compress...
+
+      \item select .zip and name the file according to the test designation. Save it in the same rosbags folder.
+            \\
+            \includegraphics[width=0.5\textwidth]{assets/table-screenshot.png}
+
+
+      \item if it complains about a file with an .active extension, just delete that file and try again
+
+      \item Upload this .zip file to sharepoint into the folder /Data/\textless testtype\textgreater /\textless specifictest\textgreater  (see installation)
+
+      \item As well as move this file to the folder catkin\_ws/src/archivedbags
+
+      \item Double check that you uploaded this data correctly
+
+      \item select all files in the rosbags folder and delete them
+    \end{itemize}
+  }
+
+  \procedureItem{
+    Save the Config file in \texttt{/home/git/configuration\_tests} to the folder mentioned above (Data/ testfolder/Configuration)
+  }
+
+  \procedureItem{
+    Save test \texttt{list.csv} and \texttt{test\_sequences.csv} in
+    \texttt{/home/git/software-rpi4/state\_machine/src}
+    to the folder mentioned above (Data/ testfolder/Configuration)
+  }
+
+  \procedureItem{
+    Save the videos from the screen recordings and potential screenshots in the Videos or Pictures folder
+  }
+
+  \procedureItem{
+    Save the ROS graphs created during the test in the corresponding folder in sharepoint inside a new folder named ROS Plots
+  }
+
+  \procedureItem{
+    Download recorded video material from surveillance modem (can also be done at a later point)
   }
 \end{tabularx}

src/dacs-sw/data-saving-and-export/sections/during-test.tex

@@ -8,6 +8,8 @@
   ID & CK 1 & CK 2 & CK 3 & Description \\ \hline
 
   \procedureItem{
-    REPLACE ME
+    Regularly save the live plots from plotjuggler, especially after failed attempts or problems for in-place analysis.
+
+    For that, click 'Stop' in the upper left corner, then right click on the plots and choose 'Save as .png'
   }
 \end{tabularx}

src/dacs-sw/data-saving-and-export/sections/export.tex

@@ -8,6 +8,69 @@
   ID & CK 1 & CK 2 & CK 3 & Description \\ \hline
 
   \procedureItem{
-    REPLACE ME
+    Make sure configFile is the same as the one being used for the test (especially Firing Parameter Specification!) (the right Configuration file should be in the designated folder of the test)
+  }
+
+  \procedureItem{
+    To connect to sql server type in terminal:
+  \\
+    \texttt{sudo service mysql start}
+  }
+
+  \procedureItem{
+    To configure db run:
+  \\
+    \texttt{cd /home/dacs/git/data-management/database\_pro}
+  \\
+    For this the Config File should be in the folder above
+  \\
+    \texttt{python3 configure\_db.py}
+  \\
+    In the above the script the right config file name has to be used
+  }
+
+  \procedureItem{
+    To read in rosbag run:
+  \\
+    For this the Folder with bagfiles (unzipped) should be in the  \texttt{database\_pro} folder
+  \\
+    Before you run this command you need to adapt the folder
+    name in the Code
+  \\
+    \texttt{python3 read\_bag.py}
+  \\
+    (This might take some time)
+  }
+
+  \procedureItem{
+    To plot data run:
+  \\
+    \texttt{python3 data\_analysis.py}
+  \\
+    (adapt code, a few instructions are in the code file)
+  }
+
+  \procedureItem{
+    To find out configid:
+    Make sure sql server is running
+  \\
+    \texttt{mysql -u root -p}
+    password: \texttt{aris}
+  \\
+    \texttt{use dacs;}
+  \\
+    \texttt{Select * from tests;}
+  \\
+    This should return a table with the tests and configIds
+  \\
+    To exit this view you can type \texttt{exit}
+  }
+
+  \procedureItem{
+    Once you're finished enter in terminal:
+  \\
+    \texttt{sudo service mysql stop}
+  \\
+    to stop SQL
   }
 \end{tabularx}

src/dacs-sw/data-saving-and-export/sections/notes.tex

@@ -5,6 +5,6 @@
   \hline
 
   \noteItem{
-    \textbf{REPLACE ME}
+    \textit{none}
   }
 \end{tabularx}

src/dacs-sw/data-saving-and-export/sections/operation-description.tex

@@ -1,2 +1,2 @@
 % Operation description
-\textbf{REPLACE ME}
+Save data of a test and export it to the database.

src/dacs-sw/data-saving-and-export/sections/preparation.tex

@@ -8,6 +8,42 @@
   ID & CK 1 & CK 2 & CK 3 & Description \\ \hline
 
   \procedureItem{
-    REPLACE ME
+    Before starting a test, create a folder for it on sharepoint if it doesn't already exist:
+  \\
+    Create a folder with the name testtype in /Data/
+  \\
+    Inside that folder, make a new folder with the test designation.
+  }
+
+  \procedureItem{
+    Inside the test specific folder, create a folder named Configuration where later the configuration files (\texttt{PRO\_DACS-Configuration}, \texttt{state\_machine\_list}, \texttt{state\_machine\_sequences}) used for that specific test should be saved in
+  }
+
+  \procedureItem{
+    Create a new folder called Rosbags inside the test specific folder
+  }
+
+  \procedureItem{
+    Create a new folder called Videos inside the test specific folder
+  }
+
+  \procedureItem{
+    Create a new folder called Photos inside the test specific folder
+  }
+
+  \procedureItem{
+    Make sure that the folder \texttt{catkin\_ws/src} contains a folder with the name rosbags.
+  \\
+    \noindent
+  \\
+    Before starting a new test, make sure that those folders are empty. If not, go to deinstallation.
+  }
+
+  \procedureItem{
+    Make sure that the launch file used for the test launches the rosbags node, i.e. you can see a line in the .launch file that looks like this (with the correct path):
+
+    \texttt{
+      <node pkg="rosbag" type="record" name="recorder" args="record -a -o /home/\textbf{dacs}/catkin\_ws/src/rosbags/test --split --duration=300"/>
+    }
   }
 \end{tabularx}

src/dacs-sw/data-saving-and-export/sections/required-documents.tex

@@ -1,2 +1,2 @@
 % Required documents
-\textbf{REPLACE ME}
+\textit{none}

src/dacs-sw/data-saving-and-export/sections/required-materials.tex

@@ -1,2 +1,2 @@
 % Required materials
-\textbf{REPLACE ME}
+\textit{none}

src/dacs-sw/data-saving-and-export/sections/required-tools.tex

@@ -4,5 +4,16 @@
   \hline
   \rowcolor{tableHeaderColor}
   Check & Amount & Description \\ \hline
-  \checklistItem{X}{Replace Me}
+  \checklistItem{1}{Mission Control PC}
+  \checklistItem{2}{Monitor}
+  \checklistItem{1}{Keyboard}
+  \checklistItem{1}{Mouse}
+  \checklistItem{1}{Wifi Adapter}
+  \checklistItem{1}{Power Adapter for PC}
+  \checklistItem{2}{Power Strip}
+  \checklistItem{2}{DP Cable}
+  \checklistItem{1}{Phone with Hotspot \& Charger}
+  \checklistItem{1}{Ethernet cable on cable roll (connected to test bench)}
+  \checklistItem{1}{PRO Ethernet Switch with power cable}
+  \checklistItem{1}{Short Ethernet cable}
 \end{tabularx}