diff --git a/WimaDok/Vorlage/.~lock.User Guide WLAN TESTING.docx# b/WimaDok/Vorlage/.~lock.User Guide WLAN TESTING.docx# new file mode 100644 index 0000000000000000000000000000000000000000..36e299396e541e80310d70dda0c5e8e1cd5175d8 --- /dev/null +++ b/WimaDok/Vorlage/.~lock.User Guide WLAN TESTING.docx# @@ -0,0 +1 @@ +,valentin,rick,31.01.2020 11:41,file:///home/valentin/.config/libreoffice/4; \ No newline at end of file diff --git a/WimaDok/Vorlage/Information Product Checklist.docx b/WimaDok/Vorlage/Information Product Checklist.docx new file mode 100644 index 0000000000000000000000000000000000000000..9228c41eea3c789a3cbfd49a4e614e24f9b6e361 Binary files /dev/null and b/WimaDok/Vorlage/Information Product Checklist.docx differ diff --git a/WimaDok/Vorlage/Training Plan Template - Blue Theme.docx b/WimaDok/Vorlage/Training Plan Template - Blue Theme.docx new file mode 100644 index 0000000000000000000000000000000000000000..efde73989ab050993fb1879b828bde7f46e75efd Binary files /dev/null and b/WimaDok/Vorlage/Training Plan Template - Blue Theme.docx differ diff --git a/WimaDok/Vorlage/User Guide Checklist.docx b/WimaDok/Vorlage/User Guide Checklist.docx new file mode 100644 index 0000000000000000000000000000000000000000..3f9e64221dd759ef5fe3c856565f3a98f6ae3963 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Checklist.docx differ diff --git a/WimaDok/Vorlage/User Guide Final Check.docx b/WimaDok/Vorlage/User Guide Final Check.docx new file mode 100644 index 0000000000000000000000000000000000000000..8b7e303509e961c92d772775b44285bd7ce0f578 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Final Check.docx differ diff --git a/WimaDok/Vorlage/User Guide Tempate ABE Tool.docx b/WimaDok/Vorlage/User Guide Tempate ABE Tool.docx new file mode 100644 index 0000000000000000000000000000000000000000..664551d79c62b6ea8c560cca92d715502e59cf29 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Tempate ABE Tool.docx differ diff --git a/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #1.docx b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #1.docx new file mode 100644 index 0000000000000000000000000000000000000000..e7ea139746e2af423cb88a880314a188ebc84314 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #1.docx differ diff --git a/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #2.docx b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #2.docx new file mode 100644 index 0000000000000000000000000000000000000000..7daca45d478213d6a2cb4e6a503374e638608883 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #2.docx differ diff --git a/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #3.docx b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #3.docx new file mode 100644 index 0000000000000000000000000000000000000000..cd0f75bdd452337868c67f8a56933ccfa03eba23 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #3.docx differ diff --git a/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #4.docx b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #4.docx new file mode 100644 index 0000000000000000000000000000000000000000..fe0165294fe14d08f59e1806175d0c68b4582b5b Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #4.docx differ diff --git a/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #5.docx b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #5.docx new file mode 100644 index 0000000000000000000000000000000000000000..4cba0445dfc58d980e361a3281decf1253da3444 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template - Blue Theme - Coversheet Image #5.docx differ diff --git a/WimaDok/Vorlage/User Guide Template - Blue Theme.docx b/WimaDok/Vorlage/User Guide Template - Blue Theme.docx new file mode 100644 index 0000000000000000000000000000000000000000..dab402feb61b234ba229e9706527124e0f5dddd5 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template - Blue Theme.docx differ diff --git a/WimaDok/Vorlage/User Guide Template - Red Theme.docx b/WimaDok/Vorlage/User Guide Template - Red Theme.docx new file mode 100644 index 0000000000000000000000000000000000000000..da6b079b04294e8b5f6f2bbbf39a8dca3fcd5aac Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template - Red Theme.docx differ diff --git a/WimaDok/Vorlage/User Guide Template 2.docx b/WimaDok/Vorlage/User Guide Template 2.docx new file mode 100644 index 0000000000000000000000000000000000000000..ff69603bfeb32034cb44adc407e111fe57c2aed1 Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template 2.docx differ diff --git a/WimaDok/Vorlage/User Guide Template 3.docx b/WimaDok/Vorlage/User Guide Template 3.docx new file mode 100644 index 0000000000000000000000000000000000000000..90660686b9cb3b9ef00593f8055038e8043988ab Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template 3.docx differ diff --git a/WimaDok/Vorlage/User Guide Template 4.docx b/WimaDok/Vorlage/User Guide Template 4.docx new file mode 100644 index 0000000000000000000000000000000000000000..6358cd628fb5db420c3e77754f30de6967923a4d Binary files /dev/null and b/WimaDok/Vorlage/User Guide Template 4.docx differ diff --git a/WimaDok/Vorlage/User Guide WLAN TESTING.docx b/WimaDok/Vorlage/User Guide WLAN TESTING.docx new file mode 100644 index 0000000000000000000000000000000000000000..1fb7e09b99115ca37c336f640477018cd22e3f18 Binary files /dev/null and b/WimaDok/Vorlage/User Guide WLAN TESTING.docx differ diff --git a/WimaDok/Vorlage/test.param_ABE_explain.txt b/WimaDok/Vorlage/test.param_ABE_explain.txt new file mode 100644 index 0000000000000000000000000000000000000000..ba2b0edfcb10d196017ef263c8adeb1f14be724e --- /dev/null +++ b/WimaDok/Vorlage/test.param_ABE_explain.txt @@ -0,0 +1,2 @@ +# //N_repeat minRate maxRate numPackets spreadingFactor initialSize startDelay maxSingleDatagramSize +5 1 100 400 1010 1000 20 1400 diff --git a/WimaDok/macros.tex b/WimaDok/macros.tex new file mode 100644 index 0000000000000000000000000000000000000000..62e6cf761e6585d2c3bd82bb8eed8afc982277e6 --- /dev/null +++ b/WimaDok/macros.tex @@ -0,0 +1,4 @@ +\newcommand{\qgc}{QGroundControl\xspace} +\newcommand{\wima}{WiMA\xspace} +\newcommand{\ethz}{ETH Zürich\xspace} +\newcommand{\uav}{Unmaned Arial Vehicle\xspace} diff --git a/WimaDok/main.aux b/WimaDok/main.aux index 14660ba562b8253a7531ab662b0466265932fa9c..ab315247d9fb805c514d934888b111cd5b454b50 100644 --- a/WimaDok/main.aux +++ b/WimaDok/main.aux @@ -1,34 +1,40 @@ \relax -\@writefile{toc}{\contentsline {section}{\numberline {1}Introduction}{1}} -\@writefile{toc}{\contentsline {section}{\numberline {2}Documentation}{1}} -\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}Structure of QGroundControl with WiMA-Extension}{1}} -\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces Detail view of the QGC window, which appears after start-up. Marked in red is the button for switching to the Plan View Window, green indicates the Flight View button (current window) and marked in magenta is the button for switching to the WiMA Main Window.}}{2}} -\newlabel{fig:QGCMainButtonExplain}{{1}{2}} -\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}WiMA Main Window}{2}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.1}WiMA Tool Strip}{2}} -\newlabel{sec:wimaToolStrip}{{2.2.1}{2}} -\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces WiMA Toolstrip inside WiMA Main Window.}}{2}} -\newlabel{fig:WimaToolstrip}{{2}{2}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.2}WiMA Areas}{3}} -\@writefile{lof}{\contentsline {figure}{\numberline {3}{\ignorespaces WiMA Item Editor at the right edge of the WiMA Main Window.}}{3}} -\newlabel{fig:WimaItemEditor}{{3}{3}} -\@writefile{lof}{\contentsline {figure}{\numberline {4}{\ignorespaces Flight path of a real vehicle (red line).}}{3}} -\newlabel{fig:optimPaht}{{4}{3}} -\@writefile{lof}{\contentsline {figure}{\numberline {5}{\ignorespaces Adjust the vertex by dragging it's handle.}}{3}} -\newlabel{fig:vertexHandle}{{5}{3}} -\@writefile{lof}{\contentsline {figure}{\numberline {6}{\ignorespaces Add vertices by hitting the plus sign.}}{3}} -\newlabel{fig:vertexPlus}{{6}{3}} -\@writefile{lof}{\contentsline {figure}{\numberline {7}{\ignorespaces Move any area by dragging its drag handle.}}{3}} -\newlabel{fig:moveArea}{{7}{3}} -\@writefile{lof}{\contentsline {figure}{\numberline {8}{\ignorespaces A valid configuration of Measurement, Service Area and Corridor.}}{4}} -\newlabel{fig:validConfig}{{8}{4}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.3}The generated Flight Path}{4}} -\@writefile{lof}{\contentsline {figure}{\numberline {9}{\ignorespaces Checking the Mission radio button displays the mission items.}}{5}} -\newlabel{fig:wimaRadioButtons}{{9}{5}} -\@writefile{lof}{\contentsline {figure}{\numberline {10}{\ignorespaces The flight path generated from the areas depicted in fig. 8\hbox {}.}}{5}} -\newlabel{fig:flightPath}{{10}{5}} -\@writefile{lof}{\contentsline {figure}{\numberline {11}{\ignorespaces An example of a Circular Survey pattern.}}{6}} -\newlabel{fig:circularSurvey}{{11}{6}} +\providecommand*\new@tpo@label[2]{} +\@writefile{toc}{\contentsline {section}{\numberline {1}Introduction}{3}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.1}Purpose}{3}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.2}Scope}{3}} +\@writefile{toc}{\contentsline {section}{\numberline {2}Documentation}{3}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}Structure of QGroundControl with WiMA-Extension}{3}} +\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces Detail view of the QGC window, which appears after start-up. Marked in red is the button for switching to the Plan View Window, green indicates the Flight View button (current window) and marked in magenta is the button for switching to the WiMA Main Window.}}{4}} +\newlabel{fig:QGCMainButtonExplain}{{1}{4}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}WiMA Main Window}{4}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.1}WiMA Tool Strip}{4}} +\newlabel{sec:wimaToolStrip}{{2.2.1}{4}} +\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces WiMA Toolstrip inside WiMA Main Window.}}{4}} +\newlabel{fig:WimaToolstrip}{{2}{4}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.2}WiMA Areas}{5}} +\@writefile{lof}{\contentsline {figure}{\numberline {3}{\ignorespaces WiMA Item Editor at the right edge of the WiMA Main Window.}}{5}} +\newlabel{fig:WimaItemEditor}{{3}{5}} +\@writefile{lof}{\contentsline {figure}{\numberline {4}{\ignorespaces Flight path of a real vehicle (red line).}}{5}} +\newlabel{fig:optimPaht}{{4}{5}} +\@writefile{lof}{\contentsline {figure}{\numberline {5}{\ignorespaces Adjust the vertex by dragging it's handle.}}{6}} +\newlabel{fig:vertexHandle}{{5}{6}} +\@writefile{lof}{\contentsline {figure}{\numberline {6}{\ignorespaces Add vertices by hitting the plus sign.}}{6}} +\newlabel{fig:vertexPlus}{{6}{6}} +\@writefile{lof}{\contentsline {figure}{\numberline {7}{\ignorespaces Move any area by dragging its drag handle.}}{6}} +\newlabel{fig:moveArea}{{7}{6}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.3}The generated Flight Path}{6}} \@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.4}Circular Survey}{6}} \newlabel{sec:circularSurvey}{{2.2.4}{6}} -\@writefile{toc}{\contentsline {subsection}{\numberline {2.3}ArduPilot Simulator}{7}} +\@writefile{lof}{\contentsline {figure}{\numberline {8}{\ignorespaces A valid configuration of Measurement, Service Area and Corridor.}}{7}} +\newlabel{fig:validConfig}{{8}{7}} +\@writefile{lof}{\contentsline {figure}{\numberline {9}{\ignorespaces Checking the Mission radio button displays the mission items.}}{7}} +\newlabel{fig:wimaRadioButtons}{{9}{7}} +\@writefile{lof}{\contentsline {figure}{\numberline {10}{\ignorespaces The flight path generated from the areas depicted in fig. 8\hbox {}.}}{8}} +\newlabel{fig:flightPath}{{10}{8}} +\@writefile{lof}{\contentsline {figure}{\numberline {11}{\ignorespaces An example of a Circular Survey pattern.}}{8}} +\newlabel{fig:circularSurvey}{{11}{8}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3}ArduPilot Simulator}{10}} +\global\@namedef{scr@dte@section@lastmaxnumwidth}{10.84047pt} +\global\@namedef{scr@dte@subsection@lastmaxnumwidth}{18.37163pt} +\global\@namedef{scr@dte@subsubsection@lastmaxnumwidth}{26.8883pt} diff --git a/WimaDok/main.pdf b/WimaDok/main.pdf index 25095046dbd055b21a8cbfe54d0fe9b00b13d12b..fabd52702abc24c661b53748bf8bd929309891f0 100644 Binary files a/WimaDok/main.pdf and b/WimaDok/main.pdf differ diff --git a/WimaDok/main.synctex.gz b/WimaDok/main.synctex.gz index 2e8eb97244fbe57adad36072176845e2e1af7969..450fe2451aeebbfd5db145565992195fbfd4fc4e 100644 Binary files a/WimaDok/main.synctex.gz and b/WimaDok/main.synctex.gz differ diff --git a/WimaDok/main.tex b/WimaDok/main.tex index b569afe1d09ab382026478ef566a24d6a30c6686..64961ac903548e223ae79b2e0f6a3e688b3253be 100644 --- a/WimaDok/main.tex +++ b/WimaDok/main.tex @@ -1,4 +1,4 @@ -\documentclass[]{article} +\documentclass[]{scrartcl} \usepackage{amsmath} \usepackage{graphicx} @@ -10,27 +10,39 @@ \usepackage{xcolor} \usepackage{framed} \usepackage{wrapfig} +\usepackage{xspace} \definecolor{shadecolor}{rgb}{0.9,0.9,0.9} %opening -\title{Documentation of the WiMA-Extension} +\subtitle{WiMA-Extension} +\title{User Guide} \author{Valentin Platzgummer} + \input{macros.tex} + \begin{document} \maketitle +\newpage +\tableofcontents +\newpage \section{Introduction} -WiMA is a abbreviation for \textbf{Wi}reless \textbf{M}easurement \textbf{A}pplication. The WiMA extension is a customization who's purpose is to simplify mobile coverage measurements. The current goal is to provide software which is able to generate flight paths form minimal user input. Future goals could be to develop interfaces such that KPI measurements could be triggered from within QGroundControl. An other goal could be to automatically retrieve, merge, analyze and visualize the measured data. +\subsection{Purpose} +The purpose of this document is to introduce the user to \wima (\textbf{Wi}reless \textbf{M}easurement \textbf{A}pplication) integrated in \qgc. \qgc is a ground control station software intended for the remote control of UAVs (\uav). A Documentation of the QGroundControl program can be found under \url{https://docs.qgroundcontrol.com/en/}. The WiMA extends the functionality of QGroundControl to simplify mobile UAV based coverage measurements. +\subsection{Scope} +The current goal of the \wima is to provide software able to generate flight plans form minimal user input. This guide contains information about how to use \wima. -This document was created to explain the functionality of the WiMA-Extension at one hand, and to encourage the reader to find bugs inside the program. As the extension is still being developed the contents demonstrated inside this document may differ from those ones in the program. -The folder "deploy" in the QGroundControl root directory (can be cloned from Gitlab) contains a AppImage of the program. QGroundControl can be launched by double-clicking the AppImage. Currently only a Linux version is available. -A Documentation of the QGroundControl program can be found under \url{https://docs.qgroundcontrol.com/en/}. -\section{Documentation} +\section{System Description} + +\subsection{Key Features} +The extension can generate flight plans based on minimal user input. This is done by defining different areas on a world map. Additionally \wima offers to partition generated flight plans, which gives more flexibility. Partitioning makes it possibly to execute a subset of a flight plan, which makes it less tedious to cover large areas. As a security feature \wima offers a smart return to launch routine. Most return to launch implementations choose the direct path for return, which can be blocked. \wima can automatically calculate a save return path, based on user defined save areas. \wima also offers fast adaption of flight altitude and speed. + +The folder "deploy" in the QGroundControl root directory (can be cloned from Gitlab) contains a AppImage of the program. QGroundControl can be launched by double-clicking the AppImage. Currently only a Linux version is available. \subsection{Structure of QGroundControl with WiMA-Extension} Figure \ref{fig:QGCMainButtonExplain} shows a detail view of the QGC main window. Relevant for this documentation are the flight view, the plan view and the WiMA main window. Their function will now be briefly summarized. diff --git a/WimaDok/main.toc b/WimaDok/main.toc new file mode 100644 index 0000000000000000000000000000000000000000..85b55affddcd4543bb4c348a76587e20bae365c4 --- /dev/null +++ b/WimaDok/main.toc @@ -0,0 +1,11 @@ +\contentsline {section}{\numberline {1}Introduction}{3} +\contentsline {subsection}{\numberline {1.1}Purpose}{3} +\contentsline {subsection}{\numberline {1.2}Scope}{3} +\contentsline {section}{\numberline {2}Documentation}{3} +\contentsline {subsection}{\numberline {2.1}Structure of QGroundControl with WiMA-Extension}{3} +\contentsline {subsection}{\numberline {2.2}WiMA Main Window}{4} +\contentsline {subsubsection}{\numberline {2.2.1}WiMA Tool Strip}{4} +\contentsline {subsubsection}{\numberline {2.2.2}WiMA Areas}{5} +\contentsline {subsubsection}{\numberline {2.2.3}The generated Flight Path}{6} +\contentsline {subsubsection}{\numberline {2.2.4}Circular Survey}{6} +\contentsline {subsection}{\numberline {2.3}ArduPilot Simulator}{10}