UASInterface.h 13.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 43

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

44
#ifndef __mobile__
45
class FileManager;
46
#endif
47

pixhawk's avatar
pixhawk committed
48 49 50 51 52 53
/**
 * @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
54 55
class UASInterface : public QObject
{
pixhawk's avatar
pixhawk committed
56 57 58 59 60 61
    Q_OBJECT
public:
    virtual ~UASInterface() {}

    /* MANAGEMENT */

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

66 67
    virtual double getLatitude() const = 0;
    virtual double getLongitude() const = 0;
68 69
    virtual double getAltitudeAMSL() const = 0;
    virtual double getAltitudeRelative() const = 0;
70
    virtual bool globalPositionKnown() const = 0;
71

lm's avatar
lm committed
72 73 74 75
    virtual double getRoll() const = 0;
    virtual double getPitch() const = 0;
    virtual double getYaw() const = 0;

76
#ifndef __mobile__
77
    virtual FileManager* getFileManager() = 0;
78
#endif
79

pixhawk's avatar
pixhawk committed
80 81 82 83 84 85 86 87
    /**
     * @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.
     */
88
    static QColor getNextColor() {
pixhawk's avatar
pixhawk committed
89
        /* Create color map */
90
        static QList<QColor> colors = QList<QColor>()
dogmaphobic's avatar
dogmaphobic committed
91 92 93 94 95 96 97 98
        << 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)
99
                << QColor(235,43,165)
dogmaphobic's avatar
dogmaphobic committed
100 101 102
        << QColor(98,248,176)
        << QColor(236,48,221)
        << QColor(92,247,217)
103
                << QColor(200,54,238)
dogmaphobic's avatar
dogmaphobic committed
104 105 106
        << QColor(87,231,246)
        << QColor(151,59,239)
        << QColor(81,183,244)
107
                << QColor(75,133,243)
dogmaphobic's avatar
dogmaphobic committed
108 109
        << QColor(242,255,128)
        << QColor(230,126,23);
110

pixhawk's avatar
pixhawk committed
111
        static int nextColor = -1;
112 113
        if(nextColor == 18){//if at the end of the list
            nextColor = -1;//go back to the beginning
pixhawk's avatar
pixhawk committed
114
        }
115
        nextColor++;
116 117
        return colors[nextColor];//return the next color
   }
pixhawk's avatar
pixhawk committed
118

LM's avatar
LM committed
119 120 121 122
    virtual QMap<int, QString> getComponents() = 0;

    QColor getColor()
    {
pixhawk's avatar
pixhawk committed
123 124 125
        return color;
    }

126 127 128 129 130
    enum StartCalibrationType {
        StartCalibrationRadio,
        StartCalibrationGyro,
        StartCalibrationMag,
        StartCalibrationAirspeed,
131
        StartCalibrationAccel,
132
        StartCalibrationLevel,
Don Gagne's avatar
Don Gagne committed
133
        StartCalibrationEsc,
134 135 136 137 138
        StartCalibrationCopyTrims,
        StartCalibrationUavcanEsc
    };

    enum StartBusConfigType {
139 140
        StartBusConfigActuators,
        EndBusConfigActuators,
141
    };
dogmaphobic's avatar
dogmaphobic committed
142

143 144
    /// Starts the specified calibration
    virtual void startCalibration(StartCalibrationType calType) = 0;
dogmaphobic's avatar
dogmaphobic committed
145

146 147
    /// Ends any current calibration
    virtual void stopCalibration(void) = 0;
148

149 150 151 152 153 154
    /// 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
155 156
public slots:

157
    /** @brief Executes a command **/
158
    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;
159

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

Lorenz Meier's avatar
Lorenz Meier committed
163
    /** @brief Send the full HIL state to the MAV */
dogmaphobic's avatar
dogmaphobic committed
164
#ifndef __mobile__
Lorenz Meier's avatar
Lorenz Meier committed
165 166
    virtual void sendHilState(quint64 time_us, float roll, float pitch, float yaw, float rollspeed,
                        float pitchspeed, float yawspeed, double lat, double lon, double alt,
167
                        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
168 169 170

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

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

176 177 178
    /** @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
179
#endif
180

181
    /** @brief Send command to map a RC channel to a parameter */
182
    virtual void sendMapRCToParam(QString param_id, float scale, float value0, quint8 param_rc_channel_index, float valueMin, float valueMax) = 0;
183 184 185 186

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

pixhawk's avatar
pixhawk committed
187 188 189 190
protected:
    QColor color;

signals:
LM's avatar
LM committed
191
    /** @brief The robot state has changed */
pixhawk's avatar
pixhawk committed
192 193 194 195 196 197 198 199
    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);
200

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

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
    /**
     * @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
219 220 221 222
    /**
     * @brief Drop rate of communication link updated
     *
     * @param systemId id of the air system
223
     * @param receiveDrop drop rate of packets this MAV receives (sent from GCS or other MAVs)
lm's avatar
lm committed
224
     */
225
    void dropRateChanged(int systemId,  float receiveDrop);
pixhawk's avatar
pixhawk committed
226 227 228 229
    /** @brief The robot is connected **/
    void connected();
    /** @brief The robot is disconnected **/
    void disconnected();
230

pixhawk's avatar
pixhawk committed
231 232 233
    /** @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
234
      * the groundstation. The data here should be converted to human-readable values before being passed, so ideally
dogmaphobic's avatar
dogmaphobic committed
235
      * SI units.
pixhawk's avatar
pixhawk committed
236 237 238
      *
      * @param uasId ID of this system
      * @param name name of the value, e.g. "battery voltage"
dogmaphobic's avatar
dogmaphobic committed
239
      * @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
240 241 242
      * @param value the value that changed
      * @param msec the timestamp of the message, in milliseconds
      */
243
    void valueChanged(const int uasid, const QString& name, const QString& unit, const QVariant &value,const quint64 msecs);
lm's avatar
lm committed
244

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

pixhawk's avatar
pixhawk committed
247 248 249 250 251 252 253 254
    /**
     * @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
255
    void batteryChanged(UASInterface* uas, double voltage, double current, double percent, int seconds);
pixhawk's avatar
pixhawk committed
256 257 258
    void statusChanged(UASInterface* uas, QString status);
    void thrustChanged(UASInterface*, double thrust);
    void attitudeChanged(UASInterface*, double roll, double pitch, double yaw, quint64 usec);
259
    void attitudeChanged(UASInterface*, int component, double roll, double pitch, double yaw, quint64 usec);
260
    void attitudeRotationRatesChanged(int uas, double rollrate, double pitchrate, double yawrate, quint64 usec);
261
    void attitudeThrustSetPointChanged(UASInterface*, float rollDesired, float pitchDesired, float yawDesired, float thrustDesired, quint64 usec);
262
    /** @brief The MAV set a new setpoint in the local (not body) NED X, Y, Z frame */
lm's avatar
lm committed
263
    void positionSetPointsChanged(int uasid, float xDesired, float yDesired, float zDesired, float yawDesired, quint64 usec);
264 265
    /** @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
266 267
    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
268 269
    /** @brief Update the status of one satellite used for localization */
    void gpsSatelliteStatusChanged(int uasid, int satid, float azimuth, float direction, float snr, bool used);
270 271

    // The horizontal speed (a scalar)
272
    void speedChanged(UASInterface* uas, double groundSpeed, double airSpeed, quint64 usec);
273
    // Consider adding a MAV_FRAME parameter to this; could help specifying what the 3 scalars are.
274
    void velocityChanged_NED(UASInterface*, double vx, double vy, double vz, quint64 usec);
275 276

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

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

pixhawk's avatar
pixhawk committed
282 283 284 285 286 287 288 289
    /** @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);
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    /** @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
307 308 309 310 311
    /**
     * @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);
312

313 314 315
    // ERROR AND STATUS SIGNALS
    /** @brief Name of system changed */
    void nameChanged(QString newName);
316 317
    /** @brief Core specifications have changed */
    void systemSpecsChanged(int uasId);
318

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

dogmaphobic's avatar
dogmaphobic committed
322 323 324
    // 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
325 326
};

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

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