QGCFlightGearLink.cc 41.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*=====================================================================

QGroundControl Open Source Ground Control Station

(c) 2009 - 2011 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>

This file is part of the QGROUNDCONTROL project

    QGROUNDCONTROL is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    QGROUNDCONTROL is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.

======================================================================*/

/**
 * @file
 *   @brief Definition of UDP connection (server) for unmanned vehicles
lm's avatar
lm committed
27
 *   @see Flightgear Manual http://mapserver.flightgear.org/getstart.pdf
28
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
Thomas Gubler's avatar
Thomas Gubler committed
29
 *   @author Thomas Gubler <thomasgubler@student.ethz.ch>
30 31 32 33 34 35 36
 *
 */

#include <QTimer>
#include <QList>
#include <QDebug>
#include <QMutexLocker>
Don Gagne's avatar
Don Gagne committed
37
#include <QHostInfo>
Don Gagne's avatar
Don Gagne committed
38
#include <QMessageBox>
Don Gagne's avatar
Don Gagne committed
39

40
#include <iostream>
Don Gagne's avatar
Don Gagne committed
41

42 43
#include "QGCFlightGearLink.h"
#include "QGC.h"
Don Gagne's avatar
Don Gagne committed
44
#include "QGCFileDialog.h"
45
#include "QGCMessageBox.h"
46

Don Gagne's avatar
Don Gagne committed
47
// 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
48
// for tracking down problems.
Don Gagne's avatar
Don Gagne committed
49
//#define DEBUG_FLIGHTGEAR_CONNECT
Don Gagne's avatar
Don Gagne committed
50

51
QGCFlightGearLink::QGCFlightGearLink(UASInterface* mav, QString startupArguments, QString remoteHost, QHostAddress host, quint16 port) :
Don Gagne's avatar
Don Gagne committed
52
    flightGearVersion(3),
Thomas Gubler's avatar
Thomas Gubler committed
53
    startupArguments(startupArguments),
54
    _sensorHilEnabled(true),
Don Gagne's avatar
Don Gagne committed
55 56 57
    barometerOffsetkPa(0.0f),
    _udpCommSocket(NULL),
    _fgProcess(NULL)
58
{
59 60 61 62
    // 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);

63
    this->host = host;
64
    this->port = port+mav->getUASID();
65
    this->connectState = false;
66
    this->currentPort = 49000+mav->getUASID();
lm's avatar
lm committed
67
    this->mav = mav;
Don Gagne's avatar
Don Gagne committed
68
    this->name = tr("FlightGear 3.0+ Link (port:%1)").arg(port);
LM's avatar
LM committed
69
    setRemoteHost(remoteHost);
Don Gagne's avatar
Don Gagne committed
70 71
    
    // We need a mechanism so show error message from our FGLink thread on the UI thread. This signal connection will do that for us.
72
    connect(this, &QGCFlightGearLink::showCriticalMessageFromThread, qgcApp(), &QGCApplication::criticalMessageBoxOnMainThread);
73 74 75
}

QGCFlightGearLink::~QGCFlightGearLink()
76
{   //do not disconnect unless it is connected.
Don Gagne's avatar
Don Gagne committed
77
    //disconnectSimulation will delete the memory that was allocated for proces, terraSync and _udpCommSocket
78 79 80
    if(connectState){
       disconnectSimulation();
    }
81 82
}

Don Gagne's avatar
Don Gagne committed
83
/// @brief Runs the simulation thread. We do setup work here which needs to happen in the seperate thread.
84 85
void QGCFlightGearLink::run()
{
Don Gagne's avatar
Don Gagne committed
86 87 88
    Q_ASSERT(mav);
    Q_ASSERT(!_fgProcessName.isEmpty());
        
Don Gagne's avatar
Don Gagne committed
89 90 91 92
    // We communicate with FlightGear over a UDP _udpCommSocket
    _udpCommSocket = new QUdpSocket(this);
    Q_CHECK_PTR(_udpCommSocket);
    _udpCommSocket->moveToThread(this);
93
    _udpCommSocket->bind(host, port, QAbstractSocket::ReuseAddressHint);
Don Gagne's avatar
Don Gagne committed
94
    QObject::connect(_udpCommSocket, SIGNAL(readyRead()), this, SLOT(readBytes()));
Don Gagne's avatar
Don Gagne committed
95 96 97 98 99 100 101 102 103 104 105
    
    
    // Connect to the various HIL signals that we use to then send information across the UDP protocol to FlightGear.
    connect(mav, SIGNAL(hilControlsChanged(quint64, float, float, float, float, quint8, quint8)),
            this, SLOT(updateControls(quint64,float,float,float,float,quint8,quint8)));
    connect(this, SIGNAL(hilStateChanged(quint64, float, float, float, float,float, float, double, double, double, float, float, float, float, float, float, float, float)),
            mav, SLOT(sendHilState(quint64, float, float, float, float,float, float, double, double, double, float, float, float, float, float, float, float, float)));
    connect(this, SIGNAL(sensorHilGpsChanged(quint64, double, double, double, int, float, float, float, float, float, float, float, int)),
            mav, SLOT(sendHilGps(quint64, double, double, double, int, float, float, float, float, float, float, float, int)));
    connect(this, SIGNAL(sensorHilRawImuChanged(quint64,float,float,float,float,float,float,float,float,float,float,float,float,float,quint32)),
            mav, SLOT(sendHilSensors(quint64,float,float,float,float,float,float,float,float,float,float,float,float,float,quint32)));
106 107
    connect(this, SIGNAL(sensorHilOpticalFlowChanged(quint64, qint16, qint16, float,float, quint8, float)),
            mav, SLOT(sendHilOpticalFlow(quint64, qint16, qint16, float, float, quint8, float)));
Don Gagne's avatar
Don Gagne committed
108
    
Don Gagne's avatar
Don Gagne committed
109 110 111 112
    // Start a new QProcess to run FlightGear in
    _fgProcess = new QProcess(this);
    Q_CHECK_PTR(_fgProcess);
    _fgProcess->moveToThread(this);
Don Gagne's avatar
Don Gagne committed
113
    
Don Gagne's avatar
Don Gagne committed
114
    connect(_fgProcess, SIGNAL(error(QProcess::ProcessError)), this, SLOT(processError(QProcess::ProcessError)));
Don Gagne's avatar
Don Gagne committed
115
#ifdef DEBUG_FLIGHTGEAR_CONNECT
Don Gagne's avatar
Don Gagne committed
116 117
    connect(_fgProcess, SIGNAL(readyReadStandardOutput()), this, SLOT(_printFgfsOutput()));
    connect(_fgProcess, SIGNAL(readyReadStandardError()), this, SLOT(_printFgfsError()));
118
#endif
Don Gagne's avatar
Don Gagne committed
119 120
    
    if (!_fgProcessWorkingDirPath.isEmpty()) {
Don Gagne's avatar
Don Gagne committed
121 122
        _fgProcess->setWorkingDirectory(_fgProcessWorkingDirPath);
		qDebug() << "Working directory" << _fgProcess->workingDirectory();
123
    }
Don Gagne's avatar
Don Gagne committed
124 125 126
    
#ifdef Q_OS_WIN32
	// On Windows we need to full qualify the location of the excecutable. The call to setWorkingDirectory only
Don Gagne's avatar
Don Gagne committed
127
	// sets the QProcess context, not the QProcess::start context. For some strange reason this is not the case on
Don Gagne's avatar
Don Gagne committed
128 129 130
	// OSX.
	QDir fgProcessFullyQualified(_fgProcessWorkingDirPath);
	_fgProcessName = fgProcessFullyQualified.absoluteFilePath(_fgProcessName);
131
#endif
Don Gagne's avatar
Don Gagne committed
132 133
    
#ifdef DEBUG_FLIGHTGEAR_CONNECT
Don Gagne's avatar
Don Gagne committed
134
    qDebug() << "\nStarting FlightGear" << _fgProcessWorkingDirPath << _fgProcessName << _fgArgList << "\n";
135
#endif
Don Gagne's avatar
Don Gagne committed
136
    
Don Gagne's avatar
Don Gagne committed
137
    _fgProcess->start(_fgProcessName, _fgArgList);
Don Gagne's avatar
Don Gagne committed
138
    connectState = true;
Don Gagne's avatar
Don Gagne committed
139
    
140
    emit simulationConnected(connectState);
Don Gagne's avatar
Don Gagne committed
141
    emit simulationConnected();
142

143 144 145 146 147 148
    exec();
}

void QGCFlightGearLink::setPort(int port)
{
    this->port = port;
lm's avatar
lm committed
149 150
    disconnectSimulation();
    connectSimulation();
151 152
}

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

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
/**
 * @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
204
            currentPort = host.split(":").last().toInt();
205 206 207 208 209 210 211 212 213 214 215
        }
    }
    else
    {
        QHostInfo info = QHostInfo::fromName(host);
        if (info.error() == QHostInfo::NoError)
        {
            // Add host
            currentHost = info.addresses().first();
        }
    }
216

217 218
}

219
void QGCFlightGearLink::updateActuators(quint64 time, float act1, float act2, float act3, float act4, float act5, float act6, float act7, float act8)
220
{
221 222 223 224 225 226 227 228 229
    Q_UNUSED(time);
    Q_UNUSED(act1);
    Q_UNUSED(act2);
    Q_UNUSED(act3);
    Q_UNUSED(act4);
    Q_UNUSED(act5);
    Q_UNUSED(act6);
    Q_UNUSED(act7);
    Q_UNUSED(act8);
230 231
}

232
void QGCFlightGearLink::updateControls(quint64 time, float rollAilerons, float pitchElevator, float yawRudder, float throttle, quint8 systemMode, quint8 navMode)
lm's avatar
lm committed
233
{
LM's avatar
LM committed
234 235
    // magnetos,aileron,elevator,rudder,throttle\n

lm's avatar
lm committed
236
    //float magnetos = 3.0f;
lm's avatar
lm committed
237 238 239
    Q_UNUSED(time);
    Q_UNUSED(systemMode);
    Q_UNUSED(navMode);
LM's avatar
LM committed
240

241 242 243 244
    if(!isnan(rollAilerons) && !isnan(pitchElevator) && !isnan(yawRudder) && !isnan(throttle))
    {
        QString state("%1\t%2\t%3\t%4\t%5\n");
        state = state.arg(rollAilerons).arg(pitchElevator).arg(yawRudder).arg(true).arg(throttle);
245
        writeBytes(state.toLatin1().constData(), state.length());
Don Gagne's avatar
Don Gagne committed
246 247
        //qDebug() << "Updated controls" << rollAilerons << pitchElevator << yawRudder << throttle;
        //qDebug() << "Updated controls" << state;
248 249 250 251 252
    }
    else
    {
        qDebug() << "HIL: Got NaN values from the hardware: isnan output: roll: " << isnan(rollAilerons) << ", pitch: " << isnan(pitchElevator) << ", yaw: " << isnan(yawRudder) << ", throttle: " << isnan(throttle);
    }
lm's avatar
lm committed
253 254
}

255 256
void QGCFlightGearLink::writeBytes(const char* data, qint64 size)
{
lm's avatar
lm committed
257
    //#define QGCFlightGearLink_DEBUG
258
#ifdef QGCFlightGearLink_DEBUG
lm's avatar
lm committed
259 260 261 262 263 264 265
    QString bytes;
    QString ascii;
    for (int i=0; i<size; i++)
    {
        unsigned char v = data[i];
        bytes.append(QString().sprintf("%02x ", v));
        if (data[i] > 31 && data[i] < 127)
266
        {
lm's avatar
lm committed
267
            ascii.append(data[i]);
268
        }
lm's avatar
lm committed
269 270 271 272 273 274 275 276
        else
        {
            ascii.append(219);
        }
    }
    qDebug() << "Sent" << size << "bytes to" << currentHost.toString() << ":" << currentPort << "data:";
    qDebug() << bytes;
    qDebug() << "ASCII:" << ascii;
277
#endif
Don Gagne's avatar
Don Gagne committed
278
    if (connectState && _udpCommSocket) _udpCommSocket->writeDatagram(data, size, currentHost, currentPort);
279 280 281 282 283 284 285 286 287 288 289
}

/**
 * @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;
290
    char data[maxLength];
291 292 293
    QHostAddress sender;
    quint16 senderPort;

Don Gagne's avatar
Don Gagne committed
294
    unsigned int s = _udpCommSocket->pendingDatagramSize();
295
    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
296
    _udpCommSocket->readDatagram(data, maxLength, &sender, &senderPort);
297 298

    QByteArray b(data, s);
lm's avatar
lm committed
299 300 301

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

lm's avatar
lm committed
304 305 306
    QStringList values = state.split("\t");

    // Check length
307
    const int nValues = 22;
308
    if (values.size() != nValues)
lm's avatar
lm committed
309
    {
310
        qDebug() << "RETURN LENGTH MISMATCHING EXPECTED" << nValues << "BUT GOT" << values.size();
lm's avatar
lm committed
311
        qDebug() << state;
312 313 314
        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
315 316
        return;
    }
lm's avatar
lm committed
317 318 319

    // Parse string
    float roll, pitch, yaw, rollspeed, pitchspeed, yawspeed;
320
    double lat, lon, alt;
Thomas Gubler's avatar
Thomas Gubler committed
321 322 323 324 325 326 327
    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;
328
    float alt_agl;
329

lm's avatar
lm committed
330

Lorenz Meier's avatar
Lorenz Meier committed
331 332 333
    lat = values.at(1).toDouble();
    lon = values.at(2).toDouble();
    alt = values.at(3).toDouble();
Thomas Gubler's avatar
Thomas Gubler committed
334 335 336 337 338 339
    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
340

Thomas Gubler's avatar
Thomas Gubler committed
341 342 343
    xacc = values.at(10).toFloat();
    yacc = values.at(11).toFloat();
    zacc = values.at(12).toFloat();
lm's avatar
lm committed
344

Thomas Gubler's avatar
Thomas Gubler committed
345 346 347 348 349 350
    vx = values.at(13).toFloat();
    vy = values.at(14).toFloat();
    vz = values.at(15).toFloat();

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

351 352
    mag_variation = values.at(17).toFloat();
    mag_dip = values.at(18).toFloat();
Thomas Gubler's avatar
Thomas Gubler committed
353

354
    temperature = values.at(19).toFloat();
355 356
    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
357

358 359
    alt_agl = values.at(21).toFloat();

360 361 362 363 364 365
    //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;
366

367 368 369 370 371 372 373 374 375
    /* 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);
    }
376

377
    //qDebug() << "ind_airspeed: " << ind_airspeed << "true_airspeed: " << true_airspeed;
378

lm's avatar
lm committed
379
    // Send updated state
Thomas Gubler's avatar
Thomas Gubler committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
    //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;

		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;

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

        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,
428
                                    xmag_body, ymag_body, zmag_body, abs_pressure*1e-2f, diff_pressure*1e-2f, pressure_alt, temperature, fields_changed); //Pressure in hPa for mavlink
Thomas Gubler's avatar
Thomas Gubler committed
429 430 431

//        qDebug()  << "sensorHilRawImuChanged " << xacc  << yacc << zacc  << rollspeed << pitchspeed << yawspeed << xmag << ymag << zmag << abs_pressure << diff_pressure << pressure_alt << temperature;
        int gps_fix_type = 3;
432 433
        float eph = 0.3f;
        float epv = 0.6f;
Thomas Gubler's avatar
Thomas Gubler committed
434 435 436 437 438 439
        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;
440 441

        // Send Optical Flow message. For now we set the flow quality to 0 and just write the ground_distance field
442 443 444 445 446
        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
        }
447 448
        emit sensorHilOpticalFlowChanged(QGC::groundTimeUsecs(), 0, 0, 0.0f,
                                         0.0f, 0.0f, distanceMeasurement);
Thomas Gubler's avatar
Thomas Gubler committed
449 450
    } else {
        emit hilStateChanged(QGC::groundTimeUsecs(), roll, pitch, yaw, rollspeed,
lm's avatar
lm committed
451
                         pitchspeed, yawspeed, lat, lon, alt,
Thomas Gubler's avatar
Thomas Gubler committed
452 453 454
                         vx, vy, vz,
                         ind_airspeed, true_airspeed,
                         xacc, yacc, zacc);
455
        //qDebug()  << "hilStateChanged " << (qint32)lat << (qint32)lon << (qint32)alt;
Thomas Gubler's avatar
Thomas Gubler committed
456
    }
lm's avatar
lm committed
457 458 459 460 461 462 463 464 465 466

    //    // 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;
467 468 469 470 471 472 473 474 475 476
}


/**
 * @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
477
    return _udpCommSocket->pendingDatagramSize();
478 479 480 481 482 483 484
}

/**
 * @brief Disconnect the connection.
 *
 * @return True if connection has been disconnected, false if connection couldn't be disconnected.
 **/
lm's avatar
lm committed
485
bool QGCFlightGearLink::disconnectSimulation()
486
{
Don Gagne's avatar
Don Gagne committed
487
    disconnect(_fgProcess, SIGNAL(error(QProcess::ProcessError)),
488
               this, SLOT(processError(QProcess::ProcessError)));
489
    disconnect(mav, SIGNAL(hilControlsChanged(quint64, float, float, float, float, quint8, quint8)), this, SLOT(updateControls(quint64,float,float,float,float,quint8,quint8)));
Thomas Gubler's avatar
Thomas Gubler committed
490 491 492
    disconnect(this, SIGNAL(hilStateChanged(quint64, float, float, float, float,float, float, double, double, double, float, float, float, float, float, float, float, float)), mav, SLOT(sendHilState(quint64, float, float, float, float,float, float, double, double, double, float, float, float, float, float, float, float, float)));
    disconnect(this, SIGNAL(sensorHilGpsChanged(quint64, double, double, double, int, float, float, float, float, float, float, float, int)), mav, SLOT(sendHilGps(quint64, double, double, double, int, float, float, float, float, float, float, float, int)));
    disconnect(this, SIGNAL(sensorHilRawImuChanged(quint64,float,float,float,float,float,float,float,float,float,float,float,float,float,quint32)), mav, SLOT(sendHilSensors(quint64,float,float,float,float,float,float,float,float,float,float,float,float,float,quint32)));
493 494
    disconnect(this, SIGNAL(sensorHilOpticalFlowChanged(quint64, qint16, qint16, float,float, quint8, float)),
            mav, SLOT(sendHilOpticalFlow(quint64, qint16, qint16, float, float, quint8, float)));
LM's avatar
LM committed
495

Don Gagne's avatar
Don Gagne committed
496
    if (_fgProcess)
lm's avatar
lm committed
497
    {
Don Gagne's avatar
Don Gagne committed
498 499 500
        _fgProcess->close();
        delete _fgProcess;
        _fgProcess = NULL;
lm's avatar
lm committed
501
    }
Don Gagne's avatar
Don Gagne committed
502
    if (_udpCommSocket)
LM's avatar
LM committed
503
    {
Don Gagne's avatar
Don Gagne committed
504 505 506
        _udpCommSocket->close();
        delete _udpCommSocket;
        _udpCommSocket = NULL;
LM's avatar
LM committed
507
    }
508 509 510

    connectState = false;

511 512
    emit simulationDisconnected();
    emit simulationConnected(false);
Don Gagne's avatar
Don Gagne committed
513 514 515 516

    // Exit the thread
    quit();

517 518 519
    return !connectState;
}

Don Gagne's avatar
Don Gagne committed
520 521
/// @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
522 523
///     @param uiArgs Arguments to parse
///     @param argList Returned argument list
Don Gagne's avatar
Don Gagne committed
524
/// @return Returns false if the argument list has mistmatced quotes within in.
525

Don Gagne's avatar
Don Gagne committed
526 527
bool QGCFlightGearLink::parseUIArguments(QString uiArgs, QStringList& argList)
{
Don Gagne's avatar
Don Gagne committed
528
    // 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
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554

	// This is not as easy as it seams since some options can be quoted to preserve spaces within things like
    // 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.
    
	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) {
555
                        QGCMessageBox::critical(tr("FlightGear HIL"), tr("FlightGear failed to start. There are mismatched quotes in specified command line options"));
Don Gagne's avatar
Don Gagne committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
						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();
	}
    
591
    return true;
592 593
}

Don Gagne's avatar
Don Gagne committed
594 595 596 597 598
/// @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
599

Don Gagne's avatar
Don Gagne committed
600 601 602 603 604 605 606 607 608 609 610 611 612
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;
    }
613 614
}

615 616 617 618 619
/**
 * @brief Connect the connection.
 *
 * @return True if connection has been established, false if connection couldn't be established.
 **/
lm's avatar
lm committed
620
bool QGCFlightGearLink::connectSimulation()
621
{
Don Gagne's avatar
Don Gagne committed
622 623 624 625 626 627 628 629 630
    // 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.
    
    if (!mav) {
        return false;
    }
    
Don Gagne's avatar
Don Gagne committed
631 632 633 634 635 636 637
    QString     fgAppName;
    QString     fgRootPath;						// FlightGear root data directory as specified by --fg-root
    QStringList fgRootPathProposedList;         // Directories we will attempt to search for --fg-root
	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
    QDir        fgAppDir;						// Location of main FlightGear application
638 639 640 641 642 643 644

    // 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) {
645
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("FlightGear failed to start. There are mismatched quotes in specified command line options"));
646 647 648 649 650 651 652
        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;
Don Gagne's avatar
Don Gagne committed
653 654 655 656 657 658 659 660
    
#if defined Q_OS_MACX
    // 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";
    _fgProcessName = "./fgfs.sh";
    _fgProcessWorkingDirPath = "/Applications/FlightGear.app/Contents/Resources/";
Don Gagne's avatar
Don Gagne committed
661
    fgRootPathProposedList += "/Applications/FlightGear.app/Contents/Resources/data/";
Don Gagne's avatar
Don Gagne committed
662
#elif defined Q_OS_WIN32
Don Gagne's avatar
Don Gagne committed
663
    _fgProcessName = "fgfs.exe";
Don Gagne's avatar
Don Gagne committed
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
    
    // 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);
			QString lookahead;	// lookahead for continuation lines
            while (!in.atEnd() || !lookahead.isEmpty()) {
                QString line;
				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();
					}
				}
                
                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
711
                        _fgProcessWorkingDirPath = fgAppDir.absolutePath();
Don Gagne's avatar
Don Gagne committed
712 713 714 715 716 717 718
                        qDebug() << "fg_exe" << fgAppDir.absolutePath();
                    }
                    continue;
                }
                
                regExp.setPattern("^fg_root:(.*)");
                if (regExp.indexIn(line) == 0 && regExp.captureCount() == 1) {
Don Gagne's avatar
Don Gagne committed
719 720
                    fgRootPathProposedList += QDir(regExp.cap(1)).absolutePath();
                    qDebug() << "fg_root" << fgRootPathProposedList[0];
Don Gagne's avatar
Don Gagne committed
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
                    continue;
                }
                
                regExp.setPattern("^fg_scenery:(.*)");
                if (regExp.indexIn(line) == 0 && regExp.captureCount() == 1) {
					// Scenery can contain multiple paths seperated by ';' so don't do QDir::absolutePath on it
                    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
737
    _fgProcessName = "fgfs";
Don Gagne's avatar
Don Gagne committed
738 739
    fgRootPathProposedList += "/usr/share/flightgear/data/";    // Default Archlinux location
    fgRootPathProposedList += "/usr/share/games/flightgear/";   // Default Ubuntu location
Don Gagne's avatar
Don Gagne committed
740 741 742 743 744
#else
#error Unknown OS build flavor
#endif
    
#ifndef Q_OS_LINUX
Don Gagne's avatar
Don Gagne committed
745
    // 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
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
    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;
        }
        
        // Let the user pick the right directory
Don Gagne's avatar
Don Gagne committed
761
        QString dirPath = QGCFileDialog::getExistingDirectory(MainWindow::instance(), tr("Please select directory of FlightGear application : ") + fgAppName);
Don Gagne's avatar
Don Gagne committed
762 763 764 765
        if (dirPath.isEmpty()) {
            return false;
        }
        fgAppDir.setPath(dirPath);
Don Gagne's avatar
Don Gagne committed
766 767 768
        fgAppFullyQualified = fgAppDir.absoluteFilePath(fgAppName);
    }
#endif
769
     
Don Gagne's avatar
Don Gagne committed
770
    // 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
771 772 773 774 775 776 777 778
    // proposed locations.
    QString argValue;
    fgRootDirOverride = _findUIArgument(_fgArgList, "--fg-root", argValue);
    if (fgRootDirOverride) {
        fgRootPathProposedList.clear();
        fgRootPathProposedList += argValue;
        qDebug() << "--fg-root override" << argValue;
    }
779

Don Gagne's avatar
Don Gagne committed
780 781 782 783 784 785 786 787 788 789 790
    // 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();
        }
    }
Don Gagne's avatar
Don Gagne committed
791
    
Don Gagne's avatar
Don Gagne committed
792 793 794 795 796 797 798 799
    // 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.");
        }
800
        QGCMessageBox::critical(tr("FlightGear HIL"), errMsg);
Don Gagne's avatar
Don Gagne committed
801 802
        return false;
    }
803

Don Gagne's avatar
Don Gagne committed
804 805 806 807
    if (!fgRootDirOverride) {
        _fgArgList += "--fg-root=" + fgRootPath;
    }

Don Gagne's avatar
Don Gagne committed
808 809
    // 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
810 811 812 813
    fgSceneryDirOverride = _findUIArgument(_fgArgList, "--fg-scenery", argValue);
    if (fgSceneryDirOverride) {
        fgSceneryPath = argValue;
        qDebug() << "--fg-scenery override" << argValue;
Don Gagne's avatar
Don Gagne committed
814 815 816 817 818 819 820 821 822 823 824 825 826 827
    } else if (!fgSceneryPath.isEmpty()) {
		_fgArgList += "--fg-scenery=" + fgSceneryPath;
	}
    
#ifdef Q_OS_WIN32
    // Windows won't start without an --fg-scenery set. We don't validate the directory in the path since
	// it can be multiple paths.
    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.");
        }
828
        QGCMessageBox::critical(tr("FlightGear HIL"), errMsg);
Don Gagne's avatar
Don Gagne committed
829 830
        return false;
    }
Don Gagne's avatar
Don Gagne committed
831 832
#else
    Q_UNUSED(fgSceneryDirOverride);
Don Gagne's avatar
Don Gagne committed
833 834 835
#endif
    
    // Setup and verify directory which contains QGC provided aircraft files
Don Gagne's avatar
Don Gagne committed
836
    QString qgcAircraftDir(QApplication::applicationDirPath() + "/flightgear/Aircraft");
Don Gagne's avatar
Don Gagne committed
837
    if (!QFileInfo(qgcAircraftDir).isDir()) {
838
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. Aircraft directory is missing: '%1'.").arg(qgcAircraftDir));
Don Gagne's avatar
Don Gagne committed
839 840 841 842 843 844
        return false;
    }
    _fgArgList += "--fg-aircraft=" + qgcAircraftDir;
    
    // Setup protocol we will be using to communicate with FlightGear
    QString fgProtocol(mav->getSystemType() == MAV_TYPE_QUADROTOR ? "qgroundcontrol-quadrotor" : "qgroundcontrol-fixed-wing");
Don Gagne's avatar
Don Gagne committed
845
    QString fgProtocolArg("--generic=socket,%1,300,127.0.0.1,%2,udp,%3");
Don Gagne's avatar
Don Gagne committed
846 847 848 849 850 851
    _fgArgList << fgProtocolArg.arg("out").arg(port).arg(fgProtocol);
    _fgArgList << fgProtocolArg.arg("in").arg(currentPort).arg(fgProtocol);
    
    // Verify directory where FlightGear stores communicaton protocols.
    QDir fgProtocolDir(fgRootPath);
    if (!fgProtocolDir.cd("Protocol")) {
852
        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
853 854 855 856
        return false;
    }
    
    // Verify directory which contains QGC provided FlightGear communication protocol files
Don Gagne's avatar
Don Gagne committed
857
    QDir qgcProtocolDir(QApplication::applicationDirPath() + "/flightgear/Protocol/");
Don Gagne's avatar
Don Gagne committed
858
    if (!qgcProtocolDir.isReadable()) {
859
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. Protocol directory is missing (%1).").arg(qgcProtocolDir.path()));
Don Gagne's avatar
Don Gagne committed
860 861 862
        return false;
    }
    
863 864 865 866
    // 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()) {
867
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. FlightGear protocol file missing: %1").arg(qgcProtocolFileFullyQualified));
868 869 870
        return false;
    }
    
Don Gagne's avatar
Don Gagne committed
871 872 873
    // 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.
874
    _fgProtocolFileFullyQualified = fgProtocolDir.absoluteFilePath(fgProtocolXmlFile);
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
    
    if (QFileInfo(_fgProtocolFileFullyQualified).exists()) {
        // Verify that the file is current by comparing it against the one in QGC
        
        QFile fgFile(_fgProtocolFileFullyQualified);
        QFile qgcFile(qgcProtocolFileFullyQualified);
        
        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));
        }
        
        QByteArray fgBytes = fgFile.readAll();
        QByteArray qgcBytes = qgcFile.readAll();
        
        fgFile.close();
        qgcFile.close();
        
        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;
            }
        }
    }
    
904
    if (!QFileInfo(_fgProtocolFileFullyQualified).exists()) {
Don Gagne's avatar
Don Gagne committed
905 906 907 908 909 910 911 912 913 914 915 916
        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;
        }
        
        // Now that we made it this far, we should be able to try to copy the protocol file to FlightGear.
917
        bool succeeded = QFile::copy(qgcProtocolFileFullyQualified, _fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
918 919
        if (!succeeded) {
#ifdef Q_OS_WIN32
920
            QString copyCmd = QString("copy \"%1\" \"%2\"").arg(qgcProtocolFileFullyQualified).arg(_fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
921 922
            copyCmd.replace("/", "\\");
#else
923
            QString copyCmd = QString("sudo cp %1 %2").arg(qgcProtocolFileFullyQualified).arg(_fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
924 925 926 927 928
#endif
            
            QMessageBox msgBox(QMessageBox::Critical,
                               tr("Copy failed"),
#ifdef Q_OS_WIN32
929
                               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
930
#else
931
                               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
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
#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;
        }
    }
    
    // Start the engines to save a startup step
    if (mav->getSystemType() == MAV_TYPE_QUADROTOR) {
        // 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";
    }
    
    // We start out at our home position
    _fgArgList << QString("--lat=%1").arg(UASManager::instance()->getHomeLatitude());
    _fgArgList << QString("--lon=%1").arg(UASManager::instance()->getHomeLongitude());
    // 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
    //_fgArgList << QString("--altitude=%1").arg(UASManager::instance()->getHomeAltitude());
    
#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
    
968 969
    start(HighPriority);
    return true;
970 971
}

Don Gagne's avatar
Don Gagne committed
972
void QGCFlightGearLink::_printFgfsOutput(void)
Thomas Gubler's avatar
Thomas Gubler committed
973 974
{
   qDebug() << "fgfs stdout:";
Don Gagne's avatar
Don Gagne committed
975
   QByteArray byteArray = _fgProcess->readAllStandardOutput();
Thomas Gubler's avatar
Thomas Gubler committed
976 977 978 979 980 981 982
   QStringList strLines = QString(byteArray).split("\n");

   foreach (QString line, strLines){
    qDebug() << line;
   }
}

Don Gagne's avatar
Don Gagne committed
983
void QGCFlightGearLink::_printFgfsError(void)
Thomas Gubler's avatar
Thomas Gubler committed
984 985 986
{
   qDebug() << "fgfs stderr:";

Don Gagne's avatar
Don Gagne committed
987
   QByteArray byteArray = _fgProcess->readAllStandardError();
Thomas Gubler's avatar
Thomas Gubler committed
988 989 990 991 992 993 994
   QStringList strLines = QString(byteArray).split("\n");

   foreach (QString line, strLines){
    qDebug() << line;
   }
}

995 996 997 998 999 1000 1001 1002 1003
/**
 * @brief Set the startup arguments used to start flightgear
 *
 **/
void QGCFlightGearLink::setStartupArguments(QString startupArguments)
{
    this->startupArguments = startupArguments;
}

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
/**
 * @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
1019 1020 1021 1022 1023
QString QGCFlightGearLink::getRemoteHost()
{
    return QString("%1:%2").arg(currentHost.toString(), currentPort);
}

1024 1025 1026
void QGCFlightGearLink::setName(QString name)
{
    this->name = name;
lm's avatar
lm committed
1027
    //    emit nameChanged(this->name);
1028
}
1029 1030 1031 1032 1033

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