MAVLinkProtocol.h 8.25 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 40 41
#include <QByteArray>
#include "ProtocolInterface.h"
#include "LinkInterface.h"
pixhawk's avatar
pixhawk committed
42
#include "QGCMAVLink.h"
43
#include "QGC.h"
pixhawk's avatar
pixhawk committed
44 45

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

public:
    MAVLinkProtocol();
    ~MAVLinkProtocol();

    void run();
    /** @brief Get the human-friendly name of this protocol */
    QString getName();
63 64 65 66
    /** @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
67 68 69
    /** @brief The auto heartbeat emission rate in Hertz */
    int getHeartbeatRate();
    /** @brief Get heartbeat state */
70 71 72
    bool heartbeatsEnabled() const {
        return m_heartbeatsEnabled;
    }
lm's avatar
lm committed
73
    /** @brief Get logging state */
74 75 76
    bool loggingEnabled() const {
        return m_loggingEnabled;
    }
lm's avatar
lm committed
77
    /** @brief Get protocol version check state */
78 79 80
    bool versionCheckEnabled() const {
        return m_enable_version_check;
    }
81
    /** @brief Get the multiplexing state */
82 83 84
    bool multiplexingEnabled() const {
        return m_multiplexingEnabled;
    }
85
    /** @brief Get the authentication state */
86 87 88
    bool getAuthEnabled() {
        return m_authEnabled;
    }
89
    /** @brief Get the protocol version */
90 91 92
    int getVersion() {
        return MAVLINK_VERSION;
    }
93
    /** @brief Get the auth key */
94 95 96
    QString getAuthKey() {
        return m_authKey;
    }
pixhawk's avatar
pixhawk committed
97
    /** @brief Get the name of the packet log file */
98
    QString getLogfileName();
99
    /** @brief Get state of parameter retransmission */
100 101 102
    bool paramGuardEnabled() {
        return m_paramGuardEnabled;
    }
103
    /** @brief Get parameter read timeout */
104 105 106
    int getParamRetransmissionTimeout() {
        return m_paramRetransmissionTimeout;
    }
107
    /** @brief Get parameter write timeout */
108 109 110
    int getParamRewriteTimeout() {
        return m_paramRewriteTimeout;
    }
111
    /** @brief Get state of action retransmission */
112 113 114
    bool actionGuardEnabled() {
        return m_actionGuardEnabled;
    }
115
    /** @brief Get parameter read timeout */
116 117 118
    int getActionRetransmissionTimeout() {
        return m_actionRetransmissionTimeout;
    }
pixhawk's avatar
pixhawk committed
119 120 121

public slots:
    /** @brief Receive bytes from a communication interface */
122
    void receiveBytes(LinkInterface* link, QByteArray b);
pixhawk's avatar
pixhawk committed
123 124 125 126 127 128
    /** @brief Send MAVLink message through serial interface */
    void sendMessage(mavlink_message_t message);
    /** @brief Send MAVLink message through serial interface */
    void sendMessage(LinkInterface* link, mavlink_message_t message);
    /** @brief Set the rate at which heartbeats are emitted */
    void setHeartbeatRate(int rate);
129 130
    /** @brief Set the system id of this application */
    void setSystemId(int id);
pixhawk's avatar
pixhawk committed
131 132 133 134

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

lm's avatar
lm committed
135 136 137
    /** @brief Enable/disable binary packet logging */
    void enableLogging(bool enabled);

138 139 140
    /** @brief Enabled/disable packet multiplexing */
    void enableMultiplexing(bool enabled);

141 142 143
    /** @brief Enable / disable parameter retransmission */
    void enableParamGuard(bool enabled);

144 145 146
    /** @brief Enable / disable action retransmission */
    void enableActionGuard(bool enabled);

147 148 149 150 151 152
    /** @brief Set parameter read timeout */
    void setParamRetransmissionTimeout(int ms);

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

153 154 155
    /** @brief Set parameter read timeout */
    void setActionRetransmissionTimeout(int ms);

156 157 158
    /** @brief Set log file name */
    void setLogfileName(const QString& filename);

lm's avatar
lm committed
159 160 161
    /** @brief Enable / disable version check */
    void enableVersionCheck(bool enabled);

162 163 164 165
    /** @brief Enable / disable authentication */
    void enableAuth(bool enable);

    /** @brief Set authentication token */
166 167 168
    void setAuthKey(QString key) {
        m_authKey = key;
    }
169

pixhawk's avatar
pixhawk committed
170 171 172
    /** @brief Send an extra heartbeat to all connected units */
    void sendHeartbeat();

173 174 175 176 177
    /** @brief Load protocol settings */
    void loadSettings();
    /** @brief Store protocol settings */
    void storeSettings();

pixhawk's avatar
pixhawk committed
178
protected:
lm's avatar
lm committed
179 180
    QTimer* heartbeatTimer;    ///< Timer to emit heartbeats
    int heartbeatRate;         ///< Heartbeat rate, controls the timer interval
pixhawk's avatar
pixhawk committed
181
    bool m_heartbeatsEnabled;  ///< Enabled/disable heartbeat emission
182
    bool m_multiplexingEnabled; ///< Enable/disable packet multiplexing
183 184 185
    bool m_authEnabled;        ///< Enable authentication token broadcast
    QString m_authKey;         ///< Authentication key
    bool m_loggingEnabled;     ///< Enable/disable packet logging
lm's avatar
lm committed
186
    QFile* m_logfile;           ///< Logfile
lm's avatar
lm committed
187
    bool m_enable_version_check; ///< Enable checking of version match of MAV and QGC
188 189
    int m_paramRetransmissionTimeout; ///< Timeout for parameter retransmission
    int m_paramRewriteTimeout;    ///< Timeout for sending re-write request
190 191 192
    bool m_paramGuardEnabled;       ///< Parameter retransmission/rewrite enabled
    bool m_actionGuardEnabled;       ///< Action request retransmission enabled
    int m_actionRetransmissionTimeout; ///< Timeout for parameter retransmission
lm's avatar
lm committed
193
    QMutex receiveMutex;       ///< Mutex to protect receiveBytes function
lm's avatar
lm committed
194
    int lastIndex[256][256];
lm's avatar
lm committed
195 196
    int totalReceiveCounter;
    int totalLossCounter;
197 198
    int currReceiveCounter;
    int currLossCounter;
199
    bool versionMismatchIgnore;
200
    int systemId;
pixhawk's avatar
pixhawk committed
201 202 203 204 205 206

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);
lm's avatar
lm committed
207 208
    /** @brief Emitted if logging is started / stopped */
    void loggingChanged(bool enabled);
209 210
    /** @brief Emitted if multiplexing is started / stopped */
    void multiplexingChanged(bool enabled);
211 212 213 214
    /** @brief Emitted if authentication support is enabled / disabled */
    void authKeyChanged(QString key);
    /** @brief Authentication changed */
    void authChanged(bool enabled);
lm's avatar
lm committed
215 216
    /** @brief Emitted if version check is enabled / disabled */
    void versionCheckChanged(bool enabled);
217 218
    /** @brief Emitted if a message from the protocol should reach the user */
    void protocolStatusMessage(const QString& title, const QString& message);
219 220 221 222 223 224 225 226
    /** @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);
227 228 229 230
    /** @brief Emitted if action guard status changed */
    void actionGuardChanged(bool enabled);
    /** @brief Emitted if actiion request timeout changed */
    void actionRetransmissionTimeoutChanged(int ms);
pixhawk's avatar
pixhawk committed
231 232 233
};

#endif // MAVLINKPROTOCOL_H_