MAVLinkProtocol.cc 16.5 KB
Newer Older
1
/*===================================================================
pixhawk's avatar
pixhawk committed
2 3 4 5
======================================================================*/

/**
 * @file
pixhawk's avatar
pixhawk committed
6 7
 *   @brief Implementation of class MAVLinkProtocol
 *   @author Lorenz Meier <mail@qgroundcontrol.org>
pixhawk's avatar
pixhawk committed
8 9 10 11 12 13 14
 */

#include <inttypes.h>
#include <iostream>

#include <QDebug>
#include <QTime>
lm's avatar
lm committed
15
#include <QApplication>
pixhawk's avatar
pixhawk committed
16
#include <QMessageBox>
17 18
#include <QSettings>
#include <QDesktopServices>
pixhawk's avatar
pixhawk committed
19

20
//#include "MG.h"
pixhawk's avatar
pixhawk committed
21 22 23 24 25
#include "MAVLinkProtocol.h"
#include "UASInterface.h"
#include "UASManager.h"
#include "UASInterface.h"
#include "UAS.h"
26 27
#include "SlugsMAV.h"
#include "PxQuadMAV.h"
28
#include "ArduPilotMegaMAV.h"
pixhawk's avatar
pixhawk committed
29 30
#include "configuration.h"
#include "LinkManager.h"
31
//#include "MainWindow.h"
32 33
#include "QGCMAVLink.h"
#include "QGCMAVLinkUASFactory.h"
34
#include "QGC.h"
pixhawk's avatar
pixhawk committed
35 36 37 38 39 40 41 42

/**
 * The default constructor will create a new MAVLink object sending heartbeats at
 * the MAVLINK_HEARTBEAT_DEFAULT_RATE to all connected links.
 */
MAVLinkProtocol::MAVLinkProtocol() :
        heartbeatTimer(new QTimer(this)),
        heartbeatRate(MAVLINK_HEARTBEAT_DEFAULT_RATE),
lm's avatar
lm committed
43 44
        m_heartbeatsEnabled(false),
        m_loggingEnabled(false),
45
        m_logfile(NULL),
lm's avatar
lm committed
46
        m_enable_version_check(true),
47 48
        versionMismatchIgnore(false),
        systemId(QGC::defaultSystemId)
pixhawk's avatar
pixhawk committed
49
{
50 51
    loadSettings();
    //start(QThread::LowPriority);
pixhawk's avatar
pixhawk committed
52 53 54
    // Start heartbeat timer, emitting a heartbeat at the configured rate
    connect(heartbeatTimer, SIGNAL(timeout()), this, SLOT(sendHeartbeat()));
    heartbeatTimer->start(1000/heartbeatRate);
lm's avatar
lm committed
55 56
    totalReceiveCounter = 0;
    totalLossCounter = 0;
57 58
    currReceiveCounter = 0;
    currLossCounter = 0;
lm's avatar
lm committed
59 60 61 62 63 64 65
    for (int i = 0; i < 256; i++)
    {
        for (int j = 0; j < 256; j++)
        {
            lastIndex[i][j] = -1;
        }
    }
lm's avatar
lm committed
66 67

    emit versionCheckChanged(m_enable_version_check);
pixhawk's avatar
pixhawk committed
68 69
}

70 71 72 73 74 75
void MAVLinkProtocol::loadSettings()
{
    // Load defaults from settings
    QSettings settings;
    settings.sync();
    settings.beginGroup("QGC_MAVLINK_PROTOCOL");
76
    enableHeartbeats(settings.value("HEARTBEATS_ENABLED", m_heartbeatsEnabled).toBool());
77 78
    enableVersionCheck(settings.value("VERSION_CHECK_ENABLED", m_enable_version_check).toBool());
    enableMultiplexing(settings.value("MULTIPLEXING_ENABLED", m_multiplexingEnabled).toBool());
79 80 81 82 83 84

    // Only set logfile if there is a name present in settings
    if (settings.contains("LOGFILE_NAME") && m_logfile == NULL)
    {
        m_logfile = new QFile(settings.value("LOGFILE_NAME").toString());
    }
85 86 87 88
    else if (m_logfile == NULL)
    {
        m_logfile = new QFile(QDesktopServices::storageLocation(QDesktopServices::HomeLocation) + "/qgroundcontrol_packetlog.mavlink");
    }
89 90
    // Enable logging
    enableLogging(settings.value("LOGGING_ENABLED", m_loggingEnabled).toBool());
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

    // Only set system id if it was valid
    int temp = settings.value("GCS_SYSTEM_ID", systemId).toInt();
    if (temp > 0 && temp < 256)
    {
        systemId = temp;
    }
    settings.endGroup();
}

void MAVLinkProtocol::storeSettings()
{
    // Store settings
    QSettings settings;
    settings.beginGroup("QGC_MAVLINK_PROTOCOL");
    settings.setValue("HEARTBEATS_ENABLED", m_heartbeatsEnabled);
    settings.setValue("LOGGING_ENABLED", m_loggingEnabled);
108 109
    settings.setValue("VERSION_CHECK_ENABLED", m_enable_version_check);
    settings.setValue("MULTIPLEXING_ENABLED", m_multiplexingEnabled);
110 111 112 113 114 115 116 117 118 119 120
    settings.setValue("GCS_SYSTEM_ID", systemId);
    if (m_logfile)
    {
        // Logfile exists, store the name
        settings.setValue("LOGFILE_NAME", m_logfile->fileName());
    }
    settings.endGroup();
    settings.sync();
    //qDebug() << "Storing settings!";
}

pixhawk's avatar
pixhawk committed
121 122
MAVLinkProtocol::~MAVLinkProtocol()
{
123
    storeSettings();
pixhawk's avatar
pixhawk committed
124 125
    if (m_logfile)
    {
126 127 128 129 130
        if (m_logfile->isOpen())
        {
            m_logfile->flush();
            m_logfile->close();
        }
pixhawk's avatar
pixhawk committed
131 132
        delete m_logfile;
    }
pixhawk's avatar
pixhawk committed
133 134 135 136 137 138
}



void MAVLinkProtocol::run()
{
lm's avatar
lm committed
139
    exec();
pixhawk's avatar
pixhawk committed
140 141
}

pixhawk's avatar
pixhawk committed
142 143
QString MAVLinkProtocol::getLogfileName()
{
144 145 146 147 148 149
    if (m_logfile)
    {
        return m_logfile->fileName();
    }
    else
    {
150
        return QDesktopServices::storageLocation(QDesktopServices::HomeLocation) + "/qgroundcontrol_packetlog.mavlink";
151
    }
pixhawk's avatar
pixhawk committed
152 153
}

pixhawk's avatar
pixhawk committed
154 155 156 157 158 159 160 161
/**
 * The bytes are copied by calling the LinkInterface::readBytes() method.
 * This method parses all incoming bytes and constructs a MAVLink packet.
 * It can handle multiple links in parallel, as each link has it's own buffer/
 * parsing state machine.
 * @param link The interface to read from
 * @see LinkInterface
 **/
162
void MAVLinkProtocol::receiveBytes(LinkInterface* link, QByteArray b)
pixhawk's avatar
pixhawk committed
163 164 165 166
{
    receiveMutex.lock();
    mavlink_message_t message;
    mavlink_status_t status;
167
    for (int position = 0; position < b.size(); position++)
pixhawk's avatar
pixhawk committed
168
    {
169
        unsigned int decodeState = mavlink_parse_char(link->getId(), (uint8_t)(b.at(position)), &message, &status);
pixhawk's avatar
pixhawk committed
170 171 172

        if (decodeState == 1)
        {
pixhawk's avatar
pixhawk committed
173
            // Log data
174
            if (m_loggingEnabled && m_logfile)
pixhawk's avatar
pixhawk committed
175
            {
lm's avatar
lm committed
176
                const int len = MAVLINK_MAX_PACKET_LEN+sizeof(quint64);
177 178
                uint8_t buf[len];
                quint64 time = QGC::groundTimeUsecs();
179
                memcpy(buf, (void*)&time, sizeof(quint64));
180
                // Write message to buffer
181
                mavlink_msg_to_send_buffer(buf+sizeof(quint64), &message);
182
                QByteArray b((const char*)buf, len);
183
                if(m_logfile->write(b) < static_cast<qint64>(MAVLINK_MAX_PACKET_LEN+sizeof(quint64)))
184 185 186 187 188
                {
                    emit protocolStatusMessage(tr("MAVLink Logging failed"), tr("Could not write to file %1, disabling logging.").arg(m_logfile->fileName()));
                    // Stop logging
                    enableLogging(false);
                }
pixhawk's avatar
pixhawk committed
189 190
            }

pixhawk's avatar
pixhawk committed
191 192 193 194 195 196
            // ORDER MATTERS HERE!
            // If the matching UAS object does not yet exist, it has to be created
            // before emitting the packetReceived signal
            UASInterface* uas = UASManager::instance()->getUASForId(message.sysid);

            // Check and (if necessary) create UAS object
197
            if (uas == NULL && message.msgid == MAVLINK_MSG_ID_HEARTBEAT)
pixhawk's avatar
pixhawk committed
198 199 200 201 202 203 204
            {
                // ORDER MATTERS HERE!
                // The UAS object has first to be created and connected,
                // only then the rest of the application can be made aware
                // of its existence, as it only then can send and receive
                // it's first messages.

pixhawk's avatar
pixhawk committed
205
                // Check if the UAS has the same id like this system
206 207
                if (message.sysid == getSystemId())
                {
208
                    emit protocolStatusMessage(tr("SYSTEM ID CONFLICT!"), tr("Warning: A second system is using the same system id (%1)").arg(getSystemId()));
209 210
                }

211 212 213 214
                // Create a new UAS based on the heartbeat received
                // Todo dynamically load plugin at run-time for MAV
                // WIKISEARCH:AUTOPILOT_TYPE_INSTANTIATION

pixhawk's avatar
pixhawk committed
215
                // First create new UAS object
216 217
                // Decode heartbeat message
                mavlink_heartbeat_t heartbeat;
pixhawk's avatar
pixhawk committed
218 219
                // Reset version field to 0
                heartbeat.mavlink_version = 0;
220
                mavlink_msg_heartbeat_decode(&message, &heartbeat);
pixhawk's avatar
pixhawk committed
221 222

                // Check if the UAS has a different protocol version
lm's avatar
lm committed
223
                if (m_enable_version_check && (heartbeat.mavlink_version != MAVLINK_VERSION))
pixhawk's avatar
pixhawk committed
224 225
                {
                    // Bring up dialog to inform user
226 227 228
                    if (!versionMismatchIgnore)
                    {
                        emit protocolStatusMessage(tr("The MAVLink protocol version on the MAV and QGroundControl mismatch!"),
229
                                                   tr("It is unsafe to use different MAVLink versions. QGroundControl therefore refuses to connect to system %1, which sends MAVLink version %2 (QGroundControl uses version %3).").arg(message.sysid).arg(heartbeat.mavlink_version).arg(MAVLINK_VERSION));
230 231
                        versionMismatchIgnore = true;
                    }
pixhawk's avatar
pixhawk committed
232 233 234 235 236

                    // Ignore this message and continue gracefully
                    continue;
                }

237 238
                // Create a new UAS object
                uas = QGCMAVLinkUASFactory::createUAS(this, link, message.sysid, &heartbeat);
pixhawk's avatar
pixhawk committed
239
            }
240 241 242

            // Only count message if UAS exists for this message
            if (uas != NULL)
lm's avatar
lm committed
243
            {
244 245 246 247 248 249
                // Increase receive counter
                totalReceiveCounter++;
                currReceiveCounter++;
                qint64 lastLoss = totalLossCounter;
                // Update last packet index
                if (lastIndex[message.sysid][message.compid] == -1)
lm's avatar
lm committed
250
                {
251
                    lastIndex[message.sysid][message.compid] = message.seq;
lm's avatar
lm committed
252 253
                }
                else
lm's avatar
lm committed
254
                {
Mariano Lizarraga's avatar
Mariano Lizarraga committed
255
                    // TODO: This if-else block can (should) be greatly simplified
lm's avatar
lm committed
256 257 258 259 260 261 262 263
                    if (lastIndex[message.sysid][message.compid] == 255)
                    {
                        lastIndex[message.sysid][message.compid] = 0;
                    }
                    else
                    {
                        lastIndex[message.sysid][message.compid]++;
                    }
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

                    int safeguard = 0;
                    //qDebug() << "SYSID" << message.sysid << "COMPID" << message.compid << "MSGID" << message.msgid << "LASTINDEX" << lastIndex[message.sysid][message.compid] << "SEQ" << message.seq;
                    while(lastIndex[message.sysid][message.compid] != message.seq && safeguard < 255)
                    {
                        if (lastIndex[message.sysid][message.compid] == 255)
                        {
                            lastIndex[message.sysid][message.compid] = 0;
                        }
                        else
                        {
                            lastIndex[message.sysid][message.compid]++;
                        }
                        totalLossCounter++;
                        currLossCounter++;
                        safeguard++;
                    }
                }
                //            if (lastIndex.contains(message.sysid))
                //            {
                //                QMap<int, int>* lastCompIndex = lastIndex.value(message.sysid);
                //                if (lastCompIndex->contains(message.compid))
                //                while (lastCompIndex->value(message.compid, 0)+1 )
                //            }
                //if ()

                // If a new loss was detected or we just hit one 128th packet step
lm's avatar
lm committed
291
                if (lastLoss != totalLossCounter || (totalReceiveCounter % 64 == 0))
292 293 294 295 296 297 298 299
                {
                    // Calculate new loss ratio
                    // Receive loss
                    float receiveLoss = (double)currLossCounter/(double)(currReceiveCounter+currLossCounter);
                    receiveLoss *= 100.0f;
                    // qDebug() << "LOSSCHANGED" << receiveLoss;
                    currLossCounter = 0;
                    currReceiveCounter = 0;
pixhawk's avatar
pixhawk committed
300
                    emit receiveLossChanged(message.sysid, receiveLoss);
lm's avatar
lm committed
301 302
                }

303 304 305 306
                // The packet is emitted as a whole, as it is only 255 - 261 bytes short
                // kind of inefficient, but no issue for a groundstation pc.
                // It buys as reentrancy for the whole code over all threads
                emit messageReceived(link, message);
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321

                // Multiplex message if enabled
                if (m_multiplexingEnabled)
                {
                    // Get all links connected to this unit
                    QList<LinkInterface*> links = LinkManager::instance()->getLinksForProtocol(this);

                    // Emit message on all links that are currently connected
                    foreach (LinkInterface* currLink, links)
                    {
                        // Only forward this message to the other links,
                        // not the link the message was received on
                        if (currLink != link) sendMessage(currLink, message);
                    }
                }
322
            }
pixhawk's avatar
pixhawk committed
323 324 325 326 327 328 329 330 331 332 333 334 335
        }
    }
    receiveMutex.unlock();
}

/**
 * @return The name of this protocol
 **/
QString MAVLinkProtocol::getName()
{
    return QString(tr("MAVLink protocol"));
}

336
/** @return System id of this application */
337
int MAVLinkProtocol::getSystemId()
338
{
339 340 341 342 343 344
    return systemId;
}

void MAVLinkProtocol::setSystemId(int id)
{
    systemId = id;
345 346 347
}

/** @return Component id of this application */
348
int MAVLinkProtocol::getComponentId()
349
{
350
    return QGC::defaultComponentId;
351 352
}

pixhawk's avatar
pixhawk committed
353 354 355 356 357 358 359 360 361 362 363 364 365
/**
 * @param message message to send
 */
void MAVLinkProtocol::sendMessage(mavlink_message_t message)
{
    // Get all links connected to this unit
    QList<LinkInterface*> links = LinkManager::instance()->getLinksForProtocol(this);

    // Emit message on all links that are currently connected
    QList<LinkInterface*>::iterator i;
    for (i = links.begin(); i != links.end(); ++i)
    {
        sendMessage(*i, message);
366
        //qDebug() << __FILE__ << __LINE__ << "SENT MESSAGE OVER" << ((LinkInterface*)*i)->getName() << "LIST SIZE:" << links.size();
pixhawk's avatar
pixhawk committed
367 368 369 370 371 372 373 374 375 376 377
    }
}

/**
 * @param link the link to send the message over
 * @param message message to send
 */
void MAVLinkProtocol::sendMessage(LinkInterface* link, mavlink_message_t message)
{
    // Create buffer
    uint8_t buffer[MAVLINK_MAX_PACKET_LEN];
378 379
    // Rewriting header to ensure correct link ID is set
    if (link->getId() != 0) mavlink_finalize_message_chan(&message, this->getSystemId(), this->getComponentId(), link->getId(), message.len);
pixhawk's avatar
pixhawk committed
380
    // Write message into buffer, prepending start sign
pixhawk's avatar
pixhawk committed
381
    int len = mavlink_msg_to_send_buffer(buffer, &message);
pixhawk's avatar
pixhawk committed
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
    // If link is connected
    if (link->isConnected())
    {
        // Send the portion of the buffer now occupied by the message
        link->writeBytes((const char*)buffer, len);
    }
}

/**
 * The heartbeat is sent out of order and does not reset the
 * periodic heartbeat emission. It will be just sent in addition.
 * @return mavlink_message_t heartbeat message sent on serial link
 */
void MAVLinkProtocol::sendHeartbeat()
{
    if (m_heartbeatsEnabled)
    {
        mavlink_message_t beat;
lm's avatar
lm committed
400
        mavlink_msg_heartbeat_pack(getSystemId(), getComponentId(),&beat, OCU, MAV_AUTOPILOT_GENERIC);
pixhawk's avatar
pixhawk committed
401 402 403 404 405 406 407 408 409 410 411
        sendMessage(beat);
    }
}

/** @param enabled true to enable heartbeats emission at heartbeatRate, false to disable */
void MAVLinkProtocol::enableHeartbeats(bool enabled)
{
    m_heartbeatsEnabled = enabled;
    emit heartbeatChanged(enabled);
}

412 413 414 415 416 417 418 419 420
void MAVLinkProtocol::enableMultiplexing(bool enabled)
{
    bool changed = false;
    if (enabled != m_multiplexingEnabled) changed = true;

    m_multiplexingEnabled = enabled;
    if (changed) emit multiplexingChanged(m_multiplexingEnabled);
}

lm's avatar
lm committed
421 422
void MAVLinkProtocol::enableLogging(bool enabled)
{
423 424 425 426
    bool changed = false;
    if (enabled != m_loggingEnabled) changed = true;

    if (enabled)
lm's avatar
lm committed
427
    {
428
        if (m_logfile && m_logfile->isOpen())
429 430 431 432
        {
            m_logfile->flush();
            m_logfile->close();
        }
433
        if (m_logfile)
434
        {
435 436
            if (!m_logfile->open(QIODevice::WriteOnly | QIODevice::Append))
            {
437 438
                emit protocolStatusMessage(tr("Opening MAVLink logfile for writing failed"), tr("MAVLink cannot log to the file %1, please choose a different file. Stopping logging.").arg(m_logfile->fileName()));
                m_loggingEnabled = false;
439
            }
440
        }
lm's avatar
lm committed
441
    }
442
    else if (!enabled)
lm's avatar
lm committed
443
    {
444 445
        if (m_logfile)
        {
446 447 448 449 450
            if (m_logfile->isOpen())
            {
                m_logfile->flush();
                m_logfile->close();
            }
451 452 453
            delete m_logfile;
            m_logfile = NULL;
        }
lm's avatar
lm committed
454 455
    }
    m_loggingEnabled = enabled;
456
    if (changed) emit loggingChanged(enabled);
457 458 459 460
}

void MAVLinkProtocol::setLogfileName(const QString& filename)
{
461 462 463 464 465 466 467 468 469
    if (!m_logfile)
    {
        m_logfile = new QFile(filename);
    }
    else
    {
        m_logfile->flush();
        m_logfile->close();
    }
470
    m_logfile->setFileName(filename);
471
    enableLogging(m_loggingEnabled);
lm's avatar
lm committed
472 473
}

lm's avatar
lm committed
474 475 476
void MAVLinkProtocol::enableVersionCheck(bool enabled)
{
    m_enable_version_check = enabled;
477
    emit versionCheckChanged(enabled);
lm's avatar
lm committed
478 479
}

pixhawk's avatar
pixhawk committed
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
/**
 * The default rate is 1 Hertz.
 *
 * @param rate heartbeat rate in hertz (times per second)
 */
void MAVLinkProtocol::setHeartbeatRate(int rate)
{
    heartbeatRate = rate;
    heartbeatTimer->setInterval(1000/heartbeatRate);
}

/** @return heartbeat rate in Hertz */
int MAVLinkProtocol::getHeartbeatRate()
{
    return heartbeatRate;
}