UAS.h 12.7 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 48 49 50

/**
 * @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.
 */
class UAS : public UASInterface {
    Q_OBJECT
public:
51
    UAS(MAVLinkProtocol* protocol, int id = 0);
pixhawk's avatar
pixhawk committed
52 53
    ~UAS();

54 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;
pixhawk's avatar
pixhawk committed
71
    /** @brief Get the unique system id */
72
    int getUASID() const;
pixhawk's avatar
pixhawk committed
73
    /** @brief The time interval the robot is switched on */
74
    quint64 getUptime() const;
pixhawk's avatar
pixhawk committed
75
    /** @brief Get the status flag for the communication */
76
    int getCommunicationStatus() const;
pixhawk's avatar
pixhawk committed
77
    /** @brief Add one measurement and get low-passed voltage */
78
    float filterVoltage(float value) const;
pixhawk's avatar
pixhawk committed
79 80 81
    /** @brief Get the links associated with this robot */
    QList<LinkInterface*>* getLinks();

82 83 84 85 86 87
    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; }
lm's avatar
lm committed
88

89 90 91
    double getRoll() const { return roll; }
    double getPitch() const { return pitch; }
    double getYaw() const { return yaw; }
lm's avatar
lm committed
92 93


pixhawk's avatar
pixhawk committed
94
friend class UASWaypointManager;
INIDETAM's avatar
INIDETAM committed
95
protected: //COMMENTS FOR TEST UNIT
96
    int uasId;                    ///< Unique system ID
97
    unsigned char type;           ///< UAS type (from type enum)
pixhawk's avatar
pixhawk committed
98 99 100
    quint64 startTime;            ///< The time the UAS was switched on
    CommStatus commStatus;        ///< Communication status
    QString name;                 ///< Human-friendly name of the vehicle, e.g. bravo
101
    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
102
    QList<LinkInterface*>* links; ///< List of links this UAS can be reached by
103
    QList<int> unknownPackets;    ///< Packet IDs which are unknown and have been received
104
    MAVLinkProtocol* mavlink;     ///< Reference to the MAVLink instance
pixhawk's avatar
pixhawk committed
105 106
    BatteryType batteryType;      ///< The battery type
    int cells;                    ///< Number of cells
pixhawk's avatar
pixhawk committed
107

108 109
    UASWaypointManager waypointManager;

pixhawk's avatar
pixhawk committed
110 111 112 113 114 115
    QList<double> actuatorValues;
    QList<QString> actuatorNames;

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

pixhawk's avatar
pixhawk committed
116 117
    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
118 119

    // Battery stats
pixhawk's avatar
pixhawk committed
120 121 122 123 124 125
    double fullVoltage;         ///< Voltage of the fully charged battery (100%)
    double emptyVoltage;        ///< Voltage of the empty battery (0%)
    double startVoltage;        ///< Voltage at system start
    double currentVoltage;      ///< Voltage currently measured
    float lpVoltage;            ///< Low-pass filtered voltage
    int timeRemaining;          ///< Remaining time calculated based on previous and current
lm's avatar
lm committed
126
    unsigned int mode;          ///< The current mode of the MAV
pixhawk's avatar
pixhawk committed
127
    int status;                 ///< The current status of the MAV
pixhawk's avatar
pixhawk committed
128 129
    quint64 onboardTimeOffset;

pixhawk's avatar
pixhawk committed
130 131 132 133 134 135 136 137 138
    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
139 140
    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
141
    bool lowBattAlarm;          ///< Switch if battery is low
142
    bool positionLock;          ///< Status if position information is available or not
lm's avatar
lm committed
143 144 145
    double localX;
    double localY;
    double localZ;
146 147 148
    double latitude;
    double longitude;
    double altitude;
149 150 151
    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
152 153 154
    double roll;
    double pitch;
    double yaw;
155
    quint64 lastHeartbeat;      ///< Time of the last heartbeat message
156
    QTimer* statusTimeout;      ///< Timer for various status timeouts
157 158
    QMap<int, QMap<QString, float>* > parameters; ///< All parameters
    bool paramsOnceRequested;   ///< If the parameter list has been read at least once
159
public:
pixhawk's avatar
pixhawk committed
160 161 162 163 164 165 166 167 168 169 170
    /** @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 */
    double getChargeLevel();
    /** @brief Get the human-readable status message for this code */
    void getStatusForCode(int statusCode, QString& uasState, QString& stateDescription);
    /** @brief Check if vehicle is in autonomous mode */
    bool isAuto();

171 172
public:
    UASWaypointManager &getWaypointManager(void) { return waypointManager; }
173
    int getSystemType();
174
    int getAutopilotType() {return autopilot;}
175

pixhawk's avatar
pixhawk committed
176
public slots:
177 178 179 180
    /** @brief Set the autopilot type */
    void setAutopilotType(int apType) { autopilot = apType; }
    /** @brief Set the type of airframe */
    void setSystemType(int systemType) { type = systemType; }
181 182 183
    /** @brief Set a new name **/
    void setUASName(const QString& name);
    /** @brief Executes an action **/
184 185
    void setAction(MAV_ACTION action);

pixhawk's avatar
pixhawk committed
186 187
    /** @brief Launches the system **/
    void launch();
lm's avatar
lm committed
188
    /** @brief Write this waypoint to the list of waypoints */
189
    //void setWaypoint(Waypoint* wp); FIXME tbd
lm's avatar
lm committed
190
    /** @brief Set currently active waypoint */
191
    //void setWaypointActive(int id); FIXME tbd
pixhawk's avatar
pixhawk committed
192 193 194 195 196 197 198 199 200 201 202 203 204
    /** @brief Order the robot to return home / to land on the runway **/
    void home();
    void halt();
    void go();
    /** @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();

205 206 207
    /** @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
208 209 210
    void startLowBattAlarm();
    void stopLowBattAlarm();

211 212
    //void requestWaypoints();  FIXME tbd
    //void clearWaypointList();   FIXME tbd
213

pixhawk's avatar
pixhawk committed
214 215 216 217 218 219 220 221 222 223
    /** @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
224
    /** @brief Add a link associated with this robot */
pixhawk's avatar
pixhawk committed
225 226 227
    void addLink(LinkInterface* link);

    /** @brief Receive a message from one of the communication links. */
228
    virtual void receiveMessage(LinkInterface* link, mavlink_message_t message);
pixhawk's avatar
pixhawk committed
229 230 231 232 233 234

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

235 236 237
    /** @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
238 239 240 241
    /** @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
242
    void setMode(int mode);
pixhawk's avatar
pixhawk committed
243

244 245 246
    /** @brief Request all parameters */
    void requestParameters();

247
    /** @brief Set a system parameter */
lm's avatar
lm committed
248
    void setParameter(const int component, const QString& id, const float value);
249 250

    /** @brief Write parameters to permanent storage */
251 252 253
    void writeParametersToStorage();
    /** @brief Read parameters from permanent storage */
    void readParametersFromStorage();
254

255 256 257 258 259 260
    /** @brief Get the names of all parameters */
    QList<QString> getParameterNames(int component);

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

261 262 263 264 265 266 267 268 269 270
    void enableAllDataTransmission(int rate);
    void enableRawSensorDataTransmission(int rate);
    void enableExtendedSystemStatusTransmission(int rate);
    void enableRCChannelDataTransmission(int rate);
    void enableRawControllerDataTransmission(int rate);
    void enableRawSensorFusionTransmission(int rate);
    void enablePositionTransmission(int rate);
    void enableExtra1Transmission(int rate);
    void enableExtra2Transmission(int rate);
    void enableExtra3Transmission(int rate);
lm's avatar
lm committed
271

272 273 274
    /** @brief Update the system state */
    void updateState();

275 276
    /** @brief Set world frame origin at current GPS position */
    void setLocalOriginAtCurrentGPSPosition();
pixhawk's avatar
pixhawk committed
277 278
    /** @brief Set local position setpoint */
    void setLocalPositionSetpoint(float x, float y, float z, float yaw);
pixhawk's avatar
pixhawk committed
279 280 281 282 283 284 285
    /** @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
286

lm's avatar
lm committed
287 288 289 290
    void startDataRecording();
    void pauseDataRecording();
    void stopDataRecording();

pixhawk's avatar
pixhawk committed
291 292 293 294 295 296 297 298 299 300 301 302 303
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);
304 305 306 307

    protected:
    /** @brief Get the UNIX timestamp in microseconds */
    quint64 getUnixTime(quint64 time);
308 309 310 311
    /** @brief Write settings to disk */
    void writeSettings();
    /** @brief Read settings from disk */
    void readSettings();
312 313 314 315

    // MESSAGE RECEPTION
    /** @brief Receive a named value message */
    void receiveMessageNamedValue(const mavlink_message_t& message);
pixhawk's avatar
pixhawk committed
316 317 318 319
};


#endif // _UAS_H_