QGCSerialPortInfo.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QRegularExpression>
#include <QtCore/QtSystemDetection>
#ifdef Q_OS_ANDROID
    #include "qserialportinfo.h"
#else
    #include <QtSerialPort/QSerialPortInfo>
#endif
 
class QGCSerialPortInfoTest;
 
 
class QGCSerialPortInfo : public QSerialPortInfo
{
    friend class QGCSerialPortInfoTest;
    friend class JsonResourceAuditTest;
public:
    QGCSerialPortInfo();
    explicit QGCSerialPortInfo(const QSerialPort &port);
    ~QGCSerialPortInfo();
 
    enum BoardType_t {
        BoardTypePixhawk = 0,
        BoardTypeSiKRadio,
        BoardTypeOpenPilot,
        BoardTypeRTKGPS,
        BoardTypeUnknown
    };
 
    bool getBoardInfo(BoardType_t &boardType, QString &name) const;
 
    bool canFlash() const;
 
    bool isBootloader() const;
 
    bool isBlackCube() const;
 
    static bool isSystemPort(const QSerialPortInfo &port);
 
    static QList<QGCSerialPortInfo> availablePorts();
 
private:
    struct BoardClassString2BoardType_t {
        const QString classString;
        const BoardType_t boardType = BoardTypeUnknown;
    };
 
    static bool _loadJsonData();
    static BoardType_t _boardClassStringToType(const QString &boardClass);
    static QString _boardTypeToString(BoardType_t boardType);
 
    static bool _jsonLoaded;
    static bool _jsonDataValid;
 
    struct BoardInfo_t {
        int vendorId;
        int productId;
        BoardType_t boardType;
        QString name;
    };
    static QList<BoardInfo_t> _boardInfoList;
 
    struct BoardRegExpFallback_t {
        QRegularExpression regExp;
        BoardType_t boardType;
        bool androidOnly;
    };
    static QList<BoardRegExpFallback_t> _boardDescriptionFallbackList;
    static QList<BoardRegExpFallback_t> _boardManufacturerFallbackList;
 
    static constexpr const char *_jsonFileTypeValue = "USBBoardInfo";
    static constexpr const char *_jsonBoardInfoKey = "boardInfo";
    static constexpr const char *_jsonBoardDescriptionFallbackKey = "boardDescriptionFallback";
    static constexpr const char *_jsonBoardManufacturerFallbackKey = "boardManufacturerFallback";
    static constexpr const char *_jsonVendorIDKey = "vendorID";
    static constexpr const char *_jsonProductIDKey = "productID";
    static constexpr const char *_jsonBoardClassKey = "boardClass";
    static constexpr const char *_jsonNameKey = "name";
    static constexpr const char *_jsonRegExpKey = "regExp";
    static constexpr const char *_jsonAndroidOnlyKey = "androidOnly";
};
Q_DECLARE_METATYPE(QGCSerialPortInfo)