QGCApplication.h 8.01 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

Don Gagne's avatar
Don Gagne committed
73
    /// Show a non-modal message to the user
74
    Q_SLOT void showMessage(const QString& message);
75

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

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

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

85 86 87
    /// Is Internet available?
    bool isInternetAvailable();

88 89
    FactGroup* gpsRtkFactGroup(void)  { return _gpsRtkFactGroup; }

90 91 92
    static QString cachedParameterMetaDataFile(void);
    static QString cachedAirframeMetaDataFile(void);

93
    void            setLanguage();
94
    QQuickItem*     mainRootWindow();
95

96 97
    uint64_t        msecsSinceBoot(void) { return _msecsElapsedTime.elapsed(); }

98 99 100
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
101

102 103
    /// 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
104

105 106
    /// 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
107

108
    void showSetupView();
Don Gagne's avatar
Don Gagne committed
109

110
    void qmlAttemptWindowClose();
Don Gagne's avatar
Don Gagne committed
111

112 113 114 115
    /// Save the specified telemetry Log
    void saveTelemetryLogOnMainThread(QString tempLogfile);

    /// Check that the telemetry save path is set correctly
116
    void checkTelemetrySavePathOnMainThread();
117

118 119 120
    /// Get current language
    const QLocale getCurrentLanguage() { return _locale; }

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

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

128
public:
129
    // Although public, these methods are internal and should only be called by UnitTest code
dogmaphobic's avatar
dogmaphobic committed
130

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

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

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

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

145 146
    bool    isErrorState()  { return _error; }

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

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

153 154
    bool _checkTelemetrySavePath(bool useMessageBox);

Don Gagne's avatar
Don Gagne committed
155
private slots:
Don Gagne's avatar
Don Gagne committed
156
    void _missingParamsDisplay(void);
Don Gagne's avatar
Don Gagne committed
157 158 159
    void _currentVersionDownloadFinished(QString remoteFile, QString localFile);
    void _currentVersionDownloadError(QString errorMsg);
    bool _parseVersionText(const QString& versionString, int& majorVersion, int& minorVersion, int& buildVersion);
160 161 162 163
    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
164

pixhawk's avatar
pixhawk committed
165
private:
166 167
    QObject*    _rootQmlObject          ();
    void        _checkForNewVersion     ();
168
    void        _exitWithError          (QString errorMessage);
Don Gagne's avatar
Don Gagne committed
169

dogmaphobic's avatar
dogmaphobic committed
170

171 172 173 174
    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
175

176 177 178 179 180 181 182 183 184 185
    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;
186
    QQuickItem*         _mainRootWindow         = nullptr;
187 188
    bool                _bluetoothAvailable     = false;
    QTranslator         _QGCTranslator;
189
    QTranslator         _QGCTranslatorQt;
190
    QLocale             _locale;
191
    bool                _error                  = false;
192
    QElapsedTimer       _msecsElapsedTime;
dogmaphobic's avatar
dogmaphobic committed
193

Don Gagne's avatar
Don Gagne committed
194 195 196
    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
197 198
    /// Unit Test have access to creating and destroying singletons
    friend class UnitTest;
Gus Grubba's avatar
Gus Grubba committed
199

pixhawk's avatar
pixhawk committed
200 201
};

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