QGCFlightGearLink.cc 40.7 KB
Newer Older
1 2 3 4 5 6 7 8
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/
9 10 11 12 13


/**
 * @file
 *   @brief Definition of UDP connection (server) for unmanned vehicles
lm's avatar
lm committed
14
 *   @see Flightgear Manual http://mapserver.flightgear.org/getstart.pdf
15
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
Thomas Gubler's avatar
Thomas Gubler committed
16
 *   @author Thomas Gubler <thomasgubler@student.ethz.ch>
17 18 19 20 21 22 23
 *
 */

#include <QTimer>
#include <QList>
#include <QDebug>
#include <QMutexLocker>
Don Gagne's avatar
Don Gagne committed
24
#include <QHostInfo>
Don Gagne's avatar
Don Gagne committed
25
#include <QMessageBox>
26
#include <QClipboard>
Don Gagne's avatar
Don Gagne committed
27

28
#include <iostream>
29
#include <Eigen/Eigen>
Don Gagne's avatar
Don Gagne committed
30

31 32
#include "QGCFlightGearLink.h"
#include "QGC.h"
Don Gagne's avatar
Don Gagne committed
33
#include "QGCFileDialog.h"
34
#include "QGCMessageBox.h"
35
#include "HomePositionManager.h"
36
#include "QGCApplication.h"
37 38
#include "Vehicle.h"
#include "UAS.h"
39

Don Gagne's avatar
Don Gagne committed
40
// FlightGear _fgProcess start and connection is quite fragile. Uncomment the define below to get higher level of debug output
Don Gagne's avatar
Don Gagne committed
41
// for tracking down problems.
Don Gagne's avatar
Don Gagne committed
42
//#define DEBUG_FLIGHTGEAR_CONNECT
Don Gagne's avatar
Don Gagne committed
43

44 45 46 47 48 49 50 51
QGCFlightGearLink::QGCFlightGearLink(Vehicle* vehicle, QString startupArguments, QString remoteHost, QHostAddress host, quint16 port)
    : _vehicle(vehicle)
    , _udpCommSocket(NULL)
    , _fgProcess(NULL)
    , flightGearVersion(3)
    , startupArguments(startupArguments)
    , _sensorHilEnabled(true)
    , barometerOffsetkPa(0.0f)
52
{
53 54 55 56
    // We're doing it wrong - because the Qt folks got the API wrong:
    // http://blog.qt.digia.com/blog/2010/06/17/youre-doing-it-wrong/
    moveToThread(this);

57
    this->host = host;
58
    this->port = port + _vehicle->id();
59
    this->connectState = false;
60
    this->currentPort = 49000 + _vehicle->id();
Don Gagne's avatar
Don Gagne committed
61
    this->name = tr("FlightGear 3.0+ Link (port:%1)").arg(port);
LM's avatar
LM committed
62
    setRemoteHost(remoteHost);
dogmaphobic's avatar
dogmaphobic committed
63

Don Gagne's avatar
Don Gagne committed
64
    // We need a mechanism so show error message from our FGLink thread on the UI thread. This signal connection will do that for us.
65
    connect(this, &QGCFlightGearLink::showCriticalMessageFromThread, qgcApp(), &QGCApplication::criticalMessageBoxOnMainThread);
66
    connect(this, &QGCFlightGearLink::disconnectSim, this, &QGCFlightGearLink::disconnectSimulation);
67 68 69
}

QGCFlightGearLink::~QGCFlightGearLink()
70
{   //do not disconnect unless it is connected.
Don Gagne's avatar
Don Gagne committed
71
    //disconnectSimulation will delete the memory that was allocated for proces, terraSync and _udpCommSocket
72 73 74
    if(connectState){
       disconnectSimulation();
    }
75 76
}

Don Gagne's avatar
Don Gagne committed
77
/// @brief Runs the simulation thread. We do setup work here which needs to happen in the seperate thread.
78 79
void QGCFlightGearLink::run()
{
80
    Q_ASSERT(_vehicle);
Don Gagne's avatar
Don Gagne committed
81
    Q_ASSERT(!_fgProcessName.isEmpty());
dogmaphobic's avatar
dogmaphobic committed
82

Don Gagne's avatar
Don Gagne committed
83 84 85 86
    // We communicate with FlightGear over a UDP _udpCommSocket
    _udpCommSocket = new QUdpSocket(this);
    Q_CHECK_PTR(_udpCommSocket);
    _udpCommSocket->moveToThread(this);
87
    _udpCommSocket->bind(host, port, QAbstractSocket::ReuseAddressHint);
88
    QObject::connect(_udpCommSocket, &QUdpSocket::readyRead, this, &QGCFlightGearLink::readBytes);
dogmaphobic's avatar
dogmaphobic committed
89 90


Don Gagne's avatar
Don Gagne committed
91
    // Connect to the various HIL signals that we use to then send information across the UDP protocol to FlightGear.
92 93 94 95 96 97
    connect(_vehicle->uas(), &UAS::hilControlsChanged, this, &QGCFlightGearLink::updateControls);

    connect(this, &QGCFlightGearLink::hilStateChanged, _vehicle->uas(), &UAS::sendHilState);
    connect(this, &QGCFlightGearLink::sensorHilGpsChanged, _vehicle->uas(), &UAS::sendHilGps);
    connect(this, &QGCFlightGearLink::sensorHilRawImuChanged, _vehicle->uas(), &UAS::sendHilSensors);
    connect(this, &QGCFlightGearLink::sensorHilOpticalFlowChanged, _vehicle->uas(), &UAS::sendHilOpticalFlow);
dogmaphobic's avatar
dogmaphobic committed
98

Don Gagne's avatar
Don Gagne committed
99 100 101 102
    // Start a new QProcess to run FlightGear in
    _fgProcess = new QProcess(this);
    Q_CHECK_PTR(_fgProcess);
    _fgProcess->moveToThread(this);
dogmaphobic's avatar
dogmaphobic committed
103

104 105 106 107 108 109 110
    connect(_fgProcess, static_cast<void (QProcess::*)(QProcess::ProcessError)>(&QProcess::error),
            this, &QGCFlightGearLink::processError);

//#ifdef DEBUG_FLIGHTGEAR_CONNECT
    connect(_fgProcess, &QProcess::readyReadStandardOutput, this, &QGCFlightGearLink::_printFgfsOutput);
    connect(_fgProcess, &QProcess::readyReadStandardError, this, &QGCFlightGearLink::_printFgfsError);
//#endif
dogmaphobic's avatar
dogmaphobic committed
111

Don Gagne's avatar
Don Gagne committed
112
    if (!_fgProcessWorkingDirPath.isEmpty()) {
Don Gagne's avatar
Don Gagne committed
113
        _fgProcess->setWorkingDirectory(_fgProcessWorkingDirPath);
dogmaphobic's avatar
dogmaphobic committed
114
        qDebug() << "Working directory" << _fgProcess->workingDirectory();
115
    }
dogmaphobic's avatar
dogmaphobic committed
116

Don Gagne's avatar
Don Gagne committed
117
#ifdef Q_OS_WIN32
dogmaphobic's avatar
dogmaphobic committed
118 119 120
    // On Windows we need to full qualify the location of the excecutable. The call to setWorkingDirectory only
    // sets the QProcess context, not the QProcess::start context. For some strange reason this is not the case on
    // OSX.
121
    QDir fgProcessFullyQualified(_fgProcessWorkingDirPath);
dogmaphobic's avatar
dogmaphobic committed
122
    _fgProcessName = fgProcessFullyQualified.absoluteFilePath(_fgProcessName);
123
#endif
dogmaphobic's avatar
dogmaphobic committed
124

Don Gagne's avatar
Don Gagne committed
125
#ifdef DEBUG_FLIGHTGEAR_CONNECT
Don Gagne's avatar
Don Gagne committed
126
    qDebug() << "\nStarting FlightGear" << _fgProcessWorkingDirPath << _fgProcessName << _fgArgList << "\n";
127
#endif
dogmaphobic's avatar
dogmaphobic committed
128

Don Gagne's avatar
Don Gagne committed
129
    _fgProcess->start(_fgProcessName, _fgArgList);
Don Gagne's avatar
Don Gagne committed
130
    connectState = true;
dogmaphobic's avatar
dogmaphobic committed
131

132
    emit simulationConnected(connectState);
Don Gagne's avatar
Don Gagne committed
133
    emit simulationConnected();
134

135 136 137 138 139 140
    exec();
}

void QGCFlightGearLink::setPort(int port)
{
    this->port = port;
lm's avatar
lm committed
141 142
    disconnectSimulation();
    connectSimulation();
143 144
}

lm's avatar
lm committed
145 146 147 148 149
void QGCFlightGearLink::processError(QProcess::ProcessError err)
{
    switch(err)
    {
    case QProcess::FailedToStart:
Don Gagne's avatar
Don Gagne committed
150
        emit showCriticalMessageFromThread(tr("FlightGear Failed to Start"), _fgProcess->errorString());
lm's avatar
lm committed
151 152
        break;
    case QProcess::Crashed:
Don Gagne's avatar
Don Gagne committed
153
        emit showCriticalMessageFromThread(tr("FlightGear Crashed"), tr("This is a FlightGear-related problem. Please upgrade FlightGear"));
lm's avatar
lm committed
154 155
        break;
    case QProcess::Timedout:
Don Gagne's avatar
Don Gagne committed
156
        emit showCriticalMessageFromThread(tr("FlightGear Start Timed Out"), tr("Please check if the path and command is correct"));
lm's avatar
lm committed
157 158
        break;
    case QProcess::WriteError:
Don Gagne's avatar
Don Gagne committed
159
        emit showCriticalMessageFromThread(tr("Could not Communicate with FlightGear"), tr("Please check if the path and command is correct"));
lm's avatar
lm committed
160 161
        break;
    case QProcess::ReadError:
Don Gagne's avatar
Don Gagne committed
162
        emit showCriticalMessageFromThread(tr("Could not Communicate with FlightGear"), tr("Please check if the path and command is correct"));
lm's avatar
lm committed
163 164 165
        break;
    case QProcess::UnknownError:
    default:
Don Gagne's avatar
Don Gagne committed
166
        emit showCriticalMessageFromThread(tr("FlightGear Error"), tr("Please check if the path and command is correct."));
lm's avatar
lm committed
167 168 169 170
        break;
    }
}

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
/**
 * @param host Hostname in standard formatting, e.g. localhost:14551 or 192.168.1.1:14551
 */
void QGCFlightGearLink::setRemoteHost(const QString& host)
{
    if (host.contains(":"))
    {
        //qDebug() << "HOST: " << host.split(":").first();
        QHostInfo info = QHostInfo::fromName(host.split(":").first());
        if (info.error() == QHostInfo::NoError)
        {
            // Add host
            QList<QHostAddress> hostAddresses = info.addresses();
            QHostAddress address;
            for (int i = 0; i < hostAddresses.size(); i++)
            {
                // Exclude loopback IPv4 and all IPv6 addresses
                if (!hostAddresses.at(i).toString().contains(":"))
                {
                    address = hostAddresses.at(i);
                }
            }
            currentHost = address;
            //qDebug() << "Address:" << address.toString();
            // Set port according to user input
lm's avatar
lm committed
196
            currentPort = host.split(":").last().toInt();
197 198 199 200 201 202 203 204 205 206 207
        }
    }
    else
    {
        QHostInfo info = QHostInfo::fromName(host);
        if (info.error() == QHostInfo::NoError)
        {
            // Add host
            currentHost = info.addresses().first();
        }
    }
208

209 210
}

211
void QGCFlightGearLink::updateControls(quint64 time, float rollAilerons, float pitchElevator, float yawRudder, float throttle, quint8 systemMode, quint8 navMode)
lm's avatar
lm committed
212
{
LM's avatar
LM committed
213 214
    // magnetos,aileron,elevator,rudder,throttle\n

lm's avatar
lm committed
215
    //float magnetos = 3.0f;
lm's avatar
lm committed
216 217 218
    Q_UNUSED(time);
    Q_UNUSED(systemMode);
    Q_UNUSED(navMode);
LM's avatar
LM committed
219

220
    if(!qIsNaN(rollAilerons) && !qIsNaN(pitchElevator) && !qIsNaN(yawRudder) && !qIsNaN(throttle))
221 222 223
    {
        QString state("%1\t%2\t%3\t%4\t%5\n");
        state = state.arg(rollAilerons).arg(pitchElevator).arg(yawRudder).arg(true).arg(throttle);
224
        emit _invokeWriteBytes(state.toLatin1());
Don Gagne's avatar
Don Gagne committed
225 226
        //qDebug() << "Updated controls" << rollAilerons << pitchElevator << yawRudder << throttle;
        //qDebug() << "Updated controls" << state;
227 228 229
    }
    else
    {
230
        qDebug() << "HIL: Got NaN values from the hardware: isnan output: roll: " << qIsNaN(rollAilerons) << ", pitch: " << qIsNaN(pitchElevator) << ", yaw: " << qIsNaN(yawRudder) << ", throttle: " << qIsNaN(throttle);
231
    }
lm's avatar
lm committed
232 233
}

234
void QGCFlightGearLink::_writeBytes(const QByteArray data)
235
{
lm's avatar
lm committed
236
    //#define QGCFlightGearLink_DEBUG
237
#ifdef QGCFlightGearLink_DEBUG
lm's avatar
lm committed
238 239
    QString bytes;
    QString ascii;
240
    for (int i=0, size = data.size(); i<size; i++)
lm's avatar
lm committed
241 242 243 244
    {
        unsigned char v = data[i];
        bytes.append(QString().sprintf("%02x ", v));
        if (data[i] > 31 && data[i] < 127)
245
        {
lm's avatar
lm committed
246
            ascii.append(data[i]);
247
        }
lm's avatar
lm committed
248 249 250 251 252 253 254 255
        else
        {
            ascii.append(219);
        }
    }
    qDebug() << "Sent" << size << "bytes to" << currentHost.toString() << ":" << currentPort << "data:";
    qDebug() << bytes;
    qDebug() << "ASCII:" << ascii;
256
#endif
257
    if (connectState && _udpCommSocket) _udpCommSocket->writeDatagram(data, currentHost, currentPort);
258 259 260 261 262 263 264 265 266 267 268
}

/**
 * @brief Read a number of bytes from the interface.
 *
 * @param data Pointer to the data byte array to write the bytes to
 * @param maxLength The maximum number of bytes to write
 **/
void QGCFlightGearLink::readBytes()
{
    const qint64 maxLength = 65536;
269
    char data[maxLength];
270 271 272
    QHostAddress sender;
    quint16 senderPort;

Don Gagne's avatar
Don Gagne committed
273
    unsigned int s = _udpCommSocket->pendingDatagramSize();
274
    if (s > maxLength) std::cerr << __FILE__ << __LINE__ << " UDP datagram overflow, allowed to read less bytes than datagram size" << std::endl;
Don Gagne's avatar
Don Gagne committed
275
    _udpCommSocket->readDatagram(data, maxLength, &sender, &senderPort);
276 277

    QByteArray b(data, s);
lm's avatar
lm committed
278 279 280

    // Print string
    QString state(b);
Don Gagne's avatar
Don Gagne committed
281
    //qDebug() << "FG LINK GOT:" << state;
lm's avatar
lm committed
282

lm's avatar
lm committed
283 284 285
    QStringList values = state.split("\t");

    // Check length
286
    const int nValues = 22;
287
    if (values.size() != nValues)
lm's avatar
lm committed
288
    {
289
        qDebug() << "RETURN LENGTH MISMATCHING EXPECTED" << nValues << "BUT GOT" << values.size();
lm's avatar
lm committed
290
        qDebug() << state;
291 292 293
        emit showCriticalMessageFromThread(tr("FlightGear HIL"),
                                           tr("Flight Gear protocol file '%1' is out of date. Quit QGroundControl. Delete the file and restart QGroundControl to fix.").arg(_fgProtocolFileFullyQualified));
        disconnectSimulation();
lm's avatar
lm committed
294 295
        return;
    }
lm's avatar
lm committed
296 297 298

    // Parse string
    float roll, pitch, yaw, rollspeed, pitchspeed, yawspeed;
299
    double lat, lon, alt;
Thomas Gubler's avatar
Thomas Gubler committed
300 301 302 303 304 305 306
    float ind_airspeed;
    float true_airspeed;
    float vx, vy, vz, xacc, yacc, zacc;
    float diff_pressure;
    float temperature;
    float abs_pressure;
    float mag_variation, mag_dip, xmag_ned, ymag_ned, zmag_ned, xmag_body, ymag_body, zmag_body;
307
    float alt_agl;
308

lm's avatar
lm committed
309

Lorenz Meier's avatar
Lorenz Meier committed
310 311 312
    lat = values.at(1).toDouble();
    lon = values.at(2).toDouble();
    alt = values.at(3).toDouble();
Thomas Gubler's avatar
Thomas Gubler committed
313 314 315 316 317 318
    roll = values.at(4).toFloat();
    pitch = values.at(5).toFloat();
    yaw = values.at(6).toFloat();
    rollspeed = values.at(7).toFloat();
    pitchspeed = values.at(8).toFloat();
    yawspeed = values.at(9).toFloat();
lm's avatar
lm committed
319

Thomas Gubler's avatar
Thomas Gubler committed
320 321 322
    xacc = values.at(10).toFloat();
    yacc = values.at(11).toFloat();
    zacc = values.at(12).toFloat();
lm's avatar
lm committed
323

Thomas Gubler's avatar
Thomas Gubler committed
324 325 326 327 328 329
    vx = values.at(13).toFloat();
    vy = values.at(14).toFloat();
    vz = values.at(15).toFloat();

    true_airspeed = values.at(16).toFloat();

330 331
    mag_variation = values.at(17).toFloat();
    mag_dip = values.at(18).toFloat();
Thomas Gubler's avatar
Thomas Gubler committed
332

333
    temperature = values.at(19).toFloat();
334 335
    abs_pressure = values.at(20).toFloat() * 1e2f; //convert to Pa from hPa
    abs_pressure += barometerOffsetkPa * 1e3f; //add offset, convert from kPa to Pa
lm's avatar
lm committed
336

337 338
    alt_agl = values.at(21).toFloat();

339 340 341 342 343 344
    //calculate differential pressure
    const float air_gas_constant = 287.1f; // J/(kg * K)
    const float absolute_null_celsius = -273.15f; // °C
    float density = abs_pressure / (air_gas_constant * (temperature - absolute_null_celsius));
    diff_pressure = true_airspeed * true_airspeed * density / 2.0f;
    //qDebug() << "diff_pressure: " << diff_pressure << "abs_pressure: " << abs_pressure;
345

346 347 348 349 350 351 352 353 354
    /* Calculate indicated airspeed */
    const float air_density_sea_level_15C  = 1.225f; //kg/m^3
    if (diff_pressure > 0)
    {
        ind_airspeed =  sqrtf((2.0f*diff_pressure) / air_density_sea_level_15C);
    } else
    {
        ind_airspeed =  -sqrtf((2.0f*fabsf(diff_pressure)) / air_density_sea_level_15C);
    }
355

356
    //qDebug() << "ind_airspeed: " << ind_airspeed << "true_airspeed: " << true_airspeed;
357

lm's avatar
lm committed
358
    // Send updated state
Thomas Gubler's avatar
Thomas Gubler committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
    //qDebug()  << "sensorHilEnabled: " << sensorHilEnabled;
    if (_sensorHilEnabled)
    {
        quint16 fields_changed = 0xFFF; //set all 12 used bits

        float pressure_alt = alt;

        xmag_ned = cosf(mag_variation);
        ymag_ned = sinf(mag_variation);
        zmag_ned = sinf(mag_dip);
        float tempMagLength = sqrtf(xmag_ned*xmag_ned + ymag_ned*ymag_ned + zmag_ned*zmag_ned);
        xmag_ned = xmag_ned / tempMagLength;
        ymag_ned = ymag_ned / tempMagLength;
        zmag_ned = zmag_ned / tempMagLength;

        //transform magnetic measurement to body frame coordinates
        double cosPhi = cos(roll);
        double sinPhi = sin(roll);
        double cosThe = cos(pitch);
        double sinThe = sin(pitch);
        double cosPsi = cos(yaw);
        double sinPsi = sin(yaw);

        float R_B_N[3][3];

        R_B_N[0][0] = cosThe * cosPsi;
        R_B_N[0][1] = -cosPhi * sinPsi + sinPhi * sinThe * cosPsi;
        R_B_N[0][2] = sinPhi * sinPsi + cosPhi * sinThe * cosPsi;

dogmaphobic's avatar
dogmaphobic committed
388 389 390
        R_B_N[1][0] = cosThe * sinPsi;
        R_B_N[1][1] = cosPhi * cosPsi + sinPhi * sinThe * sinPsi;
        R_B_N[1][2] = -sinPhi * cosPsi + cosPhi * sinThe * sinPsi;
Thomas Gubler's avatar
Thomas Gubler committed
391

dogmaphobic's avatar
dogmaphobic committed
392 393 394
        R_B_N[2][0] = -sinThe;
        R_B_N[2][1] = sinPhi * cosThe;
        R_B_N[2][2] = cosPhi * cosThe;
Thomas Gubler's avatar
Thomas Gubler committed
395 396 397 398 399 400 401 402 403 404 405 406

        Eigen::Matrix3f R_B_N_M = Eigen::Map<Eigen::Matrix3f>((float*)R_B_N).eval();

        Eigen::Vector3f mag_ned(xmag_ned, ymag_ned, zmag_ned);

        Eigen::Vector3f mag_body = R_B_N_M * mag_ned;

        xmag_body = mag_body(0);
        ymag_body = mag_body(1);
        zmag_body = mag_body(2);

        emit sensorHilRawImuChanged(QGC::groundTimeUsecs(), xacc, yacc, zacc, rollspeed, pitchspeed, yawspeed,
407
                                    xmag_body, ymag_body, zmag_body, abs_pressure*1e-2f, diff_pressure*1e-2f, pressure_alt, temperature, fields_changed); //Pressure in hPa for _vehicle->uas()link
Thomas Gubler's avatar
Thomas Gubler committed
408 409 410

//        qDebug()  << "sensorHilRawImuChanged " << xacc  << yacc << zacc  << rollspeed << pitchspeed << yawspeed << xmag << ymag << zmag << abs_pressure << diff_pressure << pressure_alt << temperature;
        int gps_fix_type = 3;
411 412
        float eph = 0.3f;
        float epv = 0.6f;
Thomas Gubler's avatar
Thomas Gubler committed
413 414 415 416 417 418
        float vel = sqrt(vx*vx + vy*vy + vz*vz);
        float cog = yaw;
        int satellites = 8;

        emit sensorHilGpsChanged(QGC::groundTimeUsecs(), lat, lon, alt, gps_fix_type, eph, epv, vel, vx, vy, vz, cog, satellites);
//        qDebug()  << "sensorHilGpsChanged " << lat  << lon << alt  << vel;
419 420

        // Send Optical Flow message. For now we set the flow quality to 0 and just write the ground_distance field
421 422 423 424 425
        float distanceMeasurement = -1.0; // -1 means invalid value
        if (fabsf(roll) < 0.87 && fabsf(pitch) < 0.87) // return a valid value only for decent angles
        {
            distanceMeasurement = fabsf((float)(1.0/cosPhi * 1.0/cosThe * alt_agl)); // assuming planar ground
        }
426 427
        emit sensorHilOpticalFlowChanged(QGC::groundTimeUsecs(), 0, 0, 0.0f,
                                         0.0f, 0.0f, distanceMeasurement);
Thomas Gubler's avatar
Thomas Gubler committed
428 429
    } else {
        emit hilStateChanged(QGC::groundTimeUsecs(), roll, pitch, yaw, rollspeed,
lm's avatar
lm committed
430
                         pitchspeed, yawspeed, lat, lon, alt,
Thomas Gubler's avatar
Thomas Gubler committed
431 432 433
                         vx, vy, vz,
                         ind_airspeed, true_airspeed,
                         xacc, yacc, zacc);
434
        //qDebug()  << "hilStateChanged " << (qint32)lat << (qint32)lon << (qint32)alt;
Thomas Gubler's avatar
Thomas Gubler committed
435
    }
lm's avatar
lm committed
436 437 438 439 440 441 442 443 444 445

    //    // Echo data for debugging purposes
    //    std::cerr << __FILE__ << __LINE__ << "Received datagram:" << std::endl;
    //    int i;
    //    for (i=0; i<s; i++)
    //    {
    //        unsigned int v=data[i];
    //        fprintf(stderr,"%02x ", v);
    //    }
    //    std::cerr << std::endl;
446 447 448 449 450 451 452 453 454 455
}


/**
 * @brief Get the number of bytes to read.
 *
 * @return The number of bytes to read
 **/
qint64 QGCFlightGearLink::bytesAvailable()
{
Don Gagne's avatar
Don Gagne committed
456
    return _udpCommSocket->pendingDatagramSize();
457 458 459 460 461 462 463
}

/**
 * @brief Disconnect the connection.
 *
 * @return True if connection has been disconnected, false if connection couldn't be disconnected.
 **/
lm's avatar
lm committed
464
bool QGCFlightGearLink::disconnectSimulation()
465
{
466 467 468 469 470 471 472 473 474
    disconnect(_fgProcess, static_cast<void (QProcess::*)(QProcess::ProcessError)>(&QProcess::error),
            this, &QGCFlightGearLink::processError);

    disconnect(_vehicle->uas(), &UAS::hilControlsChanged, this, &QGCFlightGearLink::updateControls);

    disconnect(this, &QGCFlightGearLink::hilStateChanged, _vehicle->uas(), &UAS::sendHilState);
    disconnect(this, &QGCFlightGearLink::sensorHilGpsChanged, _vehicle->uas(), &UAS::sendHilGps);
    disconnect(this, &QGCFlightGearLink::sensorHilRawImuChanged, _vehicle->uas(), &UAS::sendHilSensors);
    disconnect(this, &QGCFlightGearLink::sensorHilOpticalFlowChanged, _vehicle->uas(), &UAS::sendHilOpticalFlow);
LM's avatar
LM committed
475

Don Gagne's avatar
Don Gagne committed
476
    if (_fgProcess)
lm's avatar
lm committed
477
    {
Don Gagne's avatar
Don Gagne committed
478
        _fgProcess->close();
479
        _fgProcess->deleteLater();
Don Gagne's avatar
Don Gagne committed
480
        _fgProcess = NULL;
lm's avatar
lm committed
481
    }
Don Gagne's avatar
Don Gagne committed
482
    if (_udpCommSocket)
LM's avatar
LM committed
483
    {
Don Gagne's avatar
Don Gagne committed
484
        _udpCommSocket->close();
485
        _udpCommSocket->deleteLater();
Don Gagne's avatar
Don Gagne committed
486
        _udpCommSocket = NULL;
LM's avatar
LM committed
487
    }
488 489 490

    connectState = false;

491 492
    emit simulationDisconnected();
    emit simulationConnected(false);
Don Gagne's avatar
Don Gagne committed
493 494 495 496

    // Exit the thread
    quit();

497 498 499
    return !connectState;
}

Don Gagne's avatar
Don Gagne committed
500 501
/// @brief Splits a space seperated set of command line arguments into a QStringList.
///         Quoted strings are allowed and handled correctly.
Don Gagne's avatar
Don Gagne committed
502 503
///     @param uiArgs Arguments to parse
///     @param argList Returned argument list
Don Gagne's avatar
Don Gagne committed
504
/// @return Returns false if the argument list has mistmatced quotes within in.
505

Don Gagne's avatar
Don Gagne committed
506 507
bool QGCFlightGearLink::parseUIArguments(QString uiArgs, QStringList& argList)
{
Don Gagne's avatar
Don Gagne committed
508
    // FYI: The only reason this routine is public is so that we can reference it from a unit test.
Don Gagne's avatar
Don Gagne committed
509

dogmaphobic's avatar
dogmaphobic committed
510
    // This is not as easy as it seams since some options can be quoted to preserve spaces within things like
Don Gagne's avatar
Don Gagne committed
511 512 513 514
    // directories. There is likely some crazed regular expression which can do this. But after trying that
    // route I gave up and instead here is the code which does it the hard way. Another thing to be aware of
    // is that the QStringList passed to QProces::start is similar to what you would get in argv after the
    // command line is processed. This means that quoted strings have the quotes removed before making it to argv.
dogmaphobic's avatar
dogmaphobic committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534

    bool inQuotedString = false;
    bool previousSpace = false;
    QString currentArg;
    for (int i=0; i<uiArgs.size(); i++) {
        const QChar chr = uiArgs[i];

        if (chr == ' ') {
            if (inQuotedString) {
                // Space is inside quoted string leave it in
                currentArg += chr;
                continue;
            } else {
                if (previousSpace) {
                    // Disregard multiple spaces
                    continue;
                } else {
                    // We have a space that is finishing an argument
                    previousSpace = true;
                    if (inQuotedString) {
535
                        QGCMessageBox::critical(tr("FlightGear HIL"), tr("FlightGear failed to start. There are mismatched quotes in specified command line options"));
dogmaphobic's avatar
dogmaphobic committed
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
                        return false;
                    }
                    if (!currentArg.isEmpty()) {
                        argList += currentArg;
                        currentArg.clear();
                    }
                }
            }
        } else if (chr == '\"') {
            // Flip the state of being in a quoted string. Note that we specifically do not add the
            // quote to the string. This replicates standards command line parsing behaviour.
            if (chr == '\"') {
                inQuotedString = !inQuotedString;
            }
            previousSpace = false;
        } else {
            // Flip the state of being in a quoted string
            if (chr == '\"') {
                inQuotedString = !inQuotedString;
            }
            previousSpace = false;
            currentArg += chr;
        }
    }
    // We should never end parsing on an unterminated quote
    if (inQuotedString) {
        return false;
    }

    // Finish up last arg
    if (!currentArg.isEmpty()) {
        argList += currentArg;
        currentArg.clear();
    }

571
    return true;
572 573
}

Don Gagne's avatar
Don Gagne committed
574 575 576 577 578
/// @brief Locates the specified argument in the argument list, returning the value for it.
///     @param uiArgList Argument list to search through
///     @param argLabel Argument label to search for
///     @param argValue Returned argument value if found
/// @return Returns true if argument found and argValue returned
579

Don Gagne's avatar
Don Gagne committed
580 581 582 583 584 585 586 587 588 589 590 591 592
bool QGCFlightGearLink::_findUIArgument(const QStringList& uiArgList, const QString& argLabel, QString& argValue)
{
    QString regExpStr = argLabel + "=(.*)";
    int index = uiArgList.indexOf(QRegExp(regExpStr, Qt::CaseInsensitive));
    if (index != -1) {
        QRegExp regExp(regExpStr);
        index = regExp.indexIn(uiArgList[index]);
        Q_ASSERT(index != -1);
        argValue = regExp.cap(1);
        return true;
    } else {
        return false;
    }
593 594
}

595 596 597 598 599
/**
 * @brief Connect the connection.
 *
 * @return True if connection has been established, false if connection couldn't be established.
 **/
lm's avatar
lm committed
600
bool QGCFlightGearLink::connectSimulation()
601
{
Don Gagne's avatar
Don Gagne committed
602 603 604 605
    // We setup all the information we need to start FlightGear here such that if something goes
    // wrong we can return false out of here. All of this happens on the main UI thread. Once we
    // have that information setup we start the thread which will call run, which will in turn
    // start the various FG processes on the seperate thread.
dogmaphobic's avatar
dogmaphobic committed
606

607
    if (!_vehicle->uas()) {
Don Gagne's avatar
Don Gagne committed
608 609
        return false;
    }
dogmaphobic's avatar
dogmaphobic committed
610

Don Gagne's avatar
Don Gagne committed
611 612 613
    QString     fgAppName;
    QString     fgRootPath;						// FlightGear root data directory as specified by --fg-root
    QStringList fgRootPathProposedList;         // Directories we will attempt to search for --fg-root
dogmaphobic's avatar
dogmaphobic committed
614 615 616
    bool        fgRootDirOverride = false;		// true: User has specified --fg-root from ui options
    QString     fgSceneryPath;					// FlightGear scenery path as specified by --fg-scenery
    bool        fgSceneryDirOverride = false;	// true: User has specified --fg-scenery from ui options
Don Gagne's avatar
Don Gagne committed
617
    QDir        fgAppDir;						// Location of main FlightGear application
618 619 620 621 622 623 624

    // Reset the list of arguments which will be provided to FG to the arguments set by the user via the UI
    // First split the space seperated command line arguments coming in from the ui into a QStringList since
    // that is what QProcess::start needs.
    QStringList uiArgList;
    bool mismatchedQuotes = parseUIArguments(startupArguments, uiArgList);
    if (!mismatchedQuotes) {
625
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("FlightGear failed to start. There are mismatched quotes in specified command line options"));
626 627 628 629 630 631 632
        return false;
    }
#ifdef DEBUG_FLIGHTGEAR_CONNECT
    qDebug() << "\nSplit arguments" << uiArgList << "\n";
#endif
    // Now set the FG arguments to the arguments from the UI
    _fgArgList = uiArgList;
dogmaphobic's avatar
dogmaphobic committed
633 634

#if defined __macos__
Don Gagne's avatar
Don Gagne committed
635 636 637 638
    // Mac installs will default to the /Applications folder 99% of the time. Anything other than
    // that is pretty non-standard so we don't try to get fancy beyond hardcoding that path.
    fgAppDir.setPath("/Applications");
    fgAppName = "FlightGear.app";
639
    // new path
640 641
    _fgProcessName = "./fgfs";
    _fgProcessWorkingDirPath = "/Applications/FlightGear.app/Contents/MacOS/";
642 643 644 645 646
    if(!QFileInfo(_fgProcessWorkingDirPath + _fgProcessName).exists()){
        // old path
        _fgProcessName = "./fgfs.sh";
        _fgProcessWorkingDirPath = "/Applications/FlightGear.app/Contents/Resources/";
    }
Don Gagne's avatar
Don Gagne committed
647
    fgRootPathProposedList += "/Applications/FlightGear.app/Contents/Resources/data/";
Don Gagne's avatar
Don Gagne committed
648
#elif defined Q_OS_WIN32
Don Gagne's avatar
Don Gagne committed
649
    _fgProcessName = "fgfs.exe";
dogmaphobic's avatar
dogmaphobic committed
650

Don Gagne's avatar
Don Gagne committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664
    // Windows installs are not as easy to determine. Default installation is to
    // C:\Program Files\FlightGear, but that can be easily changed. That also doesn't
    // tell us whether the user is running 32 or 64 bit which will both be installed there.
    // The preferences for the fgrun app will tell us which version they are using
    // and where it is. That is stored in the $APPDATA\fliggear.org\fgrun.prefs file. This
    // looks to be a more stable location and way to determine app location so we use that.
    fgAppName = "fgfs.exe";
    const char* appdataEnv = "APPDATA";
    if (!qgetenv(appdataEnv).isEmpty()) {
        QString fgrunPrefsFile = QDir(qgetenv(appdataEnv).constData()).absoluteFilePath("flightgear.org/fgrun.prefs");
        qDebug() << fgrunPrefsFile;
        QFile file(fgrunPrefsFile);
        if (file.open(QIODevice::ReadOnly | QIODevice::Text)) {
            QTextStream in(&file);
dogmaphobic's avatar
dogmaphobic committed
665
            QString lookahead;	// lookahead for continuation lines
Don Gagne's avatar
Don Gagne committed
666 667
            while (!in.atEnd() || !lookahead.isEmpty()) {
                QString line;
dogmaphobic's avatar
dogmaphobic committed
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
                QRegExp regExp;

                // Prefs file has strange format where a line prepended with "+" is a continuation of the previous line.
                // So do a lookahead to determine if we have a continuation or not.

                if (!lookahead.isEmpty()) {
                    line = lookahead;
                    lookahead.clear();
                } else {
                    line = in.readLine();
                }

                if (!in.atEnd()) {
                    lookahead = in.readLine();
                    regExp.setPattern("^\\+(.*)");
                    if (regExp.indexIn(lookahead) == 0) {
                        Q_ASSERT(regExp.captureCount() == 1);
                        line += regExp.cap(1);
                        lookahead.clear();
                    }
                }

Don Gagne's avatar
Don Gagne committed
690 691 692 693 694 695 696
                regExp.setPattern("^fg_exe:(.*)");
                if (regExp.indexIn(line) == 0 && regExp.captureCount() == 1) {
                    QString fgExeLocationFullQualified = regExp.cap(1);
                    qDebug() << fgExeLocationFullQualified;
                    regExp.setPattern("(.*)\\\\fgfs.exe");
                    if (regExp.indexIn(fgExeLocationFullQualified) == 0 && regExp.captureCount() == 1) {
                        fgAppDir.setPath(regExp.cap(1));
Don Gagne's avatar
Don Gagne committed
697
                        _fgProcessWorkingDirPath = fgAppDir.absolutePath();
Don Gagne's avatar
Don Gagne committed
698 699 700 701
                        qDebug() << "fg_exe" << fgAppDir.absolutePath();
                    }
                    continue;
                }
dogmaphobic's avatar
dogmaphobic committed
702

Don Gagne's avatar
Don Gagne committed
703 704
                regExp.setPattern("^fg_root:(.*)");
                if (regExp.indexIn(line) == 0 && regExp.captureCount() == 1) {
Don Gagne's avatar
Don Gagne committed
705 706
                    fgRootPathProposedList += QDir(regExp.cap(1)).absolutePath();
                    qDebug() << "fg_root" << fgRootPathProposedList[0];
Don Gagne's avatar
Don Gagne committed
707 708
                    continue;
                }
dogmaphobic's avatar
dogmaphobic committed
709

Don Gagne's avatar
Don Gagne committed
710 711
                regExp.setPattern("^fg_scenery:(.*)");
                if (regExp.indexIn(line) == 0 && regExp.captureCount() == 1) {
dogmaphobic's avatar
dogmaphobic committed
712
                    // Scenery can contain multiple paths seperated by ';' so don't do QDir::absolutePath on it
Don Gagne's avatar
Don Gagne committed
713 714 715 716 717 718 719 720 721 722
                    fgSceneryPath = regExp.cap(1);
                    qDebug() << "fg_scenery" << fgSceneryPath;
                    continue;
                }
            }
        }
    }
#elif defined Q_OS_LINUX
    // Linux installs to a location on the path so we don't need a directory to run the executable
    fgAppName = "fgfs";
Don Gagne's avatar
Don Gagne committed
723
    _fgProcessName = "fgfs";
Don Gagne's avatar
Don Gagne committed
724 725
    fgRootPathProposedList += "/usr/share/flightgear/data/";    // Default Archlinux location
    fgRootPathProposedList += "/usr/share/games/flightgear/";   // Default Ubuntu location
Don Gagne's avatar
Don Gagne committed
726 727 728
#else
#error Unknown OS build flavor
#endif
dogmaphobic's avatar
dogmaphobic committed
729

Don Gagne's avatar
Don Gagne committed
730
#ifndef Q_OS_LINUX
Don Gagne's avatar
Don Gagne committed
731
    // Validate the FlightGear application directory location. Linux runs from path so we don't validate on that OS.
Don Gagne's avatar
Don Gagne committed
732 733 734 735 736 737 738 739 740 741 742 743 744
    Q_ASSERT(!fgAppName.isEmpty());
    QString fgAppFullyQualified = fgAppDir.absoluteFilePath(fgAppName);
    while (!QFileInfo(fgAppFullyQualified).exists()) {
        QMessageBox msgBox(QMessageBox::Critical,
                           tr("FlightGear application not found"),
                           tr("FlightGear application not found at: %1").arg(fgAppFullyQualified),
                           QMessageBox::Cancel,
                           MainWindow::instance());
        msgBox.setWindowModality(Qt::ApplicationModal);
        msgBox.addButton(tr("I'll specify directory"), QMessageBox::ActionRole);
        if (msgBox.exec() == QMessageBox::Cancel) {
            return false;
        }
dogmaphobic's avatar
dogmaphobic committed
745

Don Gagne's avatar
Don Gagne committed
746
        // Let the user pick the right directory
Don Gagne's avatar
Don Gagne committed
747
        QString dirPath = QGCFileDialog::getExistingDirectory(MainWindow::instance(), tr("Please select directory of FlightGear application : ") + fgAppName);
Don Gagne's avatar
Don Gagne committed
748 749 750 751
        if (dirPath.isEmpty()) {
            return false;
        }
        fgAppDir.setPath(dirPath);
Don Gagne's avatar
Don Gagne committed
752 753 754
        fgAppFullyQualified = fgAppDir.absoluteFilePath(fgAppName);
    }
#endif
dogmaphobic's avatar
dogmaphobic committed
755

Don Gagne's avatar
Don Gagne committed
756
    // If we have an --fg-root coming in from the ui options, that setting overrides any internal searching of
Don Gagne's avatar
Don Gagne committed
757 758 759 760 761 762 763 764
    // proposed locations.
    QString argValue;
    fgRootDirOverride = _findUIArgument(_fgArgList, "--fg-root", argValue);
    if (fgRootDirOverride) {
        fgRootPathProposedList.clear();
        fgRootPathProposedList += argValue;
        qDebug() << "--fg-root override" << argValue;
    }
765

Don Gagne's avatar
Don Gagne committed
766 767 768 769 770 771 772 773 774 775 776
    // See if we can find an --fg-root directory from the proposed list.
    Q_ASSERT(fgRootPath.isEmpty());
    for (int i=0; i<fgRootPathProposedList.count(); i++) {
        fgRootPath = fgRootPathProposedList[i];
        if (QFileInfo(fgRootPath).isDir()) {
            // We found it
            break;
        } else {
            fgRootPath.clear();
        }
    }
dogmaphobic's avatar
dogmaphobic committed
777

Don Gagne's avatar
Don Gagne committed
778 779 780 781 782 783 784 785
    // Alert the user if we couldn't find an --fg-root
    if (fgRootPath.isEmpty()) {
        QString errMsg;
        if (fgRootDirOverride) {
            errMsg = tr("--fg-root directory specified from ui option not found: %1").arg(fgRootPath);
        } else if (fgRootPath.isEmpty()) {
            errMsg = tr("Unable to automatically determine --fg-root directory location. You will need to specify --fg-root=<directory> as an additional command line parameter from ui.");
        }
786
        QGCMessageBox::critical(tr("FlightGear HIL"), errMsg);
Don Gagne's avatar
Don Gagne committed
787 788
        return false;
    }
789

Don Gagne's avatar
Don Gagne committed
790 791 792 793
    if (!fgRootDirOverride) {
        _fgArgList += "--fg-root=" + fgRootPath;
    }

Don Gagne's avatar
Don Gagne committed
794 795
    // Add --fg-scenery command line arg. If --fg-scenery is specified from the ui we use that instead.
    // On Windows --fg-scenery is required on the command line otherwise FlightGear won't boot.
Don Gagne's avatar
Don Gagne committed
796 797 798 799
    fgSceneryDirOverride = _findUIArgument(_fgArgList, "--fg-scenery", argValue);
    if (fgSceneryDirOverride) {
        fgSceneryPath = argValue;
        qDebug() << "--fg-scenery override" << argValue;
Don Gagne's avatar
Don Gagne committed
800
    } else if (!fgSceneryPath.isEmpty()) {
dogmaphobic's avatar
dogmaphobic committed
801 802 803
        _fgArgList += "--fg-scenery=" + fgSceneryPath;
    }

Don Gagne's avatar
Don Gagne committed
804 805
#ifdef Q_OS_WIN32
    // Windows won't start without an --fg-scenery set. We don't validate the directory in the path since
dogmaphobic's avatar
dogmaphobic committed
806
    // it can be multiple paths.
Don Gagne's avatar
Don Gagne committed
807 808 809 810 811 812 813
    if (fgSceneryPath.isEmpty()) {
        QString errMsg;
        if (fgSceneryDirOverride) {
            errMsg = tr("--fg-scenery directory specified from ui option not found: %1").arg(fgSceneryPath);
        } else {
            errMsg = tr("Unable to automatically determine --fg-scenery directory location. You will need to specify --fg-scenery=directory as an additional command line parameter from ui.");
        }
814
        QGCMessageBox::critical(tr("FlightGear HIL"), errMsg);
Don Gagne's avatar
Don Gagne committed
815 816
        return false;
    }
Don Gagne's avatar
Don Gagne committed
817 818
#else
    Q_UNUSED(fgSceneryDirOverride);
Don Gagne's avatar
Don Gagne committed
819
#endif
dogmaphobic's avatar
dogmaphobic committed
820

Don Gagne's avatar
Don Gagne committed
821
    // Setup and verify directory which contains QGC provided aircraft files
Don Gagne's avatar
Don Gagne committed
822
    QString qgcAircraftDir(QApplication::applicationDirPath() + "/flightgear/Aircraft");
Don Gagne's avatar
Don Gagne committed
823
    if (!QFileInfo(qgcAircraftDir).isDir()) {
824
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. Aircraft directory is missing: '%1'.").arg(qgcAircraftDir));
Don Gagne's avatar
Don Gagne committed
825 826 827
        return false;
    }
    _fgArgList += "--fg-aircraft=" + qgcAircraftDir;
dogmaphobic's avatar
dogmaphobic committed
828

Don Gagne's avatar
Don Gagne committed
829
    // Setup protocol we will be using to communicate with FlightGear
830
    QString fgProtocol(_vehicle->vehicleType() == MAV_TYPE_QUADROTOR ? "qgroundcontrol-quadrotor" : "qgroundcontrol-fixed-wing");
Don Gagne's avatar
Don Gagne committed
831
    QString fgProtocolArg("--generic=socket,%1,300,127.0.0.1,%2,udp,%3");
Don Gagne's avatar
Don Gagne committed
832 833
    _fgArgList << fgProtocolArg.arg("out").arg(port).arg(fgProtocol);
    _fgArgList << fgProtocolArg.arg("in").arg(currentPort).arg(fgProtocol);
dogmaphobic's avatar
dogmaphobic committed
834

Don Gagne's avatar
Don Gagne committed
835 836 837
    // Verify directory where FlightGear stores communicaton protocols.
    QDir fgProtocolDir(fgRootPath);
    if (!fgProtocolDir.cd("Protocol")) {
838
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect FlightGear setup. Protocol directory is missing: '%1'. Command line parameter for --fg-root may be set incorrectly.").arg(fgProtocolDir.path()));
Don Gagne's avatar
Don Gagne committed
839 840
        return false;
    }
dogmaphobic's avatar
dogmaphobic committed
841

Don Gagne's avatar
Don Gagne committed
842
    // Verify directory which contains QGC provided FlightGear communication protocol files
Don Gagne's avatar
Don Gagne committed
843
    QDir qgcProtocolDir(QApplication::applicationDirPath() + "/flightgear/Protocol/");
Don Gagne's avatar
Don Gagne committed
844
    if (!qgcProtocolDir.isReadable()) {
845
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. Protocol directory is missing (%1).").arg(qgcProtocolDir.path()));
Don Gagne's avatar
Don Gagne committed
846 847
        return false;
    }
dogmaphobic's avatar
dogmaphobic committed
848

849 850 851 852
    // Make sure we can find the communication protocol file in QGC install
    QString fgProtocolXmlFile = fgProtocol + ".xml";
    QString qgcProtocolFileFullyQualified = qgcProtocolDir.absoluteFilePath(fgProtocolXmlFile);
    if (!QFileInfo(qgcProtocolFileFullyQualified).exists()) {
853
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. FlightGear protocol file missing: %1").arg(qgcProtocolFileFullyQualified));
854 855
        return false;
    }
dogmaphobic's avatar
dogmaphobic committed
856

Don Gagne's avatar
Don Gagne committed
857 858 859
    // Communication protocol must be in FlightGear protocol directory. There does not appear to be any way
    // around this by specifying something on the FlightGear command line. FG code does direct append
    // of protocol xml file to $FG_ROOT and $FG_ROOT only allows a single directory to be specified.
860
    _fgProtocolFileFullyQualified = fgProtocolDir.absoluteFilePath(fgProtocolXmlFile);
dogmaphobic's avatar
dogmaphobic committed
861

862 863
    if (QFileInfo(_fgProtocolFileFullyQualified).exists()) {
        // Verify that the file is current by comparing it against the one in QGC
dogmaphobic's avatar
dogmaphobic committed
864

865 866
        QFile fgFile(_fgProtocolFileFullyQualified);
        QFile qgcFile(qgcProtocolFileFullyQualified);
dogmaphobic's avatar
dogmaphobic committed
867

868 869 870 871 872 873
        if (!fgFile.open(QIODevice::ReadOnly) ||
            !qgcFile.open(QIODevice::ReadOnly)) {
            QGCMessageBox::warning(tr("FlightGear HIL"), tr("Unable to verify that protocol file %1 is current. "
                                                            "If file is out of date, you may experience problems. "
                                                            "Safest approach is to delete the file manually and allow QGroundControl install the latest file.").arg(_fgProtocolFileFullyQualified));
        }
dogmaphobic's avatar
dogmaphobic committed
874

875 876
        QByteArray fgBytes = fgFile.readAll();
        QByteArray qgcBytes = qgcFile.readAll();
dogmaphobic's avatar
dogmaphobic committed
877

878 879
        fgFile.close();
        qgcFile.close();
dogmaphobic's avatar
dogmaphobic committed
880

881 882 883 884 885 886 887 888
        if (fgBytes != qgcBytes) {
            QGCMessageBox::warning(tr("FlightGear HIL"), tr("FlightGear protocol file %1 is out of date. It will be deleted, which will cause QGroundControl to install the latest version of the file.").arg(_fgProtocolFileFullyQualified));
            if (!QFile::remove(_fgProtocolFileFullyQualified)) {
                QGCMessageBox::warning(tr("FlightGear HIL"), tr("Delete of protocol file failed. You will have to manually delete the file."));
                return false;
            }
        }
    }
dogmaphobic's avatar
dogmaphobic committed
889

890
    if (!QFileInfo(_fgProtocolFileFullyQualified).exists()) {
Don Gagne's avatar
Don Gagne committed
891 892 893 894 895 896 897 898 899 900
        QMessageBox msgBox(QMessageBox::Critical,
                           tr("FlightGear Failed to Start"),
                           tr("FlightGear Failed to Start. QGroundControl protocol (%1) not installed to FlightGear Protocol directory (%2)").arg(fgProtocolXmlFile).arg(fgProtocolDir.path()),
                           QMessageBox::Cancel,
                           MainWindow::instance());
        msgBox.setWindowModality(Qt::ApplicationModal);
        msgBox.addButton(tr("Fix it for me"), QMessageBox::ActionRole);
        if (msgBox.exec() == QMessageBox::Cancel) {
            return false;
        }
dogmaphobic's avatar
dogmaphobic committed
901

Don Gagne's avatar
Don Gagne committed
902
        // Now that we made it this far, we should be able to try to copy the protocol file to FlightGear.
903
        bool succeeded = QFile::copy(qgcProtocolFileFullyQualified, _fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
904 905
        if (!succeeded) {
#ifdef Q_OS_WIN32
906
            QString copyCmd = QString("copy \"%1\" \"%2\"").arg(qgcProtocolFileFullyQualified).arg(_fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
907 908
            copyCmd.replace("/", "\\");
#else
909
            QString copyCmd = QString("sudo cp %1 %2").arg(qgcProtocolFileFullyQualified).arg(_fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
910
#endif
dogmaphobic's avatar
dogmaphobic committed
911

Don Gagne's avatar
Don Gagne committed
912 913 914
            QMessageBox msgBox(QMessageBox::Critical,
                               tr("Copy failed"),
#ifdef Q_OS_WIN32
915
                               tr("Copy from (%1) to (%2) failed, possibly due to permissions issue. You will need to perform manually. Try pasting the following command into a Command Prompt which was started with Run as Administrator:\n\n").arg(qgcProtocolFileFullyQualified).arg(_fgProtocolFileFullyQualified) + copyCmd,
Don Gagne's avatar
Don Gagne committed
916
#else
917
                               tr("Copy from (%1) to (%2) failed, possibly due to permissions issue. You will need to perform manually. Try pasting the following command into a shell:\n\n").arg(qgcProtocolFileFullyQualified).arg(_fgProtocolFileFullyQualified) + copyCmd,
Don Gagne's avatar
Don Gagne committed
918 919 920 921 922 923 924 925 926 927 928
#endif
                               QMessageBox::Cancel,
                               MainWindow::instance());
            msgBox.setWindowModality(Qt::ApplicationModal);
            msgBox.addButton(tr("Copy to Clipboard"), QMessageBox::ActionRole);
            if (msgBox.exec() != QMessageBox::Cancel) {
                QApplication::clipboard()->setText(copyCmd);
            }
            return false;
        }
    }
dogmaphobic's avatar
dogmaphobic committed
929

Don Gagne's avatar
Don Gagne committed
930
    // Start the engines to save a startup step
931
    if (_vehicle->vehicleType() == MAV_TYPE_QUADROTOR) {
Don Gagne's avatar
Don Gagne committed
932 933 934 935 936 937 938 939
        // Start all engines of the quad
        _fgArgList << "--prop:/engines/engine[0]/running=true";
        _fgArgList << "--prop:/engines/engine[1]/running=true";
        _fgArgList << "--prop:/engines/engine[2]/running=true";
        _fgArgList << "--prop:/engines/engine[3]/running=true";
    } else {
        _fgArgList << "--prop:/engines/engine/running=true";
    }
dogmaphobic's avatar
dogmaphobic committed
940

Don Gagne's avatar
Don Gagne committed
941
    // We start out at our home position
942 943
    _fgArgList << QString("--lat=%1").arg(qgcApp()->toolbox()->homePositionManager()->getHomeLatitude());
    _fgArgList << QString("--lon=%1").arg(qgcApp()->toolbox()->homePositionManager()->getHomeLongitude());
Don Gagne's avatar
Don Gagne committed
944 945
    // The altitude is not set because an altitude not equal to the ground altitude leads to a non-zero default throttle in flightgear
    // Without the altitude-setting the aircraft is positioned on the ground
946
    //_fgArgList << QString("--altitude=%1").arg(qgcApp()->toolbox()->homePositionManager()->getHomeAltitude());
dogmaphobic's avatar
dogmaphobic committed
947

Don Gagne's avatar
Don Gagne committed
948 949 950 951 952
#ifdef DEBUG_FLIGHTGEAR_CONNECT
    // This tell FlightGear to output highest debug level of log output. Handy for debuggin failures by looking at the FG
    // log files.
    _fgArgList << "--log-level=debug";
#endif
dogmaphobic's avatar
dogmaphobic committed
953

954 955
    start(HighPriority);
    return true;
956 957
}

Don Gagne's avatar
Don Gagne committed
958
void QGCFlightGearLink::_printFgfsOutput(void)
Thomas Gubler's avatar
Thomas Gubler committed
959 960
{
   qDebug() << "fgfs stdout:";
Don Gagne's avatar
Don Gagne committed
961
   QByteArray byteArray = _fgProcess->readAllStandardOutput();
Thomas Gubler's avatar
Thomas Gubler committed
962 963
   QStringList strLines = QString(byteArray).split("\n");

964
   foreach (const QString &line, strLines){
Thomas Gubler's avatar
Thomas Gubler committed
965 966 967 968
    qDebug() << line;
   }
}

Don Gagne's avatar
Don Gagne committed
969
void QGCFlightGearLink::_printFgfsError(void)
Thomas Gubler's avatar
Thomas Gubler committed
970 971 972
{
   qDebug() << "fgfs stderr:";

Don Gagne's avatar
Don Gagne committed
973
   QByteArray byteArray = _fgProcess->readAllStandardError();
Thomas Gubler's avatar
Thomas Gubler committed
974 975
   QStringList strLines = QString(byteArray).split("\n");

976
   foreach (const QString &line, strLines){
Thomas Gubler's avatar
Thomas Gubler committed
977 978 979 980
    qDebug() << line;
   }
}

981 982 983 984 985 986 987 988 989
/**
 * @brief Set the startup arguments used to start flightgear
 *
 **/
void QGCFlightGearLink::setStartupArguments(QString startupArguments)
{
    this->startupArguments = startupArguments;
}

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
/**
 * @brief Check if connection is active.
 *
 * @return True if link is connected, false otherwise.
 **/
bool QGCFlightGearLink::isConnected()
{
    return connectState;
}

QString QGCFlightGearLink::getName()
{
    return name;
}

Lorenz Meier's avatar
Lorenz Meier committed
1005 1006 1007 1008 1009
QString QGCFlightGearLink::getRemoteHost()
{
    return QString("%1:%2").arg(currentHost.toString(), currentPort);
}

1010 1011 1012
void QGCFlightGearLink::setName(QString name)
{
    this->name = name;
lm's avatar
lm committed
1013
    //    emit nameChanged(this->name);
1014
}
1015 1016 1017 1018 1019

void QGCFlightGearLink::setBarometerOffset(float barometerOffsetkPa)
{
    this->barometerOffsetkPa = barometerOffsetkPa;
}