UASInterface.h 7.9 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

Donald Gagne's avatar
Donald Gagne committed
10 11 12
// NO NEW CODE HERE
// UASInterface, UAS.h/cc are deprecated. All new functionality should go into Vehicle.h/cc
//
pixhawk's avatar
pixhawk committed
13 14 15 16 17 18 19 20

#ifndef _UASINTERFACE_H_
#define _UASINTERFACE_H_

#include <QObject>
#include <QList>
#include <QAction>
#include <QColor>
21
#include <QPointer>
pixhawk's avatar
pixhawk committed
22 23 24 25

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

26
#ifndef __mobile__
27
class FileManager;
28
#endif
29

pixhawk's avatar
pixhawk committed
30 31 32 33 34 35
/**
 * @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
36 37
class UASInterface : public QObject
{
pixhawk's avatar
pixhawk committed
38 39 40 41 42 43
    Q_OBJECT
public:
    virtual ~UASInterface() {}

    /* MANAGEMENT */

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

48
#ifndef __mobile__
49
    virtual FileManager* getFileManager() = 0;
50
#endif
51

LM's avatar
LM committed
52 53
    virtual QMap<int, QString> getComponents() = 0;

54 55 56 57 58
    enum StartCalibrationType {
        StartCalibrationRadio,
        StartCalibrationGyro,
        StartCalibrationMag,
        StartCalibrationAirspeed,
59
        StartCalibrationAccel,
60
        StartCalibrationLevel,
61
        StartCalibrationPressure,
Don Gagne's avatar
Don Gagne committed
62
        StartCalibrationEsc,
63
        StartCalibrationCopyTrims,
64 65
        StartCalibrationUavcanEsc,
        StartCalibrationCompassMot,
66 67 68
    };

    enum StartBusConfigType {
69 70
        StartBusConfigActuators,
        EndBusConfigActuators,
71
    };
dogmaphobic's avatar
dogmaphobic committed
72

73 74
    /// Starts the specified calibration
    virtual void startCalibration(StartCalibrationType calType) = 0;
dogmaphobic's avatar
dogmaphobic committed
75

76 77
    /// Ends any current calibration
    virtual void stopCalibration(void) = 0;
78

79 80 81 82 83 84
    /// 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
85
public slots:
86 87
    /** @brief Order the robot to pair its receiver **/
    virtual void pairRX(int rxType, int rxSubType) = 0;
pixhawk's avatar
pixhawk committed
88

Lorenz Meier's avatar
Lorenz Meier committed
89
    /** @brief Send the full HIL state to the MAV */
dogmaphobic's avatar
dogmaphobic committed
90
#ifndef __mobile__
Lorenz Meier's avatar
Lorenz Meier committed
91 92
    virtual void sendHilState(quint64 time_us, float roll, float pitch, float yaw, float rollspeed,
                        float pitchspeed, float yawspeed, double lat, double lon, double alt,
93
                        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
94 95 96

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

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

102 103 104
    /** @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
105
#endif
106

107
    /** @brief Send command to map a RC channel to a parameter */
108
    virtual void sendMapRCToParam(QString param_id, float scale, float value0, quint8 param_rc_channel_index, float valueMin, float valueMax) = 0;
109 110 111 112

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

pixhawk's avatar
pixhawk committed
113
signals:
114 115 116
    /**
     * @brief Update the error count of a device
     *
Ricardo de Almeida Gonzaga's avatar
Ricardo de Almeida Gonzaga committed
117
     * The error count indicates how many errors occurred during the use of a device.
118 119 120 121 122 123 124
     * 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
125
     * @param count Errors occurred since system startup
126 127 128
     */
    void errCountChanged(int uasid, QString component, QString device, int count);

pixhawk's avatar
pixhawk committed
129 130 131 132
    /** @brief The robot is connected **/
    void connected();
    /** @brief The robot is disconnected **/
    void disconnected();
133

pixhawk's avatar
pixhawk committed
134 135 136
    /** @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
137
      * the groundstation. The data here should be converted to human-readable values before being passed, so ideally
dogmaphobic's avatar
dogmaphobic committed
138
      * SI units.
pixhawk's avatar
pixhawk committed
139 140 141
      *
      * @param uasId ID of this system
      * @param name name of the value, e.g. "battery voltage"
dogmaphobic's avatar
dogmaphobic committed
142
      * @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
143 144 145
      * @param value the value that changed
      * @param msec the timestamp of the message, in milliseconds
      */
146
    void valueChanged(const int uasid, const QString& name, const QString& unit, const QVariant &value,const quint64 msecs);
lm's avatar
lm committed
147

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

pixhawk's avatar
pixhawk committed
150 151 152 153 154 155 156 157
    /**
     * @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
158
    void batteryChanged(UASInterface* uas, double voltage, double current, double percent, int seconds);
pixhawk's avatar
pixhawk committed
159
    void statusChanged(UASInterface* uas, QString status);
160

pixhawk's avatar
pixhawk committed
161 162
    void imageStarted(int imgid, int width, int height, int depth, int channels);
    void imageDataReceived(int imgid, const unsigned char* imageData, int length, int startIndex);
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180

    /** @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);

181 182 183
    // ERROR AND STATUS SIGNALS
    /** @brief Name of system changed */
    void nameChanged(QString newName);
184 185
    /** @brief Core specifications have changed */
    void systemSpecsChanged(int uasId);
186

dogmaphobic's avatar
dogmaphobic committed
187 188 189
    // 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);
190

pixhawk's avatar
pixhawk committed
191 192
};

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

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