README.md 7.47 KB
Newer Older
Gus Grubba's avatar
Gus Grubba committed
1
# QGroundControl Ground Control Station
2 3
## Open Source Micro Air Vehicle Ground Control Station

4
[![Releases](https://img.shields.io/github/release/mavlink/QGroundControl.svg)](https://github.com/mavlink/QGroundControl/releases)
5 6 7
[![Travis Build Status](https://travis-ci.org/mavlink/qgroundcontrol.svg?branch=master)](https://travis-ci.org/mavlink/qgroundcontrol)
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/crxcm4qayejuvh6c/branch/master?svg=true)](https://ci.appveyor.com/project/mavlink/qgroundcontrol)

The Gitter Badger's avatar
The Gitter Badger committed
8 9
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mavlink/qgroundcontrol?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Lorenz Meier's avatar
Lorenz Meier committed
10
The license terms are set in the COPYING.md file.
11 12 13 14 15 16 17 18 19 20 21

* Project:
<http://qgroundcontrol.org>

* Files:
<http://github.com/mavlink/qgroundcontrol>

* Credits:
<http://qgroundcontrol.org/credits>


Don Gagne's avatar
Don Gagne committed
22
## Obtaining source code
Don Gagne's avatar
Don Gagne committed
23
Source code for QGroundControl is kept on GitHub: https://github.com/mavlink/qgroundcontrol.
Stefano Probst's avatar
Stefano Probst committed
24
```
Daniel Agar's avatar
Daniel Agar committed
25
git clone --recursive https://github.com/mavlink/qgroundcontrol.git
Stefano Probst's avatar
Stefano Probst committed
26
```
Don Gagne's avatar
Don Gagne committed
27
Each time you pull new source to your repository you should run `git submodule update` to get the latest submodules as well. Since QGroundControl uses submodules, using the zip file for source download will not work. You must use git.
28

Don Gagne's avatar
Don Gagne committed
29 30 31
### User Manual
https://donlakeflyer.gitbooks.io/qgroundcontrol-user-guide/content/

Don Gagne's avatar
Don Gagne committed
32
### Supported Builds
33 34

#### Native Builds
Gus Grubba's avatar
Gus Grubba committed
35
QGroundControl builds are supported for OSX, Linux, Windows, iOS and Android. QGroundControl uses [Qt](http://www.qt.io) as its cross-platform support library and uses [QtCreator](http://doc.qt.io/qtcreator/index.html) as its default build environment.
Don Gagne's avatar
Don Gagne committed
36
* OSX: OSX 10.7 or higher, 64 bit, clang compiler (IMPORTANT: XCode 8 requires a workaround described below)
Don Gagne's avatar
Don Gagne committed
37
* Ubuntu: 64 bit, gcc compiler
Don Gagne's avatar
Don Gagne committed
38
* Windows: Vista or higher, 32 bit, [Visual Studio 2013 compiler](http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop)
Don Gagne's avatar
Don Gagne committed
39
* iOS: 8.0 and higher
Don Gagne's avatar
Don Gagne committed
40
* Android: Jelly Bean (4.1) and higher
Don Gagne's avatar
Don Gagne committed
41
* Qt version: 5.5.1 ONLY
42

43
###### Install QT
Gus Grubba's avatar
Gus Grubba committed
44
You need to install Qt as described below instead of using pre-built packages from say, a Linux distribution because QGroundControl needs access to private Qt headers.
Don Gagne's avatar
Don Gagne committed
45
* Download the [Qt installer](http://www.qt.io/download-open-source)
Don Gagne's avatar
Don Gagne committed
46 47
    * Make sure to install Qt version **5.5.1** NOT 5.4.x, 5.6.x, 5.7.x, etc. 
    * If you don't install the full Qt 5.5 make sure you install Qt Location and Qt Quick Controls.
Don Gagne's avatar
Don Gagne committed
48
    * Ubuntu: Set the downloaded file to executable using:`chmod +x`. Install to default location for use with ./qgroundcontrol-start.sh. If you install Qt to a non-default location you will need to modify qgroundcontrol-start.sh in order to run downloaded builds.
Don Gagne's avatar
Don Gagne committed
49
    * Windows: Default installer not quite correct, use [this](http://download.qt.io/official_releases/qt/5.5/5.5.1/qt-opensource-windows-x86-msvc2013-5.5.1.exe) instead
Don Gagne's avatar
Don Gagne committed
50

51
###### Install additional packages:
52 53
* Ubuntu: sudo apt-get install espeak libespeak-dev libudev-dev libsdl2-dev
* Fedora: sudo dnf install espeak espeak-devel SDL2-devel SDL2 systemd-devel
Don Gagne's avatar
Don Gagne committed
54 55 56
* Arch Linux: pacman -Sy espeak
* Windows: [USB Driver](http://www.pixhawk.org/firmware/downloads) to connect to Pixhawk/PX4Flow/3DR Radio
* Android: [Qt Android Setup](http://doc.qt.io/qt-5/androidgs.html)
57

58
###### Building using Qt Creator
Gus Grubba's avatar
Gus Grubba committed
59

Gus Grubba's avatar
Gus Grubba committed
60
* Launch Qt Creator and open the `qgroundcontrol.pro` project.
Don Gagne's avatar
Don Gagne committed
61
* Select the appropriate kit for your needs:
Don Gagne's avatar
Don Gagne committed
62
    * OSX: Desktop Qt 5.5.1 clang 64 bit
Don Gagne's avatar
Don Gagne committed
63
    * Ubuntu: Desktop Qt 5.5.1 GCC bit
Don Gagne's avatar
Don Gagne committed
64
    * Windows: Desktop Qt 5.5.1 MSVC2013 32bit
Don Gagne's avatar
Don Gagne committed
65
    * Android: Android for armeabi-v7a (GCC 4.9, Qt 5.5.1)
Gus Grubba's avatar
Gus Grubba committed
66
* Note: iOS builds must be built using xCode: http://doc.qt.io/qt-5/ios-support.html. Use Qt Creator to generate the XCode project (*Run Qmake* from the context menu).
Gus Grubba's avatar
Gus Grubba committed
67

Gus Grubba's avatar
Gus Grubba committed
68 69 70 71 72 73 74 75 76 77 78 79
###### Special case for Xcode 8 and Qt 5.5.1

Xcode 8 broke the Qt 5.5.1 build system (qmake). As this is the version of Qt we're using for the moment, you will need to patch your Qt installation to make the build work. This is for both Mac OS X and iOS.

Under the tools directory, you will find a script used by the CI build to patch Qt (`patch_qt_for_xcode8.sh`). You can use this script as a starting point. You will need to edit a few variables it expects to run:

```
IOSDIR=/<your_qt_path>/Qt/5.5/ios
OSXDIR=/<your_qt_path>/Qt/5.5/clang_64
TRAVIS_BUILD_DIR=/<your_github_repo>/qgroundcontrol
```

80 81
#### Vagrant

Lorenz Meier's avatar
Lorenz Meier committed
82
A Vagrantfile is provided to build QGroundControl using the [Vagrant](https://www.vagrantup.com/) system. This will produce a native Linux build which can be run in the Vagrant Virtual Machine or on the host machine if it is compatible.
83 84 85 86 87 88

* [Download](https://www.vagrantup.com/downloads.html) Vagrant
* [Install](https://www.vagrantup.com/docs/getting-started/) Vagrant
* From the root directory of the QGroundControl repository run "vagrant up"

#### Additional build notes for all supported OS
89

Gus Grubba's avatar
Gus Grubba committed
90 91
* Warnings as Errors: Specifying `CONFIG+=WarningsAsErrorsOn` will turn all warnings into errors which breaks the build. If you are working on a pull request you plan to submit to github for consideration, you should always run with this setting turned on, since it is required for all pull requests. NOTE: Putting this line into a file called "user_config.pri" in the top-level directory (same directory as `qgroundcontrol.pro`) will set this flag on all builds without interfering with the GIT history.
* Parallel builds: For non Windows builds, you can use the '-j#' option to run parellel builds.
Don Gagne's avatar
Don Gagne committed
92
* Location of built files: Individual build file results can be found in the `build_debug` or `build_release` directories. The built executable can be found in the `debug` or `release` directory.
Don Gagne's avatar
Don Gagne committed
93
* If you get this error when running qgroundcontrol: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version 'GLIBCXX_3.4.20' not found. You need to either update to the latest gcc, or install the latest libstdc++.6 using: sudo apt-get install libstdc++6.
94

Don Gagne's avatar
Don Gagne committed
95
## Additional functionality
Don Gagne's avatar
Don Gagne committed
96
QGroundcontrol has functionality that is dependent on the operating system and libraries installed by the user. The following sections describe these features, their dependencies, and how to disable/alter them during the build process. These features can be forcibly enabled/disabled by specifying additional values to qmake. 
Don Gagne's avatar
Don Gagne committed
97 98

### Opal-RT's RT-LAB simulator
Don Gagne's avatar
Don Gagne committed
99
Integration with Opal-RT's RT-LAB simulator can be enabled on Windows by installing RT-LAB 7.2.4. This allows vehicles to be simulated in RT-LAB and communicate directly with QGC on the same computer as if the UAS was actually deployed. This support is enabled by default once the requisite RT-LAB software is installed. Disabling this can be done by adding `DEFINES+=DISABLE_RTLAB` to qmake.
Don Gagne's avatar
Don Gagne committed
100 101 102 103

### XBee support
QGroundControl can talk to XBee wireless devices using their proprietary protocol directly on Windows and Linux platforms. This support is not necessary if you're not using XBee devices or aren't using their proprietary protocol. On Windows, the necessary dependencies are included in this repository and no additional steps are required. For Linux, change to the `libs/thirdParty/libxbee` folder and run `make;sudo make install` to install libxbee on your system (uninstalling can be done with a `sudo make uninstall`). `qmake` will automatically detect the library on Linux, so no other work is necessary.

Don Gagne's avatar
Don Gagne committed
104
To disable XBee support you may add `DEFINES+=DISABLE_XBEE` to qmake.
Gus Grubba's avatar
Gus Grubba committed
105 106 107

### Video Streaming
Check the [Video Streaming](https://github.com/mavlink/qgroundcontrol/tree/master/src/VideoStreaming) directory for further instructions.