README.md 6.16 KB
Newer Older
1
# QGroundControl
2 3
## Open Source Micro Air Vehicle Ground Control Station

4 5 6
[![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
7 8
[![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
9
The license terms are set in the COPYING.md file.
10 11 12 13 14 15 16 17 18 19 20

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

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

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


Don Gagne's avatar
Don Gagne committed
21
## Obtaining source code
Don Gagne's avatar
Don Gagne committed
22
Source code for QGroundControl is kept on GitHub: https://github.com/mavlink/qgroundcontrol.
Stefano Probst's avatar
Stefano Probst committed
23
```
Daniel Agar's avatar
Daniel Agar committed
24
git clone --recursive https://github.com/mavlink/qgroundcontrol.git
Stefano Probst's avatar
Stefano Probst committed
25
```
Don Gagne's avatar
Don Gagne committed
26
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.
27

Don Gagne's avatar
Don Gagne committed
28
### Supported Builds
29 30

#### Native Builds
Don Gagne's avatar
Don Gagne committed
31
QGroundControl builds are supported for OSX, Linux, Windows, iOS and Android. QGroundControl uses [Qt](http://www.qt.io) as it's cross-platform support library and uses [QtCreator](http://doc.qt.io/qtcreator/index.html) as it's default build environment.
Don Gagne's avatar
Don Gagne committed
32
* OSX: OSX 10.7 or higher, 64 bit, clang compiler
Don Gagne's avatar
Don Gagne committed
33
* Ubuntu: 64 bit, gcc compiler
Don Gagne's avatar
Don Gagne committed
34
* 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
35
* iOS: 8.0 and higher
Don Gagne's avatar
Don Gagne committed
36
* Android: Jelly Bean (4.1) and higher
Don Gagne's avatar
Don Gagne committed
37
* Qt version: 5.5.1 ONLY
38

39
###### Install QT
40
You need to install Qt like this instead of using packages from say a Linux distribution because QGroundControl needs access to private Qt headers.
Don Gagne's avatar
Don Gagne committed
41
* Download the [Qt installer](http://www.qt.io/download-open-source)
Don Gagne's avatar
Don Gagne committed
42
    * Make sure to install Qt 5.5 version NOT 5.6  
Don Gagne's avatar
Don Gagne committed
43
    * 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
44
    * 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
45

46
###### Install additional packages:
Don Gagne's avatar
Don Gagne committed
47
* Ubuntu: sudo apt-get install espeak libespeak-dev libudev-dev libsdl1.2-dev
48
* Fedora: sudo dnf install espeak espeak-devel SDL-devel SDL-static systemd-devel
Don Gagne's avatar
Don Gagne committed
49 50 51
* 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)
52

53
###### Building using Qt Creator
Gus Grubba's avatar
Gus Grubba committed
54
* Launch Qt Creator and open the `qgroundcontrol.pro` project.
Don Gagne's avatar
Don Gagne committed
55
* Select the appropriate kit for your needs:
Don Gagne's avatar
Don Gagne committed
56
    * OSX: Desktop Qt 5.5.1 clang 64 bit
Don Gagne's avatar
Don Gagne committed
57
    * Ubuntu: Desktop Qt 5.5.1 GCC bit
Don Gagne's avatar
Don Gagne committed
58
    * Windows: Desktop Qt 5.5.1 MSVC2013 32bit
Don Gagne's avatar
Don Gagne committed
59
    * Android: Android for armeabi-v7a (GCC 4.9, Qt 5.5.1)
Don Gagne's avatar
Don Gagne committed
60
* Note: iOS builds must be built using xCode: http://doc.qt.io/qt-5/ios-support.html
Gus Grubba's avatar
Gus Grubba committed
61

62 63
#### Vagrant

Lorenz Meier's avatar
Lorenz Meier committed
64
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.
65 66 67 68 69 70 71

* [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
72

73
* Warnings as Errors: Specifying `CONFIG+=WarningsAsErrorsOn` will turn all warnings into errors which break the build. If you are working on a pull request you plan to submit to github for consideration, you should always run with this settings 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 will set this flag on all builds without interfering with the GIT history.
Don Gagne's avatar
Don Gagne committed
74
* Parallel builds: You can use the '-j#' option to run parellel builds.
Don Gagne's avatar
Don Gagne committed
75
* 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
76
* 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.
77

Don Gagne's avatar
Don Gagne committed
78
## Additional functionality
Don Gagne's avatar
Don Gagne committed
79
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
80 81

### Opal-RT's RT-LAB simulator
Don Gagne's avatar
Don Gagne committed
82
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
83 84 85 86

### 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
87
To disable XBee support you may add `DEFINES+=DISABLE_XBEE` to qmake.