QGCApplication.h 8.16 KB
Newer Older
1 2
/****************************************************************************
 *
Gus Grubba's avatar
Gus Grubba committed
3
 * (c) 2009-2020 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
4 5 6 7 8
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/
dogmaphobic's avatar
dogmaphobic committed
9

10
#pragma once
pixhawk's avatar
pixhawk committed
11 12

#include <QApplication>
13
#include <QTimer>
Don Gagne's avatar
Don Gagne committed
14
#include <QQmlApplicationEngine>
15
#include <QElapsedTimer>
pixhawk's avatar
pixhawk committed
16

Don Gagne's avatar
Don Gagne committed
17
#include "LinkConfiguration.h"
18 19 20 21 22 23
#include "LinkManager.h"
#include "MAVLinkProtocol.h"
#include "FlightMapSettings.h"
#include "FirmwarePluginManager.h"
#include "MultiVehicleManager.h"
#include "JoystickManager.h"
24
#include "AudioOutput.h"
25 26
#include "UASMessageHandler.h"
#include "FactSystem.h"
27
#include "GPSRTKFactGroup.h"
Don Gagne's avatar
Don Gagne committed
28

29
#ifdef QGC_RTLAB_ENABLED
30 31
#include "OpalLink.h"
#endif
32

33 34
// Work around circular header includes
class QGCSingleton;
35
class QGCToolbox;
Don Gagne's avatar
Don Gagne committed
36
class QGCFileDownload;
Don Gagne's avatar
Don Gagne committed
37

38 39 40 41 42 43 44 45 46 47 48 49
/**
 * @brief The main application and management class.
 *
 * This class is started by the main method and provides
 * the central management unit of the groundstation application.
 *
 * Needs QApplication base to support QtCharts module. This way
 * we avoid application crashing on 5.12 when using the module.
 *
 * Note: `lastWindowClosed` will be sent by MessageBox popups and other
 * dialogs, that are spawned in QML, when they are closed
**/
50
class QGCApplication : public QApplication
pixhawk's avatar
pixhawk committed
51
{
52
    Q_OBJECT
pixhawk's avatar
pixhawk committed
53
public:
DonLakeFlyer's avatar
DonLakeFlyer committed
54
    QGCApplication(int &argc, char* argv[], bool unitTesting);
Don Gagne's avatar
Don Gagne committed
55
    ~QGCApplication();
dogmaphobic's avatar
dogmaphobic committed
56

Don Gagne's avatar
Don Gagne committed
57 58
    /// @brief Sets the persistent flag to delete all settings the next time QGroundControl is started.
    void deleteAllSettingsNextBoot(void);
dogmaphobic's avatar
dogmaphobic committed
59

Don Gagne's avatar
Don Gagne committed
60 61
    /// @brief Clears the persistent flag to delete all settings the next time QGroundControl is started.
    void clearDeleteAllSettingsNextBoot(void);
dogmaphobic's avatar
dogmaphobic committed
62

63
    /// @brief Returns true if unit tests are being run
Don Gagne's avatar
Don Gagne committed
64
    bool runningUnitTests(void) { return _runningUnitTests; }
dogmaphobic's avatar
dogmaphobic committed
65

66 67 68
    /// @brief Returns true if Qt debug output should be logged to a file
    bool logOutput(void) { return _logOutput; }

Don Gagne's avatar
Don Gagne committed
69
    /// Used to report a missing Parameter. Warning will be displayed to user. Method may be called
70
    /// multiple times.
Don Gagne's avatar
Don Gagne committed
71
    void reportMissingParameter(int componentId, const QString& name);
72

73 74 75 76 77
    /// Show non-modal vehicle message to the user
    Q_SLOT void showVehicleMessage(const QString& message);

    /// Show modal application message to the user
    Q_SLOT void showAppMessage(const QString& message, const QString& title = QString());
78

dogmaphobic's avatar
dogmaphobic committed
79
    /// @return true: Fake ui into showing mobile interface
80
    bool fakeMobile(void) const { return _fakeMobile; }
dogmaphobic's avatar
dogmaphobic committed
81

82 83
    // Still working on getting rid of this and using dependency injection instead for everything
    QGCToolbox* toolbox(void) { return _toolbox; }
dogmaphobic's avatar
dogmaphobic committed
84 85 86 87

    /// Do we have Bluetooth Support?
    bool isBluetoothAvailable() { return _bluetoothAvailable; }

88 89 90
    /// Is Internet available?
    bool isInternetAvailable();

91 92
    FactGroup* gpsRtkFactGroup(void)  { return _gpsRtkFactGroup; }

93 94 95
    static QString cachedParameterMetaDataFile(void);
    static QString cachedAirframeMetaDataFile(void);

96
    void            setLanguage();
97
    QQuickItem*     mainRootWindow();
98

99 100
    uint64_t        msecsSinceBoot(void) { return _msecsElapsedTime.elapsed(); }

101 102 103
public slots:
    /// You can connect to this slot to show an information message box from a different thread.
    void informationMessageBoxOnMainThread(const QString& title, const QString& msg);
dogmaphobic's avatar
dogmaphobic committed
104

105 106
    /// You can connect to this slot to show a warning message box from a different thread.
    void warningMessageBoxOnMainThread(const QString& title, const QString& msg);
dogmaphobic's avatar
dogmaphobic committed
107

108 109
    /// You can connect to this slot to show a critical message box from a different thread.
    void criticalMessageBoxOnMainThread(const QString& title, const QString& msg);
dogmaphobic's avatar
dogmaphobic committed
110

111
    void showSetupView();
Don Gagne's avatar
Don Gagne committed
112

113
    void qmlAttemptWindowClose();
Don Gagne's avatar
Don Gagne committed
114

115 116 117 118
    /// Save the specified telemetry Log
    void saveTelemetryLogOnMainThread(QString tempLogfile);

    /// Check that the telemetry save path is set correctly
119
    void checkTelemetrySavePathOnMainThread();
120

121 122 123
    /// Get current language
    const QLocale getCurrentLanguage() { return _locale; }

124 125 126
signals:
    /// This is connected to MAVLinkProtocol::checkForLostLogFiles. We signal this to ourselves to call the slot
    /// on the MAVLinkProtocol thread;
127 128 129
    void checkForLostLogFiles   ();

    void languageChanged        (const QLocale locale);
dogmaphobic's avatar
dogmaphobic committed
130

131
public:
132
    // Although public, these methods are internal and should only be called by UnitTest code
dogmaphobic's avatar
dogmaphobic committed
133

134 135
    /// @brief Perform initialize which is common to both normal application running and unit tests.
    ///         Although public should only be called by main.
136
    void _initCommon();
137

Patrick José Pereira's avatar
Patrick José Pereira committed
138
    /// @brief Initialize the application for normal application boot. Or in other words we are not going to run
139
    ///         unit tests. Although public should only be called by main.
140
    bool _initForNormalAppBoot();
dogmaphobic's avatar
dogmaphobic committed
141

Patrick José Pereira's avatar
Patrick José Pereira committed
142
    /// @brief Initialize the application for normal application boot. Or in other words we are not going to run
143
    ///         unit tests. Although public should only be called by main.
144
    bool _initForUnitTests();
Don Gagne's avatar
Don Gagne committed
145

146
    static QGCApplication*  _app;   ///< Our own singleton. Should be reference directly by qgcApp
dogmaphobic's avatar
dogmaphobic committed
147

148 149
    bool    isErrorState()  { return _error; }

Don Gagne's avatar
Don Gagne committed
150 151 152 153
public:
    // Although public, these methods are internal and should only be called by UnitTest code

    /// Shutdown the application object
154
    void _shutdown();
Don Gagne's avatar
Don Gagne committed
155

156 157
    bool _checkTelemetrySavePath(bool useMessageBox);

Don Gagne's avatar
Don Gagne committed
158
private slots:
Don Gagne's avatar
Don Gagne committed
159
    void _missingParamsDisplay(void);
Don Gagne's avatar
Don Gagne committed
160 161 162
    void _currentVersionDownloadFinished(QString remoteFile, QString localFile);
    void _currentVersionDownloadError(QString errorMsg);
    bool _parseVersionText(const QString& versionString, int& majorVersion, int& minorVersion, int& buildVersion);
163 164 165 166
    void _onGPSConnect();
    void _onGPSDisconnect();
    void _gpsSurveyInStatus(float duration, float accuracyMM,  double latitude, double longitude, float altitude, bool valid, bool active);
    void _gpsNumSatellites(int numSatellites);
dogmaphobic's avatar
dogmaphobic committed
167

pixhawk's avatar
pixhawk committed
168
private:
169 170
    QObject*    _rootQmlObject          ();
    void        _checkForNewVersion     ();
171
    void        _exitWithError          (QString errorMessage);
Don Gagne's avatar
Don Gagne committed
172

dogmaphobic's avatar
dogmaphobic committed
173

174 175 176 177
    bool                        _runningUnitTests;                                  ///< true: running unit tests, false: normal app
    static const int            _missingParamsDelayedDisplayTimerTimeout = 1000;    ///< Timeout to wait for next missing fact to come in before display
    QTimer                      _missingParamsDelayedDisplayTimer;                  ///< Timer use to delay missing fact display
    QList<QPair<int,QString>>   _missingParams;                                     ///< List of missing parameter component id:name
178

179 180 181 182 183 184 185 186 187 188
    QQmlApplicationEngine* _qmlAppEngine        = nullptr;
    bool                _logOutput              = false;                    ///< true: Log Qt debug output to file
    bool				_fakeMobile             = false;                    ///< true: Fake ui into displaying mobile interface
    bool                _settingsUpgraded       = false;                    ///< true: Settings format has been upgrade to new version
    int                 _majorVersion           = 0;
    int                 _minorVersion           = 0;
    int                 _buildVersion           = 0;
    QGCFileDownload*    _currentVersionDownload = nullptr;
    GPSRTKFactGroup*    _gpsRtkFactGroup        = nullptr;
    QGCToolbox*         _toolbox                = nullptr;
189
    QQuickItem*         _mainRootWindow         = nullptr;
190 191
    bool                _bluetoothAvailable     = false;
    QTranslator         _QGCTranslator;
192
    QTranslator         _QGCTranslatorQt;
193
    QLocale             _locale;
194
    bool                _error                  = false;
195
    QElapsedTimer       _msecsElapsedTime;
dogmaphobic's avatar
dogmaphobic committed
196

Don Gagne's avatar
Don Gagne committed
197 198 199
    static const char* _settingsVersionKey;             ///< Settings key which hold settings version
    static const char* _deleteAllSettingsKey;           ///< If this settings key is set on boot, all settings will be deleted

Don Gagne's avatar
Don Gagne committed
200 201
    /// Unit Test have access to creating and destroying singletons
    friend class UnitTest;
Gus Grubba's avatar
Gus Grubba committed
202

pixhawk's avatar
pixhawk committed
203 204
};

Don Gagne's avatar
Don Gagne committed
205 206
/// @brief Returns the QGCApplication object singleton.
QGCApplication* qgcApp(void);