MAVLinkProtocol.h 5.39 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 54 55 56 57 58 59 60 61
 **/
class MAVLinkProtocol : public ProtocolInterface {
    Q_OBJECT

public:
    MAVLinkProtocol();
    ~MAVLinkProtocol();

    void run();
    /** @brief Get the human-friendly name of this protocol */
    QString getName();
62 63 64 65
    /** @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
66 67 68
    /** @brief The auto heartbeat emission rate in Hertz */
    int getHeartbeatRate();
    /** @brief Get heartbeat state */
69
    bool heartbeatsEnabled() const { return m_heartbeatsEnabled; }
lm's avatar
lm committed
70
    /** @brief Get logging state */
71
    bool loggingEnabled() const { return m_loggingEnabled; }
lm's avatar
lm committed
72
    /** @brief Get protocol version check state */
73 74 75
    bool versionCheckEnabled() const { return m_enable_version_check; }
    /** @brief Get the multiplexing state */
    bool multiplexingEnabled() const { return m_multiplexingEnabled; }
76 77
    /** @brief Get the protocol version */
    int getVersion() { return MAVLINK_VERSION; }
pixhawk's avatar
pixhawk committed
78
    /** @brief Get the name of the packet log file */
79
    QString getLogfileName();
pixhawk's avatar
pixhawk committed
80 81 82

public slots:
    /** @brief Receive bytes from a communication interface */
83
    void receiveBytes(LinkInterface* link, QByteArray b);
pixhawk's avatar
pixhawk committed
84 85 86 87 88 89
    /** @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);
90 91
    /** @brief Set the system id of this application */
    void setSystemId(int id);
pixhawk's avatar
pixhawk committed
92 93 94 95

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

lm's avatar
lm committed
96 97 98
    /** @brief Enable/disable binary packet logging */
    void enableLogging(bool enabled);

99 100 101
    /** @brief Enabled/disable packet multiplexing */
    void enableMultiplexing(bool enabled);

102 103 104
    /** @brief Set log file name */
    void setLogfileName(const QString& filename);

lm's avatar
lm committed
105 106 107
    /** @brief Enable / disable version check */
    void enableVersionCheck(bool enabled);

pixhawk's avatar
pixhawk committed
108 109 110
    /** @brief Send an extra heartbeat to all connected units */
    void sendHeartbeat();

111 112 113 114 115
    /** @brief Load protocol settings */
    void loadSettings();
    /** @brief Store protocol settings */
    void storeSettings();

pixhawk's avatar
pixhawk committed
116
protected:
lm's avatar
lm committed
117 118
    QTimer* heartbeatTimer;    ///< Timer to emit heartbeats
    int heartbeatRate;         ///< Heartbeat rate, controls the timer interval
pixhawk's avatar
pixhawk committed
119
    bool m_heartbeatsEnabled;  ///< Enabled/disable heartbeat emission
lm's avatar
lm committed
120
    bool m_loggingEnabled;     ///< Enable/disable packet logging
121
    bool m_multiplexingEnabled; ///< Enable/disable packet multiplexing
lm's avatar
lm committed
122
    QFile* m_logfile;           ///< Logfile
lm's avatar
lm committed
123
    bool m_enable_version_check; ///< Enable checking of version match of MAV and QGC
lm's avatar
lm committed
124
    QMutex receiveMutex;       ///< Mutex to protect receiveBytes function
lm's avatar
lm committed
125
    int lastIndex[256][256];
lm's avatar
lm committed
126 127
    int totalReceiveCounter;
    int totalLossCounter;
128 129
    int currReceiveCounter;
    int currLossCounter;
130
    bool versionMismatchIgnore;
131
    int systemId;
pixhawk's avatar
pixhawk committed
132 133 134 135 136 137

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
138 139
    /** @brief Emitted if logging is started / stopped */
    void loggingChanged(bool enabled);
140 141
    /** @brief Emitted if multiplexing is started / stopped */
    void multiplexingChanged(bool enabled);
lm's avatar
lm committed
142 143
    /** @brief Emitted if version check is enabled / disabled */
    void versionCheckChanged(bool enabled);
144 145
    /** @brief Emitted if a message from the protocol should reach the user */
    void protocolStatusMessage(const QString& title, const QString& message);
pixhawk's avatar
pixhawk committed
146 147 148
};

#endif // MAVLINKPROTOCOL_H_