DebugConsole.cc 30.9 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
}

void DebugConsole::linkSelected(int linkId)
{
    // Disconnect
222
    if (currLink) {
pixhawk's avatar
pixhawk committed
223
        disconnect(currLink, SIGNAL(bytesReceived(LinkInterface*,QByteArray)), this, SLOT(receiveBytes(LinkInterface*, QByteArray)));
224
        disconnect(currLink, SIGNAL(connected(bool)), this, SLOT(setConnectionState(bool)));
pixhawk's avatar
pixhawk committed
225 226 227 228 229 230 231
    }
    // Clear data
    m_ui->receiveText->clear();

    // Connect new link
    currLink = links[linkId];
    connect(currLink, SIGNAL(bytesReceived(LinkInterface*,QByteArray)), this, SLOT(receiveBytes(LinkInterface*, QByteArray)));
232 233
    connect(currLink, SIGNAL(connected(bool)), this, SLOT(setConnectionState(bool)));
    setConnectionState(currLink->isConnected());
pixhawk's avatar
pixhawk committed
234 235 236 237 238 239 240
}

/**
 * @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)
{
241
	// Set name if signal came from a link
pixhawk's avatar
pixhawk committed
242
    LinkInterface* link = qobject_cast<LinkInterface*>(sender());
243 244 245 246 247 248
	//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
249 250 251 252 253
}

void DebugConsole::setAutoHold(bool hold)
{
    // Disable current hold if hold had been enabled
254
    if (autoHold && holdOn && !hold) {
pixhawk's avatar
pixhawk committed
255 256 257
        this->hold(false);
        m_ui->holdButton->setChecked(false);
    }
258
    // Set auto hold checkbox
259
    if (m_ui->holdCheckBox->isChecked() != hold) {
260 261
        m_ui->holdCheckBox->setChecked(hold);
    }
262 263 264 265 266 267 268 269 270 271 272

    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
273 274 275 276
    // Set new state
    autoHold = hold;
}

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

307
        m_ui->receiveText->appendHtml(QString("<font color=\"%1\">(%2:%3) %4</font>\n").arg(UASManager::instance()->getUASForId(id)->getColor().name(), name, comp, text));
308 309
        // Ensure text area scrolls correctly
        m_ui->receiveText->ensureCursorVisible();
310
    }
311 312
}

pixhawk's avatar
pixhawk committed
313 314 315 316 317 318 319
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
320
    if ((lowpassDataRate > dataRateThreshold) && autoHold) {
pixhawk's avatar
pixhawk committed
321 322 323 324 325 326 327 328 329
        // 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);

330
    if (holdOn) {
pixhawk's avatar
pixhawk committed
331 332 333 334 335 336 337 338 339 340
        //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)
{
341
    Q_UNUSED(event);
pixhawk's avatar
pixhawk committed
342
    // Update bandwidth
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
//    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
367 368 369 370 371
}

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

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

534 535 536
QByteArray DebugConsole::symbolNameToBytes(const QString& text)
{
    QByteArray b;
537
    if (text.contains("CR+LF")) {
538
        b.append(static_cast<char>(0x0D));
539
        b.append(static_cast<char>(0x0A));
540
    } else if (text.contains("LF")) {
541
        b.append(static_cast<char>(0x0A));
542
    } else if (text.contains("FF")) {
543
        b.append(static_cast<char>(0x0C));
544
    } else if (text.contains("CR")) {
545
        b.append(static_cast<char>(0x0D));
546
    } else if (text.contains("TAB")) {
547
        b.append(static_cast<char>(0x09));
548
    } else if (text.contains("NUL")) {
549
        b.append(static_cast<char>(0x00));
550
    } else if (text.contains("ESC")) {
551
        b.append(static_cast<char>(0x1B));
552
    } else if (text.contains("~")) {
553
        b.append(static_cast<char>(0x7E));
554
    } else if (text.contains("<Space>")) {
555 556 557 558 559
        b.append(static_cast<char>(0x20));
    }
    return b;
}

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

587 588 589
void DebugConsole::specialSymbolSelected(const QString& text)
{
    Q_UNUSED(text);
590
    //m_ui->specialCheckBox->setVisible(true);
591 592
}

593 594 595 596 597
void DebugConsole::appendSpecialSymbol(const QString& text)
{
    QString line = m_ui->sendText->text();
    QByteArray symbols = symbolNameToBytes(text);
    // The text is appended to the enter field
598
    if (convertToAscii) {
599
        line.append(symbols);
600
    } else {
601

602
        for (int i = 0; i < symbols.size(); i++) {
603 604 605 606 607 608 609
            QString add(" 0x%1");
            line.append(add.arg(static_cast<char>(symbols.at(i)), 2, 16, QChar('0')));
        }
    }
    m_ui->sendText->setText(line);
}

610 611 612 613 614
void DebugConsole::appendSpecialSymbol()
{
    appendSpecialSymbol(m_ui->specialComboBox->currentText());
}

pixhawk's avatar
pixhawk committed
615 616
void DebugConsole::sendBytes()
{
lm's avatar
lm committed
617 618 619 620 621 622
    // 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
623 624 625 626 627 628
    // 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();

629
    if (!m_ui->sentText->isVisible()) {
pixhawk's avatar
pixhawk committed
630 631 632
        m_ui->sentText->setVisible(true);
    }

633
    if (!currLink->isConnected()) {
634 635 636 637
        m_ui->sentText->setText(tr("Nothing sent. The link %1 is unconnected. Please connect first.").arg(currLink->getName()));
        return;
    }

638 639 640
    QString transmitUnconverted = m_ui->sendText->text();
    QByteArray specialSymbol;

641
    // Append special symbol if checkbox is checked
642
    if (m_ui->specialCheckBox->isChecked()) {
643 644 645 646
        // Get auto-add special symbols
        specialSymbol = symbolNameToBytes(m_ui->specialComboBox->currentText());

        // Convert them if needed
647
        if (!convertToAscii) {
648
            QString specialSymbolConverted;
649
            for (int i = 0; i < specialSymbol.length(); i++) {
650 651 652 653 654 655
                QString add(" 0x%1");
                specialSymbolConverted.append(add.arg(static_cast<char>(specialSymbol.at(i)), 2, 16, QChar('0')));
            }
            specialSymbol.clear();
            specialSymbol.append(specialSymbolConverted);
        }
656 657
    }

pixhawk's avatar
pixhawk committed
658 659 660
    QByteArray transmit;
    QString feedback;
    bool ok = true;
661
    if (convertToAscii) {
pixhawk's avatar
pixhawk committed
662
        // ASCII text is not converted
663 664 665 666 667 668 669
        transmit = transmitUnconverted.toLatin1();
        // Auto-add special symbol handling
        transmit.append(specialSymbol);

        QString translated;

        // Replace every occurence of a special symbol with its text name
670
        for (int i = 0; i < transmit.size(); ++i) {
671 672 673 674 675 676
            QByteArray specialChar;
            specialChar.append(transmit.at(i));
            translated.append(bytesToSymbolNames(specialChar));
        }

        feedback.append(translated);
677
    } else {
pixhawk's avatar
pixhawk committed
678
        // HEX symbols are converted to bytes
679 680
        QString str = transmitUnconverted.toLatin1();
        str.append(specialSymbol);
pixhawk's avatar
pixhawk committed
681 682 683 684
        str.remove(' ');
        str.remove("0x");
        str.simplified();
        int bufferIndex = 0;
685 686
        if ((str.size() % 2) == 0) {
            for (int i = 0; i < str.size(); i=i+2) {
pixhawk's avatar
pixhawk committed
687 688 689 690 691 692 693
                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;

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

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

777
        this->holdOn = hold;
778

779 780 781 782 783 784 785 786 787
        // 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
788 789
    }
}
pixhawk's avatar
pixhawk committed
790

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

/** @brief Handle the connect button */
void DebugConsole::handleConnectButton()
{
808 809
    if (currLink) {
        if (currLink->isConnected()) {
810
            currLink->disconnect();
811
        } else {
812
            currLink->connect();
813 814 815 816
        }
    }
}

817 818
void DebugConsole::keyPressEvent(QKeyEvent * event)
{
819
    if (event->key() == Qt::Key_Up) {
820
        cycleCommandHistory(true);
821
    } else if (event->key() == Qt::Key_Down) {
822
        cycleCommandHistory(false);
823
    } else {
824 825 826 827 828 829
        QWidget::keyPressEvent(event);
    }
}

void DebugConsole::cycleCommandHistory(bool up)
{
lm's avatar
lm committed
830
    // Only cycle if there is a history
831
    if (commandHistory.length() > 0) {
lm's avatar
lm committed
832
        // Store current command if we're not in history yet
833
        if (commandIndex == commandHistory.length() && up) {
lm's avatar
lm committed
834 835
            currCommand = m_ui->sendText->text();
        }
836

837
        if (up) {
lm's avatar
lm committed
838 839
            // UP
            commandIndex--;
840
            if (commandIndex >= 0) {
lm's avatar
lm committed
841 842 843 844
                m_ui->sendText->setText(commandHistory.at(commandIndex));
            }

            // If the index
845
        } else {
lm's avatar
lm committed
846 847
            // DOWN
            commandIndex++;
848
            if (commandIndex < commandHistory.length()) {
lm's avatar
lm committed
849 850 851
                m_ui->sendText->setText(commandHistory.at(commandIndex));
            }
            // If the index is at history length, load the last current command
852

lm's avatar
lm committed
853 854 855
        }

        // Restore current command if we went out of history
856
        if (commandIndex == commandHistory.length()) {
lm's avatar
lm committed
857
            m_ui->sendText->setText(currCommand);
858 859
        }

lm's avatar
lm committed
860
        // If we are too far down or too far up, wrap around to current command
861
        if (commandIndex < 0 || commandIndex > commandHistory.length()) {
lm's avatar
lm committed
862 863 864
            commandIndex = commandHistory.length();
            m_ui->sendText->setText(currCommand);
        }
865

lm's avatar
lm committed
866 867 868
        // Bound the index
        if (commandIndex < 0) commandIndex = 0;
        if (commandIndex > commandHistory.length()) commandIndex = commandHistory.length();
869 870 871
    }
}

pixhawk's avatar
pixhawk committed
872 873 874 875 876 877 878 879 880 881 882
void DebugConsole::changeEvent(QEvent *e)
{
    QWidget::changeEvent(e);
    switch (e->type()) {
    case QEvent::LanguageChange:
        m_ui->retranslateUi(this);
        break;
    default:
        break;
    }
}