UASInterface.h 28.8 KB
Newer Older
pixhawk's avatar
pixhawk committed
1 2
/*=====================================================================

3
QGroundControl Open Source Ground Control Station
pixhawk's avatar
pixhawk committed
4

5
(c) 2009, 2010 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
pixhawk's avatar
pixhawk committed
6

7
This file is part of the QGROUNDCONTROL project
pixhawk's avatar
pixhawk committed
8

9
    QGROUNDCONTROL is free software: you can redistribute it and/or modify
pixhawk's avatar
pixhawk committed
10 11 12 13
    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.

14
    QGROUNDCONTROL is distributed in the hope that it will be useful,
pixhawk's avatar
pixhawk committed
15 16 17 18 19
    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
20
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
pixhawk's avatar
pixhawk committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

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

/**
 * @file
 *   @brief Abstract interface, represents one unmanned aerial vehicle
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

#ifndef _UASINTERFACE_H_
#define _UASINTERFACE_H_

#include <QObject>
#include <QList>
#include <QAction>
#include <QColor>
39
#include <QPointer>
pixhawk's avatar
pixhawk committed
40 41 42

#include "LinkInterface.h"
#include "ProtocolInterface.h"
43
#include "UASParameterDataModel.h"
44
#include "UASWaypointManager.h"
45
#include "QGCUASParamManagerInterface.h"
46
#include "RadioCalibration/RadioCalibrationData.h"
pixhawk's avatar
pixhawk committed
47

48 49
#ifdef QGC_PROTOBUF_ENABLED
#include <tr1/memory>
50
#ifdef QGC_USE_PIXHAWK_MESSAGES
LM's avatar
LM committed
51
#include <pixhawk/pixhawk.pb.h>
52
#endif
53
#endif
54

55 56
class QGCUASFileManager;

57 58 59 60 61 62 63 64 65 66
enum BatteryType
{
    NICD = 0,
    NIMH = 1,
    LIION = 2,
    LIPOLY = 3,
    LIFE = 4,
    AGZN = 5
}; ///< The type of battery used

67
/*
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
enum SpeedMeasurementSource
{
    PRIMARY_SPEED = 0,          // ArduPlane: Measured airspeed or estimated airspeed. ArduCopter: Ground (XY) speed.
    GROUNDSPEED_BY_UAV = 1,     // Ground speed as reported by UAS
    GROUNDSPEED_BY_GPS = 2,     // Ground speed as calculated from received GPS velocity data
    LOCAL_SPEED = 3
}; ///< For velocity data, the data source

enum AltitudeMeasurementSource
{
    PRIMARY_ALTITUDE = 0,                  // ArduPlane: air and ground speed mix. This is the altitude used for navigastion.
    BAROMETRIC_ALTITUDE = 1,               // Altitude is pressure altitude. Ardupilot reports no altitude purely by barometer,
                                           // however when ALT_MIX==1, mix-altitude is purely barometric.
    GPS_ALTITUDE = 2                       // GPS ASL altitude
}; ///< For altitude data, the data source

// TODO!!! The different frames are probably represented elsewhere. There should really only
// be one set of frames. We also need to keep track of the home alt. somehow.
enum AltitudeMeasurementFrame
{
    ABSOLUTE = 0,               // Altitude is pressure altitude
    ABOVE_HOME_POSITION = 1
}; ///< For altitude data, a reference frame
91
*/
92

pixhawk's avatar
pixhawk committed
93 94 95 96 97 98
/**
 * @brief Interface for all robots.
 *
 * This interface is abstract and thus cannot be instantiated. It serves only as type definition.
 * It represents an unmanned aerial vehicle, e.g. a micro air vehicle.
 **/
lm's avatar
lm committed
99 100
class UASInterface : public QObject
{
pixhawk's avatar
pixhawk committed
101 102 103 104 105 106 107
    Q_OBJECT
public:
    virtual ~UASInterface() {}

    /* MANAGEMENT */

    /** @brief The name of the robot **/
108
    virtual QString getUASName() const = 0;
109 110 111 112
    /** @brief Get short state */
    virtual const QString& getShortState() const = 0;
    /** @brief Get short mode */
    virtual const QString& getShortMode() const = 0;
113 114
    /** @brief Translate mode id into text */
    static QString getShortModeTextFor(int id);
pixhawk's avatar
pixhawk committed
115
    //virtual QColor getColor() = 0;
116
    virtual int getUASID() const = 0; ///< Get the ID of the connected UAS
pixhawk's avatar
pixhawk committed
117
    /** @brief The time interval the robot is switched on **/
118
    virtual quint64 getUptime() const = 0;
pixhawk's avatar
pixhawk committed
119
    /** @brief Get the status flag for the communication **/
120
    virtual int getCommunicationStatus() const = 0;
pixhawk's avatar
pixhawk committed
121

lm's avatar
lm committed
122 123 124
    virtual double getLocalX() const = 0;
    virtual double getLocalY() const = 0;
    virtual double getLocalZ() const = 0;
125
    virtual bool localPositionKnown() const = 0;
lm's avatar
lm committed
126

127 128
    virtual double getLatitude() const = 0;
    virtual double getLongitude() const = 0;
129 130
    virtual double getAltitudeAMSL() const = 0;
    virtual double getAltitudeRelative() const = 0;
131
    virtual bool globalPositionKnown() const = 0;
132

lm's avatar
lm committed
133 134 135 136
    virtual double getRoll() const = 0;
    virtual double getPitch() const = 0;
    virtual double getYaw() const = 0;

137 138
    virtual bool getSelected() const = 0;

139
#if defined(QGC_PROTOBUF_ENABLED) && defined(QGC_USE_PIXHAWK_MESSAGES)
140 141
    virtual px::GLOverlay getOverlay() = 0;
    virtual px::GLOverlay getOverlay(qreal& receivedTimestamp) = 0;
142 143 144 145
    virtual px::ObstacleList getObstacleList() = 0;
    virtual px::ObstacleList getObstacleList(qreal& receivedTimestamp) = 0;
    virtual px::Path getPath() = 0;
    virtual px::Path getPath(qreal& receivedTimestamp) = 0;
146 147 148 149
    virtual px::PointCloudXYZRGB getPointCloud() = 0;
    virtual px::PointCloudXYZRGB getPointCloud(qreal& receivedTimestamp) = 0;
    virtual px::RGBDImage getRGBDImage() = 0;
    virtual px::RGBDImage getRGBDImage(qreal& receivedTimestamp) = 0;
150 151
#endif

152 153
    virtual bool isArmed() const = 0;

154 155 156
    /** @brief Set the airframe of this MAV */
    virtual int getAirframe() const = 0;

157
    /** @brief Get reference to the waypoint manager **/
158
    virtual UASWaypointManager* getWaypointManager(void) = 0;
159

160
    /** @brief Get reference to the param manager **/
161
    virtual QGCUASParamManagerInterface* getParamManager() = 0;
162

163 164 165 166 167 168 169
    virtual QGCUASFileManager* getFileManager() = 0;

    /** @brief Send a message over this link (to this or to all UAS on this link) */
    virtual void sendMessage(LinkInterface* link, mavlink_message_t message) = 0;
    /** @brief Send a message over all links this UAS can be reached with (!= all links) */
    virtual void sendMessage(mavlink_message_t message) = 0;

pixhawk's avatar
pixhawk committed
170 171 172 173 174 175 176 177 178 179 180
    /* COMMUNICATION FLAGS */

    enum CommStatus {
        /** Unit is disconnected, no failure state reached so far **/
        COMM_DISCONNECTED = 0,
        /** The communication is established **/
        COMM_CONNECTING = 1,
        /** The communication link is up **/
        COMM_CONNECTED = 2,
        /** The connection is closed **/
        COMM_DISCONNECTING = 3,
181 182
        COMM_FAIL = 4,
        COMM_TIMEDOUT = 5///< Communication link failed
pixhawk's avatar
pixhawk committed
183 184
    };

185 186
    enum Airframe {
        QGC_AIRFRAME_GENERIC = 0,
187 188 189 190 191 192 193 194
        QGC_AIRFRAME_EASYSTAR,
        QGC_AIRFRAME_TWINSTAR,
        QGC_AIRFRAME_MERLIN,
        QGC_AIRFRAME_CHEETAH,
        QGC_AIRFRAME_MIKROKOPTER,
        QGC_AIRFRAME_REAPER,
        QGC_AIRFRAME_PREDATOR,
        QGC_AIRFRAME_COAXIAL,
lm's avatar
lm committed
195 196
        QGC_AIRFRAME_PTERYX,
        QGC_AIRFRAME_TRICOPTER,
197
        QGC_AIRFRAME_HEXCOPTER,
Lorenz Meier's avatar
Lorenz Meier committed
198 199 200
        QGC_AIRFRAME_X8,
        QGC_AIRFRAME_VIPER_2_0,
        QGC_AIRFRAME_CAMFLYER_Q,
201
        QGC_AIRFRAME_END_OF_ENUM
202
    };
pixhawk's avatar
pixhawk committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

    /**
         * @brief Get the links associated with this robot
         *
         * @return List with all links this robot is associated with. Association is usually
         *         based on the fact that a message for this robot has been received through that
         *         interface. The LinkInterface can support multiple protocols.
         **/
    virtual QList<LinkInterface*>* getLinks() = 0;

    /**
     * @brief Get the color for this UAS
     *
     * This static function holds a color map that allows to draw a new color for each robot
     *
     * @return The next color in the color map. The map holds 20 colors and starts from the beginning
     *         if the colors are exceeded.
     */
221
    static QColor getNextColor() {
pixhawk's avatar
pixhawk committed
222
        /* Create color map */
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
        static QList<QColor> colors = QList<QColor>() 
		<< QColor(231,72,28) 
		<< QColor(104,64,240) 
		<< QColor(203,254,121) 
		<< QColor(161,252,116)
               	<< QColor(232,33,47) 
		<< QColor(116,251,110) 
		<< QColor(234,38,107) 
		<< QColor(104,250,138)
                << QColor(235,43,165) 
		<< QColor(98,248,176) 
		<< QColor(236,48,221) 
		<< QColor(92,247,217)
                << QColor(200,54,238) 
		<< QColor(87,231,246) 
		<< QColor(151,59,239) 
		<< QColor(81,183,244)
                << QColor(75,133,243) 
		<< QColor(242,255,128) 
		<< QColor(230,126,23);
        
pixhawk's avatar
pixhawk committed
244
        static int nextColor = -1;
245 246
        if(nextColor == 18){//if at the end of the list
            nextColor = -1;//go back to the beginning
pixhawk's avatar
pixhawk committed
247
        }
248 249 250
        nextColor++; 
        return colors[nextColor];//return the next color
   }
pixhawk's avatar
pixhawk committed
251

252 253
    /** @brief Get the type of the system (airplane, quadrotor, helicopter,..)*/
    virtual int getSystemType() = 0;
254 255 256 257 258
    /** @brief Indicates whether this system is capable of controlling a reverse velocity.
     * Used for, among other things, altering joystick input to either -1:1 or 0:1 range.
     */
    virtual bool systemCanReverse() const = 0;

lm's avatar
lm committed
259
    virtual QString getSystemTypeName() = 0;
LM's avatar
LM committed
260 261
    /** @brief Get the type of the autopilot (PIXHAWK, APM, UDB, PPZ,..) */
    virtual int getAutopilotType() = 0;
lm's avatar
lm committed
262
    virtual QString getAutopilotTypeName() = 0;
LM's avatar
LM committed
263
    virtual void setAutopilotType(int apType) = 0;
264

LM's avatar
LM committed
265 266 267 268
    virtual QMap<int, QString> getComponents() = 0;

    QColor getColor()
    {
pixhawk's avatar
pixhawk committed
269 270 271
        return color;
    }

272
    /** @brief Returns a list of actions/commands that this vehicle can perform.
273 274 275
     * Used for creating UI elements for built-in functionality for this vehicle.
     * Actions should be mappings to `void f(void);` functions that simply issue
     * a command to the vehicle.
276 277 278
     */
    virtual QList<QAction*> getActions() const = 0;

279 280 281
    static const unsigned int WAYPOINT_RADIUS_DEFAULT_FIXED_WING = 25;
    static const unsigned int WAYPOINT_RADIUS_DEFAULT_ROTARY_WING = 5;

pixhawk's avatar
pixhawk committed
282 283
public slots:

284 285
    /** @brief Set a new name for the system */
    virtual void setUASName(const QString& name) = 0;
lm's avatar
lm committed
286 287
    /** @brief Execute command immediately **/
    virtual void executeCommand(MAV_CMD command) = 0;
288
    /** @brief Executes a command **/
289
    virtual void executeCommand(MAV_CMD command, int confirmation, float param1, float param2, float param3, float param4, float param5, float param6, float param7, int component) = 0;
290 291
    /** @brief Executes a command ack, with success boolean **/
    virtual void executeCommandAck(int num, bool success) = 0;
292

293 294 295
    /** @brief Selects the airframe */
    virtual void setAirframe(int airframe) = 0;

pixhawk's avatar
pixhawk committed
296 297 298
    /** @brief Launches the system/Liftof **/
    virtual void launch() = 0;
    /** @brief Set a new waypoint **/
pixhawk's avatar
pixhawk committed
299
    //virtual void setWaypoint(Waypoint* wp) = 0;
pixhawk's avatar
pixhawk committed
300
    /** @brief Set this waypoint as next waypoint to fly to */
pixhawk's avatar
pixhawk committed
301
    //virtual void setWaypointActive(int wp) = 0;
pixhawk's avatar
pixhawk committed
302 303
    /** @brief Order the robot to return home / to land on the runway **/
    virtual void home() = 0;
304 305
    /** @brief Order the robot to land **/
    virtual void land() = 0;
306 307
    /** @brief Order the robot to pair its receiver **/
    virtual void pairRX(int rxType, int rxSubType) = 0;
pixhawk's avatar
pixhawk committed
308 309 310 311
    /** @brief Halt the system */
    virtual void halt() = 0;
    /** @brief Start/continue the current robot action */
    virtual void go() = 0;
pixhawk's avatar
pixhawk committed
312
    /** @brief Set the current mode of operation */
313
    virtual void setMode(uint8_t newBaseMode, uint32_t newCustomMode) = 0;
pixhawk's avatar
pixhawk committed
314 315 316 317 318 319 320 321 322 323
    /** Stops the robot system. If it is an MAV, the robot starts the emergency landing procedure **/
    virtual void emergencySTOP() = 0;
    /** Kills the robot. All systems are immediately shut down (e.g. the main power line is cut). This might lead to a crash **/
    virtual bool emergencyKILL() = 0;
    /**
     * @brief Shut down the system's computers
     *
     * Works only if already landed and will cleanly shut down all onboard computers.
     */
    virtual void shutdown() = 0;
324 325 326 327 328 329 330
    /** @brief Set the target position for the robot to navigate to.
     *  @param x x-coordinate of the target position
     *  @param y y-coordinate of the target position
     *  @param z z-coordinate of the target position
     *  @param yaw heading of the target position
     */
    virtual void setTargetPosition(float x, float y, float z, float yaw) = 0;
331
    /** @brief Request the list of stored waypoints from the robot */
pixhawk's avatar
pixhawk committed
332
    //virtual void requestWaypoints() = 0;
333
    /** @brief Clear all existing waypoints on the robot */
pixhawk's avatar
pixhawk committed
334
    //virtual void clearWaypointList() = 0;
335 336
    /** @brief Set world frame origin at current GPS position */
    virtual void setLocalOriginAtCurrentGPSPosition() = 0;
337 338
    /** @brief Set world frame origin / home position at this GPS position */
    virtual void setHomePosition(double lat, double lon, double alt) = 0;
339 340
    /** @brief Request all onboard parameters of all components */
    virtual void requestParameters() = 0;
341
    /** @brief Request one specific onboard parameter */
342
    virtual void requestParameter(int component, const QString& parameter) = 0;
343
    /** @brief Write parameter to permanent storage */
344 345 346
    virtual void writeParametersToStorage() = 0;
    /** @brief Read parameter from permanent storage */
    virtual void readParametersFromStorage() = 0;
347 348 349 350 351 352
    /** @brief Set a system parameter
     * @param component ID of the system component to write the parameter to
     * @param id String identifying the parameter
     * @warning The length of the ID string is limited by the MAVLink format! Take care to not exceed it
     * @param value Value of the parameter, IEEE 754 single precision floating point
     */
353
    virtual void setParameter(const int component, const QString& id, const QVariant& value) = 0;
pixhawk's avatar
pixhawk committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369

    /**
     * @brief Add a link to the list of current links
     *
     * Adding the link to the robot's internal link list will allow him so send its own messages
     * over all registered links. Usually a link is added once a message for this particular robot
     * has been received over a link, but adding could also be done manually.
     * @warning Not all links should be added to all robots by default, because else all robots will
     *          attempt to send over all links, typically choking wireless serial links.
     */
    virtual void addLink(LinkInterface* link) = 0;

    /**
     * @brief Set the current robot as focused in the user interface
     */
    virtual void setSelected() = 0;
lm's avatar
lm committed
370

371 372 373 374 375
    virtual void enableAllDataTransmission(int rate) = 0;
    virtual void enableRawSensorDataTransmission(int rate) = 0;
    virtual void enableExtendedSystemStatusTransmission(int rate) = 0;
    virtual void enableRCChannelDataTransmission(int rate) = 0;
    virtual void enableRawControllerDataTransmission(int rate) = 0;
lm's avatar
lm committed
376
    //virtual void enableRawSensorFusionTransmission(int rate) = 0;
377 378 379 380
    virtual void enablePositionTransmission(int rate) = 0;
    virtual void enableExtra1Transmission(int rate) = 0;
    virtual void enableExtra2Transmission(int rate) = 0;
    virtual void enableExtra3Transmission(int rate) = 0;
pixhawk's avatar
pixhawk committed
381

pixhawk's avatar
pixhawk committed
382
    virtual void setLocalPositionSetpoint(float x, float y, float z, float yaw) = 0;
pixhawk's avatar
pixhawk committed
383 384
    virtual void setLocalPositionOffset(float x, float y, float z, float yaw) = 0;

385
    virtual void startRadioControlCalibration(int param=1) = 0;
386
    virtual void endRadioControlCalibration() = 0;
pixhawk's avatar
pixhawk committed
387 388 389
    virtual void startMagnetometerCalibration() = 0;
    virtual void startGyroscopeCalibration() = 0;
    virtual void startPressureCalibration() = 0;
pixhawk's avatar
pixhawk committed
390

391 392 393 394 395
    /** @brief Return if this a rotary wing */
    virtual bool isRotaryWing() = 0;
    /** @brief Return if this is a fixed wing */
    virtual bool isFixedWing() = 0;

396 397 398 399
    /** @brief Set the current battery type and voltages */
    virtual void setBatterySpecs(const QString& specs) = 0;
    /** @brief Get the current battery type and specs */
    virtual QString getBatterySpecs() = 0;
400

Lorenz Meier's avatar
Lorenz Meier committed
401
    /** @brief Send the full HIL state to the MAV */
Lorenz Meier's avatar
Lorenz Meier committed
402 403
    virtual void sendHilState(quint64 time_us, float roll, float pitch, float yaw, float rollspeed,
                        float pitchspeed, float yawspeed, double lat, double lon, double alt,
404
                        float vx, float vy, float vz, float ind_airspeed, float true_airspeed, float xacc, float yacc, float zacc) = 0;
Lorenz Meier's avatar
Lorenz Meier committed
405 406 407

    /** @brief RAW sensors for sensor HIL */
    virtual void sendHilSensors(quint64 time_us, float xacc, float yacc, float zacc, float rollspeed, float pitchspeed, float yawspeed,
408
                                float xmag, float ymag, float zmag, float abs_pressure, float diff_pressure, float pressure_alt, float temperature, quint32 fields_changed) = 0;
Lorenz Meier's avatar
Lorenz Meier committed
409 410

    /** @brief Send raw GPS for sensor HIL */
411
    virtual void sendHilGps(quint64 time_us, double lat, double lon, double alt, int fix_type, float eph, float epv, float vel, float vn, float ve, float vd, float cog, int satellites) = 0;
Lorenz Meier's avatar
Lorenz Meier committed
412

pixhawk's avatar
pixhawk committed
413 414 415 416
protected:
    QColor color;

signals:
LM's avatar
LM committed
417
    /** @brief The robot state has changed */
pixhawk's avatar
pixhawk committed
418
    void statusChanged(int stateFlag);
LM's avatar
LM committed
419 420
    /** @brief A new component was detected or created */
    void componentCreated(int uas, int component, const QString& name);
pixhawk's avatar
pixhawk committed
421 422 423 424 425 426 427
    /** @brief The robot state has changed
     *
     * @param uas this robot
     * @param status short description of status, e.g. "connected"
     * @param description longer textual description. Should be however limited to a short text, e.g. 200 chars.
     */
    void statusChanged(UASInterface* uas, QString status, QString description);
428 429 430 431 432 433
    /**
     * @brief Received a plain text message from the robot
     * This signal should NOT be used for standard communication, but rather for VERY IMPORTANT
     * messages like critical errors.
     *
     * @param uasid ID of the sending system
434
     * @param compid ID of the sending component
435 436 437
     * @param text the status text
     * @param severity The severity of the message, 0 for plain debug messages, 10 for very critical messages
     */
438 439 440 441

    void poiFound(UASInterface* uas, int type, int colorIndex, QString message, float x, float y, float z);
    void poiConnectionFound(UASInterface* uas, int type, int colorIndex, QString message, float x1, float y1, float z1, float x2, float y2, float z2);

442
    /** @brief A text message from the system has been received */
443
    void textMessageReceived(int uasid, int componentid, int severity, QString text);
444 445 446

    void navModeChanged(int uasid, int mode, const QString& text);

447 448 449 450 451 452 453
    /** @brief System is now armed */
    void armed();
    /** @brief System is now disarmed */
    void disarmed();
    /** @brief Arming mode changed */
    void armingChanged(bool armed);

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
    /**
     * @brief Update the error count of a device
     *
     * The error count indicates how many errors occured during the use of a device.
     * Usually a random error from time to time is acceptable, e.g. through electromagnetic
     * interferences on device lines like I2C and SPI. A constantly and rapidly increasing
     * error count however can help to identify broken cables or misbehaving drivers.
     *
     * @param uasid System ID
     * @param component Name of the component, e.g. "IMU"
     * @param device Name of the device, e.g. "SPI0" or "I2C1"
     * @param count Errors occured since system startup
     */
    void errCountChanged(int uasid, QString component, QString device, int count);

lm's avatar
lm committed
469 470 471 472
    /**
     * @brief Drop rate of communication link updated
     *
     * @param systemId id of the air system
473
     * @param receiveDrop drop rate of packets this MAV receives (sent from GCS or other MAVs)
lm's avatar
lm committed
474
     */
475
    void dropRateChanged(int systemId,  float receiveDrop);
pixhawk's avatar
pixhawk committed
476 477
    /** @brief Robot mode has changed */
    void modeChanged(int sysId, QString status, QString description);
478 479
    /** @brief Robot armed state has changed */
    void armingChanged(int sysId, QString armingState);
pixhawk's avatar
pixhawk committed
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
    /** @brief A command has been issued **/
    void commandSent(int command);
    /** @brief The connection status has changed **/
    void connectionChanged(CommStatus connectionFlag);
    /** @brief The robot is connecting **/
    void connecting();
    /** @brief The robot is connected **/
    void connected();
    /** @brief The robot is disconnected **/
    void disconnected();
    /** @brief The robot is active **/
    void activated();
    /** @brief The robot is inactive **/
    void deactivated();
    /** @brief The robot is manually controlled **/
    void manualControl();
496

pixhawk's avatar
pixhawk committed
497 498 499
    /** @brief A value of the robot has changed.
      *
      * Typically this is used to send lowlevel information like the battery voltage to the plotting facilities of
500 501
      * the groundstation. The data here should be converted to human-readable values before being passed, so ideally
	  * SI units.
pixhawk's avatar
pixhawk committed
502 503 504
      *
      * @param uasId ID of this system
      * @param name name of the value, e.g. "battery voltage"
505
	  * @param unit The units this variable is in as an abbreviation. For system-dependent (such as raw ADC values) use "raw", for bitfields use "bits", for true/false or on/off use "bool", for unitless values use "-".
pixhawk's avatar
pixhawk committed
506 507 508
      * @param value the value that changed
      * @param msec the timestamp of the message, in milliseconds
      */
509
    void valueChanged(const int uasid, const QString& name, const QString& unit, const QVariant &value,const quint64 msecs);
lm's avatar
lm committed
510

pixhawk's avatar
pixhawk committed
511 512 513 514 515
    void voltageChanged(int uasId, double voltage);
    void waypointUpdated(int uasId, int id, double x, double y, double z, double yaw, bool autocontinue, bool active);
    void waypointSelected(int uasId, int id);
    void waypointReached(UASInterface* uas, int id);
    void autoModeChanged(bool autoMode);
516 517
    void parameterChanged(int uas, int component, QString parameterName, QVariant value);
    void parameterChanged(int uas, int component, int parameterCount, int parameterId, QString parameterName, QVariant value);
518
    void patternDetected(int uasId, QString patternPath, float confidence, bool detected);
pixhawk's avatar
pixhawk committed
519
    void letterDetected(int uasId, QString letter, float confidence, bool detected);
pixhawk's avatar
pixhawk committed
520 521 522 523 524 525 526 527
    /**
     * @brief The battery status has been updated
     *
     * @param uas sending system
     * @param voltage battery voltage
     * @param percent remaining capacity in percent
     * @param seconds estimated remaining flight time in seconds
     */
dongfang's avatar
dongfang committed
528
    void batteryChanged(UASInterface* uas, double voltage, double current, double percent, int seconds);
pixhawk's avatar
pixhawk committed
529 530 531 532 533
    void statusChanged(UASInterface* uas, QString status);
    void actuatorChanged(UASInterface*, int actId, double value);
    void thrustChanged(UASInterface*, double thrust);
    void heartbeat(UASInterface* uas);
    void attitudeChanged(UASInterface*, double roll, double pitch, double yaw, quint64 usec);
534
    void attitudeChanged(UASInterface*, int component, double roll, double pitch, double yaw, quint64 usec);
535
    void attitudeRotationRatesChanged(int uas, double rollrate, double pitchrate, double yawrate, quint64 usec);
pixhawk's avatar
pixhawk committed
536
    void attitudeThrustSetPointChanged(UASInterface*, double rollDesired, double pitchDesired, double yawDesired, double thrustDesired, quint64 usec);
537
    /** @brief The MAV set a new setpoint in the local (not body) NED X, Y, Z frame */
lm's avatar
lm committed
538
    void positionSetPointsChanged(int uasid, float xDesired, float yDesired, float zDesired, float yawDesired, quint64 usec);
539 540
    /** @brief A user (or an autonomous mission or obstacle avoidance planner) requested to set a new setpoint */
    void userPositionSetPointsChanged(int uasid, float xDesired, float yDesired, float zDesired, float yawDesired);
pixhawk's avatar
pixhawk committed
541
    void localPositionChanged(UASInterface*, double x, double y, double z, quint64 usec);
542
    void localPositionChanged(UASInterface*, int component, double x, double y, double z, quint64 usec);
lm's avatar
lm committed
543
    void globalPositionChanged(UASInterface*, double lat, double lon, double alt, quint64 usec);
544
    void altitudeChanged(UASInterface*, double altitudeAMSL, double altitudeRelative, double climbRate, quint64 usec);
lm's avatar
lm committed
545 546
    /** @brief Update the status of one satellite used for localization */
    void gpsSatelliteStatusChanged(int uasid, int satid, float azimuth, float direction, float snr, bool used);
547 548

    // The horizontal speed (a scalar)
549
    void speedChanged(UASInterface* uas, double groundSpeed, double airSpeed, quint64 usec);
550
    // Consider adding a MAV_FRAME parameter to this; could help specifying what the 3 scalars are.
551
    void velocityChanged_NED(UASInterface*, double vx, double vy, double vz, quint64 usec);
552 553 554

    void navigationControllerErrorsChanged(UASInterface*, double altitudeError, double speedError, double xtrackError);

pixhawk's avatar
pixhawk committed
555 556 557 558
    void imageStarted(int imgid, int width, int height, int depth, int channels);
    void imageDataReceived(int imgid, const unsigned char* imageData, int length, int startIndex);
    /** @brief Emit the new system type */
    void systemTypeSet(UASInterface* uas, unsigned int type);
559

pixhawk's avatar
pixhawk committed
560 561 562 563 564 565 566 567
    /** @brief Attitude control enabled/disabled */
    void attitudeControlEnabled(bool enabled);
    /** @brief Position 2D control enabled/disabled */
    void positionXYControlEnabled(bool enabled);
    /** @brief Altitude control enabled/disabled */
    void positionZControlEnabled(bool enabled);
    /** @brief Heading control enabled/disabled */
    void positionYawControlEnabled(bool enabled);
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
    /** @brief Optical flow status changed */
    void opticalFlowStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Vision based localization status changed */
    void visionLocalizationStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Infrared / Ultrasound status changed */
    void distanceSensorStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Gyroscope status changed */
    void gyroStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Accelerometer status changed */
    void accelStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Magnetometer status changed */
    void magSensorStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Barometer status changed */
    void baroStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Differential pressure / airspeed status changed */
    void airspeedStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Actuator status changed */
    void actuatorStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Laser scanner status changed */
    void laserStatusChanged(bool supported, bool enabled, bool ok);
    /** @brief Vicon / Leica Geotracker status changed */
    void groundTruthSensorStatusChanged(bool supported, bool enabled, bool ok);


592 593 594 595
    /** @brief Value of a remote control channel (raw) */
    void remoteControlChannelRawChanged(int channelId, float raw);
    /** @brief Value of a remote control channel (scaled)*/
    void remoteControlChannelScaledChanged(int channelId, float normalized);
pixhawk's avatar
pixhawk committed
596 597
    /** @brief Remote control RSSI changed */
    void remoteControlRSSIChanged(float rssi);
598 599
    /** @brief Radio Calibration Data has been received from the MAV*/
    void radioCalibrationReceived(const QPointer<RadioCalibrationData>&);
pixhawk's avatar
pixhawk committed
600

601 602 603 604 605 606 607 608 609 610 611 612 613
#if defined(QGC_PROTOBUF_ENABLED) && defined(QGC_USE_PIXHAWK_MESSAGES)
    /** @brief Overlay data has been changed */
    void overlayChanged(UASInterface* uas);
    /** @brief Obstacle list data has been changed */
    void obstacleListChanged(UASInterface* uas);
    /** @brief Path data has been changed */
    void pathChanged(UASInterface* uas);
    /** @brief Point cloud data has been changed */
    void pointCloudChanged(UASInterface* uas);
    /** @brief RGBD image data has been changed */
    void rgbdImageChanged(UASInterface* uas);
#endif

pixhawk's avatar
pixhawk committed
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
    /**
     * @brief Localization quality changed
     * @param fix 0: lost, 1: 2D local position hold, 2: 2D localization, 3: 3D localization
     */
    void localizationChanged(UASInterface* uas, int fix);
    /**
     * @brief GPS localization quality changed
     * @param fix 0: lost, 1: at least one satellite, but no GPS fix, 2: 2D localization, 3: 3D localization
     */
    void gpsLocalizationChanged(UASInterface* uas, int fix);
    /**
     * @brief Vision localization quality changed
     * @param fix 0: lost, 1: 2D local position hold, 2: 2D localization, 3: 3D localization
     */
    void visionLocalizationChanged(UASInterface* uas, int fix);
629 630 631 632 633
    /**
     * @brief IR/U localization quality changed
     * @param fix 0: No IR/Ultrasound sensor, N > 0: Found N active sensors
     */
    void irUltraSoundLocalizationChanged(UASInterface* uas, int fix);
634

635
    // ERROR AND STATUS SIGNALS
636 637
    /** @brief Heartbeat timed out or was regained */
    void heartbeatTimeout(bool timeout, unsigned int ms);
638 639
    /** @brief Name of system changed */
    void nameChanged(QString newName);
640 641
    /** @brief System has been selected as focused system */
    void systemSelected(bool selected);
642 643
    /** @brief Core specifications have changed */
    void systemSpecsChanged(int uasId);
644

LM's avatar
LM committed
645 646 647
    /** @brief Object detected */
    void objectDetected(unsigned int time, int id, int type, const QString& name, int quality, float bearing, float distance);

648 649 650 651

    // HOME POSITION / ORIGIN CHANGES
    void homePositionChanged(int uas, double lat, double lon, double alt);

652 653 654
    /** @brief The system received an unknown message, which it could not interpret */
    void unknownPacketReceived(int uas, int component, int messageid);

655
protected:
656

657
    // TIMEOUT CONSTANTS
Lorenz Meier's avatar
Lorenz Meier committed
658
    static const unsigned int timeoutIntervalHeartbeat = 3500 * 1000; ///< Heartbeat timeout is 2.5 seconds
659

pixhawk's avatar
pixhawk committed
660 661
};

lm's avatar
lm committed
662
Q_DECLARE_INTERFACE(UASInterface, "org.qgroundcontrol/1.0")
663

pixhawk's avatar
pixhawk committed
664
#endif // _UASINTERFACE_H_