MockLink.h 10.5 KB
Newer Older
1 2 3 4 5 6 7 8
/****************************************************************************
 *
 *   (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.
 *
 ****************************************************************************/
9

10 11 12 13 14

#ifndef MOCKLINK_H
#define MOCKLINK_H

#include <QMap>
15
#include <QLoggingCategory>
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 34 35 36 37 38 39 40

    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)

    // QML Access
    int     firmware        () { return (int)_firmwareType; }
    void    setFirmware     (int type) { _firmwareType = (MAV_AUTOPILOT)type; emit firmwareChanged(); }
    int     vehicle         () { return (int)_vehicleType; }
    void    setVehicle      (int type) { _vehicleType = (MAV_TYPE)type; emit vehicleChanged(); }

41 42 43 44
    MockConfiguration(const QString& name);
    MockConfiguration(MockConfiguration* source);

    MAV_AUTOPILOT firmwareType(void) { return _firmwareType; }
45
    void setFirmwareType(MAV_AUTOPILOT firmwareType) { _firmwareType = firmwareType; emit firmwareChanged(); }
46

47
    MAV_TYPE vehicleType(void) { return _vehicleType; }
48
    void setVehicleType(MAV_TYPE vehicleType) { _vehicleType = vehicleType; emit vehicleChanged(); }
49

50 51
    /// @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; }
52
    void setSendStatusText(bool sendStatusText) { _sendStatusText = sendStatusText; emit sendStatusChanged(); }
53

Don Gagne's avatar
Don Gagne committed
54 55 56 57 58 59 60 61 62
    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; }

63
    // Overrides from LinkConfiguration
64 65 66 67 68 69 70 71 72 73 74
    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"; }

signals:
    void firmwareChanged    ();
    void vehicleChanged     ();
    void sendStatusChanged  ();
75 76

private:
77
    MAV_AUTOPILOT   _firmwareType;
78
    MAV_TYPE        _vehicleType;
79
    bool            _sendStatusText;
Don Gagne's avatar
Don Gagne committed
80
    FailureMode_t   _failureMode;
81

82
    static const char* _firmwareTypeKey;
83
    static const char* _vehicleTypeKey;
84
    static const char* _sendStatusTextKey;
Don Gagne's avatar
Don Gagne committed
85
    static const char* _failureModeKey;
86 87
};

88 89 90
class MockLink : public LinkInterface
{
    Q_OBJECT
91

92
public:
93
    MockLink(SharedLinkConfigurationPointer& config);
94
    ~MockLink(void);
95

96
    // MockLink methods
Don Gagne's avatar
Don Gagne committed
97
    int vehicleId(void) { return _vehicleSystemId; }
Don Gagne's avatar
Don Gagne committed
98 99
    MAV_AUTOPILOT getFirmwareType(void) { return _firmwareType; }
    void setFirmwareType(MAV_AUTOPILOT autopilot) { _firmwareType = autopilot; }
100
    void setSendStatusText(bool sendStatusText) { _sendStatusText = sendStatusText; }
Don Gagne's avatar
Don Gagne committed
101
    void setFailureMode(MockConfiguration::FailureMode_t failureMode) { _failureMode = failureMode; }
Don Gagne's avatar
Don Gagne committed
102 103 104 105 106 107 108

    /// 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; }

109
    void emitRemoteControlChannelRawChanged(int channel, uint16_t raw);
110

111 112
    /// Sends the specified mavlink message to QGC
    void respondWithMavlinkMessage(const mavlink_message_t& msg);
113

114
    MockLinkFileServer* getFileServer(void) { return _fileServer; }
115

Don Gagne's avatar
Don Gagne committed
116 117 118 119 120 121 122
    // 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; }

123 124 125 126
    // 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);
127

128 129
    /// Sets a failure mode for unit testing
    ///     @param failureMode Type of failure to simulate
130
    void setMissionItemFailureMode(MockLinkMissionItemHandler::FailureMode_t failureMode);
131

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

135 136
    /// Called to send a MISSION_ITEM message while the MissionManager is in idle state
    void sendUnexpectedMissionItem(void) { _missionItemHandler.sendUnexpectedMissionItem(); }
137

138 139
    /// Called to send a MISSION_REQUEST message while the MissionManager is in idle state
    void sendUnexpectedMissionRequest(void) { _missionItemHandler.sendUnexpectedMissionRequest(); }
140

141 142
    /// Reset the state of the MissionItemHandler to no items, no transactions in progress.
    void resetMissionItemHandler(void) { _missionItemHandler.reset(); }
143

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

Don Gagne's avatar
Don Gagne committed
147 148 149 150
    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);
151
    static MockLink* startAPMArduSubMockLink     (bool sendStatusText, MockConfiguration::FailureMode_t failureMode = MockConfiguration::FailNone);
152

153
private slots:
154
    virtual void _writeBytes(const QByteArray bytes);
155

156 157 158
private slots:
    void _run1HzTasks(void);
    void _run10HzTasks(void);
Don Gagne's avatar
Don Gagne committed
159
    void _run500HzTasks(void);
160

161
private:
162 163
    // From LinkInterface
    virtual bool _connect(void);
Don Gagne's avatar
Don Gagne committed
164
    virtual void _disconnect(void);
165

166 167
    // QThread override
    virtual void run(void);
168

169 170 171 172 173 174 175 176 177 178
    // MockLink methods
    void _sendHeartBeat(void);
    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);
179
    void _handleFTP(const mavlink_message_t& msg);
180
    void _handleCommandLong(const mavlink_message_t& msg);
Don Gagne's avatar
Don Gagne committed
181
    void _handleManualControl(const mavlink_message_t& msg);
182
    void _handlePreFlightCalibration(const mavlink_command_long_t& request);
183 184
    void _handleLogRequestList(const mavlink_message_t& msg);
    void _handleLogRequestData(const mavlink_message_t& msg);
185 186
    float _floatUnionForParam(int componentId, const QString& paramName);
    void _setParamFloatUnionIntoMap(int componentId, const QString& paramName, float paramFloat);
187
    void _sendHomePosition(void);
Don Gagne's avatar
Don Gagne committed
188
    void _sendGpsRawInt(void);
Don Gagne's avatar
Don Gagne committed
189
    void _sendVibration(void);
190
    void _sendStatusTextMessages(void);
191
    void _respondWithAutopilotVersion(void);
Don Gagne's avatar
Don Gagne committed
192
    void _sendRCChannels(void);
Don Gagne's avatar
Don Gagne committed
193
    void _paramRequestListWorker(void);
194
    void _logDownloadWorker(void);
195

196 197
    static MockLink* _startMockLink(MockConfiguration* mockConfig);

198
    MockLinkMissionItemHandler  _missionItemHandler;
199

200 201
    QString _name;
    bool    _connected;
202
    int     _mavlinkChannel;
203

204 205
    uint8_t _vehicleSystemId;
    uint8_t _vehicleComponentId;
206

207 208
    bool    _inNSH;
    bool    _mavlinkStarted;
209

210 211
    QMap<int, QMap<QString, QVariant> > _mapParamName2Value;
    QMap<QString, MAV_PARAM_TYPE>       _mapParamName2MavParamType;
212

213 214 215
    uint8_t     _mavBaseMode;
    uint32_t    _mavCustomMode;
    uint8_t     _mavState;
216

217 218
    MAV_AUTOPILOT       _firmwareType;
    MAV_TYPE            _vehicleType;
219

220
    MockLinkFileServer* _fileServer;
Don Gagne's avatar
Don Gagne committed
221

222
    bool _sendStatusText;
Don Gagne's avatar
Don Gagne committed
223
    bool _apmSendHomePositionOnEmptyList;
Don Gagne's avatar
Don Gagne committed
224
    MockConfiguration::FailureMode_t _failureMode;
225

226
    int _sendHomePositionDelayCount;
227
    int _sendGPSPositionDelayCount;
228

Don Gagne's avatar
Don Gagne committed
229
    int _currentParamRequestListComponentIndex; // Current component index for param request list workflow, -1 for no request in progress
230 231 232 233 234 235 236 237
    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
238 239 240 241 242 243

    static float        _vehicleLatitude;
    static float        _vehicleLongitude;
    static float        _vehicleAltitude;
    static int          _nextVehicleSystemId;
    static const char*  _failParam;
244 245 246
};

#endif