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

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

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

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

    // Connect to link manager to get notified about new links
    connect(LinkManager::instance(), SIGNAL(newLink(LinkInterface*)), this, SLOT(addLink(LinkInterface*)));
    // 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)));
112 113
    // Connect connect button
    connect(m_ui->connectButton, SIGNAL(clicked()), this, SLOT(handleConnectButton()));
114
    // Connect the special chars combo box
115
    connect(m_ui->addSymbolButton, SIGNAL(clicked()), this, SLOT(appendSpecialSymbol()));
116 117
    // Connect Checkbox
    connect(m_ui->specialComboBox, SIGNAL(highlighted(QString)), this, SLOT(specialSymbolSelected(QString)));
118 119
    // Allow to send via return
    connect(m_ui->sendText, SIGNAL(returnPressed()), this, SLOT(sendBytes()));
pixhawk's avatar
pixhawk committed
120 121
}

122 123 124 125 126 127
void DebugConsole::hideEvent(QHideEvent* event)
{
    Q_UNUSED(event);
    storeSettings();
}

pixhawk's avatar
pixhawk committed
128 129
DebugConsole::~DebugConsole()
{
lm's avatar
lm committed
130
    storeSettings();
pixhawk's avatar
pixhawk committed
131 132 133
    delete m_ui;
}

lm's avatar
lm committed
134 135 136 137 138 139 140 141 142
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());
143 144
    MAVLINKfilterEnabled(settings.value("MAVLINK_FILTER_ENABLED", filterMAVLINK).toBool());
    setAutoHold(settings.value("AUTO_HOLD_ENABLED", autoHold).toBool());
lm's avatar
lm committed
145 146
    settings.endGroup();

147 148 149 150 151 152
//    // Update visibility settings
//    if (m_ui->specialCheckBox->isChecked())
//    {
//        m_ui->specialCheckBox->setVisible(true);
//        m_ui->addSymbolButton->setVisible(false);
//    }
lm's avatar
lm committed
153 154 155 156 157 158 159 160 161 162
}

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());
163 164
    settings.setValue("MAVLINK_FILTER_ENABLED", filterMAVLINK);
    settings.setValue("AUTO_HOLD_ENABLED", autoHold);
lm's avatar
lm committed
165 166 167 168 169
    settings.endGroup();
    settings.sync();
    //qDebug() << "Storing settings!";
}

pixhawk's avatar
pixhawk committed
170 171 172
/**
 * Add a link to the debug console output
 */
pixhawk's avatar
pixhawk committed
173 174 175 176
void DebugConsole::addLink(LinkInterface* link)
{
    // Add link to link list
    links.insert(link->getId(), link);
pixhawk's avatar
pixhawk committed
177

pixhawk's avatar
pixhawk committed
178 179 180
    m_ui->linkComboBox->insertItem(link->getId(), link->getName());
    // Set new item as current
    m_ui->linkComboBox->setCurrentIndex(qMax(0, links.size() - 1));
181
    linkSelected(m_ui->linkComboBox->currentIndex());
pixhawk's avatar
pixhawk committed
182 183 184

    // Register for name changes
    connect(link, SIGNAL(nameChanged(QString)), this, SLOT(updateLinkName(QString)));
185
    connect(link, SIGNAL(deleteLink(LinkInterface* const)), this, SLOT(removeLink(LinkInterface* const)));
186 187
}

188
void DebugConsole::removeLink(LinkInterface* const linkInterface)
189
{
190
    //LinkInterface* linkInterface = dynamic_cast<LinkInterface*>(link);
191
    // Add link to link list
192
    if (links.contains(linkInterface)) {
193 194 195 196 197 198
        int linkIndex = links.indexOf(linkInterface);

        links.removeAt(linkIndex);

        m_ui->linkComboBox->removeItem(linkIndex);
    }
199
    if (linkInterface == currLink) currLink = NULL;
pixhawk's avatar
pixhawk committed
200 201 202 203 204
}

void DebugConsole::linkSelected(int linkId)
{
    // Disconnect
205
    if (currLink) {
pixhawk's avatar
pixhawk committed
206
        disconnect(currLink, SIGNAL(bytesReceived(LinkInterface*,QByteArray)), this, SLOT(receiveBytes(LinkInterface*, QByteArray)));
207
        disconnect(currLink, SIGNAL(connected(bool)), this, SLOT(setConnectionState(bool)));
pixhawk's avatar
pixhawk committed
208 209 210 211 212 213 214
    }
    // Clear data
    m_ui->receiveText->clear();

    // Connect new link
    currLink = links[linkId];
    connect(currLink, SIGNAL(bytesReceived(LinkInterface*,QByteArray)), this, SLOT(receiveBytes(LinkInterface*, QByteArray)));
215 216
    connect(currLink, SIGNAL(connected(bool)), this, SLOT(setConnectionState(bool)));
    setConnectionState(currLink->isConnected());
pixhawk's avatar
pixhawk committed
217 218 219 220 221 222 223
}

/**
 * @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)
{
224
	// Set name if signal came from a link
pixhawk's avatar
pixhawk committed
225
    LinkInterface* link = qobject_cast<LinkInterface*>(sender());
226 227 228 229 230 231
	//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
232 233 234 235 236
}

void DebugConsole::setAutoHold(bool hold)
{
    // Disable current hold if hold had been enabled
237
    if (autoHold && holdOn && !hold) {
pixhawk's avatar
pixhawk committed
238 239 240
        this->hold(false);
        m_ui->holdButton->setChecked(false);
    }
241
    // Set auto hold checkbox
242
    if (m_ui->holdCheckBox->isChecked() != hold) {
243 244
        m_ui->holdCheckBox->setChecked(hold);
    }
245 246 247 248 249 250 251 252 253 254 255

    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
256 257 258 259
    // Set new state
    autoHold = hold;
}

260 261 262 263
/**
 * Prints the message in the UAS color
 */
void DebugConsole::receiveTextMessage(int id, int component, int severity, QString text)
264
{
265
    Q_UNUSED(severity);
266 267 268 269 270 271 272 273 274 275 276 277 278
    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
279 280
        case MAV_COMP_ID_MISSIONPLANNER:
            comp = tr("MISSION");
281 282 283 284 285 286 287 288
            break;
        case MAV_COMP_ID_SYSTEM_CONTROL:
            comp = tr("SYS-CONTROL");
            break;
        default:
            comp = QString::number(component);
            break;
        }
pixhawk's avatar
pixhawk committed
289

290
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">(%2:%3) %4</font>\n").arg(UASManager::instance()->getUASForId(id)->getColor().name(), name, comp, text));
291 292
        // Ensure text area scrolls correctly
        m_ui->receiveText->ensureCursorVisible();
293
    }
294 295
}

pixhawk's avatar
pixhawk committed
296 297 298 299 300 301 302
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
303
    if ((lowpassDataRate > dataRateThreshold) && autoHold) {
pixhawk's avatar
pixhawk committed
304 305 306 307 308 309 310 311 312
        // 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);

313
    if (holdOn) {
pixhawk's avatar
pixhawk committed
314 315 316 317 318 319 320 321 322 323
        //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)
{
324
    Q_UNUSED(event);
pixhawk's avatar
pixhawk committed
325
    // Update bandwidth
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
//    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
350 351 352 353 354
}

void DebugConsole::receiveBytes(LinkInterface* link, QByteArray bytes)
{
    snapShotBytes += bytes.size();
lm's avatar
lm committed
355 356 357
    int len = bytes.size();
    int lastSpace = 0;
    if ((this->bytesToIgnore > 260) || (this->bytesToIgnore < -2)) this->bytesToIgnore = 0;
358
    // Only add data from current link
lm's avatar
lm committed
359 360
    if (link == currLink && !holdOn)
    {
pixhawk's avatar
pixhawk committed
361
        // Parse all bytes
lm's avatar
lm committed
362 363
        for (int j = 0; j < len; j++)
        {
pixhawk's avatar
pixhawk committed
364
            unsigned char byte = bytes.at(j);
lm's avatar
lm committed
365
            // Filter MAVLink (http://qgroundcontrol.org/mavlink/) messages out of the stream.
lm's avatar
lm committed
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
            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
383
                // Filtering is done by setting an ignore counter based on the MAVLINK packet length
lm's avatar
lm committed
384 385 386 387 388 389 390 391 392
                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
393 394
                QString str;
                // Convert to ASCII for readability
lm's avatar
lm committed
395 396
                if (convertToAscii)
                {
397 398
                    if (escReceived)
                    {
399
                        if (escIndex < static_cast<int>(sizeof(escBytes)))
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
                        {
                            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
433 434 435 436
                    {
                        switch (byte)
                        {
                            case (unsigned char)'\n':   // Accept line feed
437
                                if (lastByte != '\r')   // Do not break line again for LF+CR
lm's avatar
lm committed
438
                                    str.append(byte);   // only break line for single LF or CR bytes
439
                            break;
lm's avatar
lm committed
440 441 442
                            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
443 444
                                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
445
                                lastSpace = 1;
pixhawk's avatar
pixhawk committed
446
                            break;
447 448 449 450 451 452 453 454 455
                            /* 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
456 457 458 459 460 461 462 463
                            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;
464
                                escReceived = false;
pixhawk's avatar
pixhawk committed
465
                            break;
lm's avatar
lm committed
466
                        }
pixhawk's avatar
pixhawk committed
467
                    }
lm's avatar
lm committed
468 469
                    else
                    {
470 471 472
                        // Ignore carriage return, because that
                        // is auto-added with '\n'
                        if (byte != '\r') str.append(byte);           // Append original character
lm's avatar
lm committed
473 474 475 476 477
                        lastSpace = 0;
                    }
                }
                else
                {
pixhawk's avatar
pixhawk committed
478 479 480 481 482
                    QString str2;
                    str2.sprintf("%02x ", byte);
                    str.append(str2);
                }
                lineBuffer.append(str);
483
                lastByte = byte;
lm's avatar
lm committed
484 485 486 487
            }
            else
            {
                if (filterMAVLINK) this->bytesToIgnore--;
pixhawk's avatar
pixhawk committed
488
                // Constrain bytes to positive range
lm's avatar
lm committed
489
//                bytesToIgnore = qMax(0, bytesToIgnore);
pixhawk's avatar
pixhawk committed
490 491 492
            }

        }
493
        // Plot every 200 ms if windows is visible
494
        if (lineBuffer.length() > 0 && (QGC::groundTimeMilliseconds() - lastLineBuffer) > 200) {
495 496
            if (isVisible())
            {
497 498 499
                m_ui->receiveText->appendPlainText(lineBuffer);
                lineBuffer.clear();
                lastLineBuffer = QGC::groundTimeMilliseconds();
500 501 502
                // Ensure text area scrolls correctly
                m_ui->receiveText->ensureCursorVisible();
            }
503 504 505 506
            if (lineBuffer.size() > 8192)
            {
                lineBuffer.remove(0, 4096);
            }
507
        }
lm's avatar
lm committed
508 509 510
    }
    else if (link == currLink && holdOn)
    {
pixhawk's avatar
pixhawk committed
511
        holdBuffer.append(bytes);
lm's avatar
lm committed
512 513
        if (holdBuffer.size() > 8192)
            holdBuffer.remove(0, 4096); // drop old stuff
pixhawk's avatar
pixhawk committed
514 515 516
    }
}

517 518 519
QByteArray DebugConsole::symbolNameToBytes(const QString& text)
{
    QByteArray b;
520
    if (text.contains("CR+LF")) {
521
        b.append(static_cast<char>(0x0D));
522
        b.append(static_cast<char>(0x0A));
523
    } else if (text.contains("LF")) {
524
        b.append(static_cast<char>(0x0A));
525
    } else if (text.contains("FF")) {
526
        b.append(static_cast<char>(0x0C));
527
    } else if (text.contains("CR")) {
528
        b.append(static_cast<char>(0x0D));
529
    } else if (text.contains("TAB")) {
530
        b.append(static_cast<char>(0x09));
531
    } else if (text.contains("NUL")) {
532
        b.append(static_cast<char>(0x00));
533
    } else if (text.contains("ESC")) {
534
        b.append(static_cast<char>(0x1B));
535
    } else if (text.contains("~")) {
536
        b.append(static_cast<char>(0x7E));
537
    } else if (text.contains("<Space>")) {
538 539 540 541 542
        b.append(static_cast<char>(0x20));
    }
    return b;
}

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

570 571 572
void DebugConsole::specialSymbolSelected(const QString& text)
{
    Q_UNUSED(text);
573
    //m_ui->specialCheckBox->setVisible(true);
574 575
}

576 577 578 579 580
void DebugConsole::appendSpecialSymbol(const QString& text)
{
    QString line = m_ui->sendText->text();
    QByteArray symbols = symbolNameToBytes(text);
    // The text is appended to the enter field
581
    if (convertToAscii) {
582
        line.append(symbols);
583
    } else {
584

585
        for (int i = 0; i < symbols.size(); i++) {
586 587 588 589 590 591 592
            QString add(" 0x%1");
            line.append(add.arg(static_cast<char>(symbols.at(i)), 2, 16, QChar('0')));
        }
    }
    m_ui->sendText->setText(line);
}

593 594 595 596 597
void DebugConsole::appendSpecialSymbol()
{
    appendSpecialSymbol(m_ui->specialComboBox->currentText());
}

pixhawk's avatar
pixhawk committed
598 599
void DebugConsole::sendBytes()
{
lm's avatar
lm committed
600 601 602 603 604 605
    // 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
606 607 608 609 610 611
    // 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();

612
    if (!m_ui->sentText->isVisible()) {
pixhawk's avatar
pixhawk committed
613 614 615
        m_ui->sentText->setVisible(true);
    }

616
    if (!currLink->isConnected()) {
617 618 619 620
        m_ui->sentText->setText(tr("Nothing sent. The link %1 is unconnected. Please connect first.").arg(currLink->getName()));
        return;
    }

621 622 623
    QString transmitUnconverted = m_ui->sendText->text();
    QByteArray specialSymbol;

624
    // Append special symbol if checkbox is checked
625
    if (m_ui->specialCheckBox->isChecked()) {
626 627 628 629
        // Get auto-add special symbols
        specialSymbol = symbolNameToBytes(m_ui->specialComboBox->currentText());

        // Convert them if needed
630
        if (!convertToAscii) {
631
            QString specialSymbolConverted;
632
            for (int i = 0; i < specialSymbol.length(); i++) {
633 634 635 636 637 638
                QString add(" 0x%1");
                specialSymbolConverted.append(add.arg(static_cast<char>(specialSymbol.at(i)), 2, 16, QChar('0')));
            }
            specialSymbol.clear();
            specialSymbol.append(specialSymbolConverted);
        }
639 640
    }

pixhawk's avatar
pixhawk committed
641 642 643
    QByteArray transmit;
    QString feedback;
    bool ok = true;
644
    if (convertToAscii) {
pixhawk's avatar
pixhawk committed
645
        // ASCII text is not converted
646 647 648 649 650 651 652
        transmit = transmitUnconverted.toLatin1();
        // Auto-add special symbol handling
        transmit.append(specialSymbol);

        QString translated;

        // Replace every occurence of a special symbol with its text name
653
        for (int i = 0; i < transmit.size(); ++i) {
654 655 656 657 658 659
            QByteArray specialChar;
            specialChar.append(transmit.at(i));
            translated.append(bytesToSymbolNames(specialChar));
        }

        feedback.append(translated);
660
    } else {
pixhawk's avatar
pixhawk committed
661
        // HEX symbols are converted to bytes
662 663
        QString str = transmitUnconverted.toLatin1();
        str.append(specialSymbol);
pixhawk's avatar
pixhawk committed
664 665 666 667
        str.remove(' ');
        str.remove("0x");
        str.simplified();
        int bufferIndex = 0;
668 669
        if ((str.size() % 2) == 0) {
            for (int i = 0; i < str.size(); i=i+2) {
pixhawk's avatar
pixhawk committed
670 671 672 673 674 675 676
                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;

677
                if (okByte) {
pixhawk's avatar
pixhawk committed
678 679 680 681 682
                    // Feedback
                    //feedback.append("0x");
                    feedback.append(str.at(i).toUpper());
                    feedback.append(str.at(i+1).toUpper());
                    feedback.append(" ");
683
                } else {
pixhawk's avatar
pixhawk committed
684 685 686
                    feedback = tr("HEX format error near \"") + strBuf + "\"";
                }
            }
687
        } else {
pixhawk's avatar
pixhawk committed
688 689 690 691 692 693
            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
694
    if (ok && m_ui->sendText->text().toLatin1().size() > 0) {
pixhawk's avatar
pixhawk committed
695
        // Transmit only if conversion succeeded
696 697 698 699 700 701 702 703 704 705
        //        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()));
        //        }
706
    } else if (m_ui->sendText->text().toLatin1().size() > 0) {
pixhawk's avatar
pixhawk committed
707 708 709 710 711 712 713 714 715 716 717 718 719 720
        // 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)
{
721
    if (convertToAscii == mode) {
lm's avatar
lm committed
722
        convertToAscii = !mode;
723
        if (m_ui->hexCheckBox->isChecked() != mode) {
lm's avatar
lm committed
724 725 726 727 728 729 730
            m_ui->hexCheckBox->setChecked(mode);
        }
        m_ui->receiveText->clear();
        m_ui->sendText->clear();
        m_ui->sentText->clear();
        commandHistory.clear();
    }
pixhawk's avatar
pixhawk committed
731 732 733 734 735 736 737
}

/**
 * @param filter true to ignore all MAVLINK raw data in output, false, to display all incoming data
 */
void DebugConsole::MAVLINKfilterEnabled(bool filter)
{
738
    if (filterMAVLINK != filter) {
lm's avatar
lm committed
739
        filterMAVLINK = filter;
lm's avatar
lm committed
740
        this->bytesToIgnore = 0;
741
        if (m_ui->mavlinkCheckBox->isChecked() != filter) {
lm's avatar
lm committed
742 743 744
            m_ui->mavlinkCheckBox->setChecked(filter);
        }
    }
pixhawk's avatar
pixhawk committed
745 746 747 748 749 750
}
/**
 * @param hold Freeze the input and thus any scrolling
 */
void DebugConsole::hold(bool hold)
{
751 752 753 754 755 756 757 758
    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
759

760
        this->holdOn = hold;
761

762 763 764 765 766 767 768 769 770
        // 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
771 772
    }
}
pixhawk's avatar
pixhawk committed
773

774 775 776 777 778
/**
 * Sets the connection state the widget shows to this state
 */
void DebugConsole::setConnectionState(bool connected)
{
779
    if(connected) {
780
        m_ui->connectButton->setText(tr("Disconn."));
781
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">%2</font>\n").arg(QGC::colorGreen.name(), tr("Link %1 is connected.").arg(currLink->getName())));
782
    } else {
783
        m_ui->connectButton->setText(tr("Connect"));
784
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">%2</font>\n").arg(QGC::colorOrange.name(), tr("Link %1 is unconnected.").arg(currLink->getName())));
785 786 787 788 789 790
    }
}

/** @brief Handle the connect button */
void DebugConsole::handleConnectButton()
{
791 792
    if (currLink) {
        if (currLink->isConnected()) {
793
            currLink->disconnect();
794
        } else {
795
            currLink->connect();
796 797 798 799
        }
    }
}

800 801
void DebugConsole::keyPressEvent(QKeyEvent * event)
{
802
    if (event->key() == Qt::Key_Up) {
803
        cycleCommandHistory(true);
804
    } else if (event->key() == Qt::Key_Down) {
805
        cycleCommandHistory(false);
806
    } else {
807 808 809 810 811 812
        QWidget::keyPressEvent(event);
    }
}

void DebugConsole::cycleCommandHistory(bool up)
{
lm's avatar
lm committed
813
    // Only cycle if there is a history
814
    if (commandHistory.length() > 0) {
lm's avatar
lm committed
815
        // Store current command if we're not in history yet
816
        if (commandIndex == commandHistory.length() && up) {
lm's avatar
lm committed
817 818
            currCommand = m_ui->sendText->text();
        }
819

820
        if (up) {
lm's avatar
lm committed
821 822
            // UP
            commandIndex--;
823
            if (commandIndex >= 0) {
lm's avatar
lm committed
824 825 826 827
                m_ui->sendText->setText(commandHistory.at(commandIndex));
            }

            // If the index
828
        } else {
lm's avatar
lm committed
829 830
            // DOWN
            commandIndex++;
831
            if (commandIndex < commandHistory.length()) {
lm's avatar
lm committed
832 833 834
                m_ui->sendText->setText(commandHistory.at(commandIndex));
            }
            // If the index is at history length, load the last current command
835

lm's avatar
lm committed
836 837 838
        }

        // Restore current command if we went out of history
839
        if (commandIndex == commandHistory.length()) {
lm's avatar
lm committed
840
            m_ui->sendText->setText(currCommand);
841 842
        }

lm's avatar
lm committed
843
        // If we are too far down or too far up, wrap around to current command
844
        if (commandIndex < 0 || commandIndex > commandHistory.length()) {
lm's avatar
lm committed
845 846 847
            commandIndex = commandHistory.length();
            m_ui->sendText->setText(currCommand);
        }
848

lm's avatar
lm committed
849 850 851
        // Bound the index
        if (commandIndex < 0) commandIndex = 0;
        if (commandIndex > commandHistory.length()) commandIndex = commandHistory.length();
852 853 854
    }
}

pixhawk's avatar
pixhawk committed
855 856 857 858 859 860 861 862 863 864 865
void DebugConsole::changeEvent(QEvent *e)
{
    QWidget::changeEvent(e);
    switch (e->type()) {
    case QEvent::LanguageChange:
        m_ui->retranslateUi(this);
        break;
    default:
        break;
    }
}