MAVLinkProtocol.h 10.5 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 46 47 48
#if defined(QGC_PROTOBUF_ENABLED)
#include <tr1/memory>
#include <google/protobuf/message.h>
#if defined(QGC_USE_PIXHAWK_MESSAGES)
49 50
#include <mavlink_protobuf_manager.hpp>
#endif
51
#endif
52 53


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 62
class MAVLinkProtocol : public ProtocolInterface
{
pixhawk's avatar
pixhawk committed
63 64 65 66 67 68 69 70
    Q_OBJECT

public:
    MAVLinkProtocol();
    ~MAVLinkProtocol();

    /** @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();
pixhawk's avatar
pixhawk committed
75 76 77
    /** @brief The auto heartbeat emission rate in Hertz */
    int getHeartbeatRate();
    /** @brief Get heartbeat state */
78 79 80
    bool heartbeatsEnabled() const {
        return m_heartbeatsEnabled;
    }
lm's avatar
lm committed
81
    /** @brief Get logging state */
82 83 84
    bool loggingEnabled() const {
        return m_loggingEnabled;
    }
lm's avatar
lm committed
85
    /** @brief Get protocol version check state */
86 87 88
    bool versionCheckEnabled() const {
        return m_enable_version_check;
    }
89
    /** @brief Get the multiplexing state */
90 91 92
    bool multiplexingEnabled() const {
        return m_multiplexingEnabled;
    }
93
    /** @brief Get the authentication state */
94 95 96
    bool getAuthEnabled() {
        return m_authEnabled;
    }
97
    /** @brief Get the protocol version */
98 99 100
    int getVersion() {
        return MAVLINK_VERSION;
    }
101
    /** @brief Get the auth key */
102 103 104
    QString getAuthKey() {
        return m_authKey;
    }
pixhawk's avatar
pixhawk committed
105
    /** @brief Get the name of the packet log file */
106
    QString getLogfileName();
107
    /** @brief Get state of parameter retransmission */
108 109 110
    bool paramGuardEnabled() {
        return m_paramGuardEnabled;
    }
111
    /** @brief Get parameter read timeout */
112 113 114
    int getParamRetransmissionTimeout() {
        return m_paramRetransmissionTimeout;
    }
115
    /** @brief Get parameter write timeout */
116 117 118
    int getParamRewriteTimeout() {
        return m_paramRewriteTimeout;
    }
119
    /** @brief Get state of action retransmission */
120 121 122
    bool actionGuardEnabled() {
        return m_actionGuardEnabled;
    }
123
    /** @brief Get parameter read timeout */
124 125 126
    int getActionRetransmissionTimeout() {
        return m_actionRetransmissionTimeout;
    }
127 128 129 130
    /**
     * 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.
     */
131
    qint32 getReceivedPacketCount(const LinkInterface *link) const {
132 133 134 135 136 137
        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.
     */
138
    qint32 getParsingErrorCount(const LinkInterface *link) const {
139 140 141 142 143 144
        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.
     */
145
    qint32 getDroppedPacketCount(const LinkInterface *link) const {
146 147
        return totalLossCounter[link->getId()];
    }
148 149 150 151
    /**
     * Reset the counters for all metadata for this link.
     */
    virtual void resetMetadataForLink(const LinkInterface *link);
pixhawk's avatar
pixhawk committed
152

Lorenz Meier's avatar
Lorenz Meier committed
153 154
    void run();

pixhawk's avatar
pixhawk committed
155 156
public slots:
    /** @brief Receive bytes from a communication interface */
157
    void receiveBytes(LinkInterface* link, QByteArray b);
158
    void linkStatusChanged(bool connected);
pixhawk's avatar
pixhawk committed
159 160
    /** @brief Send MAVLink message through serial interface */
    void sendMessage(mavlink_message_t message);
Lorenz Meier's avatar
Lorenz Meier committed
161
    /** @brief Send MAVLink message */
pixhawk's avatar
pixhawk committed
162
    void sendMessage(LinkInterface* link, mavlink_message_t message);
Lorenz Meier's avatar
Lorenz Meier committed
163 164
    /** @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
165 166
    /** @brief Set the rate at which heartbeats are emitted */
    void setHeartbeatRate(int rate);
167 168
    /** @brief Set the system id of this application */
    void setSystemId(int id);
pixhawk's avatar
pixhawk committed
169 170 171 172

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

lm's avatar
lm committed
173 174 175
    /** @brief Enable/disable binary packet logging */
    void enableLogging(bool enabled);

176 177 178
    /** @brief Enabled/disable packet multiplexing */
    void enableMultiplexing(bool enabled);

179 180 181
    /** @brief Enable / disable parameter retransmission */
    void enableParamGuard(bool enabled);

182 183 184
    /** @brief Enable / disable action retransmission */
    void enableActionGuard(bool enabled);

185 186 187 188 189 190
    /** @brief Set parameter read timeout */
    void setParamRetransmissionTimeout(int ms);

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

191 192 193
    /** @brief Set parameter read timeout */
    void setActionRetransmissionTimeout(int ms);

194 195 196
    /** @brief Set log file name */
    void setLogfileName(const QString& filename);

lm's avatar
lm committed
197 198 199
    /** @brief Enable / disable version check */
    void enableVersionCheck(bool enabled);

200 201 202 203
    /** @brief Enable / disable authentication */
    void enableAuth(bool enable);

    /** @brief Set authentication token */
204 205 206
    void setAuthKey(QString key) {
        m_authKey = key;
    }
207

pixhawk's avatar
pixhawk committed
208 209 210
    /** @brief Send an extra heartbeat to all connected units */
    void sendHeartbeat();

211 212 213 214 215
    /** @brief Load protocol settings */
    void loadSettings();
    /** @brief Store protocol settings */
    void storeSettings();

pixhawk's avatar
pixhawk committed
216
protected:
217
    QTimer heartbeatTimer;    ///< Timer to emit heartbeats
lm's avatar
lm committed
218
    int heartbeatRate;         ///< Heartbeat rate, controls the timer interval
pixhawk's avatar
pixhawk committed
219
    bool m_heartbeatsEnabled;  ///< Enabled/disable heartbeat emission
220
    bool m_multiplexingEnabled; ///< Enable/disable packet multiplexing
221 222 223
    bool m_authEnabled;        ///< Enable authentication token broadcast
    QString m_authKey;         ///< Authentication key
    bool m_loggingEnabled;     ///< Enable/disable packet logging
lm's avatar
lm committed
224
    QFile* m_logfile;           ///< Logfile
lm's avatar
lm committed
225
    bool m_enable_version_check; ///< Enable checking of version match of MAV and QGC
226 227
    int m_paramRetransmissionTimeout; ///< Timeout for parameter retransmission
    int m_paramRewriteTimeout;    ///< Timeout for sending re-write request
228 229 230
    bool m_paramGuardEnabled;       ///< Parameter retransmission/rewrite enabled
    bool m_actionGuardEnabled;       ///< Action request retransmission enabled
    int m_actionRetransmissionTimeout; ///< Timeout for parameter retransmission
231 232 233 234 235 236 237
    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 %.
238
    bool versionMismatchIgnore;
239
    int systemId;
240
#if defined(QGC_PROTOBUF_ENABLED) && defined(QGC_USE_PIXHAWK_MESSAGES)
241 242
    mavlink::ProtobufManager protobufManager;
#endif
pixhawk's avatar
pixhawk committed
243 244 245 246

signals:
    /** @brief Message received and directly copied via signal */
    void messageReceived(LinkInterface* link, mavlink_message_t message);
247
#if defined(QGC_PROTOBUF_ENABLED)
248 249 250
    /** @brief Message received via signal */
    void extendedMessageReceived(LinkInterface *link, std::tr1::shared_ptr<google::protobuf::Message> message);
#endif
pixhawk's avatar
pixhawk committed
251 252
    /** @brief Emitted if heartbeat emission mode is changed */
    void heartbeatChanged(bool heartbeats);
lm's avatar
lm committed
253 254
    /** @brief Emitted if logging is started / stopped */
    void loggingChanged(bool enabled);
255 256
    /** @brief Emitted if multiplexing is started / stopped */
    void multiplexingChanged(bool enabled);
257 258 259 260
    /** @brief Emitted if authentication support is enabled / disabled */
    void authKeyChanged(QString key);
    /** @brief Authentication changed */
    void authChanged(bool enabled);
lm's avatar
lm committed
261 262
    /** @brief Emitted if version check is enabled / disabled */
    void versionCheckChanged(bool enabled);
263 264
    /** @brief Emitted if a message from the protocol should reach the user */
    void protocolStatusMessage(const QString& title, const QString& message);
265 266 267 268 269 270 271 272
    /** @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);
273 274 275 276
    /** @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
277 278 279
};

#endif // MAVLINKPROTOCOL_H_