MAVLinkProtocol.h 5.99 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.
 *
 ****************************************************************************/
pixhawk's avatar
pixhawk committed
9

10
#pragma once
pixhawk's avatar
pixhawk committed
11 12 13 14 15

#include <QObject>
#include <QMutex>
#include <QString>
#include <QTimer>
lm's avatar
lm committed
16
#include <QFile>
lm's avatar
lm committed
17
#include <QMap>
pixhawk's avatar
pixhawk committed
18
#include <QByteArray>
19
#include <QLoggingCategory>
Don Gagne's avatar
Don Gagne committed
20

pixhawk's avatar
pixhawk committed
21
#include "LinkInterface.h"
pixhawk's avatar
pixhawk committed
22
#include "QGCMAVLink.h"
23
#include "QGC.h"
24
#include "QGCTemporaryFile.h"
25
#include "QGCToolbox.h"
pixhawk's avatar
pixhawk committed
26

27
class LinkManager;
28 29
class MultiVehicleManager;
class QGCApplication;
30

31 32
Q_DECLARE_LOGGING_CATEGORY(MAVLinkProtocolLog)

pixhawk's avatar
pixhawk committed
33
/**
pixhawk's avatar
pixhawk committed
34
 * @brief MAVLink micro air vehicle protocol reference implementation.
pixhawk's avatar
pixhawk committed
35
 *
pixhawk's avatar
pixhawk committed
36
 * MAVLink is a generic communication protocol for micro air vehicles.
Gus Grubba's avatar
Gus Grubba committed
37
 * for more information, please see the official website: https://mavlink.io
pixhawk's avatar
pixhawk committed
38
 **/
39
class MAVLinkProtocol : public QGCTool
40
{
pixhawk's avatar
pixhawk committed
41 42
    Q_OBJECT

43
public:
44
    MAVLinkProtocol(QGCApplication* app, QGCToolbox* toolbox);
45 46
    ~MAVLinkProtocol();

pixhawk's avatar
pixhawk committed
47 48
    /** @brief Get the human-friendly name of this protocol */
    QString getName();
49 50 51 52
    /** @brief Get the system id of this application */
    int getSystemId();
    /** @brief Get the component id of this application */
    int getComponentId();
Don Gagne's avatar
Don Gagne committed
53
    
lm's avatar
lm committed
54
    /** @brief Get protocol version check state */
55 56 57
    bool versionCheckEnabled() const {
        return m_enable_version_check;
    }
58
    /** @brief Get the protocol version */
59 60 61
    int getVersion() {
        return MAVLINK_VERSION;
    }
62 63 64 65
    /** @brief Get the currently configured protocol version */
    unsigned getCurrentVersion() {
        return _current_version;
    }
66 67 68
    /**
     * Reset the counters for all metadata for this link.
     */
69
    virtual void resetMetadataForLink(LinkInterface *link);
Don Gagne's avatar
Don Gagne committed
70
    
71 72
    /// Suspend/Restart logging during replay.
    void suspendLogForReplay(bool suspend);
Lorenz Meier's avatar
Lorenz Meier committed
73

74 75 76
    /// Set protocol version
    void setVersion(unsigned version);

77 78 79
    // Override from QGCTool
    virtual void setToolbox(QGCToolbox *toolbox);

pixhawk's avatar
pixhawk committed
80 81
public slots:
    /** @brief Receive bytes from a communication interface */
82
    void receiveBytes(LinkInterface* link, QByteArray b);
83 84 85

    /** @brief Log bytes sent from a communication interface */
    void logSentBytes(LinkInterface* link, QByteArray b);
86
    
87 88
    /** @brief Set the system id of this application */
    void setSystemId(int id);
pixhawk's avatar
pixhawk committed
89

lm's avatar
lm committed
90 91 92
    /** @brief Enable / disable version check */
    void enableVersionCheck(bool enabled);

93 94 95 96
    /** @brief Load protocol settings */
    void loadSettings();
    /** @brief Store protocol settings */
    void storeSettings();
Don Gagne's avatar
Don Gagne committed
97
    
98 99
    /// @brief Deletes any log files which are in the temp directory
    static void deleteTempLogFiles(void);
100 101 102
    
    /// Checks for lost log files
    void checkForLostLogFiles(void);
Don Gagne's avatar
Don Gagne committed
103

104
protected:
105 106 107 108 109 110 111
    bool        m_enable_version_check;                         ///< Enable checking of version match of MAV and QGC
    uint8_t     lastIndex[256][256];                            ///< Store the last received sequence ID for each system/componenet pair
    uint8_t     firstMessage[256][256];                         ///< First message flag
    uint64_t    totalReceiveCounter[MAVLINK_COMM_NUM_BUFFERS];  ///< The total number of successfully received messages
    uint64_t    totalLossCounter[MAVLINK_COMM_NUM_BUFFERS];     ///< Total messages lost during transmission.
    float       runningLossPercent[MAVLINK_COMM_NUM_BUFFERS];   ///< Loss rate

112 113
    mavlink_message_t _message;
    mavlink_status_t _status;
114 115 116 117

    bool        versionMismatchIgnore;
    int         systemId;
    unsigned    _current_version;
Don Gagne's avatar
Don Gagne committed
118
    int         _radio_version_mismatch_count;
119

pixhawk's avatar
pixhawk committed
120
signals:
Don Gagne's avatar
Don Gagne committed
121
    /// Heartbeat received on link
122
    void vehicleHeartbeatInfo(LinkInterface* link, int vehicleId, int componentId, int vehicleFirmwareType, int vehicleType);
Don Gagne's avatar
Don Gagne committed
123

pixhawk's avatar
pixhawk committed
124 125
    /** @brief Message received and directly copied via signal */
    void messageReceived(LinkInterface* link, mavlink_message_t message);
lm's avatar
lm committed
126 127
    /** @brief Emitted if version check is enabled / disabled */
    void versionCheckChanged(bool enabled);
128 129
    /** @brief Emitted if a message from the protocol should reach the user */
    void protocolStatusMessage(const QString& title, const QString& message);
130 131
    /** @brief Emitted if a new system ID was set */
    void systemIdChanged(int systemId);
132

133
    void mavlinkMessageStatus(int uasId, uint64_t totalSent, uint64_t totalReceived, uint64_t totalLoss, float lossPercent);
134

135 136 137 138 139
    /**
     * @brief Emitted if a new radio status packet received
     *
     * @param rxerrors receive errors
     * @param fixed count of error corrected packets
140 141
     * @param rssi local signal strength in dBm
     * @param remrssi remote signal strength in dBm
142 143 144 145
     * @param txbuf how full the tx buffer is as a percentage
     * @param noise background noise level
     * @param remnoise remote background noise level
     */
146
    void radioStatusChanged(LinkInterface* link, unsigned rxerrors, unsigned fixed, int rssi, int remrssi,
147
    unsigned txbuf, unsigned noise, unsigned remnoise);
Don Gagne's avatar
Don Gagne committed
148
    
149 150 151 152 153
    /// Emitted when a temporary telemetry log file is ready for saving
    void saveTelemetryLog(QString tempLogfile);

    /// Emitted when a telemetry log is started to save.
    void checkTelemetrySavePath(void);
154 155

private slots:
156
    void _vehicleCountChanged(void);
Don Gagne's avatar
Don Gagne committed
157 158 159 160 161
    
private:
    bool _closeLogFile(void);
    void _startLogging(void);
    void _stopLogging(void);
Don Gagne's avatar
Don Gagne committed
162

Don Gagne's avatar
Don Gagne committed
163 164
    bool _logSuspendError;      ///< true: Logging suspended due to error
    bool _logSuspendReplay;     ///< true: Logging suspended due to replay
165
    bool _vehicleWasArmed;      ///< true: Vehicle was armed during log sequence
Don Gagne's avatar
Don Gagne committed
166

167 168 169
    QGCTemporaryFile    _tempLogFile;            ///< File to log to
    static const char*  _tempLogFileTemplate;    ///< Template for temporary log file
    static const char*  _logFileExtension;       ///< Extension for log files
Don Gagne's avatar
Don Gagne committed
170

171 172
    LinkManager*            _linkMgr;
    MultiVehicleManager*    _multiVehicleManager;
pixhawk's avatar
pixhawk committed
173 174
};