feat(docs): Add content from current procedure from SharePoint (#29)

Copies the changes from the current installation procedure on SharePoint

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

src/dacs-sw/control-station-installation/sections/installation.tex

@@ -4,5 +4,148 @@
 \begin{tabularx}{\textwidth}{|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|X|}
   \hline
   \rowcolor{tableHeaderColor}
-  ID & CK 1 & CK 2 & CK 3 & Description \\ \hline
+  ID & CK 1 & CK 2 & CK 3 & Description                       \\ \hline
+
+  \procedureItem{
+    Unpack material and place monitors on two tables in the following order (from left to right):
+  \\
+    PROMETHEUS Monitor 1, PROMETHEUS Monitor 2, Surveillance/KiDAQ Monitor
+  }
+
+  \procedureItem{
+    Connect 2 monitors PROMETHEUS Monitor 1 and 2 to MC PC (DP cable)
+  }
+
+  \procedureItem{
+    Connect the remaining monitor to KiDAQ PC (DP cable)
+  }
+
+  \procedureItem{
+    Connect keyboards, mouses, power adapters and Wifi Adapters to both PCs
+  \\
+    Important: Connect the US keyboard to the mission control PC!
+  }
+
+  \procedureItem{
+    Plug in power of Ethernet switch
+  }
+
+  \procedureItem{
+    Connect 100m Ethernet cable to PRO Ethernet Switch
+  }
+
+  \procedureItem{
+    Connect PRO Ethernet switch to PRO Mission Control PC with short Ethernet cable
+  }
+
+  \procedureItem{
+    Connect PRO Ethernet switch to KiDAQ PC with short Ethernet cable
+  }
+
+  \procedureItem{
+    Turn both PCs on.
+  \\
+    Login credentials can be found on the DACS software page of the wiki
+  \\
+  \texttt{https://wiki.aris-space.ch/e/en/rocketry/engines    \\/liquid/test-bench/data-acquisition-and-control-system\\/Subsystems/Software}
+  }
+
+  \procedureItem{
+    For the right monitor settings on the MC PC go to 'Settings' -$>$ 'Displays' and check the following things:
+    \begin{itemize}
+      \item Primary Display: Dell Inc. 28"
+      \item Fractional Scaling ON
+      \item Dell Inc. 24": 100\% Scaling
+    \end{itemize}
+    Dell Inc. 28": 175\% Scaling (check the UI in Google Chrome and if the size is appropriate, otherwise change 175\% to 125\% and try again) if there is some problem with this monitor (e.g. flickering) you can try to change this to another value, but then the UI formatting might not be perfect but still manageable)
+  }
+
+  \procedureItem{
+    Connect the 100m ethernet cable to the ethernet switch in DACS Box and to the mission control PC.
+  \\
+    (Check that in the upper right corner when you click on the WLAN symbol it says 'Wired connected')
+  }
+
+  \procedureItem{
+    Connect mission control PC to hotspot
+  }
+
+  \procedureItem{
+    Launch system by running in terminal:
+  \\
+    \texttt{./start\_test\_maria.sh}
+  \\
+    Then continue at step 1.19.
+  \\
+    If that does not work do steps 1.14.-1.18.
+  }
+
+  \rowcolor{highlightColor}
+  \procedureItem{
+    The following steps are already executed by the \texttt{start\_test\_maria.sh} file and usually don't have to be done
+  \\
+    Open UI in browser (preferably Firefox):
+  \\
+  \texttt{file:///home/dacs/git/user-interface/rosWebPage/ui/ \\index.html}
+  \\
+    There is also a bookmark so you don't need to type this in
+  }
+
+  \rowcolor{highlightColor}
+  \procedureItem{
+    Launch ROS from terminal:
+    \begin{itemize}
+      \item \texttt{cd catkin\_ws}
+      \item \texttt{catkin build}
+      \item \texttt{source ./devel/setup.bash}
+      \item \texttt{roslaunch data\_acquisition test.launch}
+    \end{itemize}
+  }
+
+  \rowcolor{highlightColor}
+  \procedureItem{
+    Refresh UI and ensure it is connected to ROS websocket (green message in the histogram)
+  }
+
+  \rowcolor{highlightColor}
+  \procedureItem{
+    Open Plotjuggler in a new terminal:
+    \begin{itemize}
+      \item \texttt{cd catkin\_ws}
+      \item \texttt{catkin build}
+      \item \texttt{source ./devel/setup.bash}
+      \item \texttt{rosrun plotjuggler plotjuggler}
+    \end{itemize}
+  }
+
+  \rowcolor{highlightColor}
+  \procedureItem{
+    Open Plotjuggler in a new terminal:
+    \begin{itemize}
+      \item \texttt{cd catkin\_ws}
+      \item \texttt{source ./devel/setup.bash}
+      \item \texttt{rosrun plotjuggler plotjuggler}
+    \end{itemize}
+  }
+
+  \procedureItem{
+    For the first Plotjuggler window:
+    \begin{itemize}
+      \item Press 'Start' (check that ROS Topic Subscriber is chosen in the Streaming window)
+      \item Choose all sensor topics
+      \item configure plots you want to see by importing layout from \texttt{/home/dacs/git/configuration\_tests/plotjuggler\_config.xml}
+      \item set buffer in upper left corner to 60 to set the window size to 60 seconds
+      \item Move this window to the second monitor
+    \end{itemize}
+  }
+
+  \procedureItem{
+    For the second Plotjuggler window:
+    \begin{itemize}
+      \item Press 'Start' (check that ROS Topic Subscriber is chosen in the Streaming window)
+      \item Choose all sensor topics
+      \item configure plots you want to see by importing layout from \texttt{/home/dacs/git/configuration\_tests/plotjuggler\_config.xml}
+      \item set buffer in upper left corner to 600 to set the window size to 10 minutes
+    \end{itemize}
+  }
 \end{tabularx}

src/dacs-sw/control-station-installation/sections/notes.tex

@@ -3,4 +3,106 @@
 \rowcolors{1}{notesColor}{notesColor}
 \begin{tabularx}{\textwidth}{X}
   \hline
+
+  \noteItem{
+    \textbf{Do not under any circumstances upgrade the Ubuntu version to a newer release} even if prompted!
+    The ROS version we use is not compatible with all Ubuntu versions.
+  }
+
+  \noteItem{
+    The \textbf{abort key for the UI is 'Esc'}.
+    This will immediately trigger the abort sequence corresponding to the current phase.
+  }
+
+  \noteItem{
+    To \textbf{stop a process} in the terminal: CTRL-C
+  \\
+    To \textbf{save a file}: CTRL-S
+  }
+
+  \noteItem{
+    Important files that might have to be changed:
+    \begin{itemize}
+      \item \textbf{/home/dacs/git/configuration-tests/PRO\_DACS-Configuration.xlsx}
+            \\
+            here you can change controllable actuators per phase and sensor abort thresholds, afterwards do catkin build again
+
+      \item \textbf{/home/dacs/git/user-interface/rosWebPage/ui/configure\_ui.py}
+            \\
+            here you can change anything related to the UI, in particular which config file is used (this is quite unreadable code so use CTRL-F to find things)
+            To apply changes run:
+            Cd /home/dacs/git/user-interface/rosWebPage/ui/
+            python3 configure\_ui.py
+
+      \item \textbf{/home/dacs/git/software-rpi4/state\_machine/src/:}
+            \\
+            In this folder you find the state machine list (list of phases) and sequences (watch out for the syntax if you change anything here)
+            Check which file is used in state\_machine.cpp
+            afterwards do catkin build again
+
+      \item \textbf{/home/dacs/git/software-rpi4/data\_acquisition/src/core/T7\_streaming.py}
+            \\
+            here you can change the streaming rate in case you get a Labjack buffer error or anything of that kind
+
+      \item \textbf{/home/dacs/git/software-rpi4/data\_acquisition/launch/test.launch}
+            \\
+            here you can change which ROS modules are started at roslaunch, might be useful to delete the throttling module if it gives any errors for example
+
+      \item \textbf{/home/dacs/git/software-rpi4/throttling\_control/src}
+            \\
+            In the setpoint.py, control.py and the core folder you can change the setting for the setpoints and the controller parameters.
+
+    \end{itemize}
+  }
+
+  \noteItem{
+    To see \textbf{error messages regarding the UI} in Google Chrome click on the three dots '…' in the upper right corner, then 'More Tools' and 'Developer Tools'.
+    Now you can see a few messages that might help find problems in the Configuration file for example
+  }
+
+  \noteItem{
+    To \textbf{monitor ROS messages} run in terminal:
+  \\
+    cd catkin\_ws
+  \\
+    source ./devel/setup.bash
+  \\
+    then some useful commands are:
+    \begin{itemize}
+      \item \texttt{rostopic list} (to see a list of topics)
+      \item \texttt{rostopic echo /'topicname'} (the name of the actuator topics are: 'actuator\_\#actuatorid' and of sensor topics: 'sensor\_\#sensorid'
+      \item \texttt{rostopic pub /throttling\_enabled dacs\_test/Control '{state: False}'}  (to publish)
+      \item \texttt{rostopic hz /'topicname'} (to get frequency)
+    \end{itemize}
+  }
+
+  \noteItem{
+    For test without saving data:
+  \\
+    1.15 roslaunch data\_acquisition test\_minimum.launch
+  }
+
+  \noteItem{
+
+    \textbf{Change measured quantity of mass flow sensor (Software part):}
+  \\
+    Open Config file in
+  \\
+    \texttt{/home/dacs/git/configuration-tests/PRO\_DACS-Configuration.xlsx}
+  \\
+    Open Sensors Sheet
+  \\
+    We need to change the row “oss\_mf” in the following way:
+    \begin{itemize}
+      \item Change 'Sensor Designation' to the measured quantity, for example 'OSS mass flow'
+
+      \item Change 'MIN\_SI' and 'MAX SI':
+            for mass flow measurement 0 and 250,
+            for density measurement 2 and 1150,
+            for temperature measurement we need *min\_temp* and *max\_temp*
+            (check with the person that configured the mass flow sensor wether these values are correct)
+
+      \item Change 'Units [UI]' to g/s for mass flow, g/l for density, and °C for temperature
+    \end{itemize}
+  }
 \end{tabularx}

src/dacs-sw/control-station-installation/sections/operation-description.tex

@@ -1 +1,2 @@
 % Operation description
+Install the DACS mission control station including hardware and software

src/dacs-sw/control-station-installation/sections/required-documents.tex

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

src/dacs-sw/control-station-installation/sections/required-materials.tex

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

src/dacs-sw/control-station-installation/sections/required-tools.tex

@@ -4,4 +4,18 @@
   \hline
   \rowcolor{tableHeaderColor}
   Check & Amount & Description \\ \hline
+  \checklistItem{1}{Mission Control PC}
+  \checklistItem{1}{Windows PC with KiStudio Lab preinstalled (KiDAQ PC)}
+  \checklistItem{3}{Monitor}
+  \checklistItem{2}{Keyboard}
+  \checklistItem{2}{Mouse}
+  \checklistItem{2}{Wifi Adapter}
+  \checklistItem{2}{Power Adapter for PC}
+  \checklistItem{1}{Manual Override Box}
+  \checklistItem{2}{Power Strip}
+  \checklistItem{3}{DP Cable}
+  \checklistItem{1}{Phone with Hotspot \& Charger}
+  \checklistItem{1}{Ethernet cable on cable roll (connected to testbench)}
+  \checklistItem{1}{PRO Ethernet Switch with power cable}
+  \checklistItem{2}{Short Ethernet cable}
 \end{tabularx}