MAVLinkProtocol.h 10.8 KB
Newer Older
pixhawk's avatar
pixhawk committed
1 2
/*=====================================================================

pixhawk's avatar
pixhawk committed
3
QGroundControl Open Source Ground Control Station
pixhawk's avatar
pixhawk committed
4

pixhawk's avatar
pixhawk committed
5
(c) 2009, 2010 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
pixhawk's avatar
pixhawk committed
6

pixhawk's avatar
pixhawk committed
7
This file is part of the QGROUNDCONTROL project
pixhawk's avatar
pixhawk committed
8

pixhawk's avatar
pixhawk committed
9
    QGROUNDCONTROL is free software: you can redistribute it and/or modify
pixhawk's avatar
pixhawk committed
10 11 12 13
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

pixhawk's avatar
pixhawk committed
14
    QGROUNDCONTROL is distributed in the hope that it will be useful,
pixhawk's avatar
pixhawk committed
15 16 17 18 19
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
pixhawk's avatar
pixhawk committed
20
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
pixhawk's avatar
pixhawk committed
21 22 23 24 25

======================================================================*/

/**
 * @file
pixhawk's avatar
pixhawk committed
26 27
 *   @brief Definition of class MAVLinkProtocol
 *   @author Lorenz Meier <mail@qgroundcontrol.org>
pixhawk's avatar
pixhawk committed
28 29 30 31 32 33 34 35 36
 */

#ifndef MAVLINKPROTOCOL_H_
#define MAVLINKPROTOCOL_H_

#include <QObject>
#include <QMutex>
#include <QString>
#include <QTimer>
lm's avatar
lm committed
37
#include <QFile>
lm's avatar
lm committed
38
#include <QMap>
pixhawk's avatar
pixhawk committed
39
#include <QByteArray>
40
#include <QLoggingCategory>
Don Gagne's avatar
Don Gagne committed
41

pixhawk's avatar
pixhawk committed
42
#include "LinkInterface.h"
pixhawk's avatar
pixhawk committed
43
#include "QGCMAVLink.h"
44
#include "QGC.h"
45
#include "QGCTemporaryFile.h"
46
#include "QGCToolbox.h"
pixhawk's avatar
pixhawk committed
47

48
class LinkManager;
49 50
class MultiVehicleManager;
class QGCApplication;
51

52 53
Q_DECLARE_LOGGING_CATEGORY(MAVLinkProtocolLog)

pixhawk's avatar
pixhawk committed
54
/**
pixhawk's avatar
pixhawk committed
55
 * @brief MAVLink micro air vehicle protocol reference implementation.
pixhawk's avatar
pixhawk committed
56
 *
pixhawk's avatar
pixhawk committed
57 58 59
 * 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
60
 **/
61
class MAVLinkProtocol : public QGCTool
62
{
pixhawk's avatar
pixhawk committed
63 64
    Q_OBJECT

65
public:
66 67 68
    MAVLinkProtocol(QGCApplication* app);
    ~MAVLinkProtocol();

pixhawk's avatar
pixhawk committed
69 70
    /** @brief Get the human-friendly name of this protocol */
    QString getName();
71 72 73 74
    /** @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
75
    
lm's avatar
lm committed
76
    /** @brief Get protocol version check state */
77 78 79
    bool versionCheckEnabled() const {
        return m_enable_version_check;
    }
80
    /** @brief Get the multiplexing state */
81 82 83
    bool multiplexingEnabled() const {
        return m_multiplexingEnabled;
    }
84
    /** @brief Get the authentication state */
85 86 87
    bool getAuthEnabled() {
        return m_authEnabled;
    }
88
    /** @brief Get the protocol version */
89 90 91
    int getVersion() {
        return MAVLINK_VERSION;
    }
92
    /** @brief Get the auth key */
93 94 95
    QString getAuthKey() {
        return m_authKey;
    }
96
    /** @brief Get state of parameter retransmission */
97 98 99
    bool paramGuardEnabled() {
        return m_paramGuardEnabled;
    }
100
    /** @brief Get parameter read timeout */
101 102 103
    int getParamRetransmissionTimeout() {
        return m_paramRetransmissionTimeout;
    }
104
    /** @brief Get parameter write timeout */
105 106 107
    int getParamRewriteTimeout() {
        return m_paramRewriteTimeout;
    }
108
    /** @brief Get state of action retransmission */
109 110 111
    bool actionGuardEnabled() {
        return m_actionGuardEnabled;
    }
112
    /** @brief Get parameter read timeout */
113 114 115
    int getActionRetransmissionTimeout() {
        return m_actionRetransmissionTimeout;
    }
116 117 118 119
    /**
     * Retrieve a total of all successfully parsed packets for the specified link.
     * @returns -1 if this is not available for this protocol, # of packets otherwise.
     */
120
    qint32 getReceivedPacketCount(const LinkInterface *link) const {
121
        return totalReceiveCounter[link->getMavlinkChannel()];
122 123 124 125 126
    }
    /**
     * Retrieve a total of all parsing errors for the specified link.
     * @returns -1 if this is not available for this protocol, # of errors otherwise.
     */
127
    qint32 getParsingErrorCount(const LinkInterface *link) const {
128
        return totalErrorCounter[link->getMavlinkChannel()];
129 130 131 132 133
    }
    /**
     * Retrieve a total of all dropped packets for the specified link.
     * @returns -1 if this is not available for this protocol, # of packets otherwise.
     */
134
    qint32 getDroppedPacketCount(const LinkInterface *link) const {
135
        return totalLossCounter[link->getMavlinkChannel()];
136
    }
137 138 139 140
    /**
     * Reset the counters for all metadata for this link.
     */
    virtual void resetMetadataForLink(const LinkInterface *link);
Don Gagne's avatar
Don Gagne committed
141
    
142 143
    /// Suspend/Restart logging during replay.
    void suspendLogForReplay(bool suspend);
Lorenz Meier's avatar
Lorenz Meier committed
144

145 146 147
    // Override from QGCTool
    virtual void setToolbox(QGCToolbox *toolbox);

pixhawk's avatar
pixhawk committed
148 149
public slots:
    /** @brief Receive bytes from a communication interface */
150
    void receiveBytes(LinkInterface* link, QByteArray b);
151
    
152 153
    /** @brief Set the system id of this application */
    void setSystemId(int id);
pixhawk's avatar
pixhawk committed
154

155 156 157
    /** @brief Enabled/disable packet multiplexing */
    void enableMultiplexing(bool enabled);

158 159 160
    /** @brief Enable / disable parameter retransmission */
    void enableParamGuard(bool enabled);

161 162 163
    /** @brief Enable / disable action retransmission */
    void enableActionGuard(bool enabled);

164 165 166 167 168 169
    /** @brief Set parameter read timeout */
    void setParamRetransmissionTimeout(int ms);

    /** @brief Set parameter write timeout */
    void setParamRewriteTimeout(int ms);

170 171 172
    /** @brief Set parameter read timeout */
    void setActionRetransmissionTimeout(int ms);

lm's avatar
lm committed
173 174 175
    /** @brief Enable / disable version check */
    void enableVersionCheck(bool enabled);

176 177 178 179
    /** @brief Enable / disable authentication */
    void enableAuth(bool enable);

    /** @brief Set authentication token */
180 181 182
    void setAuthKey(QString key) {
        m_authKey = key;
    }
183

184 185 186 187
    /** @brief Load protocol settings */
    void loadSettings();
    /** @brief Store protocol settings */
    void storeSettings();
Don Gagne's avatar
Don Gagne committed
188
    
Don Gagne's avatar
Don Gagne committed
189
#ifndef __mobile__
190 191
    /// @brief Deletes any log files which are in the temp directory
    static void deleteTempLogFiles(void);
192 193 194
    
    /// Checks for lost log files
    void checkForLostLogFiles(void);
Don Gagne's avatar
Don Gagne committed
195
#endif
Don Gagne's avatar
Don Gagne committed
196

197
protected:
198
    bool m_multiplexingEnabled; ///< Enable/disable packet multiplexing
199 200
    bool m_authEnabled;        ///< Enable authentication token broadcast
    QString m_authKey;         ///< Authentication key
lm's avatar
lm committed
201
    bool m_enable_version_check; ///< Enable checking of version match of MAV and QGC
202 203
    int m_paramRetransmissionTimeout; ///< Timeout for parameter retransmission
    int m_paramRewriteTimeout;    ///< Timeout for sending re-write request
204 205 206
    bool m_paramGuardEnabled;       ///< Parameter retransmission/rewrite enabled
    bool m_actionGuardEnabled;       ///< Action request retransmission enabled
    int m_actionRetransmissionTimeout; ///< Timeout for parameter retransmission
207 208 209 210 211 212 213
    QMutex receiveMutex;        ///< Mutex to protect receiveBytes function
    int lastIndex[256][256];    ///< Store the last received sequence ID for each system/componenet pair
    int totalReceiveCounter[MAVLINK_COMM_NUM_BUFFERS];    ///< The total number of successfully received messages
    int totalLossCounter[MAVLINK_COMM_NUM_BUFFERS];       ///< Total messages lost during transmission.
    int totalErrorCounter[MAVLINK_COMM_NUM_BUFFERS];      ///< Total count of all parsing errors. Generally <= totalLossCounter.
    int currReceiveCounter[MAVLINK_COMM_NUM_BUFFERS];     ///< Received messages during this sample time window. Used for calculating loss %.
    int currLossCounter[MAVLINK_COMM_NUM_BUFFERS];        ///< Lost messages during this sample time window. Used for calculating loss %.
214
    bool versionMismatchIgnore;
215
    int systemId;
216

pixhawk's avatar
pixhawk committed
217
signals:
Don Gagne's avatar
Don Gagne committed
218 219 220
    /// Heartbeat received on link
    void vehicleHeartbeatInfo(LinkInterface* link, int vehicleId, int vehicleMavlinkVersion, int vehicleFirmwareType, int vehicleType);

pixhawk's avatar
pixhawk committed
221 222
    /** @brief Message received and directly copied via signal */
    void messageReceived(LinkInterface* link, mavlink_message_t message);
223 224
    /** @brief Emitted if multiplexing is started / stopped */
    void multiplexingChanged(bool enabled);
225 226 227 228
    /** @brief Emitted if authentication support is enabled / disabled */
    void authKeyChanged(QString key);
    /** @brief Authentication changed */
    void authChanged(bool enabled);
lm's avatar
lm committed
229 230
    /** @brief Emitted if version check is enabled / disabled */
    void versionCheckChanged(bool enabled);
231 232
    /** @brief Emitted if a message from the protocol should reach the user */
    void protocolStatusMessage(const QString& title, const QString& message);
233 234 235 236 237 238 239 240
    /** @brief Emitted if a new system ID was set */
    void systemIdChanged(int systemId);
    /** @brief Emitted if param guard status changed */
    void paramGuardChanged(bool enabled);
    /** @brief Emitted if param read timeout changed */
    void paramRetransmissionTimeoutChanged(int ms);
    /** @brief Emitted if param write timeout changed */
    void paramRewriteTimeoutChanged(int ms);
241 242
    /** @brief Emitted if action guard status changed */
    void actionGuardChanged(bool enabled);
243
    /** @brief Emitted if action request timeout changed */
244
    void actionRetransmissionTimeoutChanged(int ms);
245 246 247
    /** @brief Update the packet loss from one system */
    void receiveLossChanged(int uasId, float loss);

248 249 250 251 252
    /**
     * @brief Emitted if a new radio status packet received
     *
     * @param rxerrors receive errors
     * @param fixed count of error corrected packets
253 254
     * @param rssi local signal strength in dBm
     * @param remrssi remote signal strength in dBm
255 256 257 258
     * @param txbuf how full the tx buffer is as a percentage
     * @param noise background noise level
     * @param remnoise remote background noise level
     */
259
    void radioStatusChanged(LinkInterface* link, unsigned rxerrors, unsigned fixed, int rssi, int remrssi,
260
    unsigned txbuf, unsigned noise, unsigned remnoise);
Don Gagne's avatar
Don Gagne committed
261 262 263
    
    /// @brief Emitted when a temporary log file is ready for saving
    void saveTempFlightDataLog(QString tempLogfile);
264 265 266

private slots:
    void _vehicleCountChanged(int count);
Don Gagne's avatar
Don Gagne committed
267 268
    
private:
Don Gagne's avatar
Don Gagne committed
269 270 271
    void _sendMessage(mavlink_message_t message);
    void _sendMessage(LinkInterface* link, mavlink_message_t message);
    void _sendMessage(LinkInterface* link, mavlink_message_t message, quint8 systemid, quint8 componentid);
Don Gagne's avatar
Don Gagne committed
272 273

#ifndef __mobile__
Don Gagne's avatar
Don Gagne committed
274 275 276
    bool _closeLogFile(void);
    void _startLogging(void);
    void _stopLogging(void);
Don Gagne's avatar
Don Gagne committed
277

Don Gagne's avatar
Don Gagne committed
278 279
    bool _logSuspendError;      ///< true: Logging suspended due to error
    bool _logSuspendReplay;     ///< true: Logging suspended due to replay
280
    bool _logPromptForSave;     ///< true: Prompt for log save when appropriate
Don Gagne's avatar
Don Gagne committed
281

282 283 284
    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
285
#endif
Don Gagne's avatar
Don Gagne committed
286

287 288
    LinkManager*            _linkMgr;
    MultiVehicleManager*    _multiVehicleManager;
pixhawk's avatar
pixhawk committed
289 290 291
};

#endif // MAVLINKPROTOCOL_H_