MAVLinkProtocol.cc 25.6 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>
16
#include <QSettings>
17
#include <QStandardPaths>
18
#include <QtEndian>
19
#include <QMetaType>
pixhawk's avatar
pixhawk committed
20 21 22 23 24 25

#include "MAVLinkProtocol.h"
#include "UASInterface.h"
#include "UASInterface.h"
#include "UAS.h"
#include "LinkManager.h"
26
#include "QGCMAVLink.h"
27
#include "QGC.h"
Don Gagne's avatar
Don Gagne committed
28
#include "QGCApplication.h"
29
#include "QGCLoggingCategory.h"
30
#include "MultiVehicleManager.h"
pixhawk's avatar
pixhawk committed
31

32
Q_DECLARE_METATYPE(mavlink_message_t)
33

34
QGC_LOGGING_CATEGORY(MAVLinkProtocolLog, "MAVLinkProtocolLog")
35

Don Gagne's avatar
Don Gagne committed
36
#ifndef __mobile__
Don Gagne's avatar
Don Gagne committed
37 38
const char* MAVLinkProtocol::_tempLogFileTemplate = "FlightDataXXXXXX"; ///< Template for temporary log file
const char* MAVLinkProtocol::_logFileExtension = "mavlink";             ///< Extension for log files
Don Gagne's avatar
Don Gagne committed
39
#endif
Don Gagne's avatar
Don Gagne committed
40

pixhawk's avatar
pixhawk committed
41 42 43 44
/**
 * The default constructor will create a new MAVLink object sending heartbeats at
 * the MAVLINK_HEARTBEAT_DEFAULT_RATE to all connected links.
 */
45 46 47 48 49 50 51 52 53 54 55 56
MAVLinkProtocol::MAVLinkProtocol(QGCApplication* app)
    : QGCTool(app)
    , m_multiplexingEnabled(false)
    , m_authEnabled(false)
    , m_enable_version_check(true)
    , m_paramRetransmissionTimeout(350)
    , m_paramRewriteTimeout(500)
    , m_paramGuardEnabled(true)
    , m_actionGuardEnabled(false)
    , m_actionRetransmissionTimeout(100)
    , versionMismatchIgnore(false)
    , systemId(QGC::defaultSystemId)
Don Gagne's avatar
Don Gagne committed
57
#ifndef __mobile__
58 59 60 61
    , _logSuspendError(false)
    , _logSuspendReplay(false)
    , _logWasArmed(false)
    , _tempLogFile(QString("%2.%3").arg(_tempLogFileTemplate).arg(_logFileExtension))
Don Gagne's avatar
Don Gagne committed
62
#endif
63 64 65 66
    , _heartbeatRate(MAVLINK_HEARTBEAT_DEFAULT_RATE)
    , _heartbeatsEnabled(true)
    , _linkMgr(NULL)
    , _multiVehicleManager(NULL)
pixhawk's avatar
pixhawk committed
67
{
68

pixhawk's avatar
pixhawk committed
69 70
}

71 72 73 74
MAVLinkProtocol::~MAVLinkProtocol()
{
    storeSettings();
    
Don Gagne's avatar
Don Gagne committed
75
#ifndef __mobile__
76
    _closeLogFile();
Don Gagne's avatar
Don Gagne committed
77
#endif
78 79
}

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
void MAVLinkProtocol::setToolbox(QGCToolbox *toolbox)
{
   QGCTool::setToolbox(toolbox);

   _linkMgr =               _toolbox->linkManager();
   _multiVehicleManager =   _toolbox->multiVehicleManager();

   qRegisterMetaType<mavlink_message_t>("mavlink_message_t");

   m_authKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
   loadSettings();

   // All the *Counter variables are not initialized here, as they should be initialized
   // on a per-link basis before those links are used. @see resetMetadataForLink().

   // Initialize the list for tracking dropped messages to invalid.
   for (int i = 0; i < 256; i++)
   {
       for (int j = 0; j < 256; j++)
       {
           lastIndex[i][j] = -1;
       }
   }

   // Start heartbeat timer, emitting a heartbeat at the configured rate
   connect(&_heartbeatTimer, &QTimer::timeout, this, &MAVLinkProtocol::sendHeartbeat);
   _heartbeatTimer.start(1000/_heartbeatRate);

   connect(this, &MAVLinkProtocol::protocolStatusMessage, _app, &QGCApplication::criticalMessageBoxOnMainThread);
   connect(this, &MAVLinkProtocol::saveTempFlightDataLog, _app, &QGCApplication::saveTempFlightDataLogOnMainThread);

   emit versionCheckChanged(m_enable_version_check);
}

114 115 116 117 118
void MAVLinkProtocol::loadSettings()
{
    // Load defaults from settings
    QSettings settings;
    settings.beginGroup("QGC_MAVLINK_PROTOCOL");
119
    enableHeartbeats(settings.value("HEARTBEATS_ENABLED", _heartbeatsEnabled).toBool());
120 121
    enableVersionCheck(settings.value("VERSION_CHECK_ENABLED", m_enable_version_check).toBool());
    enableMultiplexing(settings.value("MULTIPLEXING_ENABLED", m_multiplexingEnabled).toBool());
122 123 124

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

130 131 132 133
    // Set auth key
    m_authKey = settings.value("GCS_AUTH_KEY", m_authKey).toString();
    enableAuth(settings.value("GCS_AUTH_ENABLED", m_authEnabled).toBool());

134 135 136 137 138 139 140
    // Parameter interface settings
    bool ok;
    temp = settings.value("PARAMETER_RETRANSMISSION_TIMEOUT", m_paramRetransmissionTimeout).toInt(&ok);
    if (ok) m_paramRetransmissionTimeout = temp;
    temp = settings.value("PARAMETER_REWRITE_TIMEOUT", m_paramRewriteTimeout).toInt(&ok);
    if (ok) m_paramRewriteTimeout = temp;
    m_paramGuardEnabled = settings.value("PARAMETER_TRANSMISSION_GUARD_ENABLED", m_paramGuardEnabled).toBool();
141 142 143 144 145 146 147 148
    settings.endGroup();
}

void MAVLinkProtocol::storeSettings()
{
    // Store settings
    QSettings settings;
    settings.beginGroup("QGC_MAVLINK_PROTOCOL");
149
    settings.setValue("HEARTBEATS_ENABLED", _heartbeatsEnabled);
150 151
    settings.setValue("VERSION_CHECK_ENABLED", m_enable_version_check);
    settings.setValue("MULTIPLEXING_ENABLED", m_multiplexingEnabled);
152
    settings.setValue("GCS_SYSTEM_ID", systemId);
153 154
    settings.setValue("GCS_AUTH_KEY", m_authKey);
    settings.setValue("GCS_AUTH_ENABLED", m_authEnabled);
155 156 157 158
    // Parameter interface settings
    settings.setValue("PARAMETER_RETRANSMISSION_TIMEOUT", m_paramRetransmissionTimeout);
    settings.setValue("PARAMETER_REWRITE_TIMEOUT", m_paramRewriteTimeout);
    settings.setValue("PARAMETER_TRANSMISSION_GUARD_ENABLED", m_paramGuardEnabled);
159 160 161
    settings.endGroup();
}

162 163
void MAVLinkProtocol::resetMetadataForLink(const LinkInterface *link)
{
164 165 166 167 168 169
    int channel = link->getMavlinkChannel();
    totalReceiveCounter[channel] = 0;
    totalLossCounter[channel] = 0;
    totalErrorCounter[channel] = 0;
    currReceiveCounter[channel] = 0;
    currLossCounter[channel] = 0;
170 171
}

172
void MAVLinkProtocol::linkConnected(void)
173 174
{
    LinkInterface* link = qobject_cast<LinkInterface*>(QObject::sender());
175
    Q_ASSERT(link);
Don Gagne's avatar
Don Gagne committed
176
    
177 178 179 180 181 182 183 184 185 186 187 188 189
    _linkStatusChanged(link, true);
}

void MAVLinkProtocol::linkDisconnected(void)
{
    LinkInterface* link = qobject_cast<LinkInterface*>(QObject::sender());
    Q_ASSERT(link);
    
    _linkStatusChanged(link, false);
}

void MAVLinkProtocol::_linkStatusChanged(LinkInterface* link, bool connected)
{
190
    qCDebug(MAVLinkProtocolLog) << "_linkStatusChanged" << QString("%1").arg((long)link, 0, 16) << connected;
191
    Q_ASSERT(link);
Don Gagne's avatar
Don Gagne committed
192 193
    
    if (connected) {
194 195 196 197 198
        foreach (SharedLinkInterface sharedLink, _connectedLinks) {
            Q_ASSERT(sharedLink.data() != link);
        }
        
        // Use the same shared pointer as LinkManager
199
        _connectedLinks.append(_linkMgr->sharedPointerForLink(link));
Don Gagne's avatar
Don Gagne committed
200
        
201 202 203 204 205 206 207
#ifndef __mobile__
        if (_connectedLinks.count() == 1) {
            // This is the first link, we need to start logging
            _startLogging();
        }
#endif
        
Don Gagne's avatar
Don Gagne committed
208 209 210
        // Send command to start MAVLink
        // XXX hacky but safe
        // Start NSH
Daniel Agar's avatar
Daniel Agar committed
211
        const char init[] = {0x0d, 0x0d, 0x0d, 0x0d};
Don Gagne's avatar
Don Gagne committed
212 213 214 215 216
        link->writeBytes(init, sizeof(init));
        const char* cmd = "sh /etc/init.d/rc.usb\n";
        link->writeBytes(cmd, strlen(cmd));
        link->writeBytes(init, 4);
    } else {
217 218 219 220 221 222 223 224
        bool found = false;
        for (int i=0; i<_connectedLinks.count(); i++) {
            if (_connectedLinks[i].data() == link) {
                found = true;
                _connectedLinks.removeAt(i);
                break;
            }
        }
225
        Q_UNUSED(found);
226
        Q_ASSERT(found);
Don Gagne's avatar
Don Gagne committed
227
        
Don Gagne's avatar
Don Gagne committed
228
#ifndef __mobile__
Don Gagne's avatar
Don Gagne committed
229 230 231 232
        if (_connectedLinks.count() == 0) {
            // Last link is gone, close out logging
            _stopLogging();
        }
Don Gagne's avatar
Don Gagne committed
233
#endif
Don Gagne's avatar
Don Gagne committed
234
    }
235 236
}

pixhawk's avatar
pixhawk committed
237 238 239 240 241 242 243
/**
 * 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
 **/
244
void MAVLinkProtocol::receiveBytes(LinkInterface* link, QByteArray b)
pixhawk's avatar
pixhawk committed
245
{
Don Gagne's avatar
Don Gagne committed
246 247 248
    // Since receiveBytes signals cross threads we can end up with signals in the queue
    // that come through after the link is disconnected. For these we just drop the data
    // since the link is closed.
249
    if (!_linkMgr->containsLink(link)) {
Don Gagne's avatar
Don Gagne committed
250 251 252
        return;
    }
    
253
//    receiveMutex.lock();
pixhawk's avatar
pixhawk committed
254 255
    mavlink_message_t message;
    mavlink_status_t status;
256

257
    int mavlinkChannel = link->getMavlinkChannel();
258

259
    static int mavlink09Count = 0;
260
    static int nonmavlinkCount = 0;
261
    static bool decodedFirstPacket = false;
262
    static bool warnedUser = false;
263 264
    static bool checkedUserNonMavlink = false;
    static bool warnedUserNonMavlink = false;
265

266
    for (int position = 0; position < b.size(); position++) {
267
        unsigned int decodeState = mavlink_parse_char(mavlinkChannel, (uint8_t)(b[position]), &message, &status);
268 269

        if ((uint8_t)b[position] == 0x55) mavlink09Count++;
270
        if ((mavlink09Count > 100) && !decodedFirstPacket && !warnedUser)
271
        {
272
            warnedUser = true;
273 274
            // Obviously the user tries to use a 0.9 autopilot
            // with QGroundControl built for version 1.0
275 276 277 278
            emit protocolStatusMessage(tr("MAVLink Protocol"), tr("There is a MAVLink Version or Baud Rate Mismatch. "
                                                                  "Your MAVLink device seems to use the deprecated version 0.9, while QGroundControl only supports version 1.0+. "
                                                                  "Please upgrade the MAVLink version of your autopilot. "
                                                                  "If your autopilot is using version 1.0, check if the baud rates of QGroundControl and your autopilot are the same."));
279
        }
pixhawk's avatar
pixhawk committed
280

281 282 283
        if (decodeState == 0 && !decodedFirstPacket)
        {
            nonmavlinkCount++;
284
            if (nonmavlinkCount > 2000 && !warnedUserNonMavlink)
285
            {
286
                //2000 bytes with no mavlink message. Are we connected to a mavlink capable device?
287 288 289 290 291 292 293 294
                if (!checkedUserNonMavlink)
                {
                    link->requestReset();
                    checkedUserNonMavlink = true;
                }
                else
                {
                    warnedUserNonMavlink = true;
295 296
                    emit protocolStatusMessage(tr("MAVLink Protocol"), tr("There is a MAVLink Version or Baud Rate Mismatch. "
                                                                          "Please check if the baud rates of QGroundControl and your autopilot are the same."));
297 298 299
                }
            }
        }
300 301
        if (decodeState == 1)
        {
302
            decodedFirstPacket = true;
303 304 305 306 307 308 309 310 311 312 313 314 315 316

            if(message.msgid == MAVLINK_MSG_ID_PING)
            {
                // process ping requests (tgt_system and tgt_comp must be zero)
                mavlink_ping_t ping;
                mavlink_msg_ping_decode(&message, &ping);
                if(!ping.target_system && !ping.target_component)
                {
                    mavlink_message_t msg;
                    mavlink_msg_ping_pack(getSystemId(), getComponentId(), &msg, ping.time_usec, ping.seq, message.sysid, message.compid);
                    sendMessage(msg);
                }
            }

317 318 319 320 321 322 323 324 325 326
            if(message.msgid == MAVLINK_MSG_ID_RADIO_STATUS)
            {
                // process telemetry status message
                mavlink_radio_status_t rstatus;
                mavlink_msg_radio_status_decode(&message, &rstatus);

                emit radioStatusChanged(link, rstatus.rxerrors, rstatus.fixed, rstatus.rssi, rstatus.remrssi,
                    rstatus.txbuf, rstatus.noise, rstatus.remnoise);
            }

Don Gagne's avatar
Don Gagne committed
327
#ifndef __mobile__
pixhawk's avatar
pixhawk committed
328
            // Log data
Don Gagne's avatar
Don Gagne committed
329
            
Don Gagne's avatar
Don Gagne committed
330
            if (!_logSuspendError && !_logSuspendReplay && _tempLogFile.isOpen()) {
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
                uint8_t buf[MAVLINK_MAX_PACKET_LEN+sizeof(quint64)];

                // Write the uint64 time in microseconds in big endian format before the message.
                // This timestamp is saved in UTC time. We are only saving in ms precision because
                // getting more than this isn't possible with Qt without a ton of extra code.
                quint64 time = (quint64)QDateTime::currentMSecsSinceEpoch() * 1000;
                qToBigEndian(time, buf);

                // Then write the message to the buffer
                int len = mavlink_msg_to_send_buffer(buf + sizeof(quint64), &message);

                // Determine how many bytes were written by adding the timestamp size to the message size
                len += sizeof(quint64);

                // Now write this timestamp/message pair to the log.
346
                QByteArray b((const char*)buf, len);
Don Gagne's avatar
Don Gagne committed
347
                if(_tempLogFile.write(b) != len)
348
                {
349
                    // If there's an error logging data, raise an alert and stop logging.
350
                    emit protocolStatusMessage(tr("MAVLink Protocol"), tr("MAVLink Logging failed. Could not write to file %1, logging disabled.").arg(_tempLogFile.fileName()));
Don Gagne's avatar
Don Gagne committed
351 352
                    _stopLogging();
                    _logSuspendError = true;
353
                }
Don Gagne's avatar
Don Gagne committed
354 355 356 357 358 359 360 361 362
                
                // Check for the vehicle arming going by. This is used to trigger log save.
                if (!_logWasArmed && message.msgid == MAVLINK_MSG_ID_HEARTBEAT) {
                    mavlink_heartbeat_t state;
                    mavlink_msg_heartbeat_decode(&message, &state);
                    if (state.base_mode & MAV_MODE_FLAG_DECODE_POSITION_SAFETY) {
                        _logWasArmed = true;
                    }
                }
pixhawk's avatar
pixhawk committed
363
            }
Don Gagne's avatar
Don Gagne committed
364
#endif
pixhawk's avatar
pixhawk committed
365

366 367
            if (message.msgid == MAVLINK_MSG_ID_HEARTBEAT) {
                // Notify the vehicle manager of the heartbeat. This will create/update vehicles as needed.
368 369
                mavlink_heartbeat_t heartbeat;
                mavlink_msg_heartbeat_decode(&message, &heartbeat);
370
                if (!_multiVehicleManager->notifyHeartbeatInfo(link, message.sysid, heartbeat)) {
pixhawk's avatar
pixhawk committed
371 372
                    continue;
                }
pixhawk's avatar
pixhawk committed
373
            }
374

375
            // Increase receive counter
376 377
            totalReceiveCounter[mavlinkChannel]++;
            currReceiveCounter[mavlinkChannel]++;
378

379 380 381 382
            // Determine what the next expected sequence number is, accounting for
            // never having seen a message for this system/component pair.
            int lastSeq = lastIndex[message.sysid][message.compid];
            int expectedSeq = (lastSeq == -1) ? message.seq : (lastSeq + 1);
383

384 385 386
            // And if we didn't encounter that sequence number, record the error
            if (message.seq != expectedSeq)
            {
387

388 389
                // Determine how many messages were skipped
                int lostMessages = message.seq - expectedSeq;
390

391 392 393 394 395
                // Out of order messages or wraparound can cause this, but we just ignore these conditions for simplicity
                if (lostMessages < 0)
                {
                    lostMessages = 0;
                }
396

397
                // And log how many were lost for all time and just this timestep
398 399
                totalLossCounter[mavlinkChannel] += lostMessages;
                currLossCounter[mavlinkChannel] += lostMessages;
400
            }
401

402 403
            // And update the last sequence number for this system/component pair
            lastIndex[message.sysid][message.compid] = expectedSeq;
404

405
            // Update on every 32th packet
406
            if ((totalReceiveCounter[mavlinkChannel] & 0x1F) == 0)
407 408 409
            {
                // Calculate new loss ratio
                // Receive loss
410
                float receiveLoss = (double)currLossCounter[mavlinkChannel]/(double)(currReceiveCounter[mavlinkChannel]+currLossCounter[mavlinkChannel]);
411
                receiveLoss *= 100.0f;
412 413
                currLossCounter[mavlinkChannel] = 0;
                currReceiveCounter[mavlinkChannel] = 0;
414 415
                emit receiveLossChanged(message.sysid, receiveLoss);
            }
416

417 418 419 420
            // 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);
lm's avatar
lm committed
421

422 423 424 425
            // Multiplex message if enabled
            if (m_multiplexingEnabled)
            {
                // Get all links connected to this unit
426
                QList<LinkInterface*> links = _linkMgr->getLinks();
427

428 429
                // Emit message on all links that are currently connected
                foreach (LinkInterface* currLink, links)
430
                {
431 432 433
                    // Only forward this message to the other links,
                    // not the link the message was received on
                    if (currLink != link) sendMessage(currLink, message, message.sysid, message.compid);
434
                }
435
            }
pixhawk's avatar
pixhawk committed
436 437 438 439 440 441 442 443 444 445 446 447
        }
    }
}

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

448
/** @return System id of this application */
449
int MAVLinkProtocol::getSystemId()
450
{
451 452 453 454 455 456
    return systemId;
}

void MAVLinkProtocol::setSystemId(int id)
{
    systemId = id;
457 458 459
}

/** @return Component id of this application */
460
int MAVLinkProtocol::getComponentId()
461
{
462
    return QGC::defaultComponentId;
463 464
}

pixhawk's avatar
pixhawk committed
465 466 467 468 469 470
/**
 * @param message message to send
 */
void MAVLinkProtocol::sendMessage(mavlink_message_t message)
{
    // Get all links connected to this unit
471
    QList<LinkInterface*> links = _linkMgr->getLinks();
pixhawk's avatar
pixhawk committed
472 473 474

    // Emit message on all links that are currently connected
    QList<LinkInterface*>::iterator i;
475 476
    for (i = links.begin(); i != links.end(); ++i)
    {
pixhawk's avatar
pixhawk committed
477
        sendMessage(*i, message);
478
//        qDebug() << __FILE__ << __LINE__ << "SENT MESSAGE OVER" << ((LinkInterface*)*i)->getName() << "LIST SIZE:" << links.size();
pixhawk's avatar
pixhawk committed
479 480 481 482 483 484 485 486 487 488
    }
}

/**
 * @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
Lorenz Meier's avatar
Lorenz Meier committed
489
    static uint8_t buffer[MAVLINK_MAX_PACKET_LEN];
490
    // Rewriting header to ensure correct link ID is set
lm's avatar
lm committed
491
    static uint8_t messageKeys[256] = MAVLINK_MESSAGE_CRCS;
492
    mavlink_finalize_message_chan(&message, this->getSystemId(), this->getComponentId(), link->getMavlinkChannel(), message.len, messageKeys[message.msgid]);
pixhawk's avatar
pixhawk committed
493
    // Write message into buffer, prepending start sign
pixhawk's avatar
pixhawk committed
494
    int len = mavlink_msg_to_send_buffer(buffer, &message);
pixhawk's avatar
pixhawk committed
495
    // If link is connected
496 497
    if (link->isConnected())
    {
pixhawk's avatar
pixhawk committed
498 499 500 501 502
        // Send the portion of the buffer now occupied by the message
        link->writeBytes((const char*)buffer, len);
    }
}

Lorenz Meier's avatar
Lorenz Meier committed
503 504 505 506 507 508 509 510 511 512 513 514
/**
 * @param link the link to send the message over
 * @param message message to send
 * @param systemid id of the system the message is originating from
 * @param componentid id of the component the message is originating from
 */
void MAVLinkProtocol::sendMessage(LinkInterface* link, mavlink_message_t message, quint8 systemid, quint8 componentid)
{
    // Create buffer
    static uint8_t buffer[MAVLINK_MAX_PACKET_LEN];
    // Rewriting header to ensure correct link ID is set
    static uint8_t messageKeys[256] = MAVLINK_MESSAGE_CRCS;
515
    mavlink_finalize_message_chan(&message, systemid, componentid, link->getMavlinkChannel(), message.len, messageKeys[message.msgid]);
Lorenz Meier's avatar
Lorenz Meier committed
516 517 518 519 520 521 522 523 524 525
    // Write message into buffer, prepending start sign
    int len = mavlink_msg_to_send_buffer(buffer, &message);
    // If link is connected
    if (link->isConnected())
    {
        // Send the portion of the buffer now occupied by the message
        link->writeBytes((const char*)buffer, len);
    }
}

pixhawk's avatar
pixhawk committed
526 527 528 529 530 531 532
/**
 * 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()
{
533
    if (_heartbeatsEnabled)
Lorenz Meier's avatar
Lorenz Meier committed
534
    {
pixhawk's avatar
pixhawk committed
535
        mavlink_message_t beat;
lm's avatar
lm committed
536
        mavlink_msg_heartbeat_pack(getSystemId(), getComponentId(),&beat, MAV_TYPE_GCS, MAV_AUTOPILOT_INVALID, MAV_MODE_MANUAL_ARMED, 0, MAV_STATE_ACTIVE);
pixhawk's avatar
pixhawk committed
537 538
        sendMessage(beat);
    }
Lorenz Meier's avatar
Lorenz Meier committed
539 540
    if (m_authEnabled)
    {
James Goppert's avatar
James Goppert committed
541 542
        mavlink_message_t msg;
        mavlink_auth_key_t auth;
543
        memset(&auth, 0, sizeof(auth));
544
        memcpy(auth.key, m_authKey.toStdString().c_str(), qMin(m_authKey.length(), MAVLINK_MSG_AUTH_KEY_FIELD_KEY_LEN));
James Goppert's avatar
James Goppert committed
545 546 547
        mavlink_msg_auth_key_encode(getSystemId(), getComponentId(), &msg, &auth);
        sendMessage(msg);
    }
pixhawk's avatar
pixhawk committed
548 549
}

550
/** @param enabled true to enable heartbeats emission at _heartbeatRate, false to disable */
pixhawk's avatar
pixhawk committed
551 552
void MAVLinkProtocol::enableHeartbeats(bool enabled)
{
553
    _heartbeatsEnabled = enabled;
pixhawk's avatar
pixhawk committed
554 555 556
    emit heartbeatChanged(enabled);
}

557 558 559 560 561 562 563 564 565
void MAVLinkProtocol::enableMultiplexing(bool enabled)
{
    bool changed = false;
    if (enabled != m_multiplexingEnabled) changed = true;

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

566 567 568 569
void MAVLinkProtocol::enableAuth(bool enable)
{
    bool changed = false;
    m_authEnabled = enable;
570
    if (m_authEnabled != enable) {
571 572 573 574 575
        changed = true;
    }
    if (changed) emit authChanged(m_authEnabled);
}

576 577
void MAVLinkProtocol::enableParamGuard(bool enabled)
{
578
    if (enabled != m_paramGuardEnabled) {
579 580 581 582 583
        m_paramGuardEnabled = enabled;
        emit paramGuardChanged(m_paramGuardEnabled);
    }
}

584 585
void MAVLinkProtocol::enableActionGuard(bool enabled)
{
586
    if (enabled != m_actionGuardEnabled) {
587 588 589 590 591
        m_actionGuardEnabled = enabled;
        emit actionGuardChanged(m_actionGuardEnabled);
    }
}

592 593
void MAVLinkProtocol::setParamRetransmissionTimeout(int ms)
{
594
    if (ms != m_paramRetransmissionTimeout) {
595 596 597 598 599 600 601
        m_paramRetransmissionTimeout = ms;
        emit paramRetransmissionTimeoutChanged(m_paramRetransmissionTimeout);
    }
}

void MAVLinkProtocol::setParamRewriteTimeout(int ms)
{
602
    if (ms != m_paramRewriteTimeout) {
603 604 605 606 607
        m_paramRewriteTimeout = ms;
        emit paramRewriteTimeoutChanged(m_paramRewriteTimeout);
    }
}

608 609
void MAVLinkProtocol::setActionRetransmissionTimeout(int ms)
{
610
    if (ms != m_actionRetransmissionTimeout) {
611 612 613 614 615
        m_actionRetransmissionTimeout = ms;
        emit actionRetransmissionTimeoutChanged(m_actionRetransmissionTimeout);
    }
}

lm's avatar
lm committed
616 617 618
void MAVLinkProtocol::enableVersionCheck(bool enabled)
{
    m_enable_version_check = enabled;
619
    emit versionCheckChanged(enabled);
lm's avatar
lm committed
620 621
}

pixhawk's avatar
pixhawk committed
622 623 624 625 626 627 628
/**
 * The default rate is 1 Hertz.
 *
 * @param rate heartbeat rate in hertz (times per second)
 */
void MAVLinkProtocol::setHeartbeatRate(int rate)
{
629 630
    _heartbeatRate = rate;
    _heartbeatTimer.setInterval(1000/_heartbeatRate);
pixhawk's avatar
pixhawk committed
631 632 633 634 635
}

/** @return heartbeat rate in Hertz */
int MAVLinkProtocol::getHeartbeatRate()
{
636
    return _heartbeatRate;
pixhawk's avatar
pixhawk committed
637
}
Don Gagne's avatar
Don Gagne committed
638

Don Gagne's avatar
Don Gagne committed
639
#ifndef __mobile__
Don Gagne's avatar
Don Gagne committed
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
/// @brief Closes the log file if it is open
bool MAVLinkProtocol::_closeLogFile(void)
{
    if (_tempLogFile.isOpen()) {
        if (_tempLogFile.size() == 0) {
            // Don't save zero byte files
            _tempLogFile.remove();
            return false;
        } else {
            _tempLogFile.flush();
            _tempLogFile.close();
            return true;
        }
    }
    
    return false;
}

void MAVLinkProtocol::_startLogging(void)
{
660 661 662 663 664 665 666 667 668
    Q_ASSERT(!_tempLogFile.isOpen());

    if (!_logSuspendReplay) {
        if (!_tempLogFile.open()) {
            emit protocolStatusMessage(tr("MAVLink Protocol"), tr("Opening Flight Data file for writing failed. "
                                                                  "Unable to write to %1. Please choose a different file location.").arg(_tempLogFile.fileName()));
            _closeLogFile();
            _logSuspendError = true;
            return;
Don Gagne's avatar
Don Gagne committed
669
        }
670 671 672 673
    
        qDebug() << "Temp log" << _tempLogFile.fileName();
        
        _logSuspendError = false;
Don Gagne's avatar
Don Gagne committed
674 675 676 677 678 679
    }
}

void MAVLinkProtocol::_stopLogging(void)
{
    if (_closeLogFile()) {
680
        // If the signals are not connected it means we are running a unit test. In that case just delete log files
681
        if (_logWasArmed && _app->promptFlightDataSave()) {
682 683 684 685
            emit saveTempFlightDataLog(_tempLogFile.fileName());
        } else {
            QFile::remove(_tempLogFile.fileName());
        }
Don Gagne's avatar
Don Gagne committed
686
    }
Don Gagne's avatar
Don Gagne committed
687
    _logWasArmed = false;
Don Gagne's avatar
Don Gagne committed
688 689 690 691 692
}

/// @brief Checks the temp directory for log files which may have been left there.
///         This could happen if QGC crashes without the temp log file being saved.
///         Give the user an option to save these orphaned files.
693
void MAVLinkProtocol::checkForLostLogFiles(void)
Don Gagne's avatar
Don Gagne committed
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
{
    QDir tempDir(QStandardPaths::writableLocation(QStandardPaths::TempLocation));
    
    QString filter(QString("*.%1").arg(_logFileExtension));
    QFileInfoList fileInfoList = tempDir.entryInfoList(QStringList(filter), QDir::Files);
    qDebug() << "Orphaned log file count" << fileInfoList.count();
    
    foreach(const QFileInfo fileInfo, fileInfoList) {
        qDebug() << "Orphaned log file" << fileInfo.filePath();
        if (fileInfo.size() == 0) {
            // Delete all zero length files
            QFile::remove(fileInfo.filePath());
            continue;
        }

        // Give the user a chance to save the orphaned log file
        emit protocolStatusMessage(tr("Found unsaved Flight Data"),
                                   tr("This can happen if QGroundControl crashes during Flight Data collection. "
                                      "If you want to save the unsaved Flight Data, select the file you want to save it to. "
                                      "If you do not want to keep the Flight Data, select 'Cancel' on the next dialog."));
        emit saveTempFlightDataLog(fileInfo.filePath());
    }
}

void MAVLinkProtocol::suspendLogForReplay(bool suspend)
{
    _logSuspendReplay = suspend;
}
722 723 724 725 726 727 728 729 730 731 732 733

void MAVLinkProtocol::deleteTempLogFiles(void)
{
    QDir tempDir(QStandardPaths::writableLocation(QStandardPaths::TempLocation));
    
    QString filter(QString("*.%1").arg(_logFileExtension));
    QFileInfoList fileInfoList = tempDir.entryInfoList(QStringList(filter), QDir::Files);
    
    foreach(const QFileInfo fileInfo, fileInfoList) {
        QFile::remove(fileInfo.filePath());
    }
}
Don Gagne's avatar
Don Gagne committed
734
#endif