MavCommandQueue.h

Go to the documentation of this file.

#pragma once
 
#include <functional>
#include <optional>
 
#include <QtCore/QElapsedTimer>
#include <QtCore/QList>
#include <QtCore/QObject>
#include <QtCore/QTimer>
 
#include "VehicleTypes.h"
 
class Vehicle;
 
class MavCommandQueue : public QObject, public VehicleTypes
{
    Q_OBJECT
 
public:
    explicit MavCommandQueue(Vehicle* vehicle);
    ~MavCommandQueue();
 
    // Public send API — mirrors Vehicle's historical sendMavCommand* surface.
    void sendCommand           (int compId, MAV_CMD command, bool showError, float param1 = 0.0f, float param2 = 0.0f, float param3 = 0.0f, float param4 = 0.0f, float param5 = 0.0f, float param6 = 0.0f, float param7 = 0.0f);
    void sendCommandDelayed    (int compId, MAV_CMD command, bool showError, int milliseconds, float param1 = 0.0f, float param2 = 0.0f, float param3 = 0.0f, float param4 = 0.0f, float param5 = 0.0f, float param6 = 0.0f, float param7 = 0.0f);
    void sendCommandInt        (int compId, MAV_CMD command, MAV_FRAME frame, bool showError, float param1, float param2, float param3, float param4, double param5, double param6, float param7);
 
    void sendCommandWithHandler    (const MavCmdAckHandlerInfo_t* ackHandlerInfo, int compId, MAV_CMD command, float param1 = 0.0f, float param2 = 0.0f, float param3 = 0.0f, float param4 = 0.0f, float param5 = 0.0f, float param6 = 0.0f, float param7 = 0.0f);
    void sendCommandIntWithHandler (const MavCmdAckHandlerInfo_t* ackHandlerInfo, int compId, MAV_CMD command, MAV_FRAME frame, float param1 = 0.0f, float param2 = 0.0f, float param3 = 0.0f, float param4 = 0.0f, double param5 = 0.0, double param6 = 0.0, float param7 = 0.0f);
 
    void sendCommandWithLambdaFallback(std::function<void()> lambda, int compId, MAV_CMD command, bool showError, float param1 = 0.0f, float param2 = 0.0f, float param3 = 0.0f, float param4 = 0.0f, float param5 = 0.0f, float param6 = 0.0f, float param7 = 0.0f);
    void sendCommandIntWithLambdaFallback(std::function<void()> lambda, int compId, MAV_CMD command, MAV_FRAME frame, bool showError, float param1 = 0.0f, float param2 = 0.0f, float param3 = 0.0f, float param4 = 0.0f, double param5 = 0.0, double param6 = 0.0, float param7 = 0.0f);
 
    void sendWorker(bool commandInt, bool showError, const MavCmdAckHandlerInfo_t* ackHandlerInfo,
                    int compId, MAV_CMD command, MAV_FRAME frame,
                    float param1, float param2, float param3, float param4, double param5, double param6, float param7);
 
    bool isPending(int targetCompId, MAV_CMD command) const;
 
    int findEntryIndex(int targetCompId, MAV_CMD command) const;
 
    void handleCommandAck(const mavlink_message_t& message, const mavlink_command_ack_t& ack);
 
    void stop();
 
    static QString failureCodeToString(MavCmdResultFailureCode_t failureCode);
    static void showCommandAckError(const mavlink_command_ack_t& ack);
 
    static constexpr int kMaxRetryCount = 3;
 
    static void setTestAckTimeoutOverride(std::optional<int> msecs);
    static std::optional<int> testAckTimeoutOverride();
 
signals:
    void commandResult(int vehicleId, int targetComponent, int command, int ackResult, int failureCode);
 
private slots:
    void _responseTimeoutCheck();
 
private:
    typedef struct MavCommandListEntry {
        int                     targetCompId        = 0;
        bool                    useCommandInt       = false;
        MAV_CMD                 command;
        MAV_FRAME               frame;
        float                   rgParam1            = 0;
        float                   rgParam2            = 0;
        float                   rgParam3            = 0;
        float                   rgParam4            = 0;
        double                  rgParam5            = 0;
        double                  rgParam6            = 0;
        float                   rgParam7            = 0;
        bool                    showError           = true;
        MavCmdAckHandlerInfo_t  ackHandlerInfo;
        int                     maxTries            = kMaxRetryCount;
        int                     tryCount            = 0;
        QElapsedTimer           elapsedTimer;
        int                     ackTimeoutMSecs     = 0;
    } MavCommandListEntry_t;
 
    void sendCommandWithLambdaFallbackWorker(std::function<void()> lambda, bool commandInt, int compId, MAV_CMD command, MAV_FRAME frame, bool showError, float param1, float param2, float param3, float param4, double param5, double param6, float param7);
 
    void _sendFromList(int index);
    static bool _shouldRetry(MAV_CMD command);
    static bool _canBeDuplicated(MAV_CMD command);
    static int _responseCheckIntervalMSecs();
    static int _ackTimeoutMSecs();
    static QString _formatCommand(MAV_CMD command, float param1);
 
    Vehicle*                         _vehicle = nullptr;
    QList<MavCommandListEntry_t>     _list;
    QTimer                           _responseCheckTimer;
    bool                             _stopped = false;  // set by stop(), gates all send paths
 
    static constexpr int _ackTimeoutMSecsDefault     = 1200;
    static constexpr int _ackTimeoutMSecsHighLatency = 120000;
    static std::optional<int>        _testAckTimeoutOverride;
};