MAVLinkProtocol.h 11.4 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>
Don Gagne's avatar
Don Gagne committed
40

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

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

public:
    MAVLinkProtocol();
    ~MAVLinkProtocol();

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

pixhawk's avatar
pixhawk committed
143 144
public slots:
    /** @brief Receive bytes from a communication interface */
145
    void receiveBytes(LinkInterface* link, QByteArray b);
146
    void linkStatusChanged(bool connected);
pixhawk's avatar
pixhawk committed
147 148
    /** @brief Send MAVLink message through serial interface */
    void sendMessage(mavlink_message_t message);
Lorenz Meier's avatar
Lorenz Meier committed
149
    /** @brief Send MAVLink message */
pixhawk's avatar
pixhawk committed
150
    void sendMessage(LinkInterface* link, mavlink_message_t message);
Lorenz Meier's avatar
Lorenz Meier committed
151 152
    /** @brief Send MAVLink message with correct system / component ID */
    void sendMessage(LinkInterface* link, mavlink_message_t message, quint8 systemid, quint8 componentid);
pixhawk's avatar
pixhawk committed
153 154
    /** @brief Set the rate at which heartbeats are emitted */
    void setHeartbeatRate(int rate);
155 156
    /** @brief Set the system id of this application */
    void setSystemId(int id);
pixhawk's avatar
pixhawk committed
157 158 159 160

    /** @brief Enable / disable the heartbeat emission */
    void enableHeartbeats(bool enabled);

161 162 163
    /** @brief Enabled/disable packet multiplexing */
    void enableMultiplexing(bool enabled);

164 165 166
    /** @brief Enable / disable parameter retransmission */
    void enableParamGuard(bool enabled);

167 168 169
    /** @brief Enable / disable action retransmission */
    void enableActionGuard(bool enabled);

170 171 172 173 174 175
    /** @brief Set parameter read timeout */
    void setParamRetransmissionTimeout(int ms);

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

176 177 178
    /** @brief Set parameter read timeout */
    void setActionRetransmissionTimeout(int ms);

lm's avatar
lm committed
179 180 181
    /** @brief Enable / disable version check */
    void enableVersionCheck(bool enabled);

182 183 184 185
    /** @brief Enable / disable authentication */
    void enableAuth(bool enable);

    /** @brief Set authentication token */
186 187 188
    void setAuthKey(QString key) {
        m_authKey = key;
    }
189

pixhawk's avatar
pixhawk committed
190 191 192
    /** @brief Send an extra heartbeat to all connected units */
    void sendHeartbeat();

193 194 195 196
    /** @brief Load protocol settings */
    void loadSettings();
    /** @brief Store protocol settings */
    void storeSettings();
Don Gagne's avatar
Don Gagne committed
197 198 199 200 201 202 203 204 205
    
    /// @brief Suspend/Restart logging during replay. This must be emitted as a signal
    ///         and not called directly in order to synchronize with the bytesReady signal
    ///         which may be ahead of it in the signal queue.
    void suspendLogForReplay(bool suspend);

protected:    
    // Override from QObject
    virtual void connectNotify(const QMetaMethod& signal);
206

207
    QTimer *heartbeatTimer;    ///< Timer to emit heartbeats
lm's avatar
lm committed
208
    int heartbeatRate;         ///< Heartbeat rate, controls the timer interval
pixhawk's avatar
pixhawk committed
209
    bool m_heartbeatsEnabled;  ///< Enabled/disable heartbeat emission
210
    bool m_multiplexingEnabled; ///< Enable/disable packet multiplexing
211 212
    bool m_authEnabled;        ///< Enable authentication token broadcast
    QString m_authKey;         ///< Authentication key
lm's avatar
lm committed
213
    bool m_enable_version_check; ///< Enable checking of version match of MAV and QGC
214 215
    int m_paramRetransmissionTimeout; ///< Timeout for parameter retransmission
    int m_paramRewriteTimeout;    ///< Timeout for sending re-write request
216 217 218
    bool m_paramGuardEnabled;       ///< Parameter retransmission/rewrite enabled
    bool m_actionGuardEnabled;       ///< Action request retransmission enabled
    int m_actionRetransmissionTimeout; ///< Timeout for parameter retransmission
219 220 221 222 223 224 225
    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 %.
226
    bool versionMismatchIgnore;
227
    int systemId;
228 229
    bool _should_exit;

pixhawk's avatar
pixhawk committed
230 231 232 233 234
signals:
    /** @brief Message received and directly copied via signal */
    void messageReceived(LinkInterface* link, mavlink_message_t message);
    /** @brief Emitted if heartbeat emission mode is changed */
    void heartbeatChanged(bool heartbeats);
235 236
    /** @brief Emitted if multiplexing is started / stopped */
    void multiplexingChanged(bool enabled);
237 238 239 240
    /** @brief Emitted if authentication support is enabled / disabled */
    void authKeyChanged(QString key);
    /** @brief Authentication changed */
    void authChanged(bool enabled);
lm's avatar
lm committed
241 242
    /** @brief Emitted if version check is enabled / disabled */
    void versionCheckChanged(bool enabled);
243 244
    /** @brief Emitted if a message from the protocol should reach the user */
    void protocolStatusMessage(const QString& title, const QString& message);
245 246 247 248 249 250 251 252
    /** @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);
253 254 255 256
    /** @brief Emitted if action guard status changed */
    void actionGuardChanged(bool enabled);
    /** @brief Emitted if actiion request timeout changed */
    void actionRetransmissionTimeoutChanged(int ms);
257 258 259 260 261 262 263 264 265 266 267 268 269
    /**
     * @brief Emitted if a new radio status packet received
     *
     * @param rxerrors receive errors
     * @param fixed count of error corrected packets
     * @param rssi local signal strength
     * @param remrssi remote signal strength
     * @param txbuf how full the tx buffer is as a percentage
     * @param noise background noise level
     * @param remnoise remote background noise level
     */
    void radioStatusChanged(LinkInterface* link, unsigned rxerrors, unsigned fixed, unsigned rssi, unsigned remrssi,
    unsigned txbuf, unsigned noise, unsigned remnoise);
Don Gagne's avatar
Don Gagne committed
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
    
    /// @brief Emitted when a temporary log file is ready for saving
    void saveTempFlightDataLog(QString tempLogfile);
    
private:
    bool _closeLogFile(void);
    void _startLogging(void);
    void _stopLogging(void);
    void _checkLostLogFiles(void);
    
    QList<LinkInterface*> _connectedLinks;  ///< List of all links connected to protocol
    
    bool _logSuspendError;      ///< true: Logging suspended due to error
    bool _logSuspendReplay;     ///< true: Logging suspended due to replay
    
285 286 287
    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
288 289 290
    
    bool _protocolStatusMessageConnected;   ///< true: protocolStatusMessage signal has been connected
    bool _saveTempFlightDataLogConnected;   ///< true: saveTempFlightDataLog signal has been connected
pixhawk's avatar
pixhawk committed
291 292 293
};

#endif // MAVLINKPROTOCOL_H_