DebugConsole.h 5.94 KB
Newer Older
pixhawk's avatar
pixhawk committed
1 2
/*=====================================================================

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

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

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

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.

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
20
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
pixhawk's avatar
pixhawk committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34

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

/**
 * @file
 *   @brief Debug console
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

#ifndef DEBUGCONSOLE_H
#define DEBUGCONSOLE_H

35
#include <QWidget>
pixhawk's avatar
pixhawk committed
36 37 38
#include <QList>
#include <QByteArray>
#include <QTimer>
39
#include <QKeyEvent>
pixhawk's avatar
pixhawk committed
40 41 42

#include "LinkInterface.h"

43 44 45
namespace Ui
{
class DebugConsole;
pixhawk's avatar
pixhawk committed
46 47
}

48 49
class UASInterface;

50 51 52 53 54 55 56 57
/**
 * @brief Shows a debug console
 *
 * This class shows the raw data stream of each link
 * and the debug / text messages sent by all systems
 */
class DebugConsole : public QWidget
{
pixhawk's avatar
pixhawk committed
58 59 60 61 62 63 64 65
    Q_OBJECT
public:
    DebugConsole(QWidget *parent = 0);
    ~DebugConsole();

public slots:
    /** @brief Add a link to the list of monitored links */
    void addLink(LinkInterface* link);
66 67
    /** @brief Add a UAS to the list of monitored UAS */
    void uasCreated(UASInterface* uas);
68
    /** @brief Remove a link from the list */
Don Gagne's avatar
Don Gagne committed
69
    void removeLink(LinkInterface* link);
pixhawk's avatar
pixhawk committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83
    /** @brief Update a link name */
    void updateLinkName(QString name);
    /** @brief Select a link for the active view */
    void linkSelected(int linkId);
    /** @brief Receive bytes from link */
    void receiveBytes(LinkInterface* link, QByteArray bytes);
    /** @brief Send lineedit content over link */
    void sendBytes();
    /** @brief Enable HEX display mode */
    void hexModeEnabled(bool mode);
    /** @brief Filter out MAVLINK raw data */
    void MAVLINKfilterEnabled(bool filter);
    /** @brief Freeze input, do not store new incoming data */
    void hold(bool hold);
84 85
    /** @brief Handle the connect button */
    void handleConnectButton();
pixhawk's avatar
pixhawk committed
86 87
    /** @brief Enable auto-freeze mode if traffic intensity is too high to display */
    void setAutoHold(bool hold);
88
    /** @brief Receive plain text message to output to the user */
89
    void receiveTextMessage(int id, int component, int severity, QString text);
90 91
    /** @brief Append a special symbol */
    void appendSpecialSymbol(const QString& text);
92 93
    /** @brief Append the special symbol currently selected in combo box */
    void appendSpecialSymbol();
94 95
    /** @brief A new special symbol is selected */
    void specialSymbolSelected(const QString& text);
pixhawk's avatar
pixhawk committed
96

97 98
    void linkStatusUpdate(const QString& name,const QString& text);

99
protected slots:
pixhawk's avatar
pixhawk committed
100 101 102 103
    /** @brief Draw information overlay */
    void paintEvent(QPaintEvent *event);
    /** @brief Update traffic measurements */
    void updateTrafficMeasurements();
lm's avatar
lm committed
104 105
    void loadSettings();
    void storeSettings();
pixhawk's avatar
pixhawk committed
106 107 108

protected:
    void changeEvent(QEvent *e);
109
    void hideEvent(QHideEvent* event);
110
    /** @brief Convert a symbol name to the byte representation */
111
    QByteArray symbolNameToBytes(const QString& symbol);
112 113
    /** @brief Convert a symbol byte to the name */
    QString bytesToSymbolNames(const QByteArray& b);
114 115 116 117
    /** @brief Handle keypress events */
    void keyPressEvent(QKeyEvent * event);
    /** @brief Cycle through the command history */
    void cycleCommandHistory(bool up);
pixhawk's avatar
pixhawk committed
118 119 120 121 122 123

    LinkInterface* currLink;

    bool holdOn;              ///< Hold current view, ignore new data
    bool convertToAscii;      ///< Convert data to ASCII
    bool filterMAVLINK;       ///< Set true to filter out MAVLink in output
lm's avatar
lm committed
124
    bool autoHold;            ///< Auto-hold mode sets view into hold if the data rate is too high
pixhawk's avatar
pixhawk committed
125 126
    int bytesToIgnore;        ///< Number of bytes to ignore
    char lastByte;            ///< The last received byte
127 128 129 130
    bool escReceived;         ///< True if received ESC char in ASCII mode
    int escIndex;             ///< Index of bytes since ESC was received
    char escBytes[5];         ///< Escape-following bytes
    bool terminalReceived;    ///< Terminal sequence received
pixhawk's avatar
pixhawk committed
131 132 133
    QList<QString> sentBytes; ///< Transmitted bytes, per transmission
    QByteArray holdBuffer;    ///< Buffer where bytes are stored during hold-enable
    QString lineBuffer;       ///< Buffere where bytes are stored before writing them out
134
    quint64 lastLineBuffer;   ///< Last line buffer emission time
pixhawk's avatar
pixhawk committed
135 136
    QTimer lineBufferTimer;   ///< Line buffer timer
    QTimer snapShotTimer;     ///< Timer for measuring traffic snapshots
137
    static const int snapShotInterval = 500;     ///< Set the time between UI updates for the data rate (ms)
138
    float lowpassInDataRate;    ///< Lowpass filtered data rate (kilobytes/s)
Don Gagne's avatar
Don Gagne committed
139
    static const float inDataRateThreshold;  ///< Threshold where to enable auto-hold (kilobytes/s)
140
    float lowpassOutDataRate;   ///< Low-pass filtered outgoing data rate (kilobytes/s)
lm's avatar
lm committed
141 142 143
    QStringList commandHistory;
    QString currCommand;
    int commandIndex;
144 145 146 147
    
private slots:
    void _linkConnected(void);
    void _linkDisconnected(void);
pixhawk's avatar
pixhawk committed
148 149

private:
150 151
    /** @brief Set connection state of the current link */
    void _setConnectionState(bool);
152 153 154 155 156
    
    /// List of all links we are keeping track of. We keep SharedLinkInterface objects
    /// which are QSharedPointer's in order to maintain reference counts. Otherwise signals
    /// can get out of order and the link may be deleted before we clean up our side.
    QList<SharedLinkInterface> _links;
157

pixhawk's avatar
pixhawk committed
158 159 160 161
    Ui::DebugConsole *m_ui;
};

#endif // DEBUGCONSOLE_H