MAVLinkProtocol.cc 26.8 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 26 27

#include "MAVLinkProtocol.h"
#include "UASInterface.h"
#include "UASManager.h"
#include "UASInterface.h"
#include "UAS.h"
#include "configuration.h"
#include "LinkManager.h"
28 29
#include "QGCMAVLink.h"
#include "QGCMAVLinkUASFactory.h"
30
#include "QGC.h"
Don Gagne's avatar
Don Gagne committed
31
#include "QGCApplication.h"
pixhawk's avatar
pixhawk committed
32

33
Q_DECLARE_METATYPE(mavlink_message_t)
34 35
IMPLEMENT_QGC_SINGLETON(MAVLinkProtocol, MAVLinkProtocol)
Q_LOGGING_CATEGORY(MAVLinkProtocolLog, "MAVLinkProtocolLog")
36

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

pixhawk's avatar
pixhawk committed
40 41 42 43
/**
 * The default constructor will create a new MAVLink object sending heartbeats at
 * the MAVLINK_HEARTBEAT_DEFAULT_RATE to all connected links.
 */
44 45
MAVLinkProtocol::MAVLinkProtocol(QObject* parent) :
    QGCSingleton(parent),
46 47 48 49 50 51 52 53 54
    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),
55
    systemId(QGC::defaultSystemId),
Don Gagne's avatar
Don Gagne committed
56 57
    _logSuspendError(false),
    _logSuspendReplay(false),
58
    _tempLogFile(QString("%2.%3").arg(_tempLogFileTemplate).arg(_logFileExtension)),
Don Gagne's avatar
Don Gagne committed
59
    _protocolStatusMessageConnected(false),
60
    _saveTempFlightDataLogConnected(false),
61 62 63
    _linkMgr(LinkManager::instance()),
    _heartbeatRate(MAVLINK_HEARTBEAT_DEFAULT_RATE),
    _heartbeatsEnabled(true)
pixhawk's avatar
pixhawk committed
64
{
65
    qRegisterMetaType<mavlink_message_t>("mavlink_message_t");
Don Gagne's avatar
Don Gagne committed
66
    
67
    m_authKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
68
    loadSettings();
69 70 71 72 73

    // 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.
74 75 76 77
    for (int i = 0; i < 256; i++)
    {
        for (int j = 0; j < 256; j++)
        {
lm's avatar
lm committed
78 79 80
            lastIndex[i][j] = -1;
        }
    }
81 82 83 84
    
    // Start heartbeat timer, emitting a heartbeat at the configured rate
    connect(&_heartbeatTimer, &QTimer::timeout, this, &MAVLinkProtocol::sendHeartbeat);
    _heartbeatTimer.start(1000/_heartbeatRate);
Lorenz Meier's avatar
Lorenz Meier committed
85

lm's avatar
lm committed
86
    emit versionCheckChanged(m_enable_version_check);
pixhawk's avatar
pixhawk committed
87 88
}

89 90 91 92 93 94 95
MAVLinkProtocol::~MAVLinkProtocol()
{
    storeSettings();
    
    _closeLogFile();
}

96 97 98 99 100
void MAVLinkProtocol::loadSettings()
{
    // Load defaults from settings
    QSettings settings;
    settings.beginGroup("QGC_MAVLINK_PROTOCOL");
101
    enableHeartbeats(settings.value("HEARTBEATS_ENABLED", _heartbeatsEnabled).toBool());
102 103
    enableVersionCheck(settings.value("VERSION_CHECK_ENABLED", m_enable_version_check).toBool());
    enableMultiplexing(settings.value("MULTIPLEXING_ENABLED", m_multiplexingEnabled).toBool());
104 105 106

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

112 113 114 115
    // Set auth key
    m_authKey = settings.value("GCS_AUTH_KEY", m_authKey).toString();
    enableAuth(settings.value("GCS_AUTH_ENABLED", m_authEnabled).toBool());

116 117 118 119 120 121 122
    // 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();
123 124 125 126 127 128 129 130
    settings.endGroup();
}

void MAVLinkProtocol::storeSettings()
{
    // Store settings
    QSettings settings;
    settings.beginGroup("QGC_MAVLINK_PROTOCOL");
131
    settings.setValue("HEARTBEATS_ENABLED", _heartbeatsEnabled);
132 133
    settings.setValue("VERSION_CHECK_ENABLED", m_enable_version_check);
    settings.setValue("MULTIPLEXING_ENABLED", m_multiplexingEnabled);
134
    settings.setValue("GCS_SYSTEM_ID", systemId);
135 136
    settings.setValue("GCS_AUTH_KEY", m_authKey);
    settings.setValue("GCS_AUTH_ENABLED", m_authEnabled);
137 138 139 140
    // 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);
141 142 143
    settings.endGroup();
}

144 145 146 147 148 149 150 151 152 153
void MAVLinkProtocol::resetMetadataForLink(const LinkInterface *link)
{
    int linkId = link->getId();
    totalReceiveCounter[linkId] = 0;
    totalLossCounter[linkId] = 0;
    totalErrorCounter[linkId] = 0;
    currReceiveCounter[linkId] = 0;
    currLossCounter[linkId] = 0;
}

154
void MAVLinkProtocol::linkConnected(void)
155 156
{
    LinkInterface* link = qobject_cast<LinkInterface*>(QObject::sender());
157
    Q_ASSERT(link);
Don Gagne's avatar
Don Gagne committed
158
    
159 160 161 162 163 164 165 166 167 168 169 170 171
    _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)
{
172
    qCDebug(MAVLinkProtocolLog) << "_linkStatusChanged" << QString("%1").arg((long)link, 0, 16) << connected;
173
    Q_ASSERT(link);
Don Gagne's avatar
Don Gagne committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
    
    if (connected) {
        Q_ASSERT(!_connectedLinks.contains(link));
        _connectedLinks.append(link);
        
        if (_connectedLinks.count() == 1) {
            // This is the first link, we need to start logging
            _startLogging();
        }
        
        // Send command to start MAVLink
        // XXX hacky but safe
        // Start NSH
        const char init[] = {0x0d, 0x0d, 0x0d};
        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 {
        Q_ASSERT(_connectedLinks.contains(link));
        _connectedLinks.removeOne(link);
        
        if (_connectedLinks.count() == 0) {
            // Last link is gone, close out logging
            _stopLogging();
        }
    }
    
    // Track the links which are connected to the protocol
    QList<LinkInterface*> _connectedLinks;  ///< List of all links connected to protocol

205
    //qDebug() << "linkStatusChanged" << connected;
Don Gagne's avatar
Don Gagne committed
206
    
207 208 209 210 211 212 213

    if (link) {
        if (connected) {
        }
    }
}

pixhawk's avatar
pixhawk committed
214 215 216 217 218 219 220
/**
 * 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
 **/
221
void MAVLinkProtocol::receiveBytes(LinkInterface* link, QByteArray b)
pixhawk's avatar
pixhawk committed
222
{
223
//    receiveMutex.lock();
pixhawk's avatar
pixhawk committed
224 225
    mavlink_message_t message;
    mavlink_status_t status;
226

227 228 229
    // Cache the link ID for common use.
    int linkId = link->getId();

230
    static int mavlink09Count = 0;
231
    static int nonmavlinkCount = 0;
232
    static bool decodedFirstPacket = false;
233
    static bool warnedUser = false;
234 235
    static bool checkedUserNonMavlink = false;
    static bool warnedUserNonMavlink = false;
236

237
    // FIXME: Add check for if link->getId() >= MAVLINK_COMM_NUM_BUFFERS
238
    for (int position = 0; position < b.size(); position++) {
239
        unsigned int decodeState = mavlink_parse_char(linkId, (uint8_t)(b[position]), &message, &status);
240 241

        if ((uint8_t)b[position] == 0x55) mavlink09Count++;
242
        if ((mavlink09Count > 100) && !decodedFirstPacket && !warnedUser)
243
        {
244
            warnedUser = true;
245 246
            // Obviously the user tries to use a 0.9 autopilot
            // with QGroundControl built for version 1.0
247
            emit protocolStatusMessage("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.");
248
        }
pixhawk's avatar
pixhawk committed
249

250 251 252
        if (decodeState == 0 && !decodedFirstPacket)
        {
            nonmavlinkCount++;
253
            if (nonmavlinkCount > 2000 && !warnedUserNonMavlink)
254
            {
255
                //2000 bytes with no mavlink message. Are we connected to a mavlink capable device?
256 257 258 259 260 261 262 263 264 265 266 267
                if (!checkedUserNonMavlink)
                {
                    link->requestReset();
                    checkedUserNonMavlink = true;
                }
                else
                {
                    warnedUserNonMavlink = true;
                    emit protocolStatusMessage("MAVLink Baud Rate Mismatch", "Please check if the baud rates of QGroundControl and your autopilot are the same.");
                }
            }
        }
268 269
        if (decodeState == 1)
        {
270
            decodedFirstPacket = true;
271 272 273 274 275 276 277 278 279 280 281 282 283 284

            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);
                }
            }

285 286 287 288 289 290 291 292 293 294
            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);
            }

pixhawk's avatar
pixhawk committed
295
            // Log data
Don Gagne's avatar
Don Gagne committed
296 297 298 299
            
            Q_ASSERT(_logSuspendError || _logSuspendReplay || _tempLogFile.isOpen());
            
            if (!_logSuspendError && !_logSuspendReplay) {
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
                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.
315
                QByteArray b((const char*)buf, len);
Don Gagne's avatar
Don Gagne committed
316
                if(_tempLogFile.write(b) != len)
317
                {
318
                    // If there's an error logging data, raise an alert and stop logging.
Don Gagne's avatar
Don Gagne committed
319 320 321
                    emit protocolStatusMessage(tr("MAVLink Logging failed"), tr("Could not write to file %1, logging disabled.").arg(_tempLogFile.fileName()));
                    _stopLogging();
                    _logSuspendError = true;
322
                }
pixhawk's avatar
pixhawk committed
323 324
            }

pixhawk's avatar
pixhawk committed
325 326 327
            // ORDER MATTERS HERE!
            // If the matching UAS object does not yet exist, it has to be created
            // before emitting the packetReceived signal
328

pixhawk's avatar
pixhawk committed
329 330 331
            UASInterface* uas = UASManager::instance()->getUASForId(message.sysid);

            // Check and (if necessary) create UAS object
332 333
            if (uas == NULL && message.msgid == MAVLINK_MSG_ID_HEARTBEAT)
            {
pixhawk's avatar
pixhawk committed
334 335 336 337 338 339
                // 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
340
                // Check if the UAS has the same id like this system
341 342
                if (message.sysid == getSystemId())
                {
343
                    emit protocolStatusMessage(tr("SYSTEM ID CONFLICT!"), tr("Warning: A second system is using the same system id (%1)").arg(getSystemId()));
344 345
                }

346 347 348 349
                // 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
350
                // First create new UAS object
351 352
                // Decode heartbeat message
                mavlink_heartbeat_t heartbeat;
pixhawk's avatar
pixhawk committed
353 354
                // Reset version field to 0
                heartbeat.mavlink_version = 0;
355
                mavlink_msg_heartbeat_decode(&message, &heartbeat);
pixhawk's avatar
pixhawk committed
356 357

                // Check if the UAS has a different protocol version
358 359
                if (m_enable_version_check && (heartbeat.mavlink_version != MAVLINK_VERSION))
                {
pixhawk's avatar
pixhawk committed
360
                    // Bring up dialog to inform user
361 362
                    if (!versionMismatchIgnore)
                    {
363
                        emit protocolStatusMessage(tr("The MAVLink protocol version on the MAV and QGroundControl mismatch!"),
364
                                                   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));
365 366
                        versionMismatchIgnore = true;
                    }
pixhawk's avatar
pixhawk committed
367 368 369 370 371

                    // Ignore this message and continue gracefully
                    continue;
                }

372 373
                // Create a new UAS object
                uas = QGCMAVLinkUASFactory::createUAS(this, link, message.sysid, &heartbeat);
374

pixhawk's avatar
pixhawk committed
375
            }
376

377 378 379
            // Increase receive counter
            totalReceiveCounter[linkId]++;
            currReceiveCounter[linkId]++;
380

381 382 383 384
            // 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);
385

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

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

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

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

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

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

419 420 421 422
            // 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
423

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

430 431
                // Emit message on all links that are currently connected
                foreach (LinkInterface* currLink, links)
432
                {
433 434 435
                    // 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);
436
                }
437
            }
pixhawk's avatar
pixhawk committed
438 439 440 441 442 443 444 445 446 447 448 449
        }
    }
}

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

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

void MAVLinkProtocol::setSystemId(int id)
{
    systemId = id;
459 460 461
}

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

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

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

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

Lorenz Meier's avatar
Lorenz Meier committed
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
/**
 * @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;
    if (link->getId() != 0) mavlink_finalize_message_chan(&message, systemid, componentid, link->getId(), message.len, messageKeys[message.msgid]);
    // 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
528 529 530 531 532 533 534
/**
 * 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()
{
535
    if (_heartbeatsEnabled)
Lorenz Meier's avatar
Lorenz Meier committed
536
    {
pixhawk's avatar
pixhawk committed
537
        mavlink_message_t beat;
lm's avatar
lm committed
538
        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
539 540
        sendMessage(beat);
    }
Lorenz Meier's avatar
Lorenz Meier committed
541 542
    if (m_authEnabled)
    {
James Goppert's avatar
James Goppert committed
543 544
        mavlink_message_t msg;
        mavlink_auth_key_t auth;
545
        memset(&auth, 0, sizeof(auth));
546
        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
547 548 549
        mavlink_msg_auth_key_encode(getSystemId(), getComponentId(), &msg, &auth);
        sendMessage(msg);
    }
pixhawk's avatar
pixhawk committed
550 551
}

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

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

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

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

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

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

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

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

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

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

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

/** @return heartbeat rate in Hertz */
int MAVLinkProtocol::getHeartbeatRate()
{
638
    return _heartbeatRate;
pixhawk's avatar
pixhawk committed
639
}
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 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680

/// @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)
{
    Q_ASSERT(!_tempLogFile.isOpen());

    if (!_logSuspendReplay) {
        if (!_tempLogFile.open()) {
            emit protocolStatusMessage(tr("Opening Flight Data file for writing failed"),
                                       tr("Unable to write to %1. Please choose a different file location.").arg(_tempLogFile.fileName()));
            _closeLogFile();
            _logSuspendError = true;
            return;
        }
    
        qDebug() << "Temp log" << _tempLogFile.fileName();
        
        _logSuspendError = false;
    }
}

void MAVLinkProtocol::_stopLogging(void)
{
    if (_closeLogFile()) {
681 682
        // If the signals are not connected it means we are running a unit test. In that case just delete log files
        if (_protocolStatusMessageConnected && _saveTempFlightDataLogConnected && qgcApp()->promptFlightDataSave()) {
683 684 685 686
            emit saveTempFlightDataLog(_tempLogFile.fileName());
        } else {
            QFile::remove(_tempLogFile.fileName());
        }
Don Gagne's avatar
Don Gagne committed
687 688 689 690 691 692 693 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 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
    }
}

/// @brief We override this virtual from QObject so that we can track when the
///         protocolStatusMessage and saveTempFlightDataLog signals are connected.
///         Once both are connected we can check for lost log files.
void MAVLinkProtocol::connectNotify(const QMetaMethod& signal)
{
    if (signal == QMetaMethod::fromSignal(&MAVLinkProtocol::protocolStatusMessage)) {
        _protocolStatusMessageConnected = true;
        if (_saveTempFlightDataLogConnected) {
            _checkLostLogFiles();
        }
    } else if (signal == QMetaMethod::fromSignal(&MAVLinkProtocol::saveTempFlightDataLog)) {
        _saveTempFlightDataLogConnected = true;
        if (_protocolStatusMessageConnected) {
            _checkLostLogFiles();
        }
    }
}

/// @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.
void MAVLinkProtocol::_checkLostLogFiles(void)
{
    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;
}
740 741 742 743 744 745 746 747 748 749 750 751

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());
    }
}