main.tex 31.3 KB
Newer Older
Valentin Platzgummer's avatar
Valentin Platzgummer committed
1
\documentclass[]{scrartcl}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
2 3 4 5 6 7 8

\usepackage{amsmath}
\usepackage{graphicx}
\usepackage{wrapfig}
\usepackage[utf8]{inputenc}
\usepackage{a4wide}
\usepackage{multicol}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
9 10 11
\usepackage{url}
\usepackage{xcolor}
\usepackage{framed}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
12
\usepackage{wrapfig}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
13
\usepackage{xspace}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
14
\usepackage{subcaption}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
15
\usepackage{cprotect} % for \verb|text| inside caption
Valentin Platzgummer's avatar
Valentin Platzgummer committed
16 17

\definecolor{shadecolor}{rgb}{0.9,0.9,0.9}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
18 19

%opening
Valentin Platzgummer's avatar
Valentin Platzgummer committed
20 21
\subtitle{WiMA-Extension}
\title{User Guide}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
22 23
\author{Valentin Platzgummer}

Valentin Platzgummer's avatar
Valentin Platzgummer committed
24
 \input{macros.tex}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
25
 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
26 27
% \renewcommand{\theparagraph}{\arabic{section}.\arabic{subsection}.\arabic{subsubsection}.\arabic{paragraph}}
% \renewcommand{\thesubparagraph}{\arabic{section}.\arabic{subsection}.\arabic{subsubsection}.\arabic{paragraph}.\arabic{subparagraph}}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
28
 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
29

Valentin Platzgummer's avatar
Valentin Platzgummer committed
30 31 32
\begin{document}

\maketitle
Valentin Platzgummer's avatar
Valentin Platzgummer committed
33 34 35
\newpage
\tableofcontents
\newpage
Valentin Platzgummer's avatar
Valentin Platzgummer committed
36
\section{Introduction} 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
37
\subsection{Purpose}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
38
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 \qgc program can be found under \qgcdocurl. The WiMA extends the functionality of \qgc to simplify mobile UAV based coverage measurements. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
39 40
\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.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
41
\subsection{How to use this Guide}
42

43

44
 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
45

Valentin Platzgummer's avatar
Valentin Platzgummer committed
46 47 48 49 50
\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.   

Valentin Platzgummer's avatar
Valentin Platzgummer committed
51 52
\subsection{Inventory}
The source code can be cloned from the git repository \gitrepourl. The root directory of the project contains the folder "deploy" inside which a \verb|.AppImage| of the program can be found. Under Linux \qgc can be launched from console or by double-clicking the \verb|.AppImage|. It is also possible to build versions for Microsoft Windows, Android or Mac. For this purpose refer to the  \qgc documentation under \qgcdocurl. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
53

Valentin Platzgummer's avatar
Valentin Platzgummer committed
54

Valentin Platzgummer's avatar
Valentin Platzgummer committed
55
\section{Menus and Instructions}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
56

Valentin Platzgummer's avatar
Valentin Platzgummer committed
57 58
\subsection{Brief Summary}
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 view. Their function will now be briefly summarized.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
59

Valentin Platzgummer's avatar
Valentin Platzgummer committed
60 61 62 63
The \textbf{plan view} is used to create flight plans and is part of standard \qgc. Flight plans can be stored as \verb|.plan| files or directly be uploaded to a vehicle (either a real one or a simulated one). Flight plans consist of way-points. Each way-point stores, among others, a coordinate (latitude, longitude, altitude) and a command (take off, land, wait for x seconds, \etc). To define a sensible flight plan a sequence of way-points should begin with a take off command and end with a land command. Besides way-points more complex patterns can be defined, which is done by inserting a Survey, a Circular Survey, a Structure Scan or a Corridor Scan.

The \textbf{flight view} comes in necessary as soon as you want a vehicle to get in action. Once the vehicle established a connection (serial, TCP, UDP, \etc), \qgc starts to communicate automatically with it, in most cases. If not, check the settings menu of \qgc. A connected vehicle will appear as a red arrow on the map, showing the vehicles position and orientation. On the top indicator strip (fig. \ref{fig:flightViewTopIndicatorStrip}), telemetry data will be published. At the left edge a tool strip (fig. \ref{fig:flightViewToolStrip}) will be activated, which can be used to command the vehicle.

64
The \textbf{\wima view} is used to generate flight paths from minimal user input. The user can define a Measurement Area, a Service Area (for take off, land, supply tasks, etc.) and a Corridor, which connects the other two areas. Further the \wima view and flight view will be described. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
65 66 67 68 69 70 71

\begin{figure}
	\includegraphics[width=0.2\textwidth]{pics/flightViewToolStrip}
	\centering
	\caption{Flight view tool strip. Used to command the vehicle.}
	\label{fig:flightViewToolStrip}
\end{figure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
72
\begin{figure}[h!]
Valentin Platzgummer's avatar
Valentin Platzgummer committed
73
	\includegraphics[width=0.5\textwidth]{pics/QGCMainWindowCroppedRect}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
74
	\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
75
	\caption{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.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
76 77
	\label{fig:QGCMainButtonExplain}
\end{figure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
78 79 80 81 82 83
\begin{figure}[h!]
	\includegraphics[width=0.8\textwidth]{pics/flightViewTopIndicatorStrip}
	\centering
	\caption{Flight view top indicator strip. Show's data about a connected vehicle. Among others satellite count, telemetry quality, battery level \etc are displayed.}
	\label{fig:flightViewTopIndicatorStrip}
\end{figure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
84

Valentin Platzgummer's avatar
Valentin Platzgummer committed
85

86
\subsection{\wima Plan View}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
87 88
\label{sec:wimaPlanView}
By clicking the wave symbol (see fig. \ref{fig:QGCMainButtonExplain}, magenta square) the WiMA view appears. After entering, at the left screen edge, the WiMA tool strip will appear (depicted in fig. \ref{fig:WimaToolstrip}). 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
89 90 91 92 93
\subsubsection{WiMA Tool Strip}
\label{sec:wimaToolStrip}

\begin{wrapfigure}{r}{0.3\textwidth}
	\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
94
	\includegraphics[width=0.05\textwidth]{pics/WiMAToolstrip}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
95 96 97
	\caption{WiMA Toolstrip inside WiMA Main Window.}
	\label{fig:WimaToolstrip}
\end{wrapfigure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
98
The \wima tool strip is used for load/ save operations as well as editing tasks. The file button can be used to load, save and clear missions. Measurement and service area as well as corridor can be added by clicking the corresponding buttons. The calculate button can be used to regenerate the current mission. However with the current version regeneration is done automatically. The center and zoom buttons are used to navigate the map.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
99

Valentin Platzgummer's avatar
Valentin Platzgummer committed
100 101
\subsubsection{WiMA Areas}
\label{sec:wimaAreas}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
102
The three areas, namely the measurement area, the service area and the corridor, can be defined using the corresponding buttons (see sec. \ref{sec:insertAreas}). In the default mode the areas will be displayed as a half transparent polygon surrounded by a white lines. The polygon shape can be altered by using the drag and split handles shown in fig. \ref{fig:vertexHandle}, \ref{fig:vertexPlus} and \ref{fig:moveArea}. All areas will be listed at the right side within the WiMA Item Editor (see fig. \ref{fig:WimaItemEditor}). The WiMA Item Editor can be used to modify area parameters.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
103 104
The Parameters \verb|Altitude|, \verb|Layers|, and \verb|Layer Dist.| are reserved for future use and don't yet have any impact. The \verb|Offset| parameter changes the distance between the area and its border polygon. The border polygon is a helper to provide sufficient clearance between the area and nearby obstacles, like trees or buildings. The border polygon can be deactivated by unchecking the \verb|Border Polygon| check box. This can be use full for service area and corridor. 
Additionally the \wima item editor shows some statistics about the polygon, like area and number of nodes.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
105

Valentin Platzgummer's avatar
Valentin Platzgummer committed
106
The three areas have the following purpose.  The \wima measurement area defines, as the name indicates, the area of interest within which any measurements are performed. See sec. \ref{sec:wimaAreas} for more information about \wima areas. The \wima service area is meant to be the place were takeoff and landing happens as well as battery exchange or repair work. See sec. \ref{sec:wimaAreas} for more information about \wima areas. The \wima corridor connects the measurement area and the service areas and defines a path which the vehicles uses to travel between Service and Measurement Area. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
107

Valentin Platzgummer's avatar
Valentin Platzgummer committed
108
A minimal configuration of areas consists of measurement and service area. In that case the two areas must be overlapping. The corridor can additionally be used to connect measurement and service area if overlapping of those two is not desired. A valid configuration including measurement, service area and corridor could look like in fig. \ref{fig:validConfig}. The sum of all three areas is further refereed to as the joined area. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
109

Valentin Platzgummer's avatar
Valentin Platzgummer committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
\begin{figure*}[h!]
	\begin{subfigure}[t]{0.49\textwidth}
		\includegraphics[width=0.8\textwidth]{pics/wimaArea}
		\centering
		\caption{\wima area with border polygon. Shown is a measurement area (green).}
		\label{fig:wimaArea}		
	\end{subfigure}
	\begin{subfigure}[t]{0.49\textwidth}
		\centering
		\includegraphics[width=0.65\textwidth]{pics/WiMAItemEditor}
		\caption{\wima item editor at the right edge of the \wima plan view.}
		\label{fig:WimaItemEditor}
	\end{subfigure}
	\caption{\wima Area and corresponding item editor.}
\end{figure*}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
125 126 127 128 129 130
\begin{figure}
	\centering
	\includegraphics[width=0.3\textwidth]{pics/optimPath}
	\caption{Flight path of a real vehicle (red line).}
	\label{fig:optimPaht}
\end{figure} 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
131 132 133
\begin{figure}
	\begin{minipage}{0.3\textwidth}
		\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
134
		\includegraphics[width=0.5\textwidth]{pics/VertexHandle}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
135 136 137
		\caption{Adjust the vertex by dragging it's handle.}
		\label{fig:vertexHandle}
	\end{minipage}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
138
	\hfill
Valentin Platzgummer's avatar
Valentin Platzgummer committed
139 140
	\begin{minipage}{0.3\textwidth}
		\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
141
		\includegraphics[width=0.5\textwidth]{pics/VertexPlus}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
142 143 144 145 146 147
		\caption{Add vertices by hitting the plus sign.}
		\label{fig:vertexPlus}
	\end{minipage}
	\hfill
	\begin{minipage}{0.3\textwidth}
		\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
148
		\includegraphics[width=0.5\textwidth]{pics/MoveArea}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
149 150 151 152
		\caption{Move any area by dragging its drag handle.}
		\label{fig:moveArea}
	\end{minipage}
\end{figure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
153
\begin{figure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
154 155 156 157 158 159 160 161 162 163 164 165 166
	\begin{subfigure}[t]{0.59\textwidth}
		\includegraphics[width=0.9\textwidth]{pics/validAreas}
		\centering
		\caption{A valid configuration of measurement, service area and corridor.}
		\label{fig:validConfig}		
	\end{subfigure}
	\begin{subfigure}[t]{0.39\textwidth}	
		\includegraphics[width=0.8\textwidth]{pics/wimaViewSaveLoad}
		\centering
		\caption{\wima tool strip save/load dialogue.}
		\label{fig:wimaViewSaveLoad}
	\end{subfigure}
	\caption{\wima areas and \wima save/load dialogue.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
167
\end{figure} 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
168

Valentin Platzgummer's avatar
Valentin Platzgummer committed
169 170
\subsubsection{Saving and Loading \wima Missions}
\label{sec:savingLoadingWima}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
171
Pressing the \verb|File| button (see fig. \ref{fig:wimaViewSaveLoad}) of \wima tool strip (see sec. \ref{sec:wimaToolStrip}) opens a menu offering saving and loading operations. At one hand all \wima areas and mission items can be saved using the \verb|.wima| file extension, at the other hand the mission items only can be stored using the \verb|.plan| file extension. The \verb|Open| button can be used to load previously stored files. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
172

Valentin Platzgummer's avatar
Valentin Platzgummer committed
173 174
\subsubsection{Clearing \wima Missions}
\label{sec:clearingWima}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
175
Press the \verb|File| button (see fig. \ref{fig:wimaViewSaveLoad}) of \wima tool strip (see sec. \ref{sec:wimaToolStrip}) to open the dialogue window. Pressing the \verb|New| button deletes all contents within the WiMA Main Window. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
176

Valentin Platzgummer's avatar
Valentin Platzgummer committed
177 178
\subsubsection{Uploading, Downloading and Clearing vehicle Missions}
\label{sec:uploadDownloadVehicle}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
179
Press \verb|File| button (see fig. \ref{fig:wimaViewSaveLoad}) of \wima tool strip (see sec. \ref{sec:wimaToolStrip}) to open the dialog window. With the \verb|Upload|, \verb|Download| and \verb|Clear Vehicle Mission| button, the mission items (if present) can be uploaded, downloaded or deleted from the vehicle.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
180 181


Valentin Platzgummer's avatar
Valentin Platzgummer committed
182 183
\subsubsection{Inserting \wima Areas}
\label{sec:insertAreas}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
184
The \verb|Measure|, \verb|Service| and \verb|Corridor| buttons of the \wima tool strip (see sec. \ref{sec:wimaToolStrip}) are used to insert a measurement, service and corridor area, respectively. Only one of each can be inserted. To generate a flight plan, at least a measurement and a service area must be defined. In that case both must be overlapping.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
185

Valentin Platzgummer's avatar
Valentin Platzgummer committed
186 187
\subsubsection{Generating a \wima flight plan}
\label{sec:generatingFlightPlan}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
188
The current version of \wima automatically updates the flight plan, after terminated user interaction. However using the \verb|Calculate| button (see fig. \ref{fig:wimaViewSaveLoad}) of the \wima tool strip (see sec. \ref{sec:wimaToolStrip}), manual regeneration can be triggered. The flight plan will be generated such that all way-points are within or at least at the edge of the joined\footnote{The joined area is the sum of measurement, service area and corridor (see sec. \ref{sec:wimaAreas}).} area. However it should be taken in account, that the vehicle could still leave the save area, even under fully functional operation. Depending on the software implementation of the vehicles flight stack (firmware), the flight controller could perform a path change. Additionally drifts caused by wind gusts could occur. An example can be seen in fig. \ref{fig:optimPaht}. The vehicles flight controller has no information about any \wima Areas, they exist exclusively within the \qgc application.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
189
\begin{figure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
190 191 192 193 194 195 196 197 198 199 200 201 202
	\begin{subfigure}[t]{0.39\textwidth}		
		\includegraphics[width=0.65\textwidth]{pics/wimaRadioButtons}
		\centering
		\caption{Checking the Mission radio button, on the right hand side, displays the mission items.}
		\label{fig:wimaRadioButtons}
	\end{subfigure}
	\begin{subfigure}[t]{0.59\textwidth}	
		\includegraphics[width=0.9\textwidth]{pics/flightPath2}
		\centering	
		\caption{The flight path generated from the areas depicted in fig. \ref{fig:validConfig}.}
		\label{fig:flightPath}
	\end{subfigure}
	\caption{Mission radio button and an example flight plan.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
203
\end{figure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
204 205
\subsubsection{Navigating the Map}
\label{sec:navigatingMap}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
206
The three buttons  \verb|Center|, \verb|In| and \verb|Out| (see fig. \ref{fig:wimaViewSaveLoad}) of the \wima tool strip (see sec. \ref{sec:wimaToolStrip}) can be used to center the view to a object of interest, and for zooming. The Map can be navigated by dragging the mouse pointer or touch screen.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
207 208

\subsubsection{How to display the generated flight plan}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
209
The flight plan can be displayed by checking the \verb|Mission| radio button above the \wima item editor (see. fig. \ref{fig:wimaRadioButtons}), as depicted in fig \ref{fig:wimaRadioButtons}. An example of a generated flight path can be seen in fig. \ref{fig:flightPath}. Within the green measurement area the program has generated a circular survey (see sec. \ref{sec:circularSurvey} ). The survey has an entry and an exit point. The program has routed paths from the take off point to the surveys entry point and from the surveys exit point to the landing point. The paths have been chosen to be within the joined area and to be as short as possible. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
210 211

\subsubsection{Circular Survey}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
212
\label{sec:circularSurvey}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
213
The Circular Survey (green area in fig. \ref{fig:flightPath}, containing circular tracks) is a flight pattern provided by \wima. It is similar to the Survey pattern of the standard \qgc application. The Circular Survey was adapted for mobile coverage measurements.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
214 215
\begin{wrapfigure}{r}{0.35\textwidth}
	\includegraphics[width=0.3\textwidth]{pics/circularSurveyItemEditor}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
216
	\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
217
	\caption{The circular survey item editor. Can be found at the right edge of the screen.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
218
	\label{fig:circularSurveyItemEditor}	
Valentin Platzgummer's avatar
Valentin Platzgummer committed
219 220
\end{wrapfigure} It consists of circle segments refereed to as transects. Ideally, the transects are connected with each other such that the path between entry and exit point is as short as possible. Currently this goal is approximated by a heuristics. The solution might not always be the global optimum. The \verb|Reference| point (Circle with R symbol and Reference tag, see fig. \ref{fig:flightPath}) defines the center of the circle segments. It is supposed to be placed on the base stations position.

Valentin Platzgummer's avatar
Valentin Platzgummer committed
221
Circular survey parameters can be edited with the circular survey editor (see fig. \ref{fig:circularSurveyItemEditor}). The \verb|Altitude| input box adjusts the altitude of the survey's way-points. The distance between adjacent circle segments can be modified by changing the \verb|Delta R| value. The circle segments are approximated by polygonal structures, consisting of way-points. Two arbitrary adjacent way-points of a circle segment have a maximum angle between them. This angle can be adjusted by editing the \verb|Delta Alpha| input box. The \verb|Delta Alpha| value can assume everything between 0.3$^{\circ}$ and 90$^{\circ}$. The higher the value the rougher the circle appears. The survey will contain the less way-points the higher the \verb|Delta R| and the \verb|Delta Alpha| values are. The number of way-points impacts the recreation and upload time. In general the following holds. The less way-points the better. Use only as many way-point as you really need.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
222 223
 
Short transects are often undesired, to remove them, the minimal transect length can be specified by the \verb|Min. Length| value. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
224

Valentin Platzgummer's avatar
Valentin Platzgummer committed
225
If it is desired that the UAV flies with the same direction for all transects the \verb|Fixed Direction| check box can be activated. The \verb|Relative Altitude| check box enables relative height. With the \verb|Reverse Path| check box path reversal can be obtained. The \verb|Reset Reference| button the reference handle can be set to the survey area center. This can be helpful if the reference handle is hidden.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
226

Valentin Platzgummer's avatar
Valentin Platzgummer committed
227 228
To reduce calculation effort, the maximum number of way-points can be set using the \verb|Max Waypoints| input box. Transects are hidden and calculations aborted, if the number of way-points exceeds \verb|Max Waypoints|.

Valentin Platzgummer's avatar
Valentin Platzgummer committed
229 230


Valentin Platzgummer's avatar
Valentin Platzgummer committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
\subsubsection{How to synchronize Data with Flight View}
\label{sec:syncWima}
To synchronize the generated flight plan with the \wima flight view (see sec. \ref{sec:wimaFlightView}) press the \verb|Sync WiMA| button in the upper right corner (see fig. \ref{fig:syncWima}). The button will be visible only if a valid flight plan was generated and flash if data is not synchronized with the \wima flight view.
\subsubsection{Editing Flight Plans}
The generated flight plan can be edited in the same way as it would be done inside the standard plan view using the mission tool strip (see fig. \ref{fig:wimaViewMissionToolStrip}). After editing, the flight plan can be saved (see sec. \ref{sec:savingLoadingWima}) or synchronized with \wima flight view (see sec. \ref{sec:syncWima}).
\subsection{\wima Flight View and \wima Menu}
\label{sec:wimaFlightView}
The \wima flight view extends the \qgc flight view by the \wima menu, which offers some useful tools like flight plan partitioning, smart return to launch, fast speed changing etc. By default the \wima menu is visible inside the flight view (see fig. \ref{fig:wimaMenu}). The menu can be hidden using the \verb|disable WiMA| slider at it's top. A slider showing the text \verb|enable WiMA| will remain a few seconds at the lower left corner of the flight view befor vanishing. Hovering the mouse at the lower left corner will make the slider visible again.
\begin{figure*}
	\begin{subfigure}[t]{0.3\textwidth}		
		\includegraphics[width=0.4\textwidth]{pics/SyncWima}
		\centering
		\caption{Synchronize button located in the upper right corner of the \wima plan view.}
		\label{fig:syncWima}
	\end{subfigure}
	\begin{subfigure}[t]{0.3\textwidth}		
		\includegraphics[width=0.25\textwidth]{pics/wimaViewMissionToolStrip}
		\centering
		\caption{Mission tool strip located at the upper left corner of the \wima plan view.}
		\label{fig:wimaViewMissionToolStrip}
	\end{subfigure}
	\begin{subfigure}[t]{0.3\textwidth}	
		\includegraphics[width=0.9\textwidth]{pics/wimaMenu}
		\centering
		\caption{The \wima menu located at the lower left corner of the flight view.}
		\label{fig:wimaMenu}
	\end{subfigure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
258
	\caption{Different elements.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
259 260
\end{figure*}
\subsubsection{How to synchronize a Flight Plan with the \wima Menu}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
261 262
See sec. \ref{sec:wimaPlanView} and especially sec. \ref{sec:syncWima}.
\subsubsection{What's the Mission Section and how to use it}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
263
\label{sec:settingsSection}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
The mission section (see fig. \ref{fig:missionSection}) is mostly used to partition the flight plan generated with \wima plan view (see sec. \ref{sec:wimaPlanView}). Additional speed and altitude can be adjusted from here. This gives the possibility to work through large flight plans (containing thousands of way-points) in a step wise manner.
\subsubsection{How to show the Mission Items}
The mission items can be made visible/invisible by checking/unchecking the \verb|Show Mission| check box (see fig. \ref{fig:missionSection}). An example can be seen in fig. \ref{fig:showAllCurrent} and \ref{fig:showAll}. The mission items consist of all items generated inside \wima plan view without the AaR path (see sec. \ref{sec:AaR}).
\subsubsection{How to show the current Phase}
The current mission items can be made visible/invisible by checking/unchecking the \verb|Show Phase| check box (see fig. \ref{fig:missionSection}). An example can be seen in fig. \ref{fig:showAllCurrent} and \ref{fig:showCurrent}. 
\begin{figure*}
	\centering
	\begin{subfigure}[t]{0.3\textwidth}
		\includegraphics[width=0.895\textwidth]{pics/showAllCurrent}
		\centering
		\caption{Mission items (gray) and current phase (green) overlayed.}
		\label{fig:showAllCurrent}
	\end{subfigure}
	\begin{subfigure}[t]{0.3\textwidth}
		\includegraphics[width=0.9\textwidth]{pics/showAll}
		\centering
		\cprotect\caption{Mission items only (\verb|Show Phase| unchecked).}
		\label{fig:showAll}
	\end{subfigure}
	\begin{subfigure}[t]{0.3\textwidth}
		\includegraphics[width=0.845\textwidth]{pics/showCurrent}
		\centering
		\cprotect\caption{Current phase only (\verb|Show Mission| unchecked).}
		\label{fig:showCurrent}
	\end{subfigure}
	\caption{Mission Items displayed on the flight map.}
\end{figure*}  
Valentin Platzgummer's avatar
Valentin Platzgummer committed
291

Valentin Platzgummer's avatar
Valentin Platzgummer committed
292
\subsubsection{What's the AaR Path}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
293
\label{sec:AaR}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
The abbreviation AaR means arrival and return and refers to the way-points which are not part of the actual measuring process. Those way-points are used to guide the UAV from service area to measurement area, hence the name.
\subsubsection{Whats a Mission Phase}
\label{sec:missionPhase}
A mission phase refers to a partition of the mission items (see fig. \ref{fig:showAll}). An example of a partion can be seen in fig. \ref{fig:showAllCurrent} and \ref{fig:showCurrent} (green way-points). 
\subsubsection{How to partition a flight plan}
The flight plan generated with the \wima plan view can be partitioned using the \verb|Next Waypoint|, \verb|Max Waypoints|, and the \verb|Overlap| input boxes and the \verb|Reset Phase|, \verb|Reverse|, and \verb|Forward| button (see fig. \ref{fig:missionSection}). The entry of the \verb|Next Waypoint| corresponds starting point of the next phase. The numbering is related to the mission items. Using the  \verb|Go Forward| or \verb|Go Reverse| buttons increases or decreases the \verb|Next Waypoint| value respectively (see sec. \ref{sec:goForwardReverse} for details). Manually editing the \verb|Next Waypoint| value sets the first point of the current phase to the way-point of the mission item with the entered number. The number of maximum way-points per phase (AaR path excluded) can be set with the \verb|Max Waypoints| input box.
\subsection{What's the Overlap}
\label{sec:Overlap}
The \verb|Overlap| it a the number of way-points two consecutive phases have in common. E.g. if the \verb|Overlap| $=2$ and the last two way-points of phase $n$ are 10 and 11, phase $n+1$ will start with way-points 10 and 11 (AaR path not included).
\subsection{What are the Go Reverse and Go Forward buttons for}
\label{sec:goForwardReverse}
The \verb|Go Forward| or \verb|Go Reverse| buttons are used to proceed to the next phase. The following notation will be used: the index of the first waypoint of Phase $n$ is denoted by $i^s_n$ and the index of the  last way-point by $i^e_n$. The positive scalars $\Delta$ and $N$ denote the \verb|Overlap| (see sec. \ref{sec:Overlap}) and the maximum number of way points per phase (\verb|Max Waypoints|, see fig. \ref{fig:missionSection}). The \verb|Go Forward| button sets start index of the next of Phase ($n+1$) to  $i^s_{n+1} = i^e_{n}-\Delta+1$ and the end index of Phase $n+1$ to $i^e_{n+1} = i^s_{n+1}+N-1$. A very similar result is delivered by the \verb|Go Reverse| button. It sets the start index of the next of Phase ($n+1$) to  $i^s_{n+1} = i^s_{n}+\Delta-1$ and the end index of Phase $n+1$ to $i^e_{n+1} = i^s_{n+1}-N+1$. The indices are truncated, if they exceed the boundaries $1$ and $N$.

\subsection{What is the Reset Phase button for}
The reset button sets the start way-point to the first or last mission 
\subsubsection{How to change Mission Flight Speed}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
310
The mission flight speed can be changed by altering the value of the \verb|Mission Speed| input box (see fig. \ref{fig:missionSection}). This affects measurement points only. The AaR path way-point speed can be altered as well (see the following section). 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
311
\subsubsection{How to change AaR Speed}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
312
The AaR (see sec. \ref{sec:AaR}) flight speed can be changed by altering the value of the \verb|AaR Speed| input box (see fig. \ref{fig:missionSection}). This affects AaR path way-points only. The measurement way-point speed can be altered as well (see the previous section).
Valentin Platzgummer's avatar
Valentin Platzgummer committed
313 314 315 316 317
\subsubsection{How to change Altitude}
The Altitude can be changed by altering the value of the \verb|Altitude| input box (see fig. \ref{fig:missionSection}). This value affects AaR path and measurement points.
\subsection{Can I invert/reverse a Phase}
\label{sec:invert}
A phase can be inverted by checking the \verb|Invert Phase| check box (see. fig. \ref{fig:missionSection}).
Valentin Platzgummer's avatar
Valentin Platzgummer committed
318 319
\subsubsection{What's the Vehicle Section and how to use it}
The vehicle section (see fig. \ref{fig:vehicleSection}) is used to upload and clear the vehicle mission. Additionally this section contains the interface to trigger a smart return to launch. 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
320 321 322
\subsubsection{How to upload and clear mission}
Missions can be uploaded and clear using the \verb|Upload| and \verb|Remove| buttons (see. fig. \ref{fig:vehicleSection}). During upload a green progress button will be displayed. After success the text \verb|Done| will be displayed. An error message will be displayed otherwise. Successfull uploaded mission items will be colored orange.
\subsubsection{What's Smart Return to Launch}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
323 324 325 326 327
\label{sec:SRTL}
Most return to launch (RTL) implementations choose the direct way from the vehicles current to it's takeoff position as a return path. \wima's smart RTL algorithms chooses a return path based on the save area defined by the user (see sec. \ref{sec:wimaAreas}). A smart RTL can be triggered by pressing the \verb|Smart RTL| button. As a security measure pressing this button the user will asked to confirm the action (see fig. \ref{fig:smartRTLconfirmStart}). After confirmation the vehicle will be paused at it's current position and a return path will be displayed. Again the user is asked for confirmation (see fig. \ref{fig:smartRTLconfirmExecute}). On success the return path will be uploaded and executed.
If configured (see sec. \ref{sec:configSRTL}) a smart RTL will be triggered on low battery voltage. The confirmation procedure is the same as described above.
\begin{figure*}
	\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
328
	\begin{subfigure}[t]{0.49\textwidth}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
329
		\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
330
		\includegraphics[width=0.5\textwidth]{pics/smarRTLGuidedAction1}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
331 332 333
		\caption{After a smart RTL was triggered the user is asked to confirm the action by moving the slider to the right hand side.}
		\label{fig:smartRTLconfirmStart}
	\end{subfigure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
334
	\begin{subfigure}[t]{0.49\textwidth}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
335
		\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
336
		\includegraphics[width=0.5\textwidth]{pics/smarRTLGuidedAction2}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
337 338 339 340 341
		\caption{The user is asked to confirm the calculated return path.}
		\label{fig:smartRTLconfirmExecute}
	\end{subfigure}
	\caption{Confirmation process of a smart RTL.}
\end{figure*} 
Valentin Platzgummer's avatar
Valentin Platzgummer committed
342
\subsubsection{How to configure Smart Return to Launch on low Battery.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
343
\label{sec:configSRTL}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
344
The smart RTL on low battery can be configured under general settings (see. fig. \ref{fig:smartRTLconfig}).
Valentin Platzgummer's avatar
Valentin Platzgummer committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
\begin{figure*}
	\centering
	\begin{subfigure}[t]{0.49\textwidth}
		\centering
		\includegraphics[width=0.3\textwidth]{pics/qgcSettings}
		\caption{Click the gear logo followed by the QGC logo to enter QGC settings.}
		\label{fig:qgcSettings}
	\end{subfigure}
	\begin{subfigure}[t]{0.49\textwidth}
		\centering
		\includegraphics[width=0.3\textwidth]{pics/generalSettings}
		\caption{Choose the general settings.}
		\label{fig:generalSettings}
	\end{subfigure}
	\newline
	\begin{subfigure}[t]{0.6\textwidth}
		\centering
		\includegraphics[width=0.8\textwidth]{pics/wimaSettings}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
363
		\cprotect\caption{The battery threshold (in percentage) below which smart RTL will be initiated can be set by altering the value of the \verb|Low Battery Threshold| input box. The low battery handling can be enabled/disabled by checking/unchecking the \verb|Enable low battery handling| check box.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
364 365 366
		\label{fig:wimaSettings}
	\end{subfigure}
	\caption{How to configure \wima smart RTL.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
367
	\label{fig:smartRTLconfig}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
368 369
\end{figure*} 
\subsubsection{What's the Statistics Section and how to use it}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
370
The statistics section is the last section of the \wima menu (see fig. \ref{fig:statisticsSection}). It shows the length of the current mission (phase) and the estimated flight time, based on the mission speed.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
371 372
\begin{figure*}[ht!]
	\centering
Valentin Platzgummer's avatar
Valentin Platzgummer committed
373
	\begin{subfigure}[t]{0.3\textwidth}		
Valentin Platzgummer's avatar
Valentin Platzgummer committed
374 375 376 377 378
		\includegraphics[width=0.95\textwidth]{pics/missionSection}
		\centering
		\caption{The mission section of the \wima menu.}
		\label{fig:missionSection}
	\end{subfigure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
379 380 381 382 383
	\begin{subfigure}[t]{0.3\textwidth}		
		\includegraphics[width=0.95\textwidth]{pics/vehicleSection}
		\centering
		\caption{The vehicle section of the \wima menu.}
		\label{fig:vehicleSection}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
384
	\end{subfigure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
385 386 387 388 389
	\begin{subfigure}[t]{0.3\textwidth}		
		\includegraphics[width=0.95\textwidth]{pics/statisticsSection}
		\centering
		\caption{The statistics section of the \wima menu.}
		\label{fig:statisticsSection}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
390
	\end{subfigure}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
391
	\caption{The different sections of the \wima menu.}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
392 393 394
\end{figure*}
\subsubsection{I can't find the \wima Menu}
See the introduction of sec. \ref{sec:wimaFlightView}.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
395 396

\newpage
397
\subsection{ArduPilot Simulator}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
398
For tasks like debugging, program verification or flight plan testing a simulated vehicle can be very useful. It can save time, money and prevent you from excessive sunburns, if you forgot that you are actually outside, starring on your screen, exposed to the hot summer sun.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
399

400
For this task the ArduPilot simulator can be used. It simulates a vehicle running the ArduPilot flight stack (firmware) on your local machine. Data is being published by the simulator via UDP and should ideally connect to \qgc without any further tweaks.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
401 402

The simulator is part of the ArduPilot project, which can be downloaded from Github: \url{https://github.com/ArduPilot/ardupilot}.
403
It is recommended to fork the repository. After cloning the repository, the sub-modules must be initialized and updated. Execute the following code to do this.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
404 405 406 407 408 409 410 411
\begin{shaded*}
	\begin{verbatim}
		git clone https://github.com/ArduPilot/ardupilot
		cd ardupilot
		git submodule init
		git submodule update
	\end{verbatim}	
\end{shaded*}
Valentin Platzgummer's avatar
Valentin Platzgummer committed
412
The simulator is launched by a Python script, thus Python must be installed on your machine. The simulator can be launched from your ArduPilot root directory with the following command.
Valentin Platzgummer's avatar
Valentin Platzgummer committed
413 414 415 416 417 418 419 420 421 422 423 424 425 426
\begin{shaded*}
	\begin{verbatim}
		./Tools/autotest/sim_vehicle.py -v ArduCopter
	\end{verbatim}
	
\end{shaded*}
Thereby the \verb|-v| option specifies the vehicle type. The \verb|-l| option can be used to define a custom start location. See the \verb|sim_vehicle.py --help| option for further information.
After launching, the vehicle should appear inside QGC.

 




Valentin Platzgummer's avatar
Valentin Platzgummer committed
427
\end{document}