DebugConsole.cc 31.3 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>
pixhawk's avatar
pixhawk committed
33 34 35 36

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

#include <QDebug>

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

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

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

96 97 98 99 100 101
    // 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
102 103
    // Get a list of all existing links
    links = QList<LinkInterface*>();
104
    foreach (LinkInterface* link, LinkManager::instance()->getLinks()) {
pixhawk's avatar
pixhawk committed
105 106 107
        addLink(link);
    }

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

pixhawk's avatar
pixhawk committed
113 114 115 116 117 118 119 120 121 122
    // 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)));
123 124
    // Connect connect button
    connect(m_ui->connectButton, SIGNAL(clicked()), this, SLOT(handleConnectButton()));
125
    // Connect the special chars combo box
126
    connect(m_ui->addSymbolButton, SIGNAL(clicked()), this, SLOT(appendSpecialSymbol()));
127 128
    // Connect Checkbox
    connect(m_ui->specialComboBox, SIGNAL(highlighted(QString)), this, SLOT(specialSymbolSelected(QString)));
129 130
    // Allow to send via return
    connect(m_ui->sendText, SIGNAL(returnPressed()), this, SLOT(sendBytes()));
pixhawk's avatar
pixhawk committed
131 132
}

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

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

lm's avatar
lm committed
145 146 147 148 149 150 151 152 153
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());
154 155
    MAVLINKfilterEnabled(settings.value("MAVLINK_FILTER_ENABLED", filterMAVLINK).toBool());
    setAutoHold(settings.value("AUTO_HOLD_ENABLED", autoHold).toBool());
lm's avatar
lm committed
156 157
    settings.endGroup();

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

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());
174 175
    settings.setValue("MAVLINK_FILTER_ENABLED", filterMAVLINK);
    settings.setValue("AUTO_HOLD_ENABLED", autoHold);
lm's avatar
lm committed
176 177 178 179 180
    settings.endGroup();
    settings.sync();
    //qDebug() << "Storing settings!";
}

181 182 183 184 185 186
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
187 188 189
/**
 * Add a link to the debug console output
 */
pixhawk's avatar
pixhawk committed
190 191 192 193
void DebugConsole::addLink(LinkInterface* link)
{
    // Add link to link list
    links.insert(link->getId(), link);
pixhawk's avatar
pixhawk committed
194

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

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

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

        links.removeAt(linkIndex);

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

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

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

/**
 * @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)
{
249
	// Set name if signal came from a link
pixhawk's avatar
pixhawk committed
250
    LinkInterface* link = qobject_cast<LinkInterface*>(sender());
251 252 253 254 255 256
	//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
257 258 259 260 261
}

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

    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
281 282 283 284
    // Set new state
    autoHold = hold;
}

285 286 287 288
/**
 * Prints the message in the UAS color
 */
void DebugConsole::receiveTextMessage(int id, int component, int severity, QString text)
289
{
290
    Q_UNUSED(severity);
291 292 293 294 295 296 297 298 299 300 301 302 303
    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
304 305
        case MAV_COMP_ID_MISSIONPLANNER:
            comp = tr("MISSION");
306 307 308 309 310 311 312 313
            break;
        case MAV_COMP_ID_SYSTEM_CONTROL:
            comp = tr("SYS-CONTROL");
            break;
        default:
            comp = QString::number(component);
            break;
        }
pixhawk's avatar
pixhawk committed
314

315
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">(%2:%3) %4</font>\n").arg(UASManager::instance()->getUASForId(id)->getColor().name(), name, comp, text));
316 317
        // Ensure text area scrolls correctly
        m_ui->receiveText->ensureCursorVisible();
318
    }
319 320
}

pixhawk's avatar
pixhawk committed
321 322 323 324 325 326 327
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
328
    if ((lowpassDataRate > dataRateThreshold) && autoHold) {
pixhawk's avatar
pixhawk committed
329 330 331 332 333 334 335 336 337
        // 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);

338
    if (holdOn) {
pixhawk's avatar
pixhawk committed
339 340 341 342 343 344 345 346 347 348
        //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)
{
349
    Q_UNUSED(event);
pixhawk's avatar
pixhawk committed
350
    // Update bandwidth
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
//    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
375 376 377 378 379
}

void DebugConsole::receiveBytes(LinkInterface* link, QByteArray bytes)
{
    snapShotBytes += bytes.size();
lm's avatar
lm committed
380 381 382
    int len = bytes.size();
    int lastSpace = 0;
    if ((this->bytesToIgnore > 260) || (this->bytesToIgnore < -2)) this->bytesToIgnore = 0;
383
    // Only add data from current link
lm's avatar
lm committed
384 385
    if (link == currLink && !holdOn)
    {
pixhawk's avatar
pixhawk committed
386
        // Parse all bytes
lm's avatar
lm committed
387 388
        for (int j = 0; j < len; j++)
        {
pixhawk's avatar
pixhawk committed
389
            unsigned char byte = bytes.at(j);
lm's avatar
lm committed
390
            // Filter MAVLink (http://qgroundcontrol.org/mavlink/) messages out of the stream.
lm's avatar
lm committed
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
            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
408
                // Filtering is done by setting an ignore counter based on the MAVLINK packet length
lm's avatar
lm committed
409 410 411 412 413 414 415 416 417
                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
418 419
                QString str;
                // Convert to ASCII for readability
lm's avatar
lm committed
420 421
                if (convertToAscii)
                {
422 423
                    if (escReceived)
                    {
424
                        if (escIndex < static_cast<int>(sizeof(escBytes)))
425 426 427 428 429 430 431 432 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
                        {
                            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
458 459 460 461
                    {
                        switch (byte)
                        {
                            case (unsigned char)'\n':   // Accept line feed
462
                                if (lastByte != '\r')   // Do not break line again for LF+CR
lm's avatar
lm committed
463
                                    str.append(byte);   // only break line for single LF or CR bytes
464
                            break;
lm's avatar
lm committed
465 466 467
                            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
468 469
                                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
470
                                lastSpace = 1;
pixhawk's avatar
pixhawk committed
471
                            break;
472 473 474 475 476 477 478 479 480
                            /* 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
481 482 483 484 485 486 487 488
                            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;
489
                                escReceived = false;
pixhawk's avatar
pixhawk committed
490
                            break;
lm's avatar
lm committed
491
                        }
pixhawk's avatar
pixhawk committed
492
                    }
lm's avatar
lm committed
493 494
                    else
                    {
495 496 497
                        // Ignore carriage return, because that
                        // is auto-added with '\n'
                        if (byte != '\r') str.append(byte);           // Append original character
lm's avatar
lm committed
498 499 500 501 502
                        lastSpace = 0;
                    }
                }
                else
                {
pixhawk's avatar
pixhawk committed
503 504 505 506 507
                    QString str2;
                    str2.sprintf("%02x ", byte);
                    str.append(str2);
                }
                lineBuffer.append(str);
508
                lastByte = byte;
lm's avatar
lm committed
509 510 511 512
            }
            else
            {
                if (filterMAVLINK) this->bytesToIgnore--;
pixhawk's avatar
pixhawk committed
513
                // Constrain bytes to positive range
lm's avatar
lm committed
514
//                bytesToIgnore = qMax(0, bytesToIgnore);
pixhawk's avatar
pixhawk committed
515 516 517
            }

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

542 543 544
QByteArray DebugConsole::symbolNameToBytes(const QString& text)
{
    QByteArray b;
545
    if (text.contains("CR+LF")) {
546
        b.append(static_cast<char>(0x0D));
547
        b.append(static_cast<char>(0x0A));
548
    } else if (text.contains("LF")) {
549
        b.append(static_cast<char>(0x0A));
550
    } else if (text.contains("FF")) {
551
        b.append(static_cast<char>(0x0C));
552
    } else if (text.contains("CR")) {
553
        b.append(static_cast<char>(0x0D));
554
    } else if (text.contains("TAB")) {
555
        b.append(static_cast<char>(0x09));
556
    } else if (text.contains("NUL")) {
557
        b.append(static_cast<char>(0x00));
558
    } else if (text.contains("ESC")) {
559
        b.append(static_cast<char>(0x1B));
560
    } else if (text.contains("~")) {
561
        b.append(static_cast<char>(0x7E));
562
    } else if (text.contains("<Space>")) {
563 564 565 566 567
        b.append(static_cast<char>(0x20));
    }
    return b;
}

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

595 596 597
void DebugConsole::specialSymbolSelected(const QString& text)
{
    Q_UNUSED(text);
598
    //m_ui->specialCheckBox->setVisible(true);
599 600
}

601 602 603 604 605
void DebugConsole::appendSpecialSymbol(const QString& text)
{
    QString line = m_ui->sendText->text();
    QByteArray symbols = symbolNameToBytes(text);
    // The text is appended to the enter field
606
    if (convertToAscii) {
607
        line.append(symbols);
608
    } else {
609

610
        for (int i = 0; i < symbols.size(); i++) {
611 612 613 614 615 616 617
            QString add(" 0x%1");
            line.append(add.arg(static_cast<char>(symbols.at(i)), 2, 16, QChar('0')));
        }
    }
    m_ui->sendText->setText(line);
}

618 619 620 621 622
void DebugConsole::appendSpecialSymbol()
{
    appendSpecialSymbol(m_ui->specialComboBox->currentText());
}

pixhawk's avatar
pixhawk committed
623 624
void DebugConsole::sendBytes()
{
lm's avatar
lm committed
625 626 627 628 629 630
    // 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
631 632 633 634 635 636
    // 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();

637
    if (!m_ui->sentText->isVisible()) {
pixhawk's avatar
pixhawk committed
638 639 640
        m_ui->sentText->setVisible(true);
    }

641
    if (!currLink->isConnected()) {
642 643 644 645
        m_ui->sentText->setText(tr("Nothing sent. The link %1 is unconnected. Please connect first.").arg(currLink->getName()));
        return;
    }

646 647 648
    QString transmitUnconverted = m_ui->sendText->text();
    QByteArray specialSymbol;

649
    // Append special symbol if checkbox is checked
650
    if (m_ui->specialCheckBox->isChecked()) {
651 652 653 654
        // Get auto-add special symbols
        specialSymbol = symbolNameToBytes(m_ui->specialComboBox->currentText());

        // Convert them if needed
655
        if (!convertToAscii) {
656
            QString specialSymbolConverted;
657
            for (int i = 0; i < specialSymbol.length(); i++) {
658 659 660 661 662 663
                QString add(" 0x%1");
                specialSymbolConverted.append(add.arg(static_cast<char>(specialSymbol.at(i)), 2, 16, QChar('0')));
            }
            specialSymbol.clear();
            specialSymbol.append(specialSymbolConverted);
        }
664 665
    }

pixhawk's avatar
pixhawk committed
666 667 668
    QByteArray transmit;
    QString feedback;
    bool ok = true;
669
    if (convertToAscii) {
pixhawk's avatar
pixhawk committed
670
        // ASCII text is not converted
671 672 673 674 675 676 677
        transmit = transmitUnconverted.toLatin1();
        // Auto-add special symbol handling
        transmit.append(specialSymbol);

        QString translated;

        // Replace every occurence of a special symbol with its text name
678
        for (int i = 0; i < transmit.size(); ++i) {
679 680 681 682 683 684
            QByteArray specialChar;
            specialChar.append(transmit.at(i));
            translated.append(bytesToSymbolNames(specialChar));
        }

        feedback.append(translated);
685
    } else {
pixhawk's avatar
pixhawk committed
686
        // HEX symbols are converted to bytes
687 688
        QString str = transmitUnconverted.toLatin1();
        str.append(specialSymbol);
pixhawk's avatar
pixhawk committed
689 690 691 692
        str.remove(' ');
        str.remove("0x");
        str.simplified();
        int bufferIndex = 0;
693 694
        if ((str.size() % 2) == 0) {
            for (int i = 0; i < str.size(); i=i+2) {
pixhawk's avatar
pixhawk committed
695 696 697 698 699 700 701
                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;

702
                if (okByte) {
pixhawk's avatar
pixhawk committed
703 704 705 706 707
                    // Feedback
                    //feedback.append("0x");
                    feedback.append(str.at(i).toUpper());
                    feedback.append(str.at(i+1).toUpper());
                    feedback.append(" ");
708
                } else {
pixhawk's avatar
pixhawk committed
709 710 711
                    feedback = tr("HEX format error near \"") + strBuf + "\"";
                }
            }
712
        } else {
pixhawk's avatar
pixhawk committed
713 714 715 716 717 718
            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
719
    if (ok && m_ui->sendText->text().toLatin1().size() > 0) {
pixhawk's avatar
pixhawk committed
720
        // Transmit only if conversion succeeded
721 722 723 724 725 726 727 728 729 730
        //        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()));
        //        }
731
    } else if (m_ui->sendText->text().toLatin1().size() > 0) {
pixhawk's avatar
pixhawk committed
732 733 734 735 736 737 738 739 740 741 742 743 744 745
        // 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)
{
746
    if (convertToAscii == mode) {
lm's avatar
lm committed
747
        convertToAscii = !mode;
748
        if (m_ui->hexCheckBox->isChecked() != mode) {
lm's avatar
lm committed
749 750 751 752 753 754 755
            m_ui->hexCheckBox->setChecked(mode);
        }
        m_ui->receiveText->clear();
        m_ui->sendText->clear();
        m_ui->sentText->clear();
        commandHistory.clear();
    }
pixhawk's avatar
pixhawk committed
756 757 758 759 760 761 762
}

/**
 * @param filter true to ignore all MAVLINK raw data in output, false, to display all incoming data
 */
void DebugConsole::MAVLINKfilterEnabled(bool filter)
{
763
    if (filterMAVLINK != filter) {
lm's avatar
lm committed
764
        filterMAVLINK = filter;
lm's avatar
lm committed
765
        this->bytesToIgnore = 0;
766
        if (m_ui->mavlinkCheckBox->isChecked() != filter) {
lm's avatar
lm committed
767 768 769
            m_ui->mavlinkCheckBox->setChecked(filter);
        }
    }
pixhawk's avatar
pixhawk committed
770 771 772 773 774 775
}
/**
 * @param hold Freeze the input and thus any scrolling
 */
void DebugConsole::hold(bool hold)
{
776 777 778 779 780 781 782 783
    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
784

785
        this->holdOn = hold;
786

787 788 789 790 791 792 793 794 795
        // 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
796 797
    }
}
pixhawk's avatar
pixhawk committed
798

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

/** @brief Handle the connect button */
void DebugConsole::handleConnectButton()
{
816 817
    if (currLink) {
        if (currLink->isConnected()) {
818
            currLink->disconnect();
819
        } else {
820
            currLink->connect();
821 822 823 824
        }
    }
}

825 826
void DebugConsole::keyPressEvent(QKeyEvent * event)
{
827
    if (event->key() == Qt::Key_Up) {
828
        cycleCommandHistory(true);
829
    } else if (event->key() == Qt::Key_Down) {
830
        cycleCommandHistory(false);
831
    } else {
832 833 834 835 836 837
        QWidget::keyPressEvent(event);
    }
}

void DebugConsole::cycleCommandHistory(bool up)
{
lm's avatar
lm committed
838
    // Only cycle if there is a history
839
    if (commandHistory.length() > 0) {
lm's avatar
lm committed
840
        // Store current command if we're not in history yet
841
        if (commandIndex == commandHistory.length() && up) {
lm's avatar
lm committed
842 843
            currCommand = m_ui->sendText->text();
        }
844

845
        if (up) {
lm's avatar
lm committed
846 847
            // UP
            commandIndex--;
848
            if (commandIndex >= 0) {
lm's avatar
lm committed
849 850 851 852
                m_ui->sendText->setText(commandHistory.at(commandIndex));
            }

            // If the index
853
        } else {
lm's avatar
lm committed
854 855
            // DOWN
            commandIndex++;
856
            if (commandIndex < commandHistory.length()) {
lm's avatar
lm committed
857 858 859
                m_ui->sendText->setText(commandHistory.at(commandIndex));
            }
            // If the index is at history length, load the last current command
860

lm's avatar
lm committed
861 862 863
        }

        // Restore current command if we went out of history
864
        if (commandIndex == commandHistory.length()) {
lm's avatar
lm committed
865
            m_ui->sendText->setText(currCommand);
866 867
        }

lm's avatar
lm committed
868
        // If we are too far down or too far up, wrap around to current command
869
        if (commandIndex < 0 || commandIndex > commandHistory.length()) {
lm's avatar
lm committed
870 871 872
            commandIndex = commandHistory.length();
            m_ui->sendText->setText(currCommand);
        }
873

lm's avatar
lm committed
874 875 876
        // Bound the index
        if (commandIndex < 0) commandIndex = 0;
        if (commandIndex > commandHistory.length()) commandIndex = commandHistory.length();
877 878 879
    }
}

pixhawk's avatar
pixhawk committed
880 881 882 883 884 885 886 887 888 889 890
void DebugConsole::changeEvent(QEvent *e)
{
    QWidget::changeEvent(e);
    switch (e->type()) {
    case QEvent::LanguageChange:
        m_ui->retranslateUi(this);
        break;
    default:
        break;
    }
}