UAS.h 17.2 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

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

/**
 * @file
 *   @brief Definition of Unmanned Aerial Vehicle object
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

#ifndef _UAS_H_
#define _UAS_H_

#include "UASInterface.h"
#include "MG.h"
37
#include <MAVLinkProtocol.h>
pixhawk's avatar
pixhawk committed
38
#include "QGCMAVLink.h"
pixhawk's avatar
pixhawk committed
39 40 41 42 43 44 45 46 47

/**
 * @brief A generic MAVLINK-connected MAV/UAV
 *
 * This class represents one vehicle. It can be used like the real vehicle, e.g. a call to halt()
 * will automatically send the appropriate messages to the vehicle. The vehicle state will also be
 * automatically updated by the comm architecture, so when writing code to e.g. control the vehicle
 * no knowledge of the communication infrastructure is needed.
 */
48 49
class UAS : public UASInterface
{
pixhawk's avatar
pixhawk committed
50 51
    Q_OBJECT
public:
52
    UAS(MAVLinkProtocol* protocol, int id = 0);
pixhawk's avatar
pixhawk committed
53 54
    ~UAS();

55
    enum BatteryType {
pixhawk's avatar
pixhawk committed
56 57 58 59 60 61
        NICD = 0,
        NIMH = 1,
        LIION = 2,
        LIPOLY = 3,
        LIFE = 4,
        AGZN = 5
62
    }; ///< The type of battery used
pixhawk's avatar
pixhawk committed
63 64 65 66 67 68 69

    static const int lipoFull = 4.2f;  ///< 100% charged voltage
    static const int lipoEmpty = 3.5f; ///< Discharged voltage

    /* MANAGEMENT */

    /** @brief The name of the robot */
70
    QString getUASName(void) const;
71 72 73 74
    /** @brief Get short state */
    const QString& getShortState() const;
    /** @brief Get short mode */
    const QString& getShortMode() const;
pixhawk's avatar
pixhawk committed
75
    /** @brief Get the unique system id */
76
    int getUASID() const;
77
    /** @brief Get the airframe */
78 79 80
    int getAirframe() const {
        return airframe;
    }
pixhawk's avatar
pixhawk committed
81
    /** @brief The time interval the robot is switched on */
82
    quint64 getUptime() const;
pixhawk's avatar
pixhawk committed
83
    /** @brief Get the status flag for the communication */
84
    int getCommunicationStatus() const;
pixhawk's avatar
pixhawk committed
85
    /** @brief Add one measurement and get low-passed voltage */
86
    float filterVoltage(float value) const;
pixhawk's avatar
pixhawk committed
87 88 89
    /** @brief Get the links associated with this robot */
    QList<LinkInterface*>* getLinks();

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
    double getLocalX() const {
        return localX;
    }
    double getLocalY() const {
        return localY;
    }
    double getLocalZ() const {
        return localZ;
    }
    double getLatitude() const {
        return latitude;
    }
    double getLongitude() const {
        return longitude;
    }
    double getAltitude() const {
        return altitude;
    }
108 109 110 111 112 113 114 115
    virtual bool localPositionKnown() const
    {
        return isLocalPositionKnown;
    }
    virtual bool globalPositionKnown() const
    {
        return isGlobalPositionKnown;
    }
116 117 118 119 120 121 122 123 124 125

    double getRoll() const {
        return roll;
    }
    double getPitch() const {
        return pitch;
    }
    double getYaw() const {
        return yaw;
    }
126
    bool getSelected() const;
lm's avatar
lm committed
127

128
    friend class UASWaypointManager;
129

INIDETAM's avatar
INIDETAM committed
130
protected: //COMMENTS FOR TEST UNIT
131
    int uasId;                    ///< Unique system ID
132
    unsigned char type;           ///< UAS type (from type enum)
pixhawk's avatar
pixhawk committed
133 134 135
    quint64 startTime;            ///< The time the UAS was switched on
    CommStatus commStatus;        ///< Communication status
    QString name;                 ///< Human-friendly name of the vehicle, e.g. bravo
136
    int autopilot;                ///< Type of the Autopilot: -1: None, 0: Generic, 1: PIXHAWK, 2: SLUGS, 3: Ardupilot (up to 15 types), defined in MAV_AUTOPILOT_TYPE ENUM
pixhawk's avatar
pixhawk committed
137
    QList<LinkInterface*>* links; ///< List of links this UAS can be reached by
138
    QList<int> unknownPackets;    ///< Packet IDs which are unknown and have been received
139
    MAVLinkProtocol* mavlink;     ///< Reference to the MAVLink instance
pixhawk's avatar
pixhawk committed
140 141
    BatteryType batteryType;      ///< The battery type
    int cells;                    ///< Number of cells
pixhawk's avatar
pixhawk committed
142

143 144
    UASWaypointManager waypointManager;

pixhawk's avatar
pixhawk committed
145 146 147 148 149 150
    QList<double> actuatorValues;
    QList<QString> actuatorNames;

    QList<double> motorValues;
    QList<QString> motorNames;

pixhawk's avatar
pixhawk committed
151 152
    double thrustSum;           ///< Sum of forward/up thrust of all thrust actuators, in Newtons
    double thrustMax;           ///< Maximum forward/up thrust of this vehicle, in Newtons
pixhawk's avatar
pixhawk committed
153 154

    // Battery stats
155 156 157
    float fullVoltage;          ///< Voltage of the fully charged battery (100%)
    float emptyVoltage;         ///< Voltage of the empty battery (0%)
    float startVoltage;         ///< Voltage at system start
158
    float warnVoltage;          ///< Voltage where QGC will start to warn about low battery
159
    float warnLevelPercent;     ///< Warning level, in percent
pixhawk's avatar
pixhawk committed
160 161
    double currentVoltage;      ///< Voltage currently measured
    float lpVoltage;            ///< Low-pass filtered voltage
162 163
    bool batteryRemainingEstimateEnabled; ///< If the estimate is enabled, QGC will try to estimate the remaining battery life
    float chargeLevel;          ///< Charge level of battery, in percent
pixhawk's avatar
pixhawk committed
164
    int timeRemaining;          ///< Remaining time calculated based on previous and current
165
    int mode;                   ///< The current mode of the MAV
pixhawk's avatar
pixhawk committed
166
    int status;                 ///< The current status of the MAV
167
    int navMode;                ///< The current navigation mode of the MAV
pixhawk's avatar
pixhawk committed
168 169
    quint64 onboardTimeOffset;

pixhawk's avatar
pixhawk committed
170 171 172 173 174 175 176 177 178
    bool controlRollManual;     ///< status flag, true if roll is controlled manually
    bool controlPitchManual;    ///< status flag, true if pitch is controlled manually
    bool controlYawManual;      ///< status flag, true if yaw is controlled manually
    bool controlThrustManual;   ///< status flag, true if thrust is controlled manually

    double manualRollAngle;     ///< Roll angle set by human pilot (radians)
    double manualPitchAngle;    ///< Pitch angle set by human pilot (radians)
    double manualYawAngle;      ///< Yaw angle set by human pilot (radians)
    double manualThrust;        ///< Thrust set by human pilot (radians)
lm's avatar
lm committed
179 180
    float receiveDropRate;      ///< Percentage of packets that were dropped on the MAV's receiving link (from GCS and other MAVs)
    float sendDropRate;         ///< Percentage of packets that were not received from the MAV by the GCS
lm's avatar
lm committed
181
    bool lowBattAlarm;          ///< Switch if battery is low
182
    bool positionLock;          ///< Status if position information is available or not
lm's avatar
lm committed
183 184 185
    double localX;
    double localY;
    double localZ;
186 187 188
    double latitude;
    double longitude;
    double altitude;
189 190 191
    double speedX;              ///< True speed in X axis
    double speedY;              ///< True speed in Y axis
    double speedZ;              ///< True speed in Z axis
lm's avatar
lm committed
192 193 194
    double roll;
    double pitch;
    double yaw;
195
    quint64 lastHeartbeat;      ///< Time of the last heartbeat message
196
    QTimer* statusTimeout;      ///< Timer for various status timeouts
197 198 199 200 201

    int imageSize;              ///< Image size being transmitted (bytes)
    int imagePackets;           ///< Number of data packets being sent for this image
    int imagePacketsArrived;    ///< Number of data packets recieved
    int imagePayload;           ///< Payload size per transmitted packet (bytes). Standard is 254, and decreases when image resolution increases.
LM's avatar
LM committed
202 203
    int imageQuality;           ///< Quality of the transmitted image (percentage)
    int imageType;              ///< Type of the transmitted image (BMP, PNG, JPEG, RAW 8 bit, RAW 32 bit)
204 205 206 207
    QByteArray imageRecBuffer;  ///< Buffer for the incoming bytestream
    QImage image;               ///< Image data of last completely transmitted image
    quint64 imageStart;

208
    QMap<int, QMap<QString, float>* > parameters; ///< All parameters
209 210 211
    bool paramsOnceRequested;     ///< If the parameter list has been read at least once
    int airframe;                 ///< The airframe type
    bool attitudeKnown;           ///< True if attitude was received, false else
212
    QGCUASParamManager* paramManager; ///< Parameter manager class
213 214 215 216 217 218
    QString shortStateText;       ///< Short textual state description
    QString shortModeText;        ///< Short textual mode description
    bool attitudeStamped;         ///< Should arriving data be timestamped with the last attitude? This helps with broken system time clocks on the MAV
    quint64 lastAttitude;         ///< Timestamp of last attitude measurement
    bool isLocalPositionKnown;    ///< If the local position has been received for this MAV
    bool isGlobalPositionKnown;   ///< If the global position has been received for this MAV
lm's avatar
lm committed
219

220
public:
pixhawk's avatar
pixhawk committed
221 222 223 224 225
    /** @brief Set the current battery type */
    void setBattery(BatteryType type, int cells);
    /** @brief Estimate how much flight time is remaining */
    int calculateTimeRemaining();
    /** @brief Get the current charge level */
226
    float getChargeLevel();
pixhawk's avatar
pixhawk committed
227 228
    /** @brief Get the human-readable status message for this code */
    void getStatusForCode(int statusCode, QString& uasState, QString& stateDescription);
229 230
    /** @brief Get the human-readable navigation mode translation for this mode */
    QString getNavModeText(int mode);
pixhawk's avatar
pixhawk committed
231 232 233
    /** @brief Check if vehicle is in autonomous mode */
    bool isAuto();

234 235 236
    UASWaypointManager* getWaypointManager() {
        return &waypointManager;
    }
237
    /** @brief Get reference to the param manager **/
238 239 240
    QGCUASParamManager* getParamManager() const {
        return paramManager;
    }
241 242
    // TODO Will be removed
    /** @brief Set reference to the param manager **/
243 244 245
    void setParamManager(QGCUASParamManager* manager) {
        paramManager = manager;
    }
246
    int getSystemType();
247
    QImage getImage();
248
    void requestImage();
249 250 251
    int getAutopilotType() {
        return autopilot;
    }
252

pixhawk's avatar
pixhawk committed
253
public slots:
254
    /** @brief Set the autopilot type */
255 256 257 258
    void setAutopilotType(int apType) {
        autopilot = apType;
        emit systemSpecsChanged(uasId);
    }
259
    /** @brief Set the type of airframe */
260
    void setSystemType(int systemType);
261
    /** @brief Set the specific airframe type */
262 263 264 265
    void setAirframe(int airframe) {
        this->airframe = airframe;
        emit systemSpecsChanged(uasId);
    }
266 267 268
    /** @brief Set a new name **/
    void setUASName(const QString& name);
    /** @brief Executes an action **/
269
    void setAction(MAV_ACTION action);
lm's avatar
lm committed
270 271
    /** @brief Executes a command **/
    void executeCommand(MAV_CMD command);
272 273
    /** @brief Executes a command **/
    void executeCommand(MAV_CMD command, int confirmation, float param1, float param2, float param3, float param4, int component);
274 275 276 277
    /** @brief Set the current battery type and voltages */
    void setBatterySpecs(const QString& specs);
    /** @brief Get the current battery type and specs */
    QString getBatterySpecs();
278

pixhawk's avatar
pixhawk committed
279 280
    /** @brief Launches the system **/
    void launch();
lm's avatar
lm committed
281
    /** @brief Write this waypoint to the list of waypoints */
282
    //void setWaypoint(Waypoint* wp); FIXME tbd
lm's avatar
lm committed
283
    /** @brief Set currently active waypoint */
284
    //void setWaypointActive(int id); FIXME tbd
pixhawk's avatar
pixhawk committed
285 286 287 288
    /** @brief Order the robot to return home / to land on the runway **/
    void home();
    void halt();
    void go();
289 290 291 292 293 294 295
    /** @brief Places the UAV in Hardware-in-the-Loop simulation status **/
    void startHil();

    /** @brief Stops the UAV's Hardware-in-the-Loop simulation status **/
    void stopHil();


pixhawk's avatar
pixhawk committed
296 297 298 299 300 301 302 303 304
    /** @brief Stops the robot system. If it is an MAV, the robot starts the emergency landing procedure **/
    void emergencySTOP();

    /** @brief Kills the robot. All systems are immediately shut down (e.g. the main power line is cut). This might lead to a crash **/
    bool emergencyKILL();

    /** @brief Shut the system cleanly down. Will shut down any onboard computers **/
    void shutdown();

305 306 307
    /** @brief Set the target position for the robot to navigate to. */
    void setTargetPosition(float x, float y, float z, float yaw);

lm's avatar
lm committed
308 309 310
    void startLowBattAlarm();
    void stopLowBattAlarm();

311 312
    //void requestWaypoints();  FIXME tbd
    //void clearWaypointList();   FIXME tbd
313

pixhawk's avatar
pixhawk committed
314 315 316 317 318 319 320 321 322 323
    /** @brief Enable the motors */
    void enable_motors();
    /** @brief Disable the motors */
    void disable_motors();

    /** @brief Set the values for the manual control of the vehicle */
    void setManualControlCommands(double roll, double pitch, double yaw, double thrust);
    /** @brief Receive a button pressed event from an input device, e.g. joystick */
    void receiveButton(int buttonIndex);

pixhawk's avatar
pixhawk committed
324
    /** @brief Add a link associated with this robot */
pixhawk's avatar
pixhawk committed
325
    void addLink(LinkInterface* link);
326 327
    /** @brief Remove a link associated with this robot */
    void removeLink(QObject* object);
pixhawk's avatar
pixhawk committed
328 329

    /** @brief Receive a message from one of the communication links. */
330
    virtual void receiveMessage(LinkInterface* link, mavlink_message_t message);
pixhawk's avatar
pixhawk committed
331 332 333 334 335 336

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

337 338 339
    /** @brief Temporary Hack for sending packets to patch Antenna. Send a message over all serial links except for this UAS's */
    void forwardMessage(mavlink_message_t message);

pixhawk's avatar
pixhawk committed
340 341 342 343
    /** @brief Set this UAS as the system currently in focus, e.g. in the main display widgets */
    void setSelected();

    /** @brief Set current mode of operation, e.g. auto or manual */
pixhawk's avatar
pixhawk committed
344
    void setMode(int mode);
pixhawk's avatar
pixhawk committed
345

346 347 348
    /** @brief Request all parameters */
    void requestParameters();

349 350 351
    /** @brief Request a single parameter by index */
    void requestParameter(int component, int parameter);

352
    /** @brief Set a system parameter */
lm's avatar
lm committed
353
    void setParameter(const int component, const QString& id, const float value);
354 355

    /** @brief Write parameters to permanent storage */
356 357 358
    void writeParametersToStorage();
    /** @brief Read parameters from permanent storage */
    void readParametersFromStorage();
359

360 361 362 363 364 365
    /** @brief Get the names of all parameters */
    QList<QString> getParameterNames(int component);

    /** @brief Get the ids of all components */
    QList<int> getComponentIds();

366 367 368 369 370
    void enableAllDataTransmission(int rate);
    void enableRawSensorDataTransmission(int rate);
    void enableExtendedSystemStatusTransmission(int rate);
    void enableRCChannelDataTransmission(int rate);
    void enableRawControllerDataTransmission(int rate);
lm's avatar
lm committed
371
    //void enableRawSensorFusionTransmission(int rate);
372 373 374 375
    void enablePositionTransmission(int rate);
    void enableExtra1Transmission(int rate);
    void enableExtra2Transmission(int rate);
    void enableExtra3Transmission(int rate);
lm's avatar
lm committed
376

377 378 379
    /** @brief Update the system state */
    void updateState();

380 381
    /** @brief Set world frame origin at current GPS position */
    void setLocalOriginAtCurrentGPSPosition();
382 383
    /** @brief Set world frame origin / home position at this GPS position */
    void setHomePosition(double lat, double lon, double alt);
pixhawk's avatar
pixhawk committed
384 385
    /** @brief Set local position setpoint */
    void setLocalPositionSetpoint(float x, float y, float z, float yaw);
pixhawk's avatar
pixhawk committed
386 387 388 389 390 391 392
    /** @brief Add an offset in body frame to the setpoint */
    void setLocalPositionOffset(float x, float y, float z, float yaw);

    void startRadioControlCalibration();
    void startMagnetometerCalibration();
    void startGyroscopeCalibration();
    void startPressureCalibration();
pixhawk's avatar
pixhawk committed
393

lm's avatar
lm committed
394 395 396 397
    void startDataRecording();
    void pauseDataRecording();
    void stopDataRecording();

pixhawk's avatar
pixhawk committed
398 399 400 401 402 403 404 405 406 407 408 409 410
signals:

    /** @brief The main/battery voltage has changed/was updated */
    void voltageChanged(int uasId, double voltage);
    /** @brief An actuator value has changed */
    void actuatorChanged(UASInterface*, int actId, double value);
    /** @brief An actuator value has changed */
    void actuatorChanged(UASInterface* uas, QString actuatorName, double min, double max, double value);
    void motorChanged(UASInterface* uas, QString motorName, double min, double max, double value);
    /** @brief The system load (MCU/CPU usage) changed */
    void loadChanged(UASInterface* uas, double load);
    /** @brief Propagate a heartbeat received from the system */
    void heartbeat(UASInterface* uas);
411
    void imageStarted(quint64 timestamp);
412 413
    /** @brief A new camera image has arrived */
    void imageReady(UASInterface* uas);
414

415
protected:
416 417
    /** @brief Get the UNIX timestamp in milliseconds */
    quint64 getUnixTime(quint64 time=0);
LM's avatar
LM committed
418 419
    /** @brief Get the UNIX timestamp in milliseconds, ignore attitudeStamped mode */
    quint64 getUnixReferenceTime(quint64 time);
420 421

protected slots:
422 423 424 425
    /** @brief Write settings to disk */
    void writeSettings();
    /** @brief Read settings from disk */
    void readSettings();
426 427 428 429

    // MESSAGE RECEPTION
    /** @brief Receive a named value message */
    void receiveMessageNamedValue(const mavlink_message_t& message);
430 431

private:
432
//    unsigned int mode;          ///< The current mode of the MAV
pixhawk's avatar
pixhawk committed
433 434 435 436
};


#endif // _UAS_H_