MockLink.h 11.7 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.
 *
 ****************************************************************************/
9

10

11
#pragma once
12 13

#include <QMap>
14
#include <QLoggingCategory>
15
#include <QGeoCoordinate>
16 17

#include "MockLinkMissionItemHandler.h"
18
#include "MockLinkFileServer.h"
19
#include "LinkManager.h"
20 21 22
#include "QGCMAVLink.h"

Q_DECLARE_LOGGING_CATEGORY(MockLinkLog)
Don Gagne's avatar
Don Gagne committed
23
Q_DECLARE_LOGGING_CATEGORY(MockLinkVerboseLog)
24

25 26
class MockConfiguration : public LinkConfiguration
{
Don Gagne's avatar
Don Gagne committed
27 28
    Q_OBJECT

29
public:
30 31 32 33

    Q_PROPERTY(int      firmware    READ firmware           WRITE setFirmware       NOTIFY firmwareChanged)
    Q_PROPERTY(int      vehicle     READ vehicle            WRITE setVehicle        NOTIFY vehicleChanged)
    Q_PROPERTY(bool     sendStatus  READ sendStatusText     WRITE setSendStatusText NOTIFY sendStatusChanged)
34
    Q_PROPERTY(bool     highLatency READ highLatency        WRITE setHighLatency    NOTIFY highLatencyChanged)
35 36 37 38 39

    // QML Access
    int     firmware        () { return (int)_firmwareType; }
    void    setFirmware     (int type) { _firmwareType = (MAV_AUTOPILOT)type; emit firmwareChanged(); }
    int     vehicle         () { return (int)_vehicleType; }
40
    bool    highLatency     () const { return _highLatency; }
41
    void    setVehicle      (int type) { _vehicleType = (MAV_TYPE)type; emit vehicleChanged(); }
42
    void    setHighLatency  (bool latency) { _highLatency = latency; emit highLatencyChanged(); }
43

44 45 46 47
    MockConfiguration(const QString& name);
    MockConfiguration(MockConfiguration* source);

    MAV_AUTOPILOT firmwareType(void) { return _firmwareType; }
48
    void setFirmwareType(MAV_AUTOPILOT firmwareType) { _firmwareType = firmwareType; emit firmwareChanged(); }
49

50
    MAV_TYPE vehicleType(void) { return _vehicleType; }
51
    void setVehicleType(MAV_TYPE vehicleType) { _vehicleType = vehicleType; emit vehicleChanged(); }
52

53 54
    /// @param sendStatusText true: mavlink status text messages will be sent for each severity, as well as voice output info message
    bool sendStatusText(void) { return _sendStatusText; }
55
    void setSendStatusText(bool sendStatusText) { _sendStatusText = sendStatusText; emit sendStatusChanged(); }
56

Don Gagne's avatar
Don Gagne committed
57 58 59 60 61 62 63 64 65
    typedef enum {
        FailNone,                           // No failures
        FailParamNoReponseToRequestList,    // Do no respond to PARAM_REQUEST_LIST
        FailMissingParamOnInitialReqest,    // Not all params are sent on initial request, should still succeed since QGC will re-query missing params
        FailMissingParamOnAllRequests,      // Not all params are sent on initial request, QGC retries will fail as well
    } FailureMode_t;
    FailureMode_t failureMode(void) { return _failureMode; }
    void setFailureMode(FailureMode_t failureMode) { _failureMode = failureMode; }

66
    // Overrides from LinkConfiguration
67 68 69 70 71 72
    LinkType    type            (void) { return LinkConfiguration::TypeMock; }
    void        copyFrom        (LinkConfiguration* source);
    void        loadSettings    (QSettings& settings, const QString& root);
    void        saveSettings    (QSettings& settings, const QString& root);
    void        updateSettings  (void);
    QString     settingsURL     () { return "MockLinkSettings.qml"; }
73
    QString     settingsTitle   () { return tr("Mock Link Settings"); }
74 75 76 77 78

signals:
    void firmwareChanged    ();
    void vehicleChanged     ();
    void sendStatusChanged  ();
79
    void highLatencyChanged ();
80 81

private:
82
    MAV_AUTOPILOT   _firmwareType;
83
    MAV_TYPE        _vehicleType;
84
    bool            _sendStatusText;
85
    bool            _highLatency;
Don Gagne's avatar
Don Gagne committed
86
    FailureMode_t   _failureMode;
87

88
    static const char* _firmwareTypeKey;
89
    static const char* _vehicleTypeKey;
90
    static const char* _sendStatusTextKey;
91
    static const char* _highLatencyKey;
Don Gagne's avatar
Don Gagne committed
92
    static const char* _failureModeKey;
93 94
};

95 96 97
class MockLink : public LinkInterface
{
    Q_OBJECT
98

99
public:
100
    MockLink(SharedLinkConfigurationPointer& config);
101
    ~MockLink(void);
102

103
    // MockLink methods
Don Gagne's avatar
Don Gagne committed
104
    int vehicleId(void) { return _vehicleSystemId; }
Don Gagne's avatar
Don Gagne committed
105 106
    MAV_AUTOPILOT getFirmwareType(void) { return _firmwareType; }
    void setFirmwareType(MAV_AUTOPILOT autopilot) { _firmwareType = autopilot; }
107
    void setSendStatusText(bool sendStatusText) { _sendStatusText = sendStatusText; }
Don Gagne's avatar
Don Gagne committed
108
    void setFailureMode(MockConfiguration::FailureMode_t failureMode) { _failureMode = failureMode; }
Don Gagne's avatar
Don Gagne committed
109 110 111 112 113 114 115

    /// APM stack has strange handling of the first item of the mission list. If it has no
    /// onboard mission items, sometimes it sends back a home position in position 0 and
    /// sometimes it doesn't. Don't ask. This option allows you to configure that behavior
    /// for unit testing.
    void setAPMMissionResponseMode(bool sendHomePositionOnEmptyList) { _apmSendHomePositionOnEmptyList = sendHomePositionOnEmptyList; }

116
    void emitRemoteControlChannelRawChanged(int channel, uint16_t raw);
117

118 119
    /// Sends the specified mavlink message to QGC
    void respondWithMavlinkMessage(const mavlink_message_t& msg);
120

121
    MockLinkFileServer* getFileServer(void) { return _fileServer; }
122

Don Gagne's avatar
Don Gagne committed
123 124 125 126 127 128 129
    // Virtuals from LinkInterface
    virtual QString getName(void) const { return _name; }
    virtual void requestReset(void){ }
    virtual bool isConnected(void) const { return _connected; }
    virtual qint64 getConnectionSpeed(void) const { return 100000000; }
    virtual qint64 bytesAvailable(void) { return 0; }

130 131 132 133
    // These are left unimplemented in order to cause linker errors which indicate incorrect usage of
    // connect/disconnect on link directly. All connect/disconnect calls should be made through LinkManager.
    bool connect(void);
    bool disconnect(void);
134

135 136
    /// Sets a failure mode for unit testing
    ///     @param failureMode Type of failure to simulate
137
    void setMissionItemFailureMode(MockLinkMissionItemHandler::FailureMode_t failureMode);
138

139 140
    /// Called to send a MISSION_ACK message while the MissionManager is in idle state
    void sendUnexpectedMissionAck(MAV_MISSION_RESULT ackType) { _missionItemHandler.sendUnexpectedMissionAck(ackType); }
141

142 143
    /// Called to send a MISSION_ITEM message while the MissionManager is in idle state
    void sendUnexpectedMissionItem(void) { _missionItemHandler.sendUnexpectedMissionItem(); }
144

145 146
    /// Called to send a MISSION_REQUEST message while the MissionManager is in idle state
    void sendUnexpectedMissionRequest(void) { _missionItemHandler.sendUnexpectedMissionRequest(); }
147

148 149
    /// Reset the state of the MissionItemHandler to no items, no transactions in progress.
    void resetMissionItemHandler(void) { _missionItemHandler.reset(); }
150

Patrick José Pereira's avatar
Patrick José Pereira committed
151
    /// Returns the filename for the simulated log file. Only available after a download is requested.
152 153
    QString logDownloadFile(void) { return _logDownloadFilename; }

Don Gagne's avatar
Don Gagne committed
154 155 156 157
    static MockLink* startPX4MockLink            (bool sendStatusText, MockConfiguration::FailureMode_t failureMode = MockConfiguration::FailNone);
    static MockLink* startGenericMockLink        (bool sendStatusText, MockConfiguration::FailureMode_t failureMode = MockConfiguration::FailNone);
    static MockLink* startAPMArduCopterMockLink  (bool sendStatusText, MockConfiguration::FailureMode_t failureMode = MockConfiguration::FailNone);
    static MockLink* startAPMArduPlaneMockLink   (bool sendStatusText, MockConfiguration::FailureMode_t failureMode = MockConfiguration::FailNone);
158
    static MockLink* startAPMArduSubMockLink     (bool sendStatusText, MockConfiguration::FailureMode_t failureMode = MockConfiguration::FailNone);
159
    static MockLink* startAPMArduRoverMockLink   (bool sendStatusText, MockConfiguration::FailureMode_t failureMode = MockConfiguration::FailNone);
160

161
private slots:
162
    virtual void _writeBytes(const QByteArray bytes);
163

164 165 166
private slots:
    void _run1HzTasks(void);
    void _run10HzTasks(void);
Don Gagne's avatar
Don Gagne committed
167
    void _run500HzTasks(void);
168

169
private:
170 171
    // From LinkInterface
    virtual bool _connect(void);
Don Gagne's avatar
Don Gagne committed
172
    virtual void _disconnect(void);
173

174 175
    // QThread override
    virtual void run(void);
176

177 178
    // MockLink methods
    void _sendHeartBeat(void);
179
    void _sendHighLatency2(void);
180 181 182 183 184 185 186 187
    void _handleIncomingNSHBytes(const char* bytes, int cBytes);
    void _handleIncomingMavlinkBytes(const uint8_t* bytes, int cBytes);
    void _loadParams(void);
    void _handleHeartBeat(const mavlink_message_t& msg);
    void _handleSetMode(const mavlink_message_t& msg);
    void _handleParamRequestList(const mavlink_message_t& msg);
    void _handleParamSet(const mavlink_message_t& msg);
    void _handleParamRequestRead(const mavlink_message_t& msg);
188
    void _handleFTP(const mavlink_message_t& msg);
189
    void _handleCommandLong(const mavlink_message_t& msg);
Don Gagne's avatar
Don Gagne committed
190
    void _handleManualControl(const mavlink_message_t& msg);
191
    void _handlePreFlightCalibration(const mavlink_command_long_t& request);
192 193
    void _handleLogRequestList(const mavlink_message_t& msg);
    void _handleLogRequestData(const mavlink_message_t& msg);
194 195
    float _floatUnionForParam(int componentId, const QString& paramName);
    void _setParamFloatUnionIntoMap(int componentId, const QString& paramName, float paramFloat);
196
    void _sendHomePosition(void);
Don Gagne's avatar
Don Gagne committed
197
    void _sendGpsRawInt(void);
Don Gagne's avatar
Don Gagne committed
198
    void _sendVibration(void);
199
    void _sendSysStatus(void);
200
    void _sendStatusTextMessages(void);
201
    void _respondWithAutopilotVersion(void);
Don Gagne's avatar
Don Gagne committed
202
    void _sendRCChannels(void);
Don Gagne's avatar
Don Gagne committed
203
    void _paramRequestListWorker(void);
204
    void _logDownloadWorker(void);
205
    void _sendADSBVehicles(void);
206
    void _moveADSBVehicle(void);
207

208
    static MockLink* _startMockLinkWorker(QString configName, MAV_AUTOPILOT firmwareType, MAV_TYPE vehicleType, bool sendStatusText, MockConfiguration::FailureMode_t failureMode);
209 210
    static MockLink* _startMockLink(MockConfiguration* mockConfig);

211
    MockLinkMissionItemHandler  _missionItemHandler;
212

213 214
    QString _name;
    bool    _connected;
215
    int     _mavlinkChannel;
216

217 218
    uint8_t _vehicleSystemId;
    uint8_t _vehicleComponentId;
219

220 221
    bool    _inNSH;
    bool    _mavlinkStarted;
222

223 224
    QMap<int, QMap<QString, QVariant>>          _mapParamName2Value;
    QMap<int, QMap<QString, MAV_PARAM_TYPE>>    _mapParamName2MavParamType;
225

226 227 228
    uint8_t     _mavBaseMode;
    uint32_t    _mavCustomMode;
    uint8_t     _mavState;
229

230 231 232
    QTime       _runningTime;
    int8_t      _batteryRemaining = 100;

233 234
    MAV_AUTOPILOT       _firmwareType;
    MAV_TYPE            _vehicleType;
235 236 237
    double              _vehicleLatitude;
    double              _vehicleLongitude;
    double              _vehicleAltitude;
238

239
    MockLinkFileServer* _fileServer;
Don Gagne's avatar
Don Gagne committed
240

241
    bool _sendStatusText;
Don Gagne's avatar
Don Gagne committed
242
    bool _apmSendHomePositionOnEmptyList;
Don Gagne's avatar
Don Gagne committed
243
    MockConfiguration::FailureMode_t _failureMode;
244

245
    int _sendHomePositionDelayCount;
246
    int _sendGPSPositionDelayCount;
247

Don Gagne's avatar
Don Gagne committed
248
    int _currentParamRequestListComponentIndex; // Current component index for param request list workflow, -1 for no request in progress
249 250 251 252 253 254 255 256
    int _currentParamRequestListParamIndex;     // Current parameter index for param request list workflow

    static const uint16_t _logDownloadLogId = 0;        ///< Id of siumulated log file
    static const uint32_t _logDownloadFileSize = 1000;  ///< Size of simulated log file

    QString _logDownloadFilename;           ///< Filename for log download which is in progress
    uint32_t    _logDownloadCurrentOffset;  ///< Current offset we are sending from
    uint32_t    _logDownloadBytesRemaining; ///< Number of bytes still to send, 0 = send inactive
Don Gagne's avatar
Don Gagne committed
257

258 259 260
    QGeoCoordinate  _adsbVehicleCoordinate;
    double          _adsbAngle;

261 262 263
    static double       _defaultVehicleLatitude;
    static double       _defaultVehicleLongitude;
    static double       _defaultVehicleAltitude;
Don Gagne's avatar
Don Gagne committed
264 265
    static int          _nextVehicleSystemId;
    static const char*  _failParam;
266 267
};