PX4ParameterMetaData.cc 19.1 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 11 12 13

/// @file
///     @author Don Gagne <don@thegagnes.com>

14
#include "PX4ParameterMetaData.h"
15 16 17 18 19 20 21 22
#include "QGCApplication.h"
#include "QGCLoggingCategory.h"

#include <QFile>
#include <QFileInfo>
#include <QDir>
#include <QDebug>

23
QGC_LOGGING_CATEGORY(PX4ParameterMetaDataLog, "PX4ParameterMetaDataLog")
24

25 26
PX4ParameterMetaData::PX4ParameterMetaData(void)
    : _parameterMetaDataLoaded(false)
27
{
28

29 30 31 32 33 34 35
}

/// Converts a string to a typed QVariant
///     @param string String to convert
///     @param type Type for Fact which dictates the QVariant type as well
///     @param convertOk Returned: true: conversion success, false: conversion failure
/// @return Returns the correctly type QVariant
36
QVariant PX4ParameterMetaData::_stringToTypedVariant(const QString& string, FactMetaData::ValueType_t type, bool* convertOk)
37 38 39
{
    QVariant var(string);

Don Gagne's avatar
Don Gagne committed
40
    int convertTo = QVariant::Int; // keep compiler warning happy
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
    switch (type) {
        case FactMetaData::valueTypeUint8:
        case FactMetaData::valueTypeUint16:
        case FactMetaData::valueTypeUint32:
            convertTo = QVariant::UInt;
            break;
        case FactMetaData::valueTypeInt8:
        case FactMetaData::valueTypeInt16:
        case FactMetaData::valueTypeInt32:
            convertTo = QVariant::Int;
            break;
        case FactMetaData::valueTypeFloat:
            convertTo = QMetaType::Float;
            break;
        case FactMetaData::valueTypeDouble:
            convertTo = QVariant::Double;
            break;
    }
    
    *convertOk = var.convert(convertTo);
    
    return var;
}

65
void PX4ParameterMetaData::loadParameterFactMetaDataFile(const QString& metaDataFile)
66
{
67
    qCDebug(ParameterLoaderLog) << "PX4ParameterMetaData::loadParameterFactMetaDataFile" << metaDataFile;
68

69
    if (_parameterMetaDataLoaded) {
70
        qWarning() << "Internal error: parameter meta data loaded more than once";
71 72 73
        return;
    }
    _parameterMetaDataLoaded = true;
74 75
	
    qCDebug(PX4ParameterMetaDataLog) << "Loading parameter meta data:" << metaDataFile;
76

77
    QFile xmlFile(metaDataFile);
78

79 80 81
    if (!xmlFile.exists()) {
        qWarning() << "Internal error: metaDataFile mission" << metaDataFile;
        return;
82
    }
83
    
84 85 86 87
    if (!xmlFile.open(QIODevice::ReadOnly)) {
        qWarning() << "Internal error: Unable to open parameter file:" << metaDataFile << xmlFile.errorString();
        return;
    }
88 89 90 91 92 93 94 95
    
    QXmlStreamReader xml(xmlFile.readAll());
    xmlFile.close();
    if (xml.hasError()) {
        qWarning() << "Badly formed XML" << xml.errorString();
        return;
    }
    
96 97 98 99 100
    QString         factGroup;
    QString         errorString;
    FactMetaData*   metaData = NULL;
    int             xmlState = XmlStateNone;
    bool            badMetaData = true;
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
    
    while (!xml.atEnd()) {
        if (xml.isStartElement()) {
            QString elementName = xml.name().toString();
            
            if (elementName == "parameters") {
                if (xmlState != XmlStateNone) {
                    qWarning() << "Badly formed XML";
                    return;
                }
                xmlState = XmlStateFoundParameters;
                
            } else if (elementName == "version") {
                if (xmlState != XmlStateFoundParameters) {
                    qWarning() << "Badly formed XML";
                    return;
                }
                xmlState = XmlStateFoundVersion;
                
                bool convertOk;
                QString strVersion = xml.readElementText();
                int intVersion = strVersion.toInt(&convertOk);
                if (!convertOk) {
                    qWarning() << "Badly formed XML";
                    return;
                }
127
                if (intVersion <= 2) {
128
                    // We can't read these old files
129
                    qDebug() << "Parameter version stamp too old, skipping load. Found:" << intVersion << "Want: 3 File:" << metaDataFile;
130 131 132
                    return;
                }
                
133 134 135 136 137
            } else if (elementName == "parameter_version_major") {
                // Just skip over for now
            } else if (elementName == "parameter_version_minor") {
                // Just skip over for now

138 139 140
            } else if (elementName == "group") {
                if (xmlState != XmlStateFoundVersion) {
                    // We didn't get a version stamp, assume older version we can't read
141
                    qDebug() << "Parameter version stamp not found, skipping load" << metaDataFile;
142 143 144 145 146 147 148 149 150
                    return;
                }
                xmlState = XmlStateFoundGroup;
                
                if (!xml.attributes().hasAttribute("name")) {
                    qWarning() << "Badly formed XML";
                    return;
                }
                factGroup = xml.attributes().value("name").toString();
151
                qCDebug(PX4ParameterMetaDataLog) << "Found group: " << factGroup;
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
                
            } else if (elementName == "parameter") {
                if (xmlState != XmlStateFoundGroup) {
                    qWarning() << "Badly formed XML";
                    return;
                }
                xmlState = XmlStateFoundParameter;
                
                if (!xml.attributes().hasAttribute("name") || !xml.attributes().hasAttribute("type")) {
                    qWarning() << "Badly formed XML";
                    return;
                }
                
                QString name = xml.attributes().value("name").toString();
                QString type = xml.attributes().value("type").toString();
167
                QString strDefault =    xml.attributes().value("default").toString();
168
                
169
                qCDebug(PX4ParameterMetaDataLog) << "Found parameter name:" << name << " type:" << type << " default:" << strDefault;
170 171

                // Convert type from string to FactMetaData::ValueType_t
Don Gagne's avatar
Don Gagne committed
172 173 174
                bool unknownType;
                FactMetaData::ValueType_t foundType = FactMetaData::stringToType(type, unknownType);
                if (unknownType) {
175 176 177 178 179
                    qWarning() << "Parameter meta data with bad type:" << type << " name:" << name;
                    return;
                }
                
                // Now that we know type we can create meta data object and add it to the system
180
                
181 182
                metaData = new FactMetaData(foundType);
                Q_CHECK_PTR(metaData);
183
                if (_mapParameterName2FactMetaData.contains(name)) {
184
                    // We can't trust the meta dafa since we have dups
185
                    qCWarning(PX4ParameterMetaDataLog) << "Duplicate parameter found:" << name;
186 187 188
                    badMetaData = true;
                    // Reset to default meta data
                    _mapParameterName2FactMetaData[name] = metaData;
189
                } else {
190
                    _mapParameterName2FactMetaData[name] = metaData;
191
                    metaData->setName(name);
192
                    metaData->setGroup(factGroup);
193
                    
194 195 196
                    if (xml.attributes().hasAttribute("default") && !strDefault.isEmpty()) {
                        QVariant varDefault;
                        
197 198
                        if (metaData->convertAndValidateRaw(strDefault, false, varDefault, errorString)) {
                            metaData->setRawDefaultValue(varDefault);
199
                        } else {
200
                            qCWarning(PX4ParameterMetaDataLog) << "Invalid default value, name:" << name << " type:" << type << " default:" << strDefault << " error:" << errorString;
201
                        }
202 203 204 205 206 207 208 209 210 211
                    }
                }
                
            } else {
                // We should be getting meta data now
                if (xmlState != XmlStateFoundParameter) {
                    qWarning() << "Badly formed XML";
                    return;
                }

212 213 214 215
                if (!badMetaData) {
                    if (elementName == "short_desc") {
                        Q_ASSERT(metaData);
                        QString text = xml.readElementText();
216
                        text = text.replace("\n", " ");
217
                        qCDebug(PX4ParameterMetaDataLog) << "Short description:" << text;
218
                        metaData->setShortDescription(text);
219

220 221 222
                    } else if (elementName == "long_desc") {
                        Q_ASSERT(metaData);
                        QString text = xml.readElementText();
223
                        text = text.replace("\n", " ");
224
                        qCDebug(PX4ParameterMetaDataLog) << "Long description:" << text;
225 226 227 228 229
                        metaData->setLongDescription(text);
                        
                    } else if (elementName == "min") {
                        Q_ASSERT(metaData);
                        QString text = xml.readElementText();
230
                        qCDebug(PX4ParameterMetaDataLog) << "Min:" << text;
231 232
                        
                        QVariant varMin;
233 234
                        if (metaData->convertAndValidateRaw(text, true /* convertOnly */, varMin, errorString)) {
                            metaData->setRawMin(varMin);
235
                        } else {
236
                            qCWarning(PX4ParameterMetaDataLog) << "Invalid min value, name:" << metaData->name() << " type:" << metaData->type() << " min:" << text << " error:" << errorString;
237 238 239 240 241
                        }
                        
                    } else if (elementName == "max") {
                        Q_ASSERT(metaData);
                        QString text = xml.readElementText();
242
                        qCDebug(PX4ParameterMetaDataLog) << "Max:" << text;
243 244
                        
                        QVariant varMax;
245 246
                        if (metaData->convertAndValidateRaw(text, true /* convertOnly */, varMax, errorString)) {
                            metaData->setRawMax(varMax);
247
                        } else {
248
                            qCWarning(PX4ParameterMetaDataLog) << "Invalid max value, name:" << metaData->name() << " type:" << metaData->type() << " max:" << text << " error:" << errorString;
249 250 251 252 253
                        }
                        
                    } else if (elementName == "unit") {
                        Q_ASSERT(metaData);
                        QString text = xml.readElementText();
254
                        qCDebug(PX4ParameterMetaDataLog) << "Unit:" << text;
255
                        metaData->setRawUnits(text);
256
                        
257 258 259
                    } else if (elementName == "decimal") {
                        Q_ASSERT(metaData);
                        QString text = xml.readElementText();
260
                        qCDebug(PX4ParameterMetaDataLog) << "Decimal:" << text;
261 262 263 264 265 266

                        bool convertOk;
                        QVariant varDecimals = QVariant(text).toUInt(&convertOk);
                        if (convertOk) {
                            metaData->setDecimalPlaces(varDecimals.toInt());
                        } else {
267
                            qCWarning(PX4ParameterMetaDataLog) << "Invalid decimals value, name:" << metaData->name() << " type:" << metaData->type() << " decimals:" << text << " error: invalid number";
268 269
                        }

270 271 272 273 274 275 276 277
                    } else if (elementName == "reboot_required") {
                        Q_ASSERT(metaData);
                        QString text = xml.readElementText();
                        qCDebug(PX4ParameterMetaDataLog) << "RebootRequired:" << text;
                        if (text.compare("true", Qt::CaseInsensitive) == 0) {
                            metaData->setRebootRequired(true);
                        }

278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
                    } else if (elementName == "values") {
                        // doing nothing individual value will follow anyway. May be used for sanity checking.

                    } else if (elementName == "value") {
                        QString enumValueStr = xml.attributes().value("code").toString();
                        QString enumString = xml.readElementText();
                        qCDebug(PX4ParameterMetaDataLog) << "parameter value:"
                                                         << "value desc:" << enumString << "code:" << enumValueStr;

                        QVariant    enumValue;
                        QString     errorString;
                        if (metaData->convertAndValidateRaw(enumValueStr, false /* validate */, enumValue, errorString)) {
                            metaData->addEnumInfo(enumString, enumValue);
                        } else {
                            qCDebug(PX4ParameterMetaDataLog) << "Invalid enum value, name:" << metaData->name()
                                                             << " type:" << metaData->type() << " value:" << enumValueStr
                                                             << " error:" << errorString;
                        }
Don Gagne's avatar
Don Gagne committed
296 297 298 299 300 301 302 303 304 305 306
                    } else if (elementName == "increment") {
                        Q_ASSERT(metaData);
                        double  increment;
                        bool    ok;
                        QString text = xml.readElementText();
                        increment = text.toDouble(&ok);
                        if (ok) {
                            metaData->setIncrement(increment);
                        } else {
                            qCWarning(PX4ParameterMetaDataLog) << "Invalid value for increment, name:" << metaData->name() << " increment:" << text;
                        }
Don Gagne's avatar
Don Gagne committed
307 308 309 310 311 312 313 314

                    } else if (elementName == "boolean") {
                        QVariant    enumValue;
                        metaData->convertAndValidateRaw(1, false /* validate */, enumValue, errorString);
                        metaData->addEnumInfo(tr("Enabled"), enumValue);
                        metaData->convertAndValidateRaw(0, false /* validate */, enumValue, errorString);
                        metaData->addEnumInfo(tr("Disabled"), enumValue);

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
                    } else if (elementName == "bitmask") {
                        // doing nothing individual bits will follow anyway. May be used for sanity checking.

                    } else if (elementName == "bit") {
                        bool ok = false;
                        unsigned char bit = xml.attributes().value("index").toString().toUInt(&ok);
                        if (ok) {
                            QString bitDescription = xml.readElementText();
                            qCDebug(PX4ParameterMetaDataLog) << "parameter value:"
                                                             << "index:" << bit << "description:" << bitDescription;

                            if (bit < 31) {
                                QVariant bitmaskRawValue = 1 << bit;
                                QVariant bitmaskValue;
                                QString errorString;
                                if (metaData->convertAndValidateRaw(bitmaskRawValue, true, bitmaskValue, errorString)) {
                                    metaData->addBitmaskInfo(bitDescription, bitmaskValue);
                                } else {
                                    qCDebug(PX4ParameterMetaDataLog) << "Invalid bitmask value, name:" << metaData->name()
                                                                     << " type:" << metaData->type() << " value:" << bitmaskValue
                                                                     << " error:" << errorString;
                                }
                            } else {
                                qCWarning(PX4ParameterMetaDataLog) << "Invalid value for bitmask, bit:" << bit;
                            }
                        }
341
                    } else {
Don Gagne's avatar
Don Gagne committed
342
                        qCDebug(PX4ParameterMetaDataLog) << "Unknown element in XML: " << elementName;
343 344 345 346 347 348 349
                    }
                }
            }
        } else if (xml.isEndElement()) {
            QString elementName = xml.name().toString();

            if (elementName == "parameter") {
350 351 352 353
                // Done loading this parameter, validate default value
                if (metaData->defaultValueAvailable()) {
                    QVariant var;
                    
354 355
                    if (!metaData->convertAndValidateRaw(metaData->rawDefaultValue(), false /* convertOnly */, var, errorString)) {
                        qCWarning(PX4ParameterMetaDataLog) << "Invalid default value, name:" << metaData->name() << " type:" << metaData->type() << " default:" << metaData->rawDefaultValue() << " error:" << errorString;
356 357 358 359
                    }
                }
                
                // Reset for next parameter
360
                metaData = NULL;
361
                badMetaData = false;
362 363 364 365 366 367 368 369 370 371 372
                xmlState = XmlStateFoundGroup;
            } else if (elementName == "group") {
                xmlState = XmlStateFoundVersion;
            } else if (elementName == "parameters") {
                xmlState = XmlStateFoundParameters;
            }
        }
        xml.readNext();
    }
}

373
void PX4ParameterMetaData::addMetaDataToFact(Fact* fact, MAV_TYPE vehicleType)
374
{
375 376
    Q_UNUSED(vehicleType)

377 378
    if (_mapParameterName2FactMetaData.contains(fact->name())) {
        fact->setMetaData(_mapParameterName2FactMetaData[fact->name()]);
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
    }
}

void PX4ParameterMetaData::getParameterMetaDataVersionInfo(const QString& metaDataFile, int& majorVersion, int& minorVersion)
{
    QFile xmlFile(metaDataFile);

    if (!xmlFile.exists()) {
        qWarning() << "Internal error: metaDataFile mission" << metaDataFile;
        return;
    }

    if (!xmlFile.open(QIODevice::ReadOnly)) {
        qWarning() << "Internal error: Unable to open parameter file:" << metaDataFile << xmlFile.errorString();
        return;
    }

    QXmlStreamReader xml(xmlFile.readAll());
    xmlFile.close();
    if (xml.hasError()) {
        qWarning() << "Badly formed XML" << xml.errorString();
        return;
    }

    majorVersion = -1;
    minorVersion = -1;

    while (!xml.atEnd() && (majorVersion == -1 || minorVersion == -1)) {
        if (xml.isStartElement()) {
            QString elementName = xml.name().toString();

            if (elementName == "parameter_version_major") {
                bool convertOk;
                QString strVersion = xml.readElementText();
                majorVersion = strVersion.toInt(&convertOk);
                if (!convertOk) {
                    qWarning() << "Badly formed XML";
                    return;
                }
            } else if (elementName == "parameter_version_minor") {
                bool convertOk;
                QString strVersion = xml.readElementText();
                minorVersion = strVersion.toInt(&convertOk);
                if (!convertOk) {
                    qWarning() << "Badly formed XML";
                    return;
                }
            }
        }
        xml.readNext();
    }

    // Assume defaults if not found
    if (majorVersion == -1) {
        majorVersion = 1;
    }
    if (minorVersion == -1) {
        minorVersion = 1;
437 438
    }
}