APMFirmwarePlugin.h 3.85 KB
Newer Older
Don Gagne's avatar
Don Gagne committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/*=====================================================================
 
 QGroundControl Open Source Ground Control Station
 
 (c) 2009 - 2014 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 
 This file is part of the QGROUNDCONTROL project
 
 QGROUNDCONTROL is free software: you can redistribute it and/or modify
 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.
 
 QGROUNDCONTROL is distributed in the hope that it will be useful,
 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
 along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
 
 ======================================================================*/

/// @file
///     @author Don Gagne <don@thegagnes.com>

#ifndef APMFirmwarePlugin_H
#define APMFirmwarePlugin_H

#include "FirmwarePlugin.h"
31
#include "QGCLoggingCategory.h"
32
#include "APMParameterMetaData.h"
Don Gagne's avatar
Don Gagne committed
33

34
Q_DECLARE_LOGGING_CATEGORY(APMFirmwarePluginLog)
Pritam Ghanghas's avatar
Pritam Ghanghas committed
35

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
class APMFirmwareVersion
{
public:
    APMFirmwareVersion(const QString &versionText = "");
    bool isValid() const;
    bool isBeta() const;
    bool isDev() const;
    bool operator<(const APMFirmwareVersion& other) const;
    QString versionString() const { return _versionString; }
    QString vehicleType() const { return _vehicleType; }
    int majorNumber() const { return _major; }
    int minorNumber() const { return _minor; }
    int patchNumber() const { return _patch; }

private:
    void _parseVersion(const QString &versionText);
    QString _versionString;
    QString _vehicleType;
    int     _major;
    int     _minor;
    int     _patch;
};

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
class APMCustomMode
{
public:
    APMCustomMode(uint32_t mode, bool settable);
    uint32_t modeAsInt() const { return _mode; }
    bool canBeSet() const { return _settable; }
    QString modeString() const;

protected:
    void setEnumToStringMapping(const QMap<uint32_t,QString>& enumToString);

private:
    uint32_t               _mode;
    bool                   _settable;
    QMap<uint32_t,QString> _enumToString;
};

76
/// This is the base class for all stack specific APM firmware plugins
Don Gagne's avatar
Don Gagne committed
77 78 79 80 81 82 83 84 85 86 87 88 89
class APMFirmwarePlugin : public FirmwarePlugin
{
    Q_OBJECT
    
public:
    // Overrides from FirmwarePlugin
    virtual bool isCapable(FirmwareCapabilities capabilities);
    virtual QList<VehicleComponent*> componentsForVehicle(AutoPilotPlugin* vehicle);
    virtual QStringList flightModes(void);
    virtual QString flightMode(uint8_t base_mode, uint32_t custom_mode);
    virtual bool setFlightMode(const QString& flightMode, uint8_t* base_mode, uint32_t* custom_mode);
    virtual int manualControlReservedButtonCount(void);
    virtual void adjustMavlinkMessage(mavlink_message_t* message);
90
    virtual void initializeVehicle(Vehicle* vehicle);
91
    virtual bool sendHomePositionToVehicle(void);
92
    virtual void addMetaDataToFact(Fact* fact, MAV_TYPE vehicleType);
93
    virtual QString getDefaultComponentIdParam(void) const { return QString("SYSID_SW_TYPE"); }
Don Gagne's avatar
Don Gagne committed
94
    virtual QList<MAV_CMD> supportedMissionCommands(void);
95

96 97
protected:
    /// All access to singleton is through stack specific implementation
98
    APMFirmwarePlugin(void);
99
    void setSupportedModes(QList<APMCustomMode> supportedModes);
100 101
    
private:
102
    void _adjustSeverity(mavlink_message_t* message) const;
Don Gagne's avatar
Don Gagne committed
103
    void _adjustCalibrationMessageSeverity(mavlink_message_t* message) const;
Pritam Ghanghas's avatar
Pritam Ghanghas committed
104
    static bool _isTextSeverityAdjustmentNeeded(const APMFirmwareVersion& firmwareVersion);
105

106 107 108
    APMFirmwareVersion      _firmwareVersion;
    bool                    _textSeverityAdjustmentNeeded;
    QList<APMCustomMode>    _supportedModes;
109
    APMParameterMetaData    _parameterMetaData;
Don Gagne's avatar
Don Gagne committed
110 111 112
};

#endif