UASInterface.h 13.2 KB
Newer Older
1 2 3 4 5 6 7 8
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/
pixhawk's avatar
pixhawk committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25


/**
 * @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>
26
#include <QPointer>
pixhawk's avatar
pixhawk committed
27 28 29 30

#include "LinkInterface.h"
#include "ProtocolInterface.h"

31
#ifndef __mobile__
32
class FileManager;
33
#endif
34

pixhawk's avatar
pixhawk committed
35 36 37 38 39 40
/**
 * @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
41 42
class UASInterface : public QObject
{
pixhawk's avatar
pixhawk committed
43 44 45 46 47 48
    Q_OBJECT
public:
    virtual ~UASInterface() {}

    /* MANAGEMENT */

49
    virtual int getUASID() const = 0; ///< Get the ID of the connected UAS
pixhawk's avatar
pixhawk committed
50
    /** @brief The time interval the robot is switched on **/
51
    virtual quint64 getUptime() const = 0;
pixhawk's avatar
pixhawk committed
52

53 54
    virtual double getLatitude() const = 0;
    virtual double getLongitude() const = 0;
55 56
    virtual double getAltitudeAMSL() const = 0;
    virtual double getAltitudeRelative() const = 0;
57
    virtual bool globalPositionKnown() const = 0;
58

lm's avatar
lm committed
59 60 61 62
    virtual double getRoll() const = 0;
    virtual double getPitch() const = 0;
    virtual double getYaw() const = 0;

63
#ifndef __mobile__
64
    virtual FileManager* getFileManager() = 0;
65
#endif
66

pixhawk's avatar
pixhawk committed
67 68 69 70 71 72 73 74
    /**
     * @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.
     */
75
    static QColor getNextColor() {
pixhawk's avatar
pixhawk committed
76
        /* Create color map */
77
        static QList<QColor> colors = QList<QColor>()
dogmaphobic's avatar
dogmaphobic committed
78 79 80 81 82 83 84 85
        << 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)
86
                << QColor(235,43,165)
dogmaphobic's avatar
dogmaphobic committed
87 88 89
        << QColor(98,248,176)
        << QColor(236,48,221)
        << QColor(92,247,217)
90
                << QColor(200,54,238)
dogmaphobic's avatar
dogmaphobic committed
91 92 93
        << QColor(87,231,246)
        << QColor(151,59,239)
        << QColor(81,183,244)
94
                << QColor(75,133,243)
dogmaphobic's avatar
dogmaphobic committed
95 96
        << QColor(242,255,128)
        << QColor(230,126,23);
97

pixhawk's avatar
pixhawk committed
98
        static int nextColor = -1;
99 100
        if(nextColor == 18){//if at the end of the list
            nextColor = -1;//go back to the beginning
pixhawk's avatar
pixhawk committed
101
        }
102
        nextColor++;
103 104
        return colors[nextColor];//return the next color
   }
pixhawk's avatar
pixhawk committed
105

LM's avatar
LM committed
106 107 108 109
    virtual QMap<int, QString> getComponents() = 0;

    QColor getColor()
    {
pixhawk's avatar
pixhawk committed
110 111 112
        return color;
    }

113 114 115 116 117
    enum StartCalibrationType {
        StartCalibrationRadio,
        StartCalibrationGyro,
        StartCalibrationMag,
        StartCalibrationAirspeed,
118
        StartCalibrationAccel,
119
        StartCalibrationLevel,
Don Gagne's avatar
Don Gagne committed
120
        StartCalibrationEsc,
121
        StartCalibrationCopyTrims,
122 123
        StartCalibrationUavcanEsc,
        StartCalibrationCompassMot,
124 125 126
    };

    enum StartBusConfigType {
127 128
        StartBusConfigActuators,
        EndBusConfigActuators,
129
    };
dogmaphobic's avatar
dogmaphobic committed
130

131 132
    /// Starts the specified calibration
    virtual void startCalibration(StartCalibrationType calType) = 0;
dogmaphobic's avatar
dogmaphobic committed
133

134 135
    /// Ends any current calibration
    virtual void stopCalibration(void) = 0;
136

137 138 139 140 141 142
    /// Starts the specified bus configuration
    virtual void startBusConfig(StartBusConfigType calType) = 0;

    /// Ends any current bus configuration
    virtual void stopBusConfig(void) = 0;

pixhawk's avatar
pixhawk committed
143 144
public slots:

145
    /** @brief Executes a command **/
146
    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;
147

148 149
    /** @brief Order the robot to pair its receiver **/
    virtual void pairRX(int rxType, int rxSubType) = 0;
pixhawk's avatar
pixhawk committed
150

Lorenz Meier's avatar
Lorenz Meier committed
151
    /** @brief Send the full HIL state to the MAV */
dogmaphobic's avatar
dogmaphobic committed
152
#ifndef __mobile__
Lorenz Meier's avatar
Lorenz Meier committed
153 154
    virtual void sendHilState(quint64 time_us, float roll, float pitch, float yaw, float rollspeed,
                        float pitchspeed, float yawspeed, double lat, double lon, double alt,
155
                        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
156 157 158

    /** @brief RAW sensors for sensor HIL */
    virtual void sendHilSensors(quint64 time_us, float xacc, float yacc, float zacc, float rollspeed, float pitchspeed, float yawspeed,
159
                                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
160 161

    /** @brief Send raw GPS for sensor HIL */
162
    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
163

164 165 166
    /** @brief Send Optical Flow sensor message for HIL, (arguments and units accoding to mavlink documentation*/
    virtual void sendHilOpticalFlow(quint64 time_us, qint16 flow_x, qint16 flow_y, float flow_comp_m_x,
                            float flow_comp_m_y, quint8 quality, float ground_distance) = 0;
dogmaphobic's avatar
dogmaphobic committed
167
#endif
168

169
    /** @brief Send command to map a RC channel to a parameter */
170
    virtual void sendMapRCToParam(QString param_id, float scale, float value0, quint8 param_rc_channel_index, float valueMin, float valueMax) = 0;
171 172 173 174

    /** @brief Send command to disable all bindings/maps between RC and parameters */
    virtual void unsetRCToParameterMap() = 0;

pixhawk's avatar
pixhawk committed
175 176 177 178
protected:
    QColor color;

signals:
LM's avatar
LM committed
179
    /** @brief The robot state has changed */
pixhawk's avatar
pixhawk committed
180 181 182 183 184 185 186 187
    void statusChanged(int stateFlag);
    /** @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);
188

189
    /** @brief A text message from the system has been received */
190
    void textMessageReceived(int uasid, int componentid, int severity, QString text);
191

192 193 194
    /**
     * @brief Update the error count of a device
     *
Ricardo de Almeida Gonzaga's avatar
Ricardo de Almeida Gonzaga committed
195
     * The error count indicates how many errors occurred during the use of a device.
196 197 198 199 200 201 202
     * 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"
Ricardo de Almeida Gonzaga's avatar
Ricardo de Almeida Gonzaga committed
203
     * @param count Errors occurred since system startup
204 205 206
     */
    void errCountChanged(int uasid, QString component, QString device, int count);

lm's avatar
lm committed
207 208 209 210
    /**
     * @brief Drop rate of communication link updated
     *
     * @param systemId id of the air system
211
     * @param receiveDrop drop rate of packets this MAV receives (sent from GCS or other MAVs)
lm's avatar
lm committed
212
     */
213
    void dropRateChanged(int systemId,  float receiveDrop);
pixhawk's avatar
pixhawk committed
214 215 216 217
    /** @brief The robot is connected **/
    void connected();
    /** @brief The robot is disconnected **/
    void disconnected();
218

pixhawk's avatar
pixhawk committed
219 220 221
    /** @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
222
      * the groundstation. The data here should be converted to human-readable values before being passed, so ideally
dogmaphobic's avatar
dogmaphobic committed
223
      * SI units.
pixhawk's avatar
pixhawk committed
224 225 226
      *
      * @param uasId ID of this system
      * @param name name of the value, e.g. "battery voltage"
dogmaphobic's avatar
dogmaphobic committed
227
      * @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
228 229 230
      * @param value the value that changed
      * @param msec the timestamp of the message, in milliseconds
      */
231
    void valueChanged(const int uasid, const QString& name, const QString& unit, const QVariant &value,const quint64 msecs);
lm's avatar
lm committed
232

233
    void parameterUpdate(int uas, int component, QString parameterName, int parameterCount, int parameterId, int type, QVariant value);
Don Gagne's avatar
Don Gagne committed
234

pixhawk's avatar
pixhawk committed
235 236 237 238 239 240 241 242
    /**
     * @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
243
    void batteryChanged(UASInterface* uas, double voltage, double current, double percent, int seconds);
pixhawk's avatar
pixhawk committed
244 245 246
    void statusChanged(UASInterface* uas, QString status);
    void thrustChanged(UASInterface*, double thrust);
    void attitudeChanged(UASInterface*, double roll, double pitch, double yaw, quint64 usec);
247
    void attitudeChanged(UASInterface*, int component, double roll, double pitch, double yaw, quint64 usec);
248
    void attitudeRotationRatesChanged(int uas, double rollrate, double pitchrate, double yawrate, quint64 usec);
249
    void attitudeThrustSetPointChanged(UASInterface*, float rollDesired, float pitchDesired, float yawDesired, float thrustDesired, quint64 usec);
250
    /** @brief The MAV set a new setpoint in the local (not body) NED X, Y, Z frame */
lm's avatar
lm committed
251
    void positionSetPointsChanged(int uasid, float xDesired, float yDesired, float zDesired, float yawDesired, quint64 usec);
252 253
    /** @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);
Don Gagne's avatar
Don Gagne committed
254 255
    void globalPositionChanged(UASInterface*, double lat, double lon, double altAMSL, quint64 usec);
    void altitudeChanged(UASInterface*, double altitudeAMSL, double altitudeRelative, double climbRate, quint64 usec);
lm's avatar
lm committed
256 257
    /** @brief Update the status of one satellite used for localization */
    void gpsSatelliteStatusChanged(int uasid, int satid, float azimuth, float direction, float snr, bool used);
258 259

    // The horizontal speed (a scalar)
260
    void speedChanged(UASInterface* uas, double groundSpeed, double airSpeed, quint64 usec);
261
    // Consider adding a MAV_FRAME parameter to this; could help specifying what the 3 scalars are.
262
    void velocityChanged_NED(UASInterface*, double vx, double vy, double vz, quint64 usec);
263 264

    void navigationControllerErrorsChanged(UASInterface*, double altitudeError, double speedError, double xtrackError);
265
    void NavigationControllerDataChanged(UASInterface *uas, float navRoll, float navPitch, float navBearing, float targetBearing, float targetDist);
266

pixhawk's avatar
pixhawk committed
267 268
    void imageStarted(int imgid, int width, int height, int depth, int channels);
    void imageDataReceived(int imgid, const unsigned char* imageData, int length, int startIndex);
269

pixhawk's avatar
pixhawk committed
270 271 272 273 274 275 276 277
    /** @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);
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
    /** @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);

pixhawk's avatar
pixhawk committed
295 296 297 298 299
    /**
     * @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);
300

301 302 303
    // ERROR AND STATUS SIGNALS
    /** @brief Name of system changed */
    void nameChanged(QString newName);
304 305
    /** @brief Core specifications have changed */
    void systemSpecsChanged(int uasId);
306

dogmaphobic's avatar
dogmaphobic committed
307 308 309
    // Log Download Signals
    void logEntry   (UASInterface* uas, uint32_t time_utc, uint32_t size, uint16_t id, uint16_t num_logs, uint16_t last_log_num);
    void logData    (UASInterface* uas, uint32_t ofs, uint16_t id, uint8_t count, const uint8_t* data);
pixhawk's avatar
pixhawk committed
310 311
};

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

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