ParameterManager.h 11.9 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
#pragma once
11 12 13 14 15

#include <QObject>
#include <QMap>
#include <QXmlStreamReader>
#include <QLoggingCategory>
16
#include <QMutex>
Don Gagne's avatar
Don Gagne committed
17
#include <QDir>
18
#include <QJsonObject>
19 20

#include "FactSystem.h"
21 22
#include "MAVLinkProtocol.h"
#include "AutoPilotPlugin.h"
23
#include "QGCMAVLink.h"
24
#include "Vehicle.h"
25

26 27
Q_DECLARE_LOGGING_CATEGORY(ParameterManagerVerbose1Log)
Q_DECLARE_LOGGING_CATEGORY(ParameterManagerVerbose2Log)
28
Q_DECLARE_LOGGING_CATEGORY(ParameterManagerDebugCacheFailureLog)
29

30
class ParameterManager : public QObject
31 32
{
    Q_OBJECT
33

34 35
public:
    /// @param uas Uas which this set of facts is associated with
36 37
    ParameterManager    (Vehicle* vehicle);
    ~ParameterManager   ();
38

39 40 41
    Q_PROPERTY(bool     parametersReady     READ parametersReady    NOTIFY parametersReadyChanged)      ///< true: Parameters are ready for use
    Q_PROPERTY(bool     missingParameters   READ missingParameters  NOTIFY missingParametersChanged)    ///< true: Parameters are missing from firmware response, false: all parameters received from firmware
    Q_PROPERTY(double   loadProgress        READ loadProgress       NOTIFY loadProgressChanged)
42
    Q_PROPERTY(bool     pendingWrites       READ pendingWrites      NOTIFY pendingWritesChanged)        ///< true: There are still pending write updates against the vehicle
43

44 45 46
    bool parametersReady    (void) const { return _parametersReady; }
    bool missingParameters  (void) const { return _missingParameters; }
    double loadProgress     (void) const { return _loadProgress; }
47

48 49 50
    /// @return Directory of parameter caches
    static QDir parameterCacheDir();

51
    /// @return Location of parameter cache file
52
    static QString parameterCacheFile(int vehicleId, int componentId);
Don Gagne's avatar
Don Gagne committed
53 54

    QList<int> componentIds(void);
55

56
    /// Re-request the full set of parameters from the autopilot
dogmaphobic's avatar
dogmaphobic committed
57
    void refreshAllParameters(uint8_t componentID = MAV_COMP_ID_ALL);
58

59
    /// Request a refresh on the specific parameter
60
    void refreshParameter(int componentId, const QString& paramName);
61

62 63
    /// Request a refresh on all parameters that begin with the specified prefix
    void refreshParametersPrefix(int componentId, const QString& namePrefix);
64 65 66

    void resetAllParametersToDefaults();
    void resetAllToVehicleConfiguration();
67

68
    /// Returns true if the specifed parameter exists
69 70
    ///     @param componentId Component id or FactSystem::defaultComponentId
    ///     @param name Parameter name
71
    bool parameterExists(int componentId, const QString& paramName);
72

73 74 75
    /// Returns all parameter names
    QStringList parameterNames(int componentId);

76 77 78 79
    /// Returns the specified Parameter. Returns a default empty fact is parameter does not exists. Also will pop
    /// a missing parameter error to user if parameter does not exist.
    ///     @param componentId Component id or FactSystem::defaultComponentId
    ///     @param name Parameter name
80
    Fact* getParameter(int componentId, const QString& paramName);
81

82 83 84
    int  getComponentId(const QString& category);
    QString getComponentCategory(int componentId);
    const QMap<QString, QMap<QString, QStringList> >& getComponentCategoryMap(int componentId);
85

86 87
    /// Returns error messages from loading
    QString readParametersFromStream(QTextStream& stream);
88

89
    void writeParametersToStream(QTextStream& stream);
90 91 92 93 94 95 96 97 98

    /// Returns the version number for the parameter set, -1 if not known
    int parameterSetVersion(void) { return _parameterSetMajorVersion; }

    /// Returns the newest available parameter meta data file (from cache or internal) for the specified information.
    ///     @param wantedMajorVersion Major version you are looking for
    ///     @param[out] majorVersion Major version for found meta data
    ///     @param[out] minorVersion Minor version for found meta data
    /// @return Meta data file name of best match, emptyString is none found
99
    static QString parameterMetaDataFile(Vehicle* vehicle, MAV_AUTOPILOT firmwareType, int wantedMajorVersion, int& majorVersion, int& minorVersion);
100 101 102

    /// If this file is newer than anything in the cache, cache it as the latest version
    static void cacheMetaDataFile(const QString& metaDataFile, MAV_AUTOPILOT firmwareType);
Don Gagne's avatar
Don Gagne committed
103

104 105 106 107 108 109 110 111 112 113 114 115 116
    /// Saves the specified param set to the json object.
    ///     @param componentId Component id which contains params, MAV_COMP_ID_ALL to save all components
    ///     @param paramsToSave List of params names to save, empty to save all for component
    ///     @param saveObject Json object to save to
    void saveToJson(int componentId, const QStringList& paramsToSave, QJsonObject& saveObject);

    /// Load a parameter set from json
    ///     @param json Json object to load from
    ///     @param required true: no parameters in object will generate error
    ///     @param errorString Error string if return is false
    /// @return true: success, false: failure (errorString set)
    bool loadFromJson(const QJsonObject& json, bool required, QString& errorString);

117 118
    bool pendingWrites(void);

119 120
    Vehicle* vehicle(void) { return _vehicle; }

121
signals:
122 123 124 125
    void parametersReadyChanged     (bool parametersReady);
    void missingParametersChanged   (bool missingParameters);
    void loadProgressChanged        (float value);
    void pendingWritesChanged       (bool pendingWrites);
126

127
protected:
128 129
    Vehicle*            _vehicle;
    MAVLinkProtocol*    _mavlink;
130

131
    void _parameterUpdate(int vehicleId, int componentId, QString parameterName, int parameterCount, int parameterId, int mavType, QVariant value);
132
    void _valueUpdated(const QVariant& value);
133
    void _waitingParamTimeout(void);
134
    void _tryCacheLookup(void);
135
    void _initialRequestTimeout(void);
dogmaphobic's avatar
dogmaphobic committed
136

137
private:
138 139 140 141
    static QVariant         _stringToTypedVariant(const QString& string, FactMetaData::ValueType_t type, bool failOk = false);
    static FirmwarePlugin*  _anyVehicleTypeFirmwarePlugin(MAV_AUTOPILOT firmwareType);

    int     _actualComponentId(int componentId);
142
    void    _setupComponentCategoryMap(int componentId);
143 144 145 146 147 148 149 150
    void    _setupDefaultComponentCategoryMap(void);
    void    _readParameterRaw(int componentId, const QString& paramName, int paramIndex);
    void    _writeParameterRaw(int componentId, const QString& paramName, const QVariant& value);
    void    _writeLocalParamCache(int vehicleId, int componentId);
    void    _tryCacheHashLoad(int vehicleId, int componentId, QVariant hash_value);
    void    _loadMetaData(void);
    void    _clearMetaData(void);
    void    _addMetaDataToDefaultComponent(void);
151
    QString _remapParamNameToVersion(const QString& paramName);
152
    void    _loadOfflineEditingParams(void);
153
    QString _logVehiclePrefix(int componentId);
154 155
    void    _setLoadProgress(double loadProgress);
    bool    _fillIndexBatchQueue(bool waitingParamTimeout);
156
    void    _updateProgressBar(void);
157

158 159
    MAV_PARAM_TYPE _factTypeToMavType(FactMetaData::ValueType_t factType);
    FactMetaData::ValueType_t _mavTypeToFactType(MAV_PARAM_TYPE mavType);
160
    void _checkInitialLoadComplete(void);
161

162
    /// First mapping is by component id
163
    /// Second mapping is parameter name, to Fact* in QVariant
164
    QMap<int, QVariantMap>            _mapParameterName2Variant;
165

166 167 168 169
    // List of category map of component parameters
    typedef QMap<QString, QMap<QString, QStringList>>   ComponentCategoryMapType; //<Key: category, Value: Map< Key: group, Value: parameter names list >>
    QMap<int, ComponentCategoryMapType>                 _componentCategoryMaps;
    QHash<QString, int>                                 _componentCategoryHash;
170

171
    double      _loadProgress;                  ///< Parameter load progess, [0.0,1.0]
172 173
    bool        _parametersReady;               ///< true: parameter load complete
    bool        _missingParameters;             ///< true: parameter missing from initial load
Ricardo de Almeida Gonzaga's avatar
Ricardo de Almeida Gonzaga committed
174
    bool        _initialLoadComplete;           ///< true: Initial load of all parameters complete, whether successful or not
175 176
    bool        _waitingForDefaultComponent;    ///< true: last chance wait for default component params
    bool        _saveRequired;                  ///< true: _saveToEEPROM should be called
177
    bool        _metaDataAddedToFacts;          ///< true: FactMetaData has been adde to the default component facts
Don Gagne's avatar
Don Gagne committed
178
    bool        _logReplay;                     ///< true: running with log replay link
179 180 181
    QString     _versionParam;                  ///< Parameter which contains parameter set version
    int         _parameterSetMajorVersion;      ///< Version for parameter set, -1 if not known
    QObject*    _parameterMetaData;             ///< Opaque data from FirmwarePlugin::loadParameterMetaDataCall
182

183 184 185 186 187 188 189
    typedef QPair<int /* FactMetaData::ValueType_t */, QVariant /* Fact::rawValue */> ParamTypeVal;
    typedef QMap<QString /* parameter name */, ParamTypeVal> CacheMapName2ParamTypeVal;

    QMap<int /* component id */, bool>                                              _debugCacheCRC; ///< true: debug cache crc failure
    QMap<int /* component id */, CacheMapName2ParamTypeVal>                         _debugCacheMap;
    QMap<int /* component id */, QMap<QString /* param name */, bool /* seen */>>   _debugCacheParamSeen;

Don Gagne's avatar
Don Gagne committed
190
    // Wait counts from previous parameter update cycle
191 192 193 194 195 196 197
    int _prevWaitingReadParamIndexCount;
    int _prevWaitingReadParamNameCount;
    int _prevWaitingWriteParamNameCount;

    bool _readParamIndexProgressActive =    false;
    bool _readParamNameProgressActive =     false;
    bool _writeParamProgressActive =        false;
Don Gagne's avatar
Don Gagne committed
198

199 200 201 202 203
    static const int    _maxInitialRequestListRetry = 4;        ///< Maximum retries for request list
    int                 _initialRequestRetryCount;              ///< Current retry count for request list
    static const int    _maxInitialLoadRetrySingleParam = 5;    ///< Maximum retries for initial index based load of a single param
    static const int    _maxReadWriteRetry = 5;                 ///< Maximum retries read/write
    bool                _disableAllRetries;                     ///< true: Don't retry any requests (used for testing)
204

205 206 207
    bool        _indexBatchQueueActive; ///< true: we are actively batching re-requests for missing index base params, false: index based re-request has not yet started
    QList<int>  _indexBatchQueue;       ///< The current queue of index re-requests

208 209 210 211 212
    QMap<int, int>                  _paramCountMap;             ///< Key: Component id, Value: count of parameters in this component
    QMap<int, QMap<int, int> >      _waitingReadParamIndexMap;  ///< Key: Component id, Value: Map { Key: parameter index still waiting for, Value: retry count }
    QMap<int, QMap<QString, int> >  _waitingReadParamNameMap;   ///< Key: Component id, Value: Map { Key: parameter name still waiting for, Value: retry count }
    QMap<int, QMap<QString, int> >  _waitingWriteParamNameMap;  ///< Key: Component id, Value: Map { Key: parameter name still waiting for, Value: retry count }
    QMap<int, QList<int> >          _failedReadParamIndexMap;   ///< Key: Component id, Value: failed parameter index
213

214 215 216
    int _totalParamCount;                       ///< Number of parameters across all components
    int _waitingWriteParamBatchCount = 0;       ///< Number of parameters which are batched up waiting on write responses
    int _waitingReadParamNameBatchCount = 0;    ///< Number of parameters which are batched up waiting on read responses
217

218
    QTimer _initialRequestTimeoutTimer;
219
    QTimer _waitingParamTimeoutTimer;
220

221
    QMutex _dataMutex;
222

223
    Fact _defaultFact;   ///< Used to return default fact, when parameter not found
224 225

    static const char* _cachedMetaDataFilePrefix;
226 227 228 229
    static const char* _jsonParametersKey;
    static const char* _jsonCompIdKey;
    static const char* _jsonParamNameKey;
    static const char* _jsonParamValueKey;
230
};