DebugConsole.cc 31.7 KB
Newer Older
pixhawk's avatar
pixhawk committed
1 2
/*=====================================================================

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

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

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

lm's avatar
lm 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.

lm's avatar
lm 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
lm's avatar
lm committed
20
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
pixhawk's avatar
pixhawk committed
21 22 23 24 25

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

/**
 * @file
lm's avatar
lm committed
26
 *   @brief Implementation of DebugConsole
pixhawk's avatar
pixhawk committed
27 28 29 30 31
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */
#include <QPainter>
lm's avatar
lm committed
32
#include <QSettings>
Lorenz Meier's avatar
Lorenz Meier committed
33
#include <QScrollBar>
pixhawk's avatar
pixhawk committed
34 35 36 37

#include "DebugConsole.h"
#include "ui_DebugConsole.h"
#include "LinkManager.h"
38
#include "UASManager.h"
39
#include "protocol.h"
40
#include "QGC.h"
pixhawk's avatar
pixhawk committed
41 42 43 44

#include <QDebug>

DebugConsole::DebugConsole(QWidget *parent) :
45 46 47 48 49 50 51 52
    QWidget(parent),
    currLink(NULL),
    holdOn(false),
    convertToAscii(true),
    filterMAVLINK(false),
    autoHold(true),
    bytesToIgnore(0),
    lastByte(-1),
53 54
    escReceived(false),
    escIndex(0),
55 56 57
    sentBytes(),
    holdBuffer(),
    lineBuffer(""),
58
    lastLineBuffer(0),
59 60 61 62 63 64
    lineBufferTimer(),
    snapShotTimer(),
    snapShotInterval(500),
    snapShotBytes(0),
    dataRate(0.0f),
    lowpassDataRate(0.0f),
65
    dataRateThreshold(400),
66 67
    commandIndex(0),
    m_ui(new Ui::DebugConsole)
pixhawk's avatar
pixhawk committed
68 69 70
{
    // Setup basic user interface
    m_ui->setupUi(this);
pixhawk's avatar
pixhawk committed
71 72
    // Hide sent text field - it is only useful after send has been hit
    m_ui->sentText->setVisible(false);
73
    // Hide auto-send checkbox
74
    //m_ui->specialCheckBox->setVisible(false);
pixhawk's avatar
pixhawk committed
75
    // Make text area not editable
lm's avatar
lm committed
76
    m_ui->receiveText->setReadOnly(false);
pixhawk's avatar
pixhawk committed
77 78 79 80
    // Limit to 500 lines
    m_ui->receiveText->setMaximumBlockCount(500);
    // Allow to wrap everywhere
    m_ui->receiveText->setWordWrapMode(QTextOption::WrapAnywhere);
81 82
//    // Set monospace font
//    m_ui->receiveText->setFontFamily("Monospace");
pixhawk's avatar
pixhawk committed
83 84 85 86 87

    // Enable 10 Hz output
    //connect(&lineBufferTimer, SIGNAL(timeout()), this, SLOT(showData()));
    //lineBufferTimer.setInterval(100); // 100 Hz
    //lineBufferTimer.start();
88 89
    loadSettings();

pixhawk's avatar
pixhawk committed
90 91 92 93
    // Enable traffic measurements
    connect(&snapShotTimer, SIGNAL(timeout()), this, SLOT(updateTrafficMeasurements()));
    snapShotTimer.setInterval(snapShotInterval);
    snapShotTimer.start();
94 95
    // Update measurements the first time
    updateTrafficMeasurements();
pixhawk's avatar
pixhawk committed
96

97 98 99 100 101 102
    // First connect management slots, then make sure to add all existing objects
    // Connect to link manager to get notified about new links
    connect(LinkManager::instance(), SIGNAL(newLink(LinkInterface*)), this, SLOT(addLink(LinkInterface*)));
    // Connect to UAS manager to get notified about new UAS
    connect(UASManager::instance(), SIGNAL(UASCreated(UASInterface*)), this, SLOT(uasCreated(UASInterface*)));

pixhawk's avatar
pixhawk committed
103 104
    // Get a list of all existing links
    links = QList<LinkInterface*>();
105
    foreach (LinkInterface* link, LinkManager::instance()->getLinks()) {
pixhawk's avatar
pixhawk committed
106 107 108
        addLink(link);
    }

109 110 111 112 113
    // Get a list of all existing UAS
    foreach (UASInterface* uas, UASManager::instance()->getUASList()) {
        uasCreated(uas);
    }

pixhawk's avatar
pixhawk committed
114 115 116 117 118 119 120 121 122 123
    // Connect link combo box
    connect(m_ui->linkComboBox, SIGNAL(currentIndexChanged(int)), this, SLOT(linkSelected(int)));
    // Connect send button
    connect(m_ui->transmitButton, SIGNAL(clicked()), this, SLOT(sendBytes()));
    // Connect HEX conversion and MAVLINK filter checkboxes
    connect(m_ui->mavlinkCheckBox, SIGNAL(clicked(bool)), this, SLOT(MAVLINKfilterEnabled(bool)));
    connect(m_ui->hexCheckBox, SIGNAL(clicked(bool)), this, SLOT(hexModeEnabled(bool)));
    connect(m_ui->holdCheckBox, SIGNAL(clicked(bool)), this, SLOT(setAutoHold(bool)));
    // Connect hold button
    connect(m_ui->holdButton, SIGNAL(toggled(bool)), this, SLOT(hold(bool)));
124 125
    // Connect connect button
    connect(m_ui->connectButton, SIGNAL(clicked()), this, SLOT(handleConnectButton()));
126
    // Connect the special chars combo box
127
    connect(m_ui->addSymbolButton, SIGNAL(clicked()), this, SLOT(appendSpecialSymbol()));
128 129
    // Connect Checkbox
    connect(m_ui->specialComboBox, SIGNAL(highlighted(QString)), this, SLOT(specialSymbolSelected(QString)));
130 131
    // Allow to send via return
    connect(m_ui->sendText, SIGNAL(returnPressed()), this, SLOT(sendBytes()));
pixhawk's avatar
pixhawk committed
132 133
}

134 135 136 137 138 139
void DebugConsole::hideEvent(QHideEvent* event)
{
    Q_UNUSED(event);
    storeSettings();
}

pixhawk's avatar
pixhawk committed
140 141
DebugConsole::~DebugConsole()
{
lm's avatar
lm committed
142
    storeSettings();
pixhawk's avatar
pixhawk committed
143 144 145
    delete m_ui;
}

lm's avatar
lm committed
146 147 148 149 150 151 152 153 154
void DebugConsole::loadSettings()
{
    // Load defaults from settings
    QSettings settings;
    settings.sync();
    settings.beginGroup("QGC_DEBUG_CONSOLE");
    m_ui->specialComboBox->setCurrentIndex(settings.value("SPECIAL_SYMBOL", m_ui->specialComboBox->currentIndex()).toInt());
    m_ui->specialCheckBox->setChecked(settings.value("SPECIAL_SYMBOL_CHECKBOX_STATE", m_ui->specialCheckBox->isChecked()).toBool());
    hexModeEnabled(settings.value("HEX_MODE_ENABLED", m_ui->hexCheckBox->isChecked()).toBool());
155 156
    MAVLINKfilterEnabled(settings.value("MAVLINK_FILTER_ENABLED", filterMAVLINK).toBool());
    setAutoHold(settings.value("AUTO_HOLD_ENABLED", autoHold).toBool());
lm's avatar
lm committed
157 158
    settings.endGroup();

159 160 161 162 163 164
//    // Update visibility settings
//    if (m_ui->specialCheckBox->isChecked())
//    {
//        m_ui->specialCheckBox->setVisible(true);
//        m_ui->addSymbolButton->setVisible(false);
//    }
lm's avatar
lm committed
165 166 167 168 169 170 171 172 173 174
}

void DebugConsole::storeSettings()
{
    // Store settings
    QSettings settings;
    settings.beginGroup("QGC_DEBUG_CONSOLE");
    settings.setValue("SPECIAL_SYMBOL", m_ui->specialComboBox->currentIndex());
    settings.setValue("SPECIAL_SYMBOL_CHECKBOX_STATE", m_ui->specialCheckBox->isChecked());
    settings.setValue("HEX_MODE_ENABLED", m_ui->hexCheckBox->isChecked());
175 176
    settings.setValue("MAVLINK_FILTER_ENABLED", filterMAVLINK);
    settings.setValue("AUTO_HOLD_ENABLED", autoHold);
lm's avatar
lm committed
177 178 179 180 181
    settings.endGroup();
    settings.sync();
    //qDebug() << "Storing settings!";
}

182 183 184 185 186 187
void DebugConsole::uasCreated(UASInterface* uas)
{
    connect(uas, SIGNAL(textMessageReceived(int,int,int,QString)),
            this, SLOT(receiveTextMessage(int,int,int,QString)), Qt::UniqueConnection);
}

pixhawk's avatar
pixhawk committed
188 189 190
/**
 * Add a link to the debug console output
 */
pixhawk's avatar
pixhawk committed
191 192 193 194
void DebugConsole::addLink(LinkInterface* link)
{
    // Add link to link list
    links.insert(link->getId(), link);
pixhawk's avatar
pixhawk committed
195

pixhawk's avatar
pixhawk committed
196 197 198
    m_ui->linkComboBox->insertItem(link->getId(), link->getName());
    // Set new item as current
    m_ui->linkComboBox->setCurrentIndex(qMax(0, links.size() - 1));
199
    linkSelected(m_ui->linkComboBox->currentIndex());
pixhawk's avatar
pixhawk committed
200 201

    // Register for name changes
202 203
    connect(link, SIGNAL(nameChanged(QString)), this, SLOT(updateLinkName(QString)), Qt::UniqueConnection);
    connect(link, SIGNAL(deleteLink(LinkInterface* const)), this, SLOT(removeLink(LinkInterface* const)), Qt::UniqueConnection);
204 205
}

206
void DebugConsole::removeLink(LinkInterface* const linkInterface)
207
{
208
    //LinkInterface* linkInterface = dynamic_cast<LinkInterface*>(link);
209
    // Add link to link list
210
    if (links.contains(linkInterface)) {
211 212 213 214 215 216
        int linkIndex = links.indexOf(linkInterface);

        links.removeAt(linkIndex);

        m_ui->linkComboBox->removeItem(linkIndex);
    }
217
    if (linkInterface == currLink) currLink = NULL;
pixhawk's avatar
pixhawk committed
218
}
219 220
void DebugConsole::linkStatusUpdate(const QString& name,const QString& text)
{
221
    Q_UNUSED(name);
222 223 224 225
    m_ui->receiveText->appendPlainText(text);
    // Ensure text area scrolls correctly
    m_ui->receiveText->ensureCursorVisible();
}
pixhawk's avatar
pixhawk committed
226 227 228 229

void DebugConsole::linkSelected(int linkId)
{
    // Disconnect
230
    if (currLink) {
pixhawk's avatar
pixhawk committed
231
        disconnect(currLink, SIGNAL(bytesReceived(LinkInterface*,QByteArray)), this, SLOT(receiveBytes(LinkInterface*, QByteArray)));
232
        disconnect(currLink, SIGNAL(connected(bool)), this, SLOT(setConnectionState(bool)));
233
        disconnect(currLink,SIGNAL(communicationUpdate(QString,QString)),this,SLOT(linkStatusUpdate(QString,QString)));
pixhawk's avatar
pixhawk committed
234 235 236 237 238 239 240
    }
    // Clear data
    m_ui->receiveText->clear();

    // Connect new link
    currLink = links[linkId];
    connect(currLink, SIGNAL(bytesReceived(LinkInterface*,QByteArray)), this, SLOT(receiveBytes(LinkInterface*, QByteArray)));
241
    connect(currLink, SIGNAL(connected(bool)), this, SLOT(setConnectionState(bool)));
242
    connect(currLink,SIGNAL(communicationUpdate(QString,QString)),this,SLOT(linkStatusUpdate(QString,QString)));
243
    setConnectionState(currLink->isConnected());
pixhawk's avatar
pixhawk committed
244 245 246 247 248 249 250
}

/**
 * @param name new name for this link - the link is determined to the sender to this slot by QObject::sender()
 */
void DebugConsole::updateLinkName(QString name)
{
251
	// Set name if signal came from a link
pixhawk's avatar
pixhawk committed
252
    LinkInterface* link = qobject_cast<LinkInterface*>(sender());
253 254 255 256 257 258
	//if (link != NULL) m_ui->linkComboBox->setItemText(link->getId(), name);
	if((link != NULL) && (links.contains(link)))
	{
		const qint16 &linkIndex(links.indexOf(link));
		m_ui->linkComboBox->setItemText(linkIndex,name);
	}
pixhawk's avatar
pixhawk committed
259 260 261 262 263
}

void DebugConsole::setAutoHold(bool hold)
{
    // Disable current hold if hold had been enabled
264
    if (autoHold && holdOn && !hold) {
pixhawk's avatar
pixhawk committed
265 266 267
        this->hold(false);
        m_ui->holdButton->setChecked(false);
    }
268
    // Set auto hold checkbox
269
    if (m_ui->holdCheckBox->isChecked() != hold) {
270 271
        m_ui->holdCheckBox->setChecked(hold);
    }
272 273 274 275 276 277 278 279 280 281 282

    if (!hold)
    {
        // Warn user about not activated hold
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">%2</font>\n").arg(QColor(Qt::red).name(), tr("WARNING: You have NOT enabled auto-hold (stops updating the console if huge amounts of serial data arrive). Updating the console consumes significant CPU load, so if you receive more than about 5 KB/s of serial data, make sure to enable auto-hold if not using the console.")));
    }
    else
    {
        m_ui->receiveText->clear();
    }

pixhawk's avatar
pixhawk committed
283 284 285 286
    // Set new state
    autoHold = hold;
}

287 288 289 290
/**
 * Prints the message in the UAS color
 */
void DebugConsole::receiveTextMessage(int id, int component, int severity, QString text)
291
{
292
    Q_UNUSED(severity);
293 294 295 296 297 298 299 300 301 302 303 304 305
    if (isVisible())
    {
        QString name = UASManager::instance()->getUASForId(id)->getUASName();
        QString comp;
        // Get a human readable name if possible
        switch (component) {
            // TODO: To be completed
        case MAV_COMP_ID_IMU:
            comp = tr("IMU");
            break;
        case MAV_COMP_ID_MAPPER:
            comp = tr("MAPPER");
            break;
lm's avatar
lm committed
306 307
        case MAV_COMP_ID_MISSIONPLANNER:
            comp = tr("MISSION");
308 309 310 311 312 313 314 315
            break;
        case MAV_COMP_ID_SYSTEM_CONTROL:
            comp = tr("SYS-CONTROL");
            break;
        default:
            comp = QString::number(component);
            break;
        }
pixhawk's avatar
pixhawk committed
316

Lorenz Meier's avatar
Lorenz Meier committed
317 318 319 320
        //turn off updates while we're appending content to avoid breaking the autoscroll behavior
        m_ui->receiveText->setUpdatesEnabled(false);
        QScrollBar *scroller = m_ui->receiveText->verticalScrollBar();

321
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">(%2:%3) %4</font>\n").arg(UASManager::instance()->getUASForId(id)->getColor().name(), name, comp, text));
Lorenz Meier's avatar
Lorenz Meier committed
322

323
        // Ensure text area scrolls correctly
Lorenz Meier's avatar
Lorenz Meier committed
324 325
        scroller->setValue(scroller->maximum());
        m_ui->receiveText->setUpdatesEnabled(true);
326
    }
327 328
}

pixhawk's avatar
pixhawk committed
329 330 331 332 333 334 335
void DebugConsole::updateTrafficMeasurements()
{
    lowpassDataRate = lowpassDataRate * 0.9f + (0.1f * ((float)snapShotBytes / (float)snapShotInterval) * 1000.0f);
    dataRate = ((float)snapShotBytes / (float)snapShotInterval) * 1000.0f;
    snapShotBytes = 0;

    // Check if limit has been exceeded
336
    if ((lowpassDataRate > dataRateThreshold) && autoHold) {
pixhawk's avatar
pixhawk committed
337 338 339 340 341 342 343 344 345
        // Enable auto-old
        m_ui->holdButton->setChecked(true);
        hold(true);
    }

    QString speed;
    speed = speed.sprintf("%04.1f kB/s", dataRate/1000.0f);
    m_ui->speedLabel->setText(speed);

346
    if (holdOn) {
pixhawk's avatar
pixhawk committed
347 348 349 350 351 352 353 354 355 356
        //repaint();
    }
}

//QPainter painter(m_ui->receiveText);
//painter.setRenderHint(QPainter::HighQualityAntialiasing);
//painter.translate((this->vwidth/2.0+xCenterOffset)*scalingFactor, (this->vheight/2.0+yCenterOffset)*scalingFactor);

void DebugConsole::paintEvent(QPaintEvent *event)
{
357
    Q_UNUSED(event);
pixhawk's avatar
pixhawk committed
358
    // Update bandwidth
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
//    if (holdOn)
//    {
//        //qDebug() << "Data rate:" << dataRate/1000.0f << "kB/s";
//        QString rate("data rate: %1");
//        rate.arg(dataRate);
//        QPainter painter(this);
//        painter.setRenderHint(QPainter::HighQualityAntialiasing);
//        painter.translate(width()/5.0f, height()/5.0f);



//        //QFont font("Bitstream Vera Sans");
//        QFont font = painter.font();
//        font.setPixelSize((int)(60.0f));

//        QFontMetrics metrics = QFontMetrics(font);
//        int border = qMax(4, metrics.leading());
//        QRect rect = metrics.boundingRect(0, 0, width() - 2*border, int(height()*0.125),
//                                          Qt::AlignLeft | Qt::TextWordWrap, rate);
//        painter.setPen(QColor(255, 50, 50));
//        painter.setRenderHint(QPainter::TextAntialiasing);
//        painter.drawText(QRect(QPoint(static_cast<int>(width()/5.0f), static_cast<int>(height()/5.0f)), QPoint(static_cast<int>(width() - width()/5.0f), static_cast<int>(height() - height()/5.0f))), rate);
//        //Qt::AlignRight | Qt::TextWordWrap
//    }
pixhawk's avatar
pixhawk committed
383 384 385 386 387
}

void DebugConsole::receiveBytes(LinkInterface* link, QByteArray bytes)
{
    snapShotBytes += bytes.size();
lm's avatar
lm committed
388 389 390
    int len = bytes.size();
    int lastSpace = 0;
    if ((this->bytesToIgnore > 260) || (this->bytesToIgnore < -2)) this->bytesToIgnore = 0;
391
    // Only add data from current link
lm's avatar
lm committed
392 393
    if (link == currLink && !holdOn)
    {
pixhawk's avatar
pixhawk committed
394
        // Parse all bytes
lm's avatar
lm committed
395 396
        for (int j = 0; j < len; j++)
        {
pixhawk's avatar
pixhawk committed
397
            unsigned char byte = bytes.at(j);
lm's avatar
lm committed
398
            // Filter MAVLink (http://qgroundcontrol.org/mavlink/) messages out of the stream.
lm's avatar
lm committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
            if (filterMAVLINK)
            {
                if (this->bytesToIgnore > 0)
                {
                    if ( (j + this->bytesToIgnore) < len )
                        j += this->bytesToIgnore - 1, this->bytesToIgnore = 1;
                    else
                        this->bytesToIgnore -= (len - j - 1), j = len - 1;
                } else
                if (this->bytesToIgnore == -2)
                {   // Payload plus header - but we got STX already
                    this->bytesToIgnore = static_cast<unsigned int>(byte) + MAVLINK_NUM_NON_PAYLOAD_BYTES - 1;
                    if ( (j + this->bytesToIgnore) < len )
                        j += this->bytesToIgnore - 1, this->bytesToIgnore = 1;
                    else
                        this->bytesToIgnore -= (len - j - 1), j = len - 1;
                } else
pixhawk's avatar
pixhawk committed
416
                // Filtering is done by setting an ignore counter based on the MAVLINK packet length
lm's avatar
lm committed
417 418 419 420 421 422 423 424 425
                if (static_cast<unsigned char>(byte) == MAVLINK_STX)
                {
                    this->bytesToIgnore = -1;
                } else
                    this->bytesToIgnore = 0;
            } else this->bytesToIgnore = 0;

            if ( (this->bytesToIgnore <= 0) && (this->bytesToIgnore != -1) )
            {
pixhawk's avatar
pixhawk committed
426 427
                QString str;
                // Convert to ASCII for readability
lm's avatar
lm committed
428 429
                if (convertToAscii)
                {
430 431
                    if (escReceived)
                    {
432
                        if (escIndex < static_cast<int>(sizeof(escBytes)))
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
                        {
                            escBytes[escIndex] = byte;
                            //qDebug() << "GOT BYTE ESC:" << byte;
                            if (/*escIndex == 1 && */escBytes[escIndex] == 0x48)
                            {
                                // Handle sequence
                                // for this one, clear all text
                                m_ui->receiveText->clear();
                                escReceived = false;
                            }
                            else if (/*escIndex == 1 && */escBytes[escIndex] == 0x4b)
                            {
                                // Handle sequence
                                // for this one, do nothing
                                escReceived = false;
                            }
                            else if (byte == 0x5b)
                            {
                                // Do nothing, this is still a valid escape sequence
                            }
                            else
                            {
                                escReceived = false;
                            }
                         }
                        else
                        {
                            // Obviously something went wrong, reset
                            escReceived = false;
                            escIndex = 0;
                        }
                    }
                    else if ((byte <= 32) || (byte > 126))
lm's avatar
lm committed
466 467 468 469
                    {
                        switch (byte)
                        {
                            case (unsigned char)'\n':   // Accept line feed
470
                                if (lastByte != '\r')   // Do not break line again for LF+CR
lm's avatar
lm committed
471
                                    str.append(byte);   // only break line for single LF or CR bytes
472
                            break;
lm's avatar
lm committed
473 474 475
                            case (unsigned char)' ':    // space of any type means don't add another on hex output
                            case (unsigned char)'\t':   // Accept tab
                            case (unsigned char)'\r':   // Catch and carriage return
476 477
                                if (lastByte != '\n')   // Do not break line again for CR+LF
                                str.append(byte);       // only break line for single LF or CR bytes
lm's avatar
lm committed
478
                                lastSpace = 1;
pixhawk's avatar
pixhawk committed
479
                            break;
480 481 482 483 484 485 486 487 488
                            /* VT100 emulation (partially */
                            case 0x1b:                  // ESC received
                                escReceived = true;
                                escIndex = 0;
                                //qDebug() << "GOT ESC";
                                break;
                            case 0x08:                  // BS (backspace) received
                                // Do nothing for now
                                break;
lm's avatar
lm committed
489 490 491 492 493 494 495 496
                            default:                    // Append replacement character (box) if char is not ASCII
//                                str.append(QChar(QChar::ReplacementCharacter));
                                QString str2;
                                if ( lastSpace == 1)
                                    str2.sprintf("0x%02x ", byte);
                                else str2.sprintf(" 0x%02x ", byte);
                                str.append(str2);
                                lastSpace = 1;
497
                                escReceived = false;
pixhawk's avatar
pixhawk committed
498
                            break;
lm's avatar
lm committed
499
                        }
pixhawk's avatar
pixhawk committed
500
                    }
lm's avatar
lm committed
501 502
                    else
                    {
503 504 505
                        // Ignore carriage return, because that
                        // is auto-added with '\n'
                        if (byte != '\r') str.append(byte);           // Append original character
lm's avatar
lm committed
506 507 508 509 510
                        lastSpace = 0;
                    }
                }
                else
                {
pixhawk's avatar
pixhawk committed
511 512 513 514 515
                    QString str2;
                    str2.sprintf("%02x ", byte);
                    str.append(str2);
                }
                lineBuffer.append(str);
516
                lastByte = byte;
lm's avatar
lm committed
517 518 519 520
            }
            else
            {
                if (filterMAVLINK) this->bytesToIgnore--;
pixhawk's avatar
pixhawk committed
521
                // Constrain bytes to positive range
lm's avatar
lm committed
522
//                bytesToIgnore = qMax(0, bytesToIgnore);
pixhawk's avatar
pixhawk committed
523 524 525
            }

        }
526
        // Plot every 200 ms if windows is visible
527
        if (lineBuffer.length() > 0 && (QGC::groundTimeMilliseconds() - lastLineBuffer) > 200) {
528 529
            if (isVisible())
            {
530 531 532
                m_ui->receiveText->appendPlainText(lineBuffer);
                lineBuffer.clear();
                lastLineBuffer = QGC::groundTimeMilliseconds();
533 534 535
                // Ensure text area scrolls correctly
                m_ui->receiveText->ensureCursorVisible();
            }
536 537 538 539
            if (lineBuffer.size() > 8192)
            {
                lineBuffer.remove(0, 4096);
            }
540
        }
lm's avatar
lm committed
541 542 543
    }
    else if (link == currLink && holdOn)
    {
pixhawk's avatar
pixhawk committed
544
        holdBuffer.append(bytes);
lm's avatar
lm committed
545 546
        if (holdBuffer.size() > 8192)
            holdBuffer.remove(0, 4096); // drop old stuff
pixhawk's avatar
pixhawk committed
547 548 549
    }
}

550 551 552
QByteArray DebugConsole::symbolNameToBytes(const QString& text)
{
    QByteArray b;
553
    if (text.contains("CR+LF")) {
554
        b.append(static_cast<char>(0x0D));
555
        b.append(static_cast<char>(0x0A));
556
    } else if (text.contains("LF")) {
557
        b.append(static_cast<char>(0x0A));
558
    } else if (text.contains("FF")) {
559
        b.append(static_cast<char>(0x0C));
560
    } else if (text.contains("CR")) {
561
        b.append(static_cast<char>(0x0D));
562
    } else if (text.contains("TAB")) {
563
        b.append(static_cast<char>(0x09));
564
    } else if (text.contains("NUL")) {
565
        b.append(static_cast<char>(0x00));
566
    } else if (text.contains("ESC")) {
567
        b.append(static_cast<char>(0x1B));
568
    } else if (text.contains("~")) {
569
        b.append(static_cast<char>(0x7E));
570
    } else if (text.contains("<Space>")) {
571 572 573 574 575
        b.append(static_cast<char>(0x20));
    }
    return b;
}

576 577 578
QString DebugConsole::bytesToSymbolNames(const QByteArray& b)
{
    QString text;
579
    if (b.size() > 1 && b.contains(0x0D) && b.contains(0x0A)) {
580
        text = "<CR+LF>";
581
    } else if (b.contains(0x0A)) {
582
        text = "<LF>";
583
    } else if (b.contains(0x0C)) {
584
        text = "<FF>";
585
    } else if (b.contains(0x0D)) {
586
        text = "<CR>";
587
    } else if (b.contains(0x09)) {
588
        text = "<TAB>";
589
    } else if (b.contains((char)0x00)) {
590
        text = "<NUL>";
591
    } else if (b.contains(0x1B)) {
592
        text = "<ESC>";
593
    } else if (b.contains(0x7E)) {
594
        text = "<~>";
595
    } else if (b.contains(0x20)) {
596
        text = "<Space>";
597
    } else {
598 599 600 601 602
        text.append(b);
    }
    return text;
}

603 604 605
void DebugConsole::specialSymbolSelected(const QString& text)
{
    Q_UNUSED(text);
606
    //m_ui->specialCheckBox->setVisible(true);
607 608
}

609 610 611 612 613
void DebugConsole::appendSpecialSymbol(const QString& text)
{
    QString line = m_ui->sendText->text();
    QByteArray symbols = symbolNameToBytes(text);
    // The text is appended to the enter field
614
    if (convertToAscii) {
615
        line.append(symbols);
616
    } else {
617

618
        for (int i = 0; i < symbols.size(); i++) {
619 620 621 622 623 624 625
            QString add(" 0x%1");
            line.append(add.arg(static_cast<char>(symbols.at(i)), 2, 16, QChar('0')));
        }
    }
    m_ui->sendText->setText(line);
}

626 627 628 629 630
void DebugConsole::appendSpecialSymbol()
{
    appendSpecialSymbol(m_ui->specialComboBox->currentText());
}

pixhawk's avatar
pixhawk committed
631 632
void DebugConsole::sendBytes()
{
lm's avatar
lm committed
633 634 635 636 637 638
    // FIXME This store settings should be removed
    // once all threading issues have been resolved
    // since its called in the destructor, which
    // is absolutely sufficient
    storeSettings();

lm's avatar
lm committed
639 640 641 642 643 644
    // Store command history
    commandHistory.append(m_ui->sendText->text());
    // Since text was just sent, we're at position commandHistory.length()
    // which is the current text
    commandIndex = commandHistory.length();

645
    if (!m_ui->sentText->isVisible()) {
pixhawk's avatar
pixhawk committed
646 647 648
        m_ui->sentText->setVisible(true);
    }

649
    if (!currLink->isConnected()) {
650 651 652 653
        m_ui->sentText->setText(tr("Nothing sent. The link %1 is unconnected. Please connect first.").arg(currLink->getName()));
        return;
    }

654 655 656
    QString transmitUnconverted = m_ui->sendText->text();
    QByteArray specialSymbol;

657
    // Append special symbol if checkbox is checked
658
    if (m_ui->specialCheckBox->isChecked()) {
659 660 661 662
        // Get auto-add special symbols
        specialSymbol = symbolNameToBytes(m_ui->specialComboBox->currentText());

        // Convert them if needed
663
        if (!convertToAscii) {
664
            QString specialSymbolConverted;
665
            for (int i = 0; i < specialSymbol.length(); i++) {
666 667 668 669 670 671
                QString add(" 0x%1");
                specialSymbolConverted.append(add.arg(static_cast<char>(specialSymbol.at(i)), 2, 16, QChar('0')));
            }
            specialSymbol.clear();
            specialSymbol.append(specialSymbolConverted);
        }
672 673
    }

pixhawk's avatar
pixhawk committed
674 675 676
    QByteArray transmit;
    QString feedback;
    bool ok = true;
677
    if (convertToAscii) {
pixhawk's avatar
pixhawk committed
678
        // ASCII text is not converted
679 680 681 682 683 684 685
        transmit = transmitUnconverted.toLatin1();
        // Auto-add special symbol handling
        transmit.append(specialSymbol);

        QString translated;

        // Replace every occurence of a special symbol with its text name
686
        for (int i = 0; i < transmit.size(); ++i) {
687 688 689 690 691 692
            QByteArray specialChar;
            specialChar.append(transmit.at(i));
            translated.append(bytesToSymbolNames(specialChar));
        }

        feedback.append(translated);
693
    } else {
pixhawk's avatar
pixhawk committed
694
        // HEX symbols are converted to bytes
695 696
        QString str = transmitUnconverted.toLatin1();
        str.append(specialSymbol);
pixhawk's avatar
pixhawk committed
697 698
        str.remove(' ');
        str.remove("0x");
699
        str = str.simplified();
pixhawk's avatar
pixhawk committed
700
        int bufferIndex = 0;
701 702
        if ((str.size() % 2) == 0) {
            for (int i = 0; i < str.size(); i=i+2) {
pixhawk's avatar
pixhawk committed
703 704 705 706 707 708 709
                bool okByte;
                QString strBuf = QString(str.at(i));
                strBuf.append(str.at(i+1));
                unsigned char hex = strBuf.toInt(&okByte, 16);
                ok = (ok && okByte);
                transmit[bufferIndex++] = hex;

710
                if (okByte) {
pixhawk's avatar
pixhawk committed
711 712 713 714 715
                    // Feedback
                    //feedback.append("0x");
                    feedback.append(str.at(i).toUpper());
                    feedback.append(str.at(i+1).toUpper());
                    feedback.append(" ");
716
                } else {
pixhawk's avatar
pixhawk committed
717 718 719
                    feedback = tr("HEX format error near \"") + strBuf + "\"";
                }
            }
720
        } else {
pixhawk's avatar
pixhawk committed
721 722 723 724 725 726
            ok = false;
            feedback = tr("HEX values have to be in pairs, e.g. AA or AA 05");
        }
    }

    // Transmit ASCII or HEX formatted text, only if more than one symbol
727
    if (ok && m_ui->sendText->text().toLatin1().size() > 0) {
pixhawk's avatar
pixhawk committed
728
        // Transmit only if conversion succeeded
729 730 731 732 733 734 735 736 737 738
        //        int transmitted =
        currLink->writeBytes(transmit, transmit.size());
        //        if (transmit.size() == transmitted)
        //        {
        m_ui->sentText->setText(tr("Sent: ") + feedback);
        //        }
        //        else
        //        {
        //            m_ui->sentText->setText(tr("Error during sending: Transmitted only %1 bytes instead of %2.").arg(transmitted, transmit.size()));
        //        }
739
    } else if (m_ui->sendText->text().toLatin1().size() > 0) {
pixhawk's avatar
pixhawk committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753
        // Conversion failed, display error message
        m_ui->sentText->setText(tr("Not sent: ") + feedback);
    }

    // Select text to easy follow-up input from user
    m_ui->sendText->selectAll();
    m_ui->sendText->setFocus(Qt::OtherFocusReason);
}

/**
 * @param mode true to convert all in and output to/from HEX, false to send and receive ASCII values
 */
void DebugConsole::hexModeEnabled(bool mode)
{
754
    if (convertToAscii == mode) {
lm's avatar
lm committed
755
        convertToAscii = !mode;
756
        if (m_ui->hexCheckBox->isChecked() != mode) {
lm's avatar
lm committed
757 758 759 760 761 762 763
            m_ui->hexCheckBox->setChecked(mode);
        }
        m_ui->receiveText->clear();
        m_ui->sendText->clear();
        m_ui->sentText->clear();
        commandHistory.clear();
    }
pixhawk's avatar
pixhawk committed
764 765 766 767 768 769 770
}

/**
 * @param filter true to ignore all MAVLINK raw data in output, false, to display all incoming data
 */
void DebugConsole::MAVLINKfilterEnabled(bool filter)
{
771
    if (filterMAVLINK != filter) {
lm's avatar
lm committed
772
        filterMAVLINK = filter;
lm's avatar
lm committed
773
        this->bytesToIgnore = 0;
774
        if (m_ui->mavlinkCheckBox->isChecked() != filter) {
lm's avatar
lm committed
775 776 777
            m_ui->mavlinkCheckBox->setChecked(filter);
        }
    }
pixhawk's avatar
pixhawk committed
778 779 780 781 782 783
}
/**
 * @param hold Freeze the input and thus any scrolling
 */
void DebugConsole::hold(bool hold)
{
784 785 786 787 788 789 790 791
    if (holdOn != hold) {
        // Check if we need to append bytes from the hold buffer
        if (this->holdOn && !hold) {
            // TODO No conversion is done to the bytes in the hold buffer
            m_ui->receiveText->appendPlainText(QString(holdBuffer));
            holdBuffer.clear();
            lowpassDataRate = 0.0f;
        }
pixhawk's avatar
pixhawk committed
792

793
        this->holdOn = hold;
794

795 796 797 798 799 800 801 802 803
        // Change text interaction mode
        if (hold) {
            m_ui->receiveText->setTextInteractionFlags(Qt::TextSelectableByKeyboard | Qt::TextSelectableByMouse | Qt::LinksAccessibleByKeyboard | Qt::LinksAccessibleByMouse);
        } else {
            m_ui->receiveText->setTextInteractionFlags(Qt::NoTextInteraction);
        }
        if (m_ui->holdCheckBox->isChecked() != hold) {
            m_ui->holdCheckBox->setChecked(hold);
        }
lm's avatar
lm committed
804 805
    }
}
pixhawk's avatar
pixhawk committed
806

807 808 809 810 811
/**
 * Sets the connection state the widget shows to this state
 */
void DebugConsole::setConnectionState(bool connected)
{
812
    if(connected) {
813
        m_ui->connectButton->setText(tr("Disconn."));
814
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">%2</font>\n").arg(QGC::colorGreen.name(), tr("Link %1 is connected.").arg(currLink->getName())));
815
    } else {
816
        m_ui->connectButton->setText(tr("Connect"));
817
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">%2</font>\n").arg(QGC::colorOrange.name(), tr("Link %1 is unconnected.").arg(currLink->getName())));
818 819 820 821 822 823
    }
}

/** @brief Handle the connect button */
void DebugConsole::handleConnectButton()
{
824 825
    if (currLink) {
        if (currLink->isConnected()) {
826
            currLink->disconnect();
827
        } else {
828
            currLink->connect();
829 830 831 832
        }
    }
}

833 834
void DebugConsole::keyPressEvent(QKeyEvent * event)
{
835
    if (event->key() == Qt::Key_Up) {
836
        cycleCommandHistory(true);
837
    } else if (event->key() == Qt::Key_Down) {
838
        cycleCommandHistory(false);
839
    } else {
840 841 842 843 844 845
        QWidget::keyPressEvent(event);
    }
}

void DebugConsole::cycleCommandHistory(bool up)
{
lm's avatar
lm committed
846
    // Only cycle if there is a history
847
    if (commandHistory.length() > 0) {
lm's avatar
lm committed
848
        // Store current command if we're not in history yet
849
        if (commandIndex == commandHistory.length() && up) {
lm's avatar
lm committed
850 851
            currCommand = m_ui->sendText->text();
        }
852

853
        if (up) {
lm's avatar
lm committed
854 855
            // UP
            commandIndex--;
856
            if (commandIndex >= 0) {
lm's avatar
lm committed
857 858 859 860
                m_ui->sendText->setText(commandHistory.at(commandIndex));
            }

            // If the index
861
        } else {
lm's avatar
lm committed
862 863
            // DOWN
            commandIndex++;
864
            if (commandIndex < commandHistory.length()) {
lm's avatar
lm committed
865 866 867
                m_ui->sendText->setText(commandHistory.at(commandIndex));
            }
            // If the index is at history length, load the last current command
868

lm's avatar
lm committed
869 870 871
        }

        // Restore current command if we went out of history
872
        if (commandIndex == commandHistory.length()) {
lm's avatar
lm committed
873
            m_ui->sendText->setText(currCommand);
874 875
        }

lm's avatar
lm committed
876
        // If we are too far down or too far up, wrap around to current command
877
        if (commandIndex < 0 || commandIndex > commandHistory.length()) {
lm's avatar
lm committed
878 879 880
            commandIndex = commandHistory.length();
            m_ui->sendText->setText(currCommand);
        }
881

lm's avatar
lm committed
882 883 884
        // Bound the index
        if (commandIndex < 0) commandIndex = 0;
        if (commandIndex > commandHistory.length()) commandIndex = commandHistory.length();
885 886 887
    }
}

pixhawk's avatar
pixhawk committed
888 889 890 891 892 893 894 895 896 897 898
void DebugConsole::changeEvent(QEvent *e)
{
    QWidget::changeEvent(e);
    switch (e->type()) {
    case QEvent::LanguageChange:
        m_ui->retranslateUi(this);
        break;
    default:
        break;
    }
}