MAVLinkProtocol.h 5.9 KB
Newer Older
1
2
/****************************************************************************
 *
3
 *   (c) 2009-2018 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"
Don Gagne's avatar
Don Gagne committed
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
37
38
 * MAVLink is a generic communication protocol for micro air vehicles.
 * for more information, please see the official website.
 * @ref http://pixhawk.ethz.ch/software/mavlink/
pixhawk's avatar
pixhawk committed
39
 **/
40
class MAVLinkProtocol : public QGCTool
41
{
pixhawk's avatar
pixhawk committed
42
43
    Q_OBJECT

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

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

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

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

pixhawk's avatar
pixhawk committed
81
82
public slots:
    /** @brief Receive bytes from a communication interface */
83
    void receiveBytes(LinkInterface* link, QByteArray b);
84
    
85
86
    /** @brief Set the system id of this application */
    void setSystemId(int id);
pixhawk's avatar
pixhawk committed
87

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

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

102
protected:
Gus Grubba's avatar
Gus Grubba committed
103
104
105
106
107
108
109
    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

Gus Grubba's avatar
Gus Grubba committed
110
111
    mavlink_message_t _message;
    mavlink_status_t _status;
Gus Grubba's avatar
Gus Grubba committed
112
113
114
115

    bool        versionMismatchIgnore;
    int         systemId;
    unsigned    _current_version;
Don Gagne's avatar
   
Don Gagne committed
116
    int         _radio_version_mismatch_count;
117

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

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

Gus Grubba's avatar
Gus Grubba committed
131
    void mavlinkMessageStatus(int uasId, uint64_t totalSent, uint64_t totalReceived, uint64_t totalLoss, float lossPercent);
132

133
134
135
136
137
    /**
     * @brief Emitted if a new radio status packet received
     *
     * @param rxerrors receive errors
     * @param fixed count of error corrected packets
138
139
     * @param rssi local signal strength in dBm
     * @param remrssi remote signal strength in dBm
140
141
142
143
     * @param txbuf how full the tx buffer is as a percentage
     * @param noise background noise level
     * @param remnoise remote background noise level
     */
144
    void radioStatusChanged(LinkInterface* link, unsigned rxerrors, unsigned fixed, int rssi, int remrssi,
145
    unsigned txbuf, unsigned noise, unsigned remnoise);
Don Gagne's avatar
Don Gagne committed
146
    
147
148
149
150
151
    /// 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);
152
153

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

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

Don Gagne's avatar
Don Gagne committed
165
166
167
    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
168

169
170
    LinkManager*            _linkMgr;
    MultiVehicleManager*    _multiVehicleManager;
pixhawk's avatar
pixhawk committed
171
172
};