MissionManager.h 5.29 KB
Newer Older
1 2 3 4 5 6 7 8 9
/****************************************************************************
 *
 *   (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.
 *
 ****************************************************************************/

Don Gagne's avatar
Don Gagne committed
10 11 12 13 14 15 16 17 18 19

#ifndef MissionManager_H
#define MissionManager_H

#include <QObject>
#include <QLoggingCategory>
#include <QThread>
#include <QMutex>
#include <QTimer>

20
#include "MissionItem.h"
Don Gagne's avatar
Don Gagne committed
21 22
#include "QGCMAVLink.h"
#include "QGCLoggingCategory.h"
23
#include "LinkInterface.h"
Don Gagne's avatar
Don Gagne committed
24 25 26 27 28

class Vehicle;

Q_DECLARE_LOGGING_CATEGORY(MissionManagerLog)

29
class MissionManager : public QObject
Don Gagne's avatar
Don Gagne committed
30 31 32 33 34 35 36
{
    Q_OBJECT
    
public:
    MissionManager(Vehicle* vehicle);
    ~MissionManager();
    
37
    bool inProgress(void);
38
    const QList<MissionItem*>& missionItems(void) { return _missionItems; }
39 40 41 42 43 44

    /// Current mission item as reported by MISSION_CURRENT
    int currentItem(void) const { return _currentMissionItem; }

    /// Last current mission item reported while in Mission flight mode
    int lastCurrentItem(void) const { return _lastCurrentItem; }
Don Gagne's avatar
Don Gagne committed
45
    
Don Gagne's avatar
Don Gagne committed
46 47 48
    void requestMissionItems(void);
    
    /// Writes the specified set of mission items to the vehicle
49 50
    ///     @param missionItems Items to send to vehicle
    void writeMissionItems(const QList<MissionItem*>& missionItems);
51
    
Don Gagne's avatar
Don Gagne committed
52 53 54 55 56
    /// Writes the specified set mission items to the vehicle as an ArduPilot guided mode mission item.
    ///     @param gotoCoord Coordinate to move to
    ///     @param altChangeOnly true: only altitude change, false: lat/lon/alt change
    void writeArduPilotGuidedMissionItem(const QGeoCoordinate& gotoCoord, bool altChangeOnly);

57 58 59
    /// Removes all mission items from vehicle
    void removeAll(void);

60 61 62 63
    /// Generates a new mission which starts from the specified index. It will include all the CMD_DO items
    /// from mission start to resumeIndex in the generate mission.
    void generateResumeMission(int resumeIndex);

64 65 66 67 68 69 70 71 72
    /// Error codes returned in error signal
    typedef enum {
        InternalError,
        AckTimeoutError,        ///< Timed out waiting for response from vehicle
        ProtocolOrderError,     ///< Incorrect protocol sequence from vehicle
        RequestRangeError,      ///< Vehicle requested item out of range
        ItemMismatchError,      ///< Vehicle returned item with seq # different than requested
        VehicleError,           ///< Vehicle returned error
        MissingRequestsError,   ///< Vehicle did not request all items during write sequence
73
        MaxRetryExceeded,       ///< Retry failed
74
    } ErrorCode_t;
Don Gagne's avatar
Don Gagne committed
75

Don Gagne's avatar
Don Gagne committed
76
    // These values are public so the unit test can set appropriate signal wait times
77
    static const int _ackTimeoutMilliseconds = 1000;
Don Gagne's avatar
Don Gagne committed
78 79
    static const int _maxRetryCount = 5;
    
Don Gagne's avatar
Don Gagne committed
80
signals:
81
    void newMissionItemsAvailable(bool removeAllRequested);
Don Gagne's avatar
Don Gagne committed
82
    void inProgressChanged(bool inProgress);
83
    void error(int errorCode, const QString& errorMsg);
84
    void currentItemChanged(int currentItem);
85 86 87
    void lastCurrentItemChanged(int lastCurrentMissionItem);
    void resumeMissionReady(void);

Don Gagne's avatar
Don Gagne committed
88 89 90 91 92 93 94 95 96 97
private slots:
    void _mavlinkMessageReceived(const mavlink_message_t& message);
    void _ackTimeout(void);
    
private:
    typedef enum {
        AckNone,            ///< State machine is idle
        AckMissionCount,    ///< MISSION_COUNT message expected
        AckMissionItem,     ///< MISSION_ITEM expected
        AckMissionRequest,  ///< MISSION_REQUEST is expected, or MISSION_ACK to end sequence
Ricardo de Almeida Gonzaga's avatar
Ricardo de Almeida Gonzaga committed
98
        AckGuidedItem,      ///< MISSION_ACK expected in response to ArduPilot guided mode single item send
Don Gagne's avatar
Don Gagne committed
99 100
    } AckType_t;
    
101
    void _startAckTimeout(AckType_t ack);
102
    bool _checkForExpectedAck(AckType_t receivedAck);
103
    void _readTransactionComplete(void);
Don Gagne's avatar
Don Gagne committed
104
    void _handleMissionCount(const mavlink_message_t& message);
105 106
    void _handleMissionItem(const mavlink_message_t& message, bool missionItemInt);
    void _handleMissionRequest(const mavlink_message_t& message, bool missionItemInt);
Don Gagne's avatar
Don Gagne committed
107
    void _handleMissionAck(const mavlink_message_t& message);
108
    void _handleMissionCurrent(const mavlink_message_t& message);
109
    void _requestNextMissionItem(void);
Don Gagne's avatar
Don Gagne committed
110
    void _clearMissionItems(void);
111
    void _sendError(ErrorCode_t errorCode, const QString& errorMsg);
Don Gagne's avatar
Don Gagne committed
112
    QString _ackTypeToString(AckType_t ackType);
Don Gagne's avatar
Don Gagne committed
113
    QString _missionResultToString(MAV_MISSION_RESULT result);
114
    void _finishTransaction(bool success);
115 116
    void _requestList(void);
    void _writeMissionCount(void);
117 118
    void _writeMissionItemsWorker(void);
    void _clearAndDeleteMissionItems(void);
Don Gagne's avatar
Don Gagne committed
119 120 121

private:
    Vehicle*            _vehicle;
122
    LinkInterface*      _dedicatedLink;
Don Gagne's avatar
Don Gagne committed
123 124
    
    QTimer*             _ackTimeoutTimer;
125 126
    AckType_t           _expectedAck;
    int                 _retryCount;
Don Gagne's avatar
Don Gagne committed
127
    
128 129
    bool        _readTransactionInProgress;
    bool        _writeTransactionInProgress;
130
    bool        _resumeMission;
131 132
    QList<int>  _itemIndicesToWrite;    ///< List of mission items which still need to be written to vehicle
    QList<int>  _itemIndicesToRead;     ///< List of mission items which still need to be requested from vehicle
Don Gagne's avatar
Don Gagne committed
133 134 135
    
    QMutex _dataMutex;
    
136
    QList<MissionItem*> _missionItems;
137
    int                 _currentMissionItem;
138
    int                 _lastCurrentItem;
Don Gagne's avatar
Don Gagne committed
139 140
};

141
#endif