iboardtype.h

Go to the documentation of this file.

/*
 * This program 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.
 *
 * This program 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 this program; if not, see <http://www.gnu.org/licenses/>
 *
 * Additional note on redistribution: The copyright and license notices above
 * must be maintained in each individual source file that is a derivative work
 * of this source file; otherwise redistribution is prohibited.
 */
#ifndef IBOARDTYPE_H
#define IBOARDTYPE_H

#include <QObject>
#include <QtCore/QStringList>
#include <QPixmap>

#include "core_global.h"

namespace Core {

class CORE_EXPORT IBoardType : public QObject
{
    Q_OBJECT

public:
    struct USBInfo
    {
        QString serialNumber;
        QString manufacturer;
        QString product;
        int usagePage = 0;
        int usage = 0;
        int vendorID = 0;
        int productID = 0;
        int bcdDevice = 0;

        USBInfo(int vendorID, int productID, int bcdDevice)
        {
            this->vendorID = vendorID;
            this->productID = productID;
            this->bcdDevice = bcdDevice;
        }
    };

    virtual QString shortName() = 0;

    virtual QString boardDescription() = 0;

    enum BoardCapabilities {
        BOARD_CAPABILITIES_GYROS,
        BOARD_CAPABILITIES_ACCELS,
        BOARD_CAPABILITIES_MAGS,
        BOARD_CAPABILITIES_BAROS,
        BOARD_CAPABILITIES_RADIO,
        BOARD_CAPABILITIES_OSD,
        BOARD_CAPABILITIES_UPGRADEABLE,
    };

    virtual bool queryCapabilities(BoardCapabilities capability) = 0;

    virtual QStringList queryChannelBanks();

    virtual QVector<QVector<int>> getChannelBanks() { return channelBanks; }

    virtual QPixmap getBoardPicture() = 0;

    virtual QString getHwUAVO() = 0;

    QList<int> getVendorIDs();

    int getBoardType() { return boardType; }

    virtual QWidget *getBoardConfiguration(QWidget * /*parent*/ = nullptr, bool /*connected*/ = true)
    {
        return NULL;
    }

    /***** methods related to configuring specific boards *****/

    enum InputType {
        INPUT_TYPE_DISABLED,
        INPUT_TYPE_PWM,
        INPUT_TYPE_PPM,
        INPUT_TYPE_DSM,
        INPUT_TYPE_SBUS,
        INPUT_TYPE_SBUSNONINVERTED,
        INPUT_TYPE_HOTTSUMD,
        INPUT_TYPE_HOTTSUMH,
        INPUT_TYPE_IBUS,
        INPUT_TYPE_SRXL,
        INPUT_TYPE_TBSCROSSFIRE,
        INPUT_TYPE_UNKNOWN,
        INPUT_TYPE_ANY
    };

    enum AnnunciatorType {
        ANNUNCIATOR_HEARTBEAT = 1 << 0,
        ANNUNCIATOR_ALARM     = 1 << 1,
        ANNUNCIATOR_BUZZER    = 1 << 2,
        ANNUNCIATOR_RGB       = 1 << 3,
        ANNUNCIATOR_DAC       = 1 << 4,
    };

    virtual int minBootLoaderVersion() { return 0; }

    virtual bool isInputConfigurationSupported(InputType type = INPUT_TYPE_ANY)
    {
        Q_UNUSED(type);
        return false;
    }

    virtual bool setInputType(InputType /*type*/) { return false; }

    virtual InputType getInputType() { return INPUT_TYPE_UNKNOWN; }

    virtual QString getConnectionDiagram() { return ""; }

    virtual int queryMaxGyroRate() { return -1; }

    enum LinkMode { LINK_TELEM, LINK_TELEM_PPM, LINK_PPM };

    virtual bool isUSBSupported() { return true; }

    static QString getBoardNameFromID(int id);

    virtual QStringList getAdcNames() { return QStringList(); }

    int getBankFromOutputChannel(int channel);

    QList<USBInfo> firmwareUSBInfo() { return m_firmwareUSBInfo; }

    QList<USBInfo> bootloaderUSBInfo() { return m_bootloaderUSBInfo; }

    virtual bool hasAnnunciator(AnnunciatorType annunc) { Q_UNUSED(annunc) return false; }

    virtual int onBoardRgbLeds() const { return 0; }

signals:

protected:
    enum BcdDevice {
        BCD_DEVICE_BOOTLOADER = 1,
        BCD_DEVICE_FIRMWARE = 2,
        BCD_DEVICE_UPGRADER = 3,
    };

    void addFirmwareUSBInfo(USBInfo info) { m_firmwareUSBInfo.append(info); }
    void addBootloaderUSBInfo(USBInfo info) { m_bootloaderUSBInfo.append(info); }

    QList<USBInfo> m_firmwareUSBInfo;
    QList<USBInfo> m_bootloaderUSBInfo;

    qint32 boardType;

    QVector<QVector<qint32>> channelBanks;
};

} // namespace Core

#endif // IBOARDTYPE_H