diff --git a/WimaDok/main.pdf b/WimaDok/main.pdf index 7e28af3daca9a918ef7ed691b1a52152bd4675a9..25095046dbd055b21a8cbfe54d0fe9b00b13d12b 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 ae2034ad0e3a6c298abf519085420b23b11d9483..2e8eb97244fbe57adad36072176845e2e1af7969 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 8b267b3d9c89f6ca4d6e8f942b2776f7d789dd08..15efb6802526ff455dfa562f9369f46c6ea7a0de 100644 --- a/WimaDok/main.tex +++ b/WimaDok/main.tex @@ -32,11 +32,11 @@ The folder "deploy" in the QGroundControl root directory (can be cloned from Git \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. -The \textbf{plan view window} is used to create flight plans. They can be stored as .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. Just try them out! Using the simulator can be very helpful. +The \textbf{Plan View Window} is used to create flight plans. They 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. Just try them out! Using the simulator can be very helpful. The \textbf{Flight View Window} comes in necessary as soon as you want a vehicle to get in action. Once the vehicle established a connection (serial, TCP, UDP, etc.), QGroundControl starts to communicate automatically with it, in most cases. If not, check the settings menu of QGroundControl. A red arrow will appear on the map, showing the vehicles position and orientation. On the top indicator strip, telemetry data will be published. At the left edge a tool strip will be activated, which can be used to command the vehicle. -The \textbf{WiMA Main W4indow} is used to automatically 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 previous two areas. Below the WiMA main window will be described in more detail. +The \textbf{WiMA Main Window} is used to automatically 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 previous two areas. Below the WiMA main window will be described in more detail. \begin{figure}[h!] \includegraphics[width=\textwidth]{pics/QGCMainWindowCroppedRect} @@ -49,7 +49,7 @@ The \textbf{WiMA Main W4indow} is used to automatically generate flight paths fr \subsection{WiMA Main Window} \subsubsection{WiMA Tool Strip} \label{sec:wimaToolStrip} -By clicking the wave symbol (see fig. \ref{fig:QGCMainButtonExplain}; magenta square) the WiMA main window appears. After entering, at the left edge, the WiMA tool strip will appear (depicted in fig. \ref{fig:WimaToolstrip}). +By clicking the wave symbol (see fig. \ref{fig:QGCMainButtonExplain}; magenta square) the WiMA Main Window appears. After entering, at the left edge, the WiMA tool strip will appear (depicted in fig. \ref{fig:WimaToolstrip}). \begin{wrapfigure}{r}{0.3\textwidth} \centering @@ -57,18 +57,18 @@ By clicking the wave symbol (see fig. \ref{fig:QGCMainButtonExplain}; magenta sq \caption{WiMA Toolstrip inside WiMA Main Window.} \label{fig:WimaToolstrip} \end{wrapfigure} -Pressing the \textbf{File} button opens a menu which offers 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 Open button can be used to load previously stored files. Pressing the New button deletes all contents within the WiMA Main Window. Additionally with the Upload, Download and Clear Vehicle Mission button the mission items (if present) can be uploaded, downloaded or be deleted from the vehicle respectively. +Pressing the \textbf{File} button opens a menu which offers 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 Open button can be used to load previously stored files. Pressing the New button deletes all contents within the WiMA Main Window. Additionally with the Upload, Download and Clear Vehicle Mission button, the mission items (if present) can be uploaded, downloaded or be deleted from the vehicle respectively. -The \textbf{Measure}, \textbf{Service} and \textbf{Corridor} buttons are used to insert a measurement, service and corridor area, respectively. At the time only one of each areas can be inserted. To automatically generate a flight plan at least a measurement and a service area must be defined. Both must be overlapping. +The \textbf{Measure}, \textbf{Service} and \textbf{Corridor} buttons are used to insert a measurement, service and corridor area, respectively. At the time only one of each area can be inserted. To generate a flight plan, at least a measurement and a service area must be defined. Both must be overlapping. -To generate a flight plan the \textbf{Calculate} button must be pressed. Further information about how to display the generated flight plan will follow below. In the future this button might be removed and be replaced by a routine which automatically triggers recalculation after any modification. However as the flight plan generation can be time consuming on older devices, this button will remain in the near future, up to the point, underlying routines get optimized. +To generate a flight plan the \textbf{Calculate} button must be pressed. Further information about how to display the generated flight plan will follow below. In the future this button might be removed and be replaced by a routine which automatically triggers recalculation. However as the flight plan generation can be time consuming on older devices, this button will remain in the near future, up to the point, underlying routines get optimized. -As flight generation is manually triggered the flight plans might look wrong (for e.g. after user modification), pressing the \textbf{Calculate} button often will remove errors. If not, please report any bugs. +As flight generation is manually triggered the flight plans might look wrong (for e.g. after any kind of manual modification), pressing the \textbf{Calculate} button often will remove errors. If not, please report any bugs. -The last three buttons, \textbf{Center}, \textbf{In} and \textbf{Out} are used to center the view and for zooming respectively. +The last three buttons, \textbf{Center}, \textbf{In} and \textbf{Out} are used to center the view, and for zooming. \subsubsection{WiMA Areas} -As all ready mentioned the three areas, namely the Measurement Area, the Service Area and the Corridor can be defined using the corresponding buttons of the WiMA Tool Strip (see \ref{sec:wimaToolStrip}). +As all ready mentioned the three areas, namely the Measurement Area, the Service Area and the Corridor, can be defined using the corresponding buttons of the WiMA Tool Strip (see \ref{sec:wimaToolStrip}). \begin{figure}[h!] \begin{minipage}{0.3\textwidth} @@ -115,10 +115,10 @@ As all ready mentioned the three areas, namely the Measurement Area, the Service -The \textbf{WiMA Measurement Area} defines, as the name indicates, the area of interest within which any measurements should be performed. The area will be displayed as a green shaded rectangle surrounded by a white line, after pressing the Measure button. The area will be listed at the right side within the WiMA Item Editor, after creation (see fig. \ref{fig:WimaItemEditor}). The WiMA Item Editor can be used to modify area parameters. +The \textbf{WiMA Measurement Area} defines, as the name indicates, the area of interest within which any measurements are be performed. The area will be displayed as a green shaded rectangle surrounded by a white line, after pressing the Measure button. The area will be listed at the right side within the WiMA Item Editor, after creation (see fig. \ref{fig:WimaItemEditor}). The WiMA Item Editor can be used to modify area parameters. % area parameter description here -The Offset parameter (see fig. \ref{fig:WimaItemEditor}) changes the distance between the measurement area and its surrounding polygon. The surrounding polygon is a helper to provide sufficient clearance between the measurement area and surrounding obstacles like trees or buildings. +The Offset parameter (see fig. \ref{fig:WimaItemEditor}) changes the distance between the measurement area and its surrounding polygon. The surrounding polygon is a helper to provide sufficient clearance between the measurement area and obstacles, like trees or buildings. % remove later All other parameters shown in fig. \ref{fig:WimaItemEditor} don't yet have any impact (intended for future use). @@ -128,7 +128,7 @@ The \textbf{WiMA Service Area} is meant to be the area were takeoff and landing The \textbf{WiMA Corridor} connects the two previous areas and defines a corridor which the vehicles uses to travel between Service and Measurement Area. -The flight plan will be generated such that all way-points are within or at least at the edge of the above mentioned areas. However it should be taken in account, that the vehicle could still leave the save area, even under fully functional operation. Depending on software implementation of the vehicles flight stack (firmware) the flight controller could decide to perform any kind of path optimization. Additionally drifts caused by wind gusts could occur. An example can be seen in fig. \ref{fig:optimPaht}. +The flight plan will be generated such that all way-points are within or at least at the edge of the above mentioned areas. However it should be taken in account, that the vehicle could still leave the save area, even under fully functional operation. Depending on software implementation of the vehicles flight stack (firmware), the flight controller could decide to perform any kind of path optimization. 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 QGroundControl application. @@ -157,7 +157,7 @@ A valid configuration including Measurement, Service Area and Corridor could loo \caption{The flight path generated from the areas depicted in fig. \ref{fig:validConfig}.} \label{fig:flightPath} \end{figure} -The flight plan can be displayed by checking the mission radio button, as depicted in fig \ref{fig:wimaRadioButtons}. An example of a automatically generated flight path can be seen in figure \ref{fig:flightPath}. Within the green measurement area the program has generated a Circular Survey (see \ref{sec:circularSurvey} for further information). 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 areas and as short as possible. +The flight plan can be displayed by checking the mission radio button, as depicted in fig \ref{fig:wimaRadioButtons}. An example of a generated flight path can be seen in figure \ref{fig:flightPath}. Within the green measurement area the program has generated a Circular Survey (see \ref{sec:circularSurvey} for further information). 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 areas and as short as possible. \subsubsection{Circular Survey} \label{sec:circularSurvey} @@ -170,17 +170,18 @@ The flight plan can be displayed by checking the mission radio button, as depict The Circular Survey (see fig. \ref{fig:circularSurvey}) is a flight pattern provided by the WiMA extension. It is similar to the Survey pattern of the standard QGroundControl application. The Circular Survey was adapted for mobile coverage measurements. 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 \textbf{Reference} point (Circle with R symbol and Reference tag, see fig. \ref{fig:circularSurvey}) defines the center of the circle segments. Normally it well be placed on the base stations position. +The \textbf{Reference} point (Circle with R symbol and Reference tag, see fig. \ref{fig:circularSurvey}) defines the center of the circle segments. It is supposed to be placed on the base stations position. -The Circular Survey editor (on the left side of the window) offers some options. The \textbf{Altitude} input box adjusts the altitude of the survey. The distance between adjacent circle segments can be modified by changing the \text{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 constant angle between the. This angle can be adjusted by editing the \textbf{Delta Alpha} input box. The 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 Delta R and the Delta Alpha values are. The number of way-points impacts how fast the computer can do recalculations and how long the upload to the UAV takes. -Sometimes transects are short (length of less than e.g. 3 m). Such ones are often undesired, because the real vehicle will not follow them correctly. To remove them in advance, the minimal transect length can be adjusted by editing the \textbf{Min. Length} value. Transects with a length smaller than Min. Length will removed. +The Circular Survey editor (on the left side of the window) offers some options. The \textbf{Altitude} input box adjusts the altitude of the survey. The distance between adjacent circle segments can be modified by changing the \textbf{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 constant angle between them. This angle can be adjusted by editing the \textbf{Delta Alpha} input box. The 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 Delta R and the Delta Alpha value is. The number of way-points impacts how fast the computer can do recalculations and how long the upload to the UAV takes. In general the following holds: the less way-points the better for the overall performance. + +Sometimes transects are short (e.g. length of less than 3 m). Such ones are often undesired, because the real vehicle will not follow them correctly. To remove them in advance, the minimal transect length can be adjusted by editing the \textbf{Min. Length} value. Transects with a length smaller than Min. Length will be removed. The \textbf{Rotate Entry Point} button and the \textbf{Relative altitude} check box don't yet have a function. \newpage \subsection{ArduPilot Simulator} -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 any excessive sunburns, if you forgot that you are actually outside, starring on your screen, exposed to the hot summer sun. +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. For this task the ArduPilot simulator can be used. It simulates a vehicle runnig the ArduPilot flight stack (firmware) on your local machine. Data is beeing published by the simulator via UDP and should ideally connect to QGroundControl without any further tweaks. @@ -194,7 +195,7 @@ It is recommanded to fork the repository. After cloning the repository, the subm git submodule update \end{verbatim} \end{shaded*} -The simulator is launched by a Python script, thus Python must be installed on your machine. The simulator is now ready to run, it can be launched from your ArduPilot root directory with the following command. +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. \begin{shaded*} \begin{verbatim} ./Tools/autotest/sim_vehicle.py -v ArduCopter