QGCCorePlugin.cc 10.8 KB
Newer Older
1 2 3 4 5 6 7 8 9
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

10
#include "QGCApplication.h"
11 12
#include "QGCCorePlugin.h"
#include "QGCOptions.h"
13
#include "QmlComponentInfo.h"
14
#include "FactMetaData.h"
Don Gagne's avatar
Don Gagne committed
15
#include "SettingsManager.h"
16
#include "AppMessages.h"
17
#include "QmlObjectListModel.h"
18
#include "VideoReceiver.h"
19
#include "QGCLoggingCategory.h"
20 21 22 23 24 25 26 27 28 29 30 31

#include <QtQml>
#include <QQmlEngine>

/// @file
///     @brief Core Plugin Interface for QGroundControl - Default Implementation
///     @author Gus Grubba <mavlink@grubba.com>

class QGCCorePlugin_p
{
public:
    QGCCorePlugin_p()
32 33 34 35 36
        : pGeneral                  (NULL)
        , pCommLinks                (NULL)
        , pOfflineMaps              (NULL)
        , pMAVLink                  (NULL)
        , pConsole                  (NULL)
37
        , pHelp                     (NULL)
DonLakeFlyer's avatar
DonLakeFlyer committed
38
    #if defined(QT_DEBUG)
39 40
        , pMockLink                 (NULL)
        , pDebug                    (NULL)
DonLakeFlyer's avatar
DonLakeFlyer committed
41
    #endif
42 43 44
        , defaultOptions            (NULL)
        , valuesPageWidgetInfo      (NULL)
        , cameraPageWidgetInfo      (NULL)
Gus Grubba's avatar
Gus Grubba committed
45
        , videoPageWidgetInfo       (NULL)
46 47
        , healthPageWidgetInfo      (NULL)
        , vibrationPageWidgetInfo   (NULL)
48 49
    {
    }
50

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
    ~QGCCorePlugin_p()
    {
        if(pGeneral)
            delete pGeneral;
        if(pCommLinks)
            delete pCommLinks;
        if(pOfflineMaps)
            delete pOfflineMaps;
        if(pMAVLink)
            delete pMAVLink;
        if(pConsole)
            delete pConsole;
#if defined(QT_DEBUG)
        if(pMockLink)
            delete pMockLink;
        if(pDebug)
            delete pDebug;
#endif
        if(defaultOptions)
            delete defaultOptions;
    }
72

73 74 75 76 77
    QmlComponentInfo* pGeneral;
    QmlComponentInfo* pCommLinks;
    QmlComponentInfo* pOfflineMaps;
    QmlComponentInfo* pMAVLink;
    QmlComponentInfo* pConsole;
78
    QmlComponentInfo* pHelp;
79
#if defined(QT_DEBUG)
80 81
    QmlComponentInfo* pMockLink;
    QmlComponentInfo* pDebug;
82 83 84
#endif
    QVariantList settingsList;
    QGCOptions*  defaultOptions;
85

86 87
    QmlComponentInfo*   valuesPageWidgetInfo;
    QmlComponentInfo*   cameraPageWidgetInfo;
Gus Grubba's avatar
Gus Grubba committed
88
    QmlComponentInfo*   videoPageWidgetInfo;
89 90 91 92 93
    QmlComponentInfo*   healthPageWidgetInfo;
    QmlComponentInfo*   vibrationPageWidgetInfo;
    QVariantList        instrumentPageWidgetList;

    QmlObjectListModel _emptyCustomMapItems;
94 95 96 97 98 99 100 101 102
};

QGCCorePlugin::~QGCCorePlugin()
{
    if(_p) {
        delete _p;
    }
}

103 104
QGCCorePlugin::QGCCorePlugin(QGCApplication *app, QGCToolbox* toolbox)
    : QGCTool(app, toolbox)
105
    , _showTouchAreas(false)
106
    , _showAdvancedUI(true)
107 108 109 110 111 112
{
    _p = new QGCCorePlugin_p;
}

void QGCCorePlugin::setToolbox(QGCToolbox *toolbox)
{
DonLakeFlyer's avatar
DonLakeFlyer committed
113 114 115 116
    QGCTool::setToolbox(toolbox);
    QQmlEngine::setObjectOwnership(this, QQmlEngine::CppOwnership);
    qmlRegisterUncreatableType<QGCCorePlugin>("QGroundControl.QGCCorePlugin", 1, 0, "QGCCorePlugin", "Reference only");
    qmlRegisterUncreatableType<QGCOptions>("QGroundControl.QGCOptions",       1, 0, "QGCOptions",    "Reference only");
117 118
}

119
QVariantList &QGCCorePlugin::settingsPages()
120 121
{
    if(!_p->pGeneral) {
122
        _p->pGeneral = new QmlComponentInfo(tr("General"),
DonLakeFlyer's avatar
DonLakeFlyer committed
123 124
                                       QUrl::fromUserInput("qrc:/qml/GeneralSettings.qml"),
                                       QUrl::fromUserInput("qrc:/res/gear-white.svg"));
125 126
        _p->settingsList.append(QVariant::fromValue((QmlComponentInfo*)_p->pGeneral));
        _p->pCommLinks = new QmlComponentInfo(tr("Comm Links"),
DonLakeFlyer's avatar
DonLakeFlyer committed
127 128
                                         QUrl::fromUserInput("qrc:/qml/LinkSettings.qml"),
                                         QUrl::fromUserInput("qrc:/res/waves.svg"));
129 130
        _p->settingsList.append(QVariant::fromValue((QmlComponentInfo*)_p->pCommLinks));
        _p->pOfflineMaps = new QmlComponentInfo(tr("Offline Maps"),
DonLakeFlyer's avatar
DonLakeFlyer committed
131 132
                                           QUrl::fromUserInput("qrc:/qml/OfflineMap.qml"),
                                           QUrl::fromUserInput("qrc:/res/waves.svg"));
133 134
        _p->settingsList.append(QVariant::fromValue((QmlComponentInfo*)_p->pOfflineMaps));
        _p->pMAVLink = new QmlComponentInfo(tr("MAVLink"),
DonLakeFlyer's avatar
DonLakeFlyer committed
135 136
                                       QUrl::fromUserInput("qrc:/qml/MavlinkSettings.qml"),
                                       QUrl::fromUserInput("qrc:/res/waves.svg"));
137 138
        _p->settingsList.append(QVariant::fromValue((QmlComponentInfo*)_p->pMAVLink));
        _p->pConsole = new QmlComponentInfo(tr("Console"),
DonLakeFlyer's avatar
DonLakeFlyer committed
139
                                       QUrl::fromUserInput("qrc:/qml/QGroundControl/Controls/AppMessages.qml"));
140
        _p->settingsList.append(QVariant::fromValue((QmlComponentInfo*)_p->pConsole));
141 142 143
        _p->pHelp = new QmlComponentInfo(tr("Help"),
                                       QUrl::fromUserInput("qrc:/qml/HelpSettings.qml"));
        _p->settingsList.append(QVariant::fromValue((QmlComponentInfo*)_p->pHelp));
DonLakeFlyer's avatar
DonLakeFlyer committed
144
#if defined(QT_DEBUG)
145
        //-- These are always present on Debug builds
146
        _p->pMockLink = new QmlComponentInfo(tr("Mock Link"),
DonLakeFlyer's avatar
DonLakeFlyer committed
147
                                        QUrl::fromUserInput("qrc:/qml/MockLink.qml"));
148 149
        _p->settingsList.append(QVariant::fromValue((QmlComponentInfo*)_p->pMockLink));
        _p->pDebug = new QmlComponentInfo(tr("Debug"),
DonLakeFlyer's avatar
DonLakeFlyer committed
150
                                     QUrl::fromUserInput("qrc:/qml/DebugWindow.qml"));
151
        _p->settingsList.append(QVariant::fromValue((QmlComponentInfo*)_p->pDebug));
DonLakeFlyer's avatar
DonLakeFlyer committed
152
#endif
153 154 155 156
    }
    return _p->settingsList;
}

157 158 159
QVariantList& QGCCorePlugin::instrumentPages(void)
{
    if (!_p->valuesPageWidgetInfo) {
Gus Grubba's avatar
Gus Grubba committed
160 161 162
        _p->valuesPageWidgetInfo    = new QmlComponentInfo(tr("Values"),    QUrl::fromUserInput("qrc:/qml/ValuePageWidget.qml"));
        _p->cameraPageWidgetInfo    = new QmlComponentInfo(tr("Camera"),    QUrl::fromUserInput("qrc:/qml/CameraPageWidget.qml"));
#if defined(QGC_GST_STREAMING)
163
        _p->videoPageWidgetInfo     = new QmlComponentInfo(tr("Video Stream"), QUrl::fromUserInput("qrc:/qml/VideoPageWidget.qml"));
Gus Grubba's avatar
Gus Grubba committed
164 165
#endif
        _p->healthPageWidgetInfo    = new QmlComponentInfo(tr("Health"),    QUrl::fromUserInput("qrc:/qml/HealthPageWidget.qml"));
166
        _p->vibrationPageWidgetInfo = new QmlComponentInfo(tr("Vibration"), QUrl::fromUserInput("qrc:/qml/VibrationPageWidget.qml"));
167 168 169

        _p->instrumentPageWidgetList.append(QVariant::fromValue(_p->valuesPageWidgetInfo));
        _p->instrumentPageWidgetList.append(QVariant::fromValue(_p->cameraPageWidgetInfo));
Gus Grubba's avatar
Gus Grubba committed
170 171 172
#if defined(QGC_GST_STREAMING)
        _p->instrumentPageWidgetList.append(QVariant::fromValue(_p->videoPageWidgetInfo));
#endif
173 174 175 176 177 178
        _p->instrumentPageWidgetList.append(QVariant::fromValue(_p->healthPageWidgetInfo));
        _p->instrumentPageWidgetList.append(QVariant::fromValue(_p->vibrationPageWidgetInfo));
    }
    return _p->instrumentPageWidgetList;
}

179
int QGCCorePlugin::defaultSettings()
180 181 182 183
{
    return 0;
}

184 185 186 187 188 189 190 191
QGCOptions* QGCCorePlugin::options()
{
    if(!_p->defaultOptions) {
        _p->defaultOptions = new QGCOptions();
    }
    return _p->defaultOptions;
}

192 193 194
bool QGCCorePlugin::overrideSettingsGroupVisibility(QString name)
{
    Q_UNUSED(name);
195

196 197 198
    // Always show all
    return true;
}
199

200
bool QGCCorePlugin::adjustSettingMetaData(const QString& settingsGroup, FactMetaData& metaData)
201
{
202 203 204 205 206
    if (settingsGroup != AppSettings::settingsGroup) {
        // All changes refer to AppSettings
        return true;
    }

207
    //-- Default Palette
Don Gagne's avatar
Don Gagne committed
208 209 210 211 212 213 214 215
    if (metaData.name() == AppSettings::indoorPaletteName) {
        QVariant outdoorPalette;
#if defined (__mobile__)
        outdoorPalette = 0;
#else
        outdoorPalette = 1;
#endif
        metaData.setRawDefaultValue(outdoorPalette);
216 217 218 219 220
        return true;
    //-- Auto Save Telemetry Logs
    } else if (metaData.name() == AppSettings::telemetrySaveName) {
#if defined (__mobile__)
        metaData.setRawDefaultValue(false);
221
        return true;
222 223 224
#else
        metaData.setRawDefaultValue(true);
        return true;
225 226 227 228 229 230 231
#endif
#if defined(__ios__)
    } else if (metaData.name() == AppSettings::savePathName) {
        QString appName = qgcApp()->applicationName();
        QDir rootDir = QDir(QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation));
        metaData.setRawDefaultValue(rootDir.filePath(appName));
        return false;
232
#endif
Don Gagne's avatar
Don Gagne committed
233
    }
234
    return true; // Show setting in ui
235
}
DonLakeFlyer's avatar
DonLakeFlyer committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

void QGCCorePlugin::setShowTouchAreas(bool show)
{
    if (show != _showTouchAreas) {
        _showTouchAreas = show;
        emit showTouchAreasChanged(show);
    }
}

void QGCCorePlugin::setShowAdvancedUI(bool show)
{
    if (show != _showAdvancedUI) {
        _showAdvancedUI = show;
        emit showAdvancedUIChanged(show);
    }
}
252 253 254 255 256 257

void QGCCorePlugin::paletteOverride(QString colorName, QGCPalette::PaletteColorInfo_t& colorInfo)
{
    Q_UNUSED(colorName);
    Q_UNUSED(colorInfo);
}
258 259 260 261 262 263 264 265

QString QGCCorePlugin::showAdvancedUIMessage(void) const
{
    return tr("WARNING: You are about to enter Advanced Mode. "
              "If used incorrectly, this may cause your vehicle to malfunction thus voiding your warranty. "
              "You should do so only if instructed by customer support. "
              "Are you sure you want to enable Advanced Mode?");
}
266 267 268 269 270 271

void QGCCorePlugin::valuesWidgetDefaultSettings(QStringList& largeValues, QStringList& smallValues)
{
    Q_UNUSED(smallValues);
    largeValues << "Vehicle.altitudeRelative" << "Vehicle.groundSpeed" << "Vehicle.flightTime";
}
272 273 274 275 276 277 278 279 280 281

QQmlApplicationEngine* QGCCorePlugin::createRootWindow(QObject *parent)
{
    QQmlApplicationEngine* pEngine = new QQmlApplicationEngine(parent);
    pEngine->addImportPath("qrc:/qml");
    pEngine->rootContext()->setContextProperty("joystickManager", qgcApp()->toolbox()->joystickManager());
    pEngine->rootContext()->setContextProperty("debugMessageModel", AppMessages::getModel());
    pEngine->load(QUrl(QStringLiteral("qrc:/qml/MainWindowNative.qml")));
    return pEngine;
}
282 283 284 285 286 287 288 289 290

bool QGCCorePlugin::mavlinkMessage(Vehicle* vehicle, LinkInterface* link, mavlink_message_t message)
{
    Q_UNUSED(vehicle);
    Q_UNUSED(link);
    Q_UNUSED(message);

    return true;
}
291 292 293 294 295

QmlObjectListModel* QGCCorePlugin::customMapItems(void)
{
    return &_p->_emptyCustomMapItems;
}
296 297 298 299 300

VideoReceiver* QGCCorePlugin::createVideoReceiver(QObject* parent)
{
    return new VideoReceiver(parent);
}
301 302 303 304 305

bool QGCCorePlugin::guidedActionsControllerLogging(void) const
{
    return GuidedActionsControllerLog().isDebugEnabled();
}
306 307 308 309 310 311 312 313 314 315

QString QGCCorePlugin::stableVersionCheckFileUrl(void) const
{
#ifdef QGC_CUSTOM_BUILD
    // Custom builds must override to turn on and provide their own location
    return QString();
#else
    return QString("https://s3-us-west-2.amazonaws.com/qgroundcontrol/latest/QGC.version.txt");
#endif
}