QGCFlightGearLink.cc 43.1 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>
39
#include <QClipboard>
Don Gagne's avatar
Don Gagne committed
40

41
#include <iostream>
42
#include <Eigen/Eigen>
Don Gagne's avatar
Don Gagne committed
43

44 45
#include "QGCFlightGearLink.h"
#include "QGC.h"
Don Gagne's avatar
Don Gagne committed
46
#include "QGCFileDialog.h"
47
#include "QGCMessageBox.h"
48
#include "HomePositionManager.h"
49
#include "QGCApplication.h"
50 51
#include "Vehicle.h"
#include "UAS.h"
52

Don Gagne's avatar
Don Gagne committed
53
// 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
54
// for tracking down problems.
Don Gagne's avatar
Don Gagne committed
55
//#define DEBUG_FLIGHTGEAR_CONNECT
Don Gagne's avatar
Don Gagne committed
56

57 58 59 60 61 62 63 64
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)
65
{
66 67 68 69
    // 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);

70
    this->host = host;
71
    this->port = port + _vehicle->id();
72
    this->connectState = false;
73
    this->currentPort = 49000 + _vehicle->id();
Don Gagne's avatar
Don Gagne committed
74
    this->name = tr("FlightGear 3.0+ Link (port:%1)").arg(port);
LM's avatar
LM committed
75
    setRemoteHost(remoteHost);
dogmaphobic's avatar
dogmaphobic committed
76

Don Gagne's avatar
Don Gagne committed
77
    // We need a mechanism so show error message from our FGLink thread on the UI thread. This signal connection will do that for us.
78
    connect(this, &QGCFlightGearLink::showCriticalMessageFromThread, qgcApp(), &QGCApplication::criticalMessageBoxOnMainThread);
79
    connect(this, &QGCFlightGearLink::disconnectSim, this, &QGCFlightGearLink::disconnectSimulation);
80 81 82
}

QGCFlightGearLink::~QGCFlightGearLink()
83
{   //do not disconnect unless it is connected.
Don Gagne's avatar
Don Gagne committed
84
    //disconnectSimulation will delete the memory that was allocated for proces, terraSync and _udpCommSocket
85 86 87
    if(connectState){
       disconnectSimulation();
    }
88 89
}

Don Gagne's avatar
Don Gagne committed
90
/// @brief Runs the simulation thread. We do setup work here which needs to happen in the seperate thread.
91 92
void QGCFlightGearLink::run()
{
93
    Q_ASSERT(_vehicle);
Don Gagne's avatar
Don Gagne committed
94
    Q_ASSERT(!_fgProcessName.isEmpty());
dogmaphobic's avatar
dogmaphobic committed
95

Don Gagne's avatar
Don Gagne committed
96 97 98 99
    // We communicate with FlightGear over a UDP _udpCommSocket
    _udpCommSocket = new QUdpSocket(this);
    Q_CHECK_PTR(_udpCommSocket);
    _udpCommSocket->moveToThread(this);
100
    _udpCommSocket->bind(host, port, QAbstractSocket::ReuseAddressHint);
Don Gagne's avatar
Don Gagne committed
101
    QObject::connect(_udpCommSocket, SIGNAL(readyRead()), this, SLOT(readBytes()));
dogmaphobic's avatar
dogmaphobic committed
102 103


Don Gagne's avatar
Don Gagne committed
104
    // Connect to the various HIL signals that we use to then send information across the UDP protocol to FlightGear.
105
    connect(_vehicle->uas(), SIGNAL(hilControlsChanged(quint64, float, float, float, float, quint8, quint8)),
Don Gagne's avatar
Don Gagne committed
106 107
            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)),
108
            _vehicle->uas(), SLOT(sendHilState(quint64, float, float, float, float,float, float, double, double, double, float, float, float, float, float, float, float, float)));
Don Gagne's avatar
Don Gagne committed
109
    connect(this, SIGNAL(sensorHilGpsChanged(quint64, double, double, double, int, float, float, float, float, float, float, float, int)),
110
            _vehicle->uas(), SLOT(sendHilGps(quint64, double, double, double, int, float, float, float, float, float, float, float, int)));
Don Gagne's avatar
Don Gagne committed
111
    connect(this, SIGNAL(sensorHilRawImuChanged(quint64,float,float,float,float,float,float,float,float,float,float,float,float,float,quint32)),
112
            _vehicle->uas(), SLOT(sendHilSensors(quint64,float,float,float,float,float,float,float,float,float,float,float,float,float,quint32)));
113
    connect(this, SIGNAL(sensorHilOpticalFlowChanged(quint64, qint16, qint16, float,float, quint8, float)),
114
            _vehicle->uas(), SLOT(sendHilOpticalFlow(quint64, qint16, qint16, float, float, quint8, float)));
dogmaphobic's avatar
dogmaphobic committed
115

Don Gagne's avatar
Don Gagne committed
116 117 118 119
    // Start a new QProcess to run FlightGear in
    _fgProcess = new QProcess(this);
    Q_CHECK_PTR(_fgProcess);
    _fgProcess->moveToThread(this);
dogmaphobic's avatar
dogmaphobic committed
120

Don Gagne's avatar
Don Gagne committed
121
    connect(_fgProcess, SIGNAL(error(QProcess::ProcessError)), this, SLOT(processError(QProcess::ProcessError)));
Don Gagne's avatar
Don Gagne committed
122
#ifdef DEBUG_FLIGHTGEAR_CONNECT
Don Gagne's avatar
Don Gagne committed
123 124
    connect(_fgProcess, SIGNAL(readyReadStandardOutput()), this, SLOT(_printFgfsOutput()));
    connect(_fgProcess, SIGNAL(readyReadStandardError()), this, SLOT(_printFgfsError()));
125
#endif
dogmaphobic's avatar
dogmaphobic committed
126

Don Gagne's avatar
Don Gagne committed
127
    if (!_fgProcessWorkingDirPath.isEmpty()) {
Don Gagne's avatar
Don Gagne committed
128
        _fgProcess->setWorkingDirectory(_fgProcessWorkingDirPath);
dogmaphobic's avatar
dogmaphobic committed
129
        qDebug() << "Working directory" << _fgProcess->workingDirectory();
130
    }
dogmaphobic's avatar
dogmaphobic committed
131

Don Gagne's avatar
Don Gagne committed
132
#ifdef Q_OS_WIN32
dogmaphobic's avatar
dogmaphobic committed
133 134 135
    // 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.
136
    QDir fgProcessFullyQualified(_fgProcessWorkingDirPath);
dogmaphobic's avatar
dogmaphobic committed
137
    _fgProcessName = fgProcessFullyQualified.absoluteFilePath(_fgProcessName);
138
#endif
dogmaphobic's avatar
dogmaphobic committed
139

Don Gagne's avatar
Don Gagne committed
140
#ifdef DEBUG_FLIGHTGEAR_CONNECT
Don Gagne's avatar
Don Gagne committed
141
    qDebug() << "\nStarting FlightGear" << _fgProcessWorkingDirPath << _fgProcessName << _fgArgList << "\n";
142
#endif
dogmaphobic's avatar
dogmaphobic committed
143

Don Gagne's avatar
Don Gagne committed
144
    _fgProcess->start(_fgProcessName, _fgArgList);
Don Gagne's avatar
Don Gagne committed
145
    connectState = true;
dogmaphobic's avatar
dogmaphobic committed
146

147
    emit simulationConnected(connectState);
Don Gagne's avatar
Don Gagne committed
148
    emit simulationConnected();
149

150 151 152 153 154 155
    exec();
}

void QGCFlightGearLink::setPort(int port)
{
    this->port = port;
lm's avatar
lm committed
156 157
    disconnectSimulation();
    connectSimulation();
158 159
}

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

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
/**
 * @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
211
            currentPort = host.split(":").last().toInt();
212 213 214 215 216 217 218 219 220 221 222
        }
    }
    else
    {
        QHostInfo info = QHostInfo::fromName(host);
        if (info.error() == QHostInfo::NoError)
        {
            // Add host
            currentHost = info.addresses().first();
        }
    }
223

224 225
}

226
void QGCFlightGearLink::updateActuators(quint64 time, float act1, float act2, float act3, float act4, float act5, float act6, float act7, float act8)
227
{
228 229 230 231 232 233 234 235 236
    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);
237 238
}

239
void QGCFlightGearLink::updateControls(quint64 time, float rollAilerons, float pitchElevator, float yawRudder, float throttle, quint8 systemMode, quint8 navMode)
lm's avatar
lm committed
240
{
LM's avatar
LM committed
241 242
    // magnetos,aileron,elevator,rudder,throttle\n

lm's avatar
lm committed
243
    //float magnetos = 3.0f;
lm's avatar
lm committed
244 245 246
    Q_UNUSED(time);
    Q_UNUSED(systemMode);
    Q_UNUSED(navMode);
LM's avatar
LM committed
247

248 249 250 251
    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);
252
        writeBytes(state.toLatin1().constData(), state.length());
Don Gagne's avatar
Don Gagne committed
253 254
        //qDebug() << "Updated controls" << rollAilerons << pitchElevator << yawRudder << throttle;
        //qDebug() << "Updated controls" << state;
255 256 257 258 259
    }
    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
260 261
}

262 263
void QGCFlightGearLink::writeBytes(const char* data, qint64 size)
{
lm's avatar
lm committed
264
    //#define QGCFlightGearLink_DEBUG
265
#ifdef QGCFlightGearLink_DEBUG
lm's avatar
lm committed
266 267 268 269 270 271 272
    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)
273
        {
lm's avatar
lm committed
274
            ascii.append(data[i]);
275
        }
lm's avatar
lm committed
276 277 278 279 280 281 282 283
        else
        {
            ascii.append(219);
        }
    }
    qDebug() << "Sent" << size << "bytes to" << currentHost.toString() << ":" << currentPort << "data:";
    qDebug() << bytes;
    qDebug() << "ASCII:" << ascii;
284
#endif
Don Gagne's avatar
Don Gagne committed
285
    if (connectState && _udpCommSocket) _udpCommSocket->writeDatagram(data, size, currentHost, currentPort);
286 287 288 289 290 291 292 293 294 295 296
}

/**
 * @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;
297
    char data[maxLength];
298 299 300
    QHostAddress sender;
    quint16 senderPort;

Don Gagne's avatar
Don Gagne committed
301
    unsigned int s = _udpCommSocket->pendingDatagramSize();
302
    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
303
    _udpCommSocket->readDatagram(data, maxLength, &sender, &senderPort);
304 305

    QByteArray b(data, s);
lm's avatar
lm committed
306 307 308

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

lm's avatar
lm committed
311 312 313
    QStringList values = state.split("\t");

    // Check length
314
    const int nValues = 22;
315
    if (values.size() != nValues)
lm's avatar
lm committed
316
    {
317
        qDebug() << "RETURN LENGTH MISMATCHING EXPECTED" << nValues << "BUT GOT" << values.size();
lm's avatar
lm committed
318
        qDebug() << state;
319 320 321
        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
322 323
        return;
    }
lm's avatar
lm committed
324 325 326

    // Parse string
    float roll, pitch, yaw, rollspeed, pitchspeed, yawspeed;
327
    double lat, lon, alt;
Thomas Gubler's avatar
Thomas Gubler committed
328 329 330 331 332 333 334
    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;
335
    float alt_agl;
336

lm's avatar
lm committed
337

Lorenz Meier's avatar
Lorenz Meier committed
338 339 340
    lat = values.at(1).toDouble();
    lon = values.at(2).toDouble();
    alt = values.at(3).toDouble();
Thomas Gubler's avatar
Thomas Gubler committed
341 342 343 344 345 346
    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
347

Thomas Gubler's avatar
Thomas Gubler committed
348 349 350
    xacc = values.at(10).toFloat();
    yacc = values.at(11).toFloat();
    zacc = values.at(12).toFloat();
lm's avatar
lm committed
351

Thomas Gubler's avatar
Thomas Gubler committed
352 353 354 355 356 357
    vx = values.at(13).toFloat();
    vy = values.at(14).toFloat();
    vz = values.at(15).toFloat();

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

358 359
    mag_variation = values.at(17).toFloat();
    mag_dip = values.at(18).toFloat();
Thomas Gubler's avatar
Thomas Gubler committed
360

361
    temperature = values.at(19).toFloat();
362 363
    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
364

365 366
    alt_agl = values.at(21).toFloat();

367 368 369 370 371 372
    //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;
373

374 375 376 377 378 379 380 381 382
    /* 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);
    }
383

384
    //qDebug() << "ind_airspeed: " << ind_airspeed << "true_airspeed: " << true_airspeed;
385

lm's avatar
lm committed
386
    // Send updated state
Thomas Gubler's avatar
Thomas Gubler committed
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
    //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
416 417 418
        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
419

dogmaphobic's avatar
dogmaphobic committed
420 421 422
        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
423 424 425 426 427 428 429 430 431 432 433 434

        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,
435
                                    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
436 437 438

//        qDebug()  << "sensorHilRawImuChanged " << xacc  << yacc << zacc  << rollspeed << pitchspeed << yawspeed << xmag << ymag << zmag << abs_pressure << diff_pressure << pressure_alt << temperature;
        int gps_fix_type = 3;
439 440
        float eph = 0.3f;
        float epv = 0.6f;
Thomas Gubler's avatar
Thomas Gubler committed
441 442 443 444 445 446
        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;
447 448

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

    //    // 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;
474 475 476 477 478 479 480 481 482 483
}


/**
 * @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
484
    return _udpCommSocket->pendingDatagramSize();
485 486 487 488 489 490 491
}

/**
 * @brief Disconnect the connection.
 *
 * @return True if connection has been disconnected, false if connection couldn't be disconnected.
 **/
lm's avatar
lm committed
492
bool QGCFlightGearLink::disconnectSimulation()
493
{
Don Gagne's avatar
Don Gagne committed
494
    disconnect(_fgProcess, SIGNAL(error(QProcess::ProcessError)),
495
               this, SLOT(processError(QProcess::ProcessError)));
496 497 498 499
    disconnect(_vehicle->uas(), SIGNAL(hilControlsChanged(quint64, float, float, float, float, quint8, quint8)), this, SLOT(updateControls(quint64,float,float,float,float,quint8,quint8)));
    disconnect(this, SIGNAL(hilStateChanged(quint64, float, float, float, float,float, float, double, double, double, float, float, float, float, float, float, float, float)), _vehicle->uas(), 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)), _vehicle->uas(), 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)), _vehicle->uas(), SLOT(sendHilSensors(quint64,float,float,float,float,float,float,float,float,float,float,float,float,float,quint32)));
500
    disconnect(this, SIGNAL(sensorHilOpticalFlowChanged(quint64, qint16, qint16, float,float, quint8, float)),
501
            _vehicle->uas(), SLOT(sendHilOpticalFlow(quint64, qint16, qint16, float, float, quint8, float)));
LM's avatar
LM committed
502

Don Gagne's avatar
Don Gagne committed
503
    if (_fgProcess)
lm's avatar
lm committed
504
    {
Don Gagne's avatar
Don Gagne committed
505
        _fgProcess->close();
506
        _fgProcess->deleteLater();
Don Gagne's avatar
Don Gagne committed
507
        _fgProcess = NULL;
lm's avatar
lm committed
508
    }
Don Gagne's avatar
Don Gagne committed
509
    if (_udpCommSocket)
LM's avatar
LM committed
510
    {
Don Gagne's avatar
Don Gagne committed
511
        _udpCommSocket->close();
512
        _udpCommSocket->deleteLater();
Don Gagne's avatar
Don Gagne committed
513
        _udpCommSocket = NULL;
LM's avatar
LM committed
514
    }
515 516 517

    connectState = false;

518 519
    emit simulationDisconnected();
    emit simulationConnected(false);
Don Gagne's avatar
Don Gagne committed
520 521 522 523

    // Exit the thread
    quit();

524 525 526
    return !connectState;
}

Don Gagne's avatar
Don Gagne committed
527 528
/// @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
529 530
///     @param uiArgs Arguments to parse
///     @param argList Returned argument list
Don Gagne's avatar
Don Gagne committed
531
/// @return Returns false if the argument list has mistmatced quotes within in.
532

Don Gagne's avatar
Don Gagne committed
533 534
bool QGCFlightGearLink::parseUIArguments(QString uiArgs, QStringList& argList)
{
Don Gagne's avatar
Don Gagne committed
535
    // 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
536

dogmaphobic's avatar
dogmaphobic committed
537
    // 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
538 539 540 541
    // 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
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561

    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) {
562
                        QGCMessageBox::critical(tr("FlightGear HIL"), tr("FlightGear failed to start. There are mismatched quotes in specified command line options"));
dogmaphobic's avatar
dogmaphobic committed
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 591 592 593 594 595 596 597
                        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();
    }

598
    return true;
599 600
}

Don Gagne's avatar
Don Gagne committed
601 602 603 604 605
/// @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
606

Don Gagne's avatar
Don Gagne committed
607 608 609 610 611 612 613 614 615 616 617 618 619
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;
    }
620 621
}

622 623 624 625 626
/**
 * @brief Connect the connection.
 *
 * @return True if connection has been established, false if connection couldn't be established.
 **/
lm's avatar
lm committed
627
bool QGCFlightGearLink::connectSimulation()
628
{
Don Gagne's avatar
Don Gagne committed
629 630 631 632
    // 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
633

634
    if (!_vehicle->uas()) {
Don Gagne's avatar
Don Gagne committed
635 636
        return false;
    }
dogmaphobic's avatar
dogmaphobic committed
637

Don Gagne's avatar
Don Gagne committed
638 639 640
    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
641 642 643
    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
644
    QDir        fgAppDir;						// Location of main FlightGear application
645 646 647 648 649 650 651

    // 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) {
652
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("FlightGear failed to start. There are mismatched quotes in specified command line options"));
653 654 655 656 657 658 659
        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
660 661

#if defined __macos__
Don Gagne's avatar
Don Gagne committed
662 663 664 665
    // 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";
666
    // new path
667 668
    _fgProcessName = "./fgfs";
    _fgProcessWorkingDirPath = "/Applications/FlightGear.app/Contents/MacOS/";
669 670 671 672 673
    if(!QFileInfo(_fgProcessWorkingDirPath + _fgProcessName).exists()){
        // old path
        _fgProcessName = "./fgfs.sh";
        _fgProcessWorkingDirPath = "/Applications/FlightGear.app/Contents/Resources/";
    }
Don Gagne's avatar
Don Gagne committed
674
    fgRootPathProposedList += "/Applications/FlightGear.app/Contents/Resources/data/";
Don Gagne's avatar
Don Gagne committed
675
#elif defined Q_OS_WIN32
Don Gagne's avatar
Don Gagne committed
676
    _fgProcessName = "fgfs.exe";
dogmaphobic's avatar
dogmaphobic committed
677

Don Gagne's avatar
Don Gagne committed
678 679 680 681 682 683 684 685 686 687 688 689 690 691
    // 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
692
            QString lookahead;	// lookahead for continuation lines
Don Gagne's avatar
Don Gagne committed
693 694
            while (!in.atEnd() || !lookahead.isEmpty()) {
                QString line;
dogmaphobic's avatar
dogmaphobic committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
                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
717 718 719 720 721 722 723
                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
724
                        _fgProcessWorkingDirPath = fgAppDir.absolutePath();
Don Gagne's avatar
Don Gagne committed
725 726 727 728
                        qDebug() << "fg_exe" << fgAppDir.absolutePath();
                    }
                    continue;
                }
dogmaphobic's avatar
dogmaphobic committed
729

Don Gagne's avatar
Don Gagne committed
730 731
                regExp.setPattern("^fg_root:(.*)");
                if (regExp.indexIn(line) == 0 && regExp.captureCount() == 1) {
Don Gagne's avatar
Don Gagne committed
732 733
                    fgRootPathProposedList += QDir(regExp.cap(1)).absolutePath();
                    qDebug() << "fg_root" << fgRootPathProposedList[0];
Don Gagne's avatar
Don Gagne committed
734 735
                    continue;
                }
dogmaphobic's avatar
dogmaphobic committed
736

Don Gagne's avatar
Don Gagne committed
737 738
                regExp.setPattern("^fg_scenery:(.*)");
                if (regExp.indexIn(line) == 0 && regExp.captureCount() == 1) {
dogmaphobic's avatar
dogmaphobic committed
739
                    // Scenery can contain multiple paths seperated by ';' so don't do QDir::absolutePath on it
Don Gagne's avatar
Don Gagne committed
740 741 742 743 744 745 746 747 748 749
                    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
750
    _fgProcessName = "fgfs";
Don Gagne's avatar
Don Gagne committed
751 752
    fgRootPathProposedList += "/usr/share/flightgear/data/";    // Default Archlinux location
    fgRootPathProposedList += "/usr/share/games/flightgear/";   // Default Ubuntu location
Don Gagne's avatar
Don Gagne committed
753 754 755
#else
#error Unknown OS build flavor
#endif
dogmaphobic's avatar
dogmaphobic committed
756

Don Gagne's avatar
Don Gagne committed
757
#ifndef Q_OS_LINUX
Don Gagne's avatar
Don Gagne committed
758
    // 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
759 760 761 762 763 764 765 766 767 768 769 770 771
    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
772

Don Gagne's avatar
Don Gagne committed
773
        // Let the user pick the right directory
Don Gagne's avatar
Don Gagne committed
774
        QString dirPath = QGCFileDialog::getExistingDirectory(MainWindow::instance(), tr("Please select directory of FlightGear application : ") + fgAppName);
Don Gagne's avatar
Don Gagne committed
775 776 777 778
        if (dirPath.isEmpty()) {
            return false;
        }
        fgAppDir.setPath(dirPath);
Don Gagne's avatar
Don Gagne committed
779 780 781
        fgAppFullyQualified = fgAppDir.absoluteFilePath(fgAppName);
    }
#endif
dogmaphobic's avatar
dogmaphobic committed
782

Don Gagne's avatar
Don Gagne committed
783
    // 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
784 785 786 787 788 789 790 791
    // proposed locations.
    QString argValue;
    fgRootDirOverride = _findUIArgument(_fgArgList, "--fg-root", argValue);
    if (fgRootDirOverride) {
        fgRootPathProposedList.clear();
        fgRootPathProposedList += argValue;
        qDebug() << "--fg-root override" << argValue;
    }
792

Don Gagne's avatar
Don Gagne committed
793 794 795 796 797 798 799 800 801 802 803
    // 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
804

Don Gagne's avatar
Don Gagne committed
805 806 807 808 809 810 811 812
    // 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.");
        }
813
        QGCMessageBox::critical(tr("FlightGear HIL"), errMsg);
Don Gagne's avatar
Don Gagne committed
814 815
        return false;
    }
816

Don Gagne's avatar
Don Gagne committed
817 818 819 820
    if (!fgRootDirOverride) {
        _fgArgList += "--fg-root=" + fgRootPath;
    }

Don Gagne's avatar
Don Gagne committed
821 822
    // 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
823 824 825 826
    fgSceneryDirOverride = _findUIArgument(_fgArgList, "--fg-scenery", argValue);
    if (fgSceneryDirOverride) {
        fgSceneryPath = argValue;
        qDebug() << "--fg-scenery override" << argValue;
Don Gagne's avatar
Don Gagne committed
827
    } else if (!fgSceneryPath.isEmpty()) {
dogmaphobic's avatar
dogmaphobic committed
828 829 830
        _fgArgList += "--fg-scenery=" + fgSceneryPath;
    }

Don Gagne's avatar
Don Gagne committed
831 832
#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
833
    // it can be multiple paths.
Don Gagne's avatar
Don Gagne committed
834 835 836 837 838 839 840
    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.");
        }
841
        QGCMessageBox::critical(tr("FlightGear HIL"), errMsg);
Don Gagne's avatar
Don Gagne committed
842 843
        return false;
    }
Don Gagne's avatar
Don Gagne committed
844 845
#else
    Q_UNUSED(fgSceneryDirOverride);
Don Gagne's avatar
Don Gagne committed
846
#endif
dogmaphobic's avatar
dogmaphobic committed
847

Don Gagne's avatar
Don Gagne committed
848
    // Setup and verify directory which contains QGC provided aircraft files
Don Gagne's avatar
Don Gagne committed
849
    QString qgcAircraftDir(QApplication::applicationDirPath() + "/flightgear/Aircraft");
Don Gagne's avatar
Don Gagne committed
850
    if (!QFileInfo(qgcAircraftDir).isDir()) {
851
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. Aircraft directory is missing: '%1'.").arg(qgcAircraftDir));
Don Gagne's avatar
Don Gagne committed
852 853 854
        return false;
    }
    _fgArgList += "--fg-aircraft=" + qgcAircraftDir;
dogmaphobic's avatar
dogmaphobic committed
855

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

Don Gagne's avatar
Don Gagne committed
862 863 864
    // Verify directory where FlightGear stores communicaton protocols.
    QDir fgProtocolDir(fgRootPath);
    if (!fgProtocolDir.cd("Protocol")) {
865
        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
866 867
        return false;
    }
dogmaphobic's avatar
dogmaphobic committed
868

Don Gagne's avatar
Don Gagne committed
869
    // Verify directory which contains QGC provided FlightGear communication protocol files
Don Gagne's avatar
Don Gagne committed
870
    QDir qgcProtocolDir(QApplication::applicationDirPath() + "/flightgear/Protocol/");
Don Gagne's avatar
Don Gagne committed
871
    if (!qgcProtocolDir.isReadable()) {
872
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. Protocol directory is missing (%1).").arg(qgcProtocolDir.path()));
Don Gagne's avatar
Don Gagne committed
873 874
        return false;
    }
dogmaphobic's avatar
dogmaphobic committed
875

876 877 878 879
    // 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()) {
880
        QGCMessageBox::critical(tr("FlightGear HIL"), tr("Incorrect QGroundControl installation. FlightGear protocol file missing: %1").arg(qgcProtocolFileFullyQualified));
881 882
        return false;
    }
dogmaphobic's avatar
dogmaphobic committed
883

Don Gagne's avatar
Don Gagne committed
884 885 886
    // 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.
887
    _fgProtocolFileFullyQualified = fgProtocolDir.absoluteFilePath(fgProtocolXmlFile);
dogmaphobic's avatar
dogmaphobic committed
888

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

892 893
        QFile fgFile(_fgProtocolFileFullyQualified);
        QFile qgcFile(qgcProtocolFileFullyQualified);
dogmaphobic's avatar
dogmaphobic committed
894

895 896 897 898 899 900
        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
901

902 903
        QByteArray fgBytes = fgFile.readAll();
        QByteArray qgcBytes = qgcFile.readAll();
dogmaphobic's avatar
dogmaphobic committed
904

905 906
        fgFile.close();
        qgcFile.close();
dogmaphobic's avatar
dogmaphobic committed
907

908 909 910 911 912 913 914 915
        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
916

917
    if (!QFileInfo(_fgProtocolFileFullyQualified).exists()) {
Don Gagne's avatar
Don Gagne committed
918 919 920 921 922 923 924 925 926 927
        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
928

Don Gagne's avatar
Don Gagne committed
929
        // Now that we made it this far, we should be able to try to copy the protocol file to FlightGear.
930
        bool succeeded = QFile::copy(qgcProtocolFileFullyQualified, _fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
931 932
        if (!succeeded) {
#ifdef Q_OS_WIN32
933
            QString copyCmd = QString("copy \"%1\" \"%2\"").arg(qgcProtocolFileFullyQualified).arg(_fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
934 935
            copyCmd.replace("/", "\\");
#else
936
            QString copyCmd = QString("sudo cp %1 %2").arg(qgcProtocolFileFullyQualified).arg(_fgProtocolFileFullyQualified);
Don Gagne's avatar
Don Gagne committed
937
#endif
dogmaphobic's avatar
dogmaphobic committed
938

Don Gagne's avatar
Don Gagne committed
939 940 941
            QMessageBox msgBox(QMessageBox::Critical,
                               tr("Copy failed"),
#ifdef Q_OS_WIN32
942
                               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
943
#else
944
                               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
945 946 947 948 949 950 951 952 953 954 955
#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
956

Don Gagne's avatar
Don Gagne committed
957
    // Start the engines to save a startup step
958
    if (_vehicle->vehicleType() == MAV_TYPE_QUADROTOR) {
Don Gagne's avatar
Don Gagne committed
959 960 961 962 963 964 965 966
        // 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
967

Don Gagne's avatar
Don Gagne committed
968
    // We start out at our home position
969 970
    _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
971 972
    // 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
973
    //_fgArgList << QString("--altitude=%1").arg(qgcApp()->toolbox()->homePositionManager()->getHomeAltitude());
dogmaphobic's avatar
dogmaphobic committed
974

Don Gagne's avatar
Don Gagne committed
975 976 977 978 979
#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
980

981 982
    start(HighPriority);
    return true;
983 984
}

Don Gagne's avatar
Don Gagne committed
985
void QGCFlightGearLink::_printFgfsOutput(void)
Thomas Gubler's avatar
Thomas Gubler committed
986 987
{
   qDebug() << "fgfs stdout:";
Don Gagne's avatar
Don Gagne committed
988
   QByteArray byteArray = _fgProcess->readAllStandardOutput();
Thomas Gubler's avatar
Thomas Gubler committed
989 990
   QStringList strLines = QString(byteArray).split("\n");

991
   foreach (const QString &line, strLines){
Thomas Gubler's avatar
Thomas Gubler committed
992 993 994 995
    qDebug() << line;
   }
}

Don Gagne's avatar
Don Gagne committed
996
void QGCFlightGearLink::_printFgfsError(void)
Thomas Gubler's avatar
Thomas Gubler committed
997 998 999
{
   qDebug() << "fgfs stderr:";

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

1003
   foreach (const QString &line, strLines){
Thomas Gubler's avatar
Thomas Gubler committed
1004 1005 1006 1007
    qDebug() << line;
   }
}

1008 1009 1010 1011 1012 1013 1014 1015 1016
/**
 * @brief Set the startup arguments used to start flightgear
 *
 **/
void QGCFlightGearLink::setStartupArguments(QString startupArguments)
{
    this->startupArguments = startupArguments;
}

1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
/**
 * @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
1032 1033 1034 1035 1036
QString QGCFlightGearLink::getRemoteHost()
{
    return QString("%1:%2").arg(currentHost.toString(), currentPort);
}

1037 1038 1039
void QGCFlightGearLink::setName(QString name)
{
    this->name = name;
lm's avatar
lm committed
1040
    //    emit nameChanged(this->name);
1041
}
1042 1043 1044 1045 1046

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