MissionCommandList.cc 11.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*===================================================================
QGroundControl Open Source Ground Control Station

(c) 2009, 2010 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>

This file is part of the QGROUNDCONTROL project

    QGROUNDCONTROL is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    QGROUNDCONTROL is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.

======================================================================*/

#include "MissionCommandList.h"
#include "FactMetaData.h"
#include "Vehicle.h"
#include "FirmwarePluginManager.h"
#include "QGCApplication.h"
#include "QGroundControlQmlGlobal.h"
Don Gagne's avatar
Don Gagne committed
29
#include "JsonHelper.h"
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

#include <QStringList>
#include <QJsonDocument>
#include <QJsonParseError>
#include <QJsonArray>
#include <QDebug>
#include <QFile>

const QString MissionCommandList::_categoryJsonKey             (QStringLiteral("category"));
const QString MissionCommandList::_decimalPlacesJsonKey        (QStringLiteral("decimalPlaces"));
const QString MissionCommandList::_defaultJsonKey              (QStringLiteral("default"));
const QString MissionCommandList::_descriptionJsonKey          (QStringLiteral("description"));
const QString MissionCommandList::_enumStringsJsonKey          (QStringLiteral("enumStrings"));
const QString MissionCommandList::_enumValuesJsonKey           (QStringLiteral("enumValues"));
const QString MissionCommandList::_friendlyEditJsonKey         (QStringLiteral("friendlyEdit"));
const QString MissionCommandList::_friendlyNameJsonKey         (QStringLiteral("friendlyName"));
const QString MissionCommandList::_idJsonKey                   (QStringLiteral("id"));
const QString MissionCommandList::_labelJsonKey                (QStringLiteral("label"));
const QString MissionCommandList::_mavCmdInfoJsonKey           (QStringLiteral("mavCmdInfo"));
const QString MissionCommandList::_param1JsonKey               (QStringLiteral("param1"));
const QString MissionCommandList::_param2JsonKey               (QStringLiteral("param2"));
const QString MissionCommandList::_param3JsonKey               (QStringLiteral("param3"));
const QString MissionCommandList::_param4JsonKey               (QStringLiteral("param4"));
const QString MissionCommandList::_paramJsonKeyFormat          (QStringLiteral("param%1"));
const QString MissionCommandList::_rawNameJsonKey              (QStringLiteral("rawName"));
const QString MissionCommandList::_standaloneCoordinateJsonKey (QStringLiteral("standaloneCoordinate"));
const QString MissionCommandList::_specifiesCoordinateJsonKey  (QStringLiteral("specifiesCoordinate"));
const QString MissionCommandList::_unitsJsonKey                (QStringLiteral("units"));
const QString MissionCommandList::_versionJsonKey              (QStringLiteral("version"));

MissionCommandList::MissionCommandList(const QString& jsonFilename, QObject* parent)
    : QObject(parent)
{
    _loadMavCmdInfoJson(jsonFilename);
}

void MissionCommandList::_loadMavCmdInfoJson(const QString& jsonFilename)
{
    if (jsonFilename.isEmpty()) {
        return;
    }

    qCDebug(MissionCommandsLog) << "Loading" << jsonFilename;

    QFile jsonFile(jsonFilename);
    if (!jsonFile.open(QIODevice::ReadOnly | QIODevice::Text)) {
        qWarning() << "Unable to open file" << jsonFilename << jsonFile.errorString();
        return;
    }

    QByteArray bytes = jsonFile.readAll();
    jsonFile.close();
    QJsonParseError jsonParseError;
    QJsonDocument doc = QJsonDocument::fromJson(bytes, &jsonParseError);
    if (jsonParseError.error != QJsonParseError::NoError) {
Don Gagne's avatar
Don Gagne committed
85
        qWarning() << jsonFilename << "Unable to open json document" << jsonParseError.errorString();
86 87 88 89 90 91 92
        return;
    }

    QJsonObject json = doc.object();

    int version = json.value(_versionJsonKey).toInt();
    if (version != 1) {
Don Gagne's avatar
Don Gagne committed
93
        qWarning() << jsonFilename << "Invalid version" << version;
94 95 96 97 98
        return;
    }

    QJsonValue jsonValue = json.value(_mavCmdInfoJsonKey);
    if (!jsonValue.isArray()) {
Don Gagne's avatar
Don Gagne committed
99
        qWarning() << jsonFilename << "mavCmdInfo not array";
100 101 102 103 104 105
        return;
    }

    QJsonArray jsonArray = jsonValue.toArray();
    foreach(QJsonValue info, jsonArray) {
        if (!info.isObject()) {
Don Gagne's avatar
Don Gagne committed
106
            qWarning() << jsonFilename << "mavCmdArray should contain objects";
107 108 109 110 111
            return;
        }
        QJsonObject jsonObject = info.toObject();

        // Make sure we have the required keys
Don Gagne's avatar
Don Gagne committed
112
        QString errorString;
113 114
        QStringList requiredKeys;
        requiredKeys << _idJsonKey << _rawNameJsonKey;
Don Gagne's avatar
Don Gagne committed
115
        if (!JsonHelper::validateRequiredKeys(jsonObject, requiredKeys, errorString)) {
Don Gagne's avatar
Don Gagne committed
116
            qWarning() << jsonFilename << errorString;
Don Gagne's avatar
Don Gagne committed
117
            return;
118 119 120 121 122 123 124 125 126 127
        }

        // Validate key types

        QStringList             keys;
        QList<QJsonValue::Type> types;
        keys << _idJsonKey << _rawNameJsonKey << _friendlyNameJsonKey << _descriptionJsonKey << _standaloneCoordinateJsonKey << _specifiesCoordinateJsonKey <<_friendlyEditJsonKey
             << _param1JsonKey << _param2JsonKey << _param3JsonKey << _param4JsonKey << _categoryJsonKey;
        types << QJsonValue::Double << QJsonValue::String << QJsonValue::String<< QJsonValue::String << QJsonValue::Bool << QJsonValue::Bool << QJsonValue::Bool
              << QJsonValue::Object << QJsonValue::Object << QJsonValue::Object << QJsonValue::Object << QJsonValue::String;
Don Gagne's avatar
Don Gagne committed
128
        if (!JsonHelper::validateKeyTypes(jsonObject, keys, types, errorString)) {
Don Gagne's avatar
Don Gagne committed
129
            qWarning() << jsonFilename << errorString;
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
            return;
        }

        MavCmdInfo* mavCmdInfo = new MavCmdInfo(this);

        mavCmdInfo->_command = (MAV_CMD)      jsonObject.value(_idJsonKey).toInt();
        mavCmdInfo->_category =               jsonObject.value(_categoryJsonKey).toString("Advanced");
        mavCmdInfo->_rawName =                jsonObject.value(_rawNameJsonKey).toString();
        mavCmdInfo->_friendlyName =           jsonObject.value(_friendlyNameJsonKey).toString(QString());
        mavCmdInfo->_description =            jsonObject.value(_descriptionJsonKey).toString(QString());
        mavCmdInfo->_standaloneCoordinate =   jsonObject.value(_standaloneCoordinateJsonKey).toBool(false);
        mavCmdInfo->_specifiesCoordinate =    jsonObject.value(_specifiesCoordinateJsonKey).toBool(false);
        mavCmdInfo->_friendlyEdit =           jsonObject.value(_friendlyEditJsonKey).toBool(false);

        qCDebug(MissionCommandsLog) << "Command"
                                    << mavCmdInfo->_command
                                    << mavCmdInfo->_category
                                    << mavCmdInfo->_rawName
                                    << mavCmdInfo->_friendlyName
                                    << mavCmdInfo->_description
                                    << mavCmdInfo->_standaloneCoordinate
                                    << mavCmdInfo->_specifiesCoordinate
                                    << mavCmdInfo->_friendlyEdit;

        if (_mavCmdInfoMap.contains((MAV_CMD)mavCmdInfo->command())) {
Don Gagne's avatar
Don Gagne committed
155
            qWarning() << jsonFilename << "Duplicate command" << mavCmdInfo->command();
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
            return;
        }

        _mavCmdInfoMap[mavCmdInfo->_command] = mavCmdInfo;

        // Read params

        for (int i=1; i<=7; i++) {
            QString paramKey = QString(_paramJsonKeyFormat).arg(i);

            if (jsonObject.contains(paramKey)) {
                QJsonObject paramObject = jsonObject.value(paramKey).toObject();

                // Validate key types
                QStringList             keys;
                QList<QJsonValue::Type> types;
                keys << _defaultJsonKey << _decimalPlacesJsonKey << _enumStringsJsonKey << _enumValuesJsonKey << _labelJsonKey << _unitsJsonKey;
                types << QJsonValue::Double <<  QJsonValue::Double << QJsonValue::String << QJsonValue::String << QJsonValue::String << QJsonValue::String;
Don Gagne's avatar
Don Gagne committed
174
                if (!JsonHelper::validateKeyTypes(jsonObject, keys, types, errorString)) {
Don Gagne's avatar
Don Gagne committed
175
                    qWarning() << jsonFilename << errorString;
176 177 178 179 180 181
                    return;
                }

                mavCmdInfo->_friendlyEdit = true; // Assume friendly edit if we have params

                if (!paramObject.contains(_labelJsonKey)) {
Don Gagne's avatar
Don Gagne committed
182
                    qWarning() << jsonFilename << "param object missing label key" << mavCmdInfo->rawName() << paramKey;
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
                    return;
                }

                MavCmdParamInfo* paramInfo = new MavCmdParamInfo(this);

                paramInfo->_label =         paramObject.value(_labelJsonKey).toString();
                paramInfo->_defaultValue =  paramObject.value(_defaultJsonKey).toDouble(0.0);
                paramInfo->_decimalPlaces = paramObject.value(_decimalPlacesJsonKey).toInt(FactMetaData::defaultDecimalPlaces);
                paramInfo->_enumStrings =   paramObject.value(_enumStringsJsonKey).toString().split(",", QString::SkipEmptyParts);
                paramInfo->_param =         i;
                paramInfo->_units =         paramObject.value(_unitsJsonKey).toString();

                QStringList enumValues = paramObject.value(_enumValuesJsonKey).toString().split(",", QString::SkipEmptyParts);
                foreach (const QString &enumValue, enumValues) {
                    bool    convertOk;
                    double  value = enumValue.toDouble(&convertOk);

                    if (!convertOk) {
Don Gagne's avatar
Don Gagne committed
201
                        qWarning() << jsonFilename << "Bad enumValue" << enumValue;
202 203 204 205 206 207
                        return;
                    }

                    paramInfo->_enumValues << QVariant(value);
                }
                if (paramInfo->_enumValues.count() != paramInfo->_enumStrings.count()) {
Don Gagne's avatar
Don Gagne committed
208
                    qWarning() << jsonFilename << "enum strings/values count mismatch" << paramInfo->_enumStrings.count() << paramInfo->_enumValues.count();
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
                    return;
                }

                qCDebug(MissionCommandsLog) << "Param"
                                            << paramInfo->_label
                                            << paramInfo->_defaultValue
                                            << paramInfo->_decimalPlaces
                                            << paramInfo->_param
                                            << paramInfo->_units
                                            << paramInfo->_enumStrings
                                            << paramInfo->_enumValues;

                mavCmdInfo->_paramInfoMap[i] = paramInfo;
            }
        }

        if (mavCmdInfo->friendlyEdit()) {
            if (mavCmdInfo->description().isEmpty()) {
Don Gagne's avatar
Don Gagne committed
227
                qWarning() << jsonFilename << "Missing description" << mavCmdInfo->rawName();
228 229 230
                return;
            }
            if (mavCmdInfo->rawName() ==  mavCmdInfo->friendlyName()) {
Don Gagne's avatar
Don Gagne committed
231
                qWarning() << jsonFilename << "Missing friendly name" << mavCmdInfo->rawName() << mavCmdInfo->friendlyName();
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
                return;
            }
        }
    }
}

bool MissionCommandList::contains(MAV_CMD command) const
{
    return _mavCmdInfoMap.contains(command);
}

MavCmdInfo* MissionCommandList::getMavCmdInfo(MAV_CMD command) const
{
    if (!contains(command)) {
        qWarning() << "Unknown command" << command;
        return NULL;
    }

    return _mavCmdInfoMap[command];
}

QList<MAV_CMD> MissionCommandList::commandsIds(void) const
{
    QList<MAV_CMD> list;

    foreach (const MavCmdInfo* mavCmdInfo, _mavCmdInfoMap) {
        list << (MAV_CMD)mavCmdInfo->command();
    }

    return list;
}