ground/gcs/src/plugins/setupwizard/vehicleconfigurationsource.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       vehicleconfigurationsource.h
   5  * @author     The LibrePilot Project, http://www.librepilot.org Copyright (C) 2015-2016.
   6  *             The OpenPilot Team, http://www.openpilot.org Copyright (C) 2012.
   7  * @addtogroup
   8  * @{
   9  * @addtogroup VehicleConfigurationSource
  10  * @{
  11  * @brief
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #ifndef VEHICLECONFIGURATIONSOURCE_H
  30 #define VEHICLECONFIGURATIONSOURCE_H
  31
  32 #include <QString>
  33 #include <QJsonObject>
  34 #include "actuatorsettings.h"
  35
  36 struct accelGyroBias {
  37     float m_accelerometerXBias;
  38     float m_accelerometerYBias;
  39     float m_accelerometerZBias;
  40
  41     float m_gyroXBias;
  42     float m_gyroYBias;
  43     float m_gyroZBias;
  44 };
  45
  46 struct actuatorChannelSettings {
  47     quint16 channelMin;
  48     quint16 channelNeutral;
  49     quint16 channelMax;
  50     bool    isReversableMotor;
  51
  52     // Default values
  53     actuatorChannelSettings() : channelMin(1000), channelNeutral(1000), channelMax(1900), isReversableMotor(false) {}
  54 };
  55
  56
  57 class VehicleConfigurationSource {
  58 public:
  59     VehicleConfigurationSource();
  60
  61     enum CONTROLLER_TYPE { CONTROLLER_UNKNOWN, CONTROLLER_CC, CONTROLLER_CC3D, CONTROLLER_REVO, CONTROLLER_NANO, CONTROLLER_SPARKY2, CONTROLLER_OPLINK, CONTROLLER_DISCOVERYF4, CONTROLLER_SPRACINGF3, CONTROLLER_SPRACINGF3EVO, CONTROLLER_PIKOBLX, CONTROLLER_TINYFISH };
  62     enum VEHICLE_TYPE { VEHICLE_UNKNOWN, VEHICLE_MULTI, VEHICLE_FIXEDWING, VEHICLE_HELI, VEHICLE_SURFACE };
  63     enum VEHICLE_SUB_TYPE { MULTI_ROTOR_UNKNOWN, MULTI_ROTOR_TRI_Y, MULTI_ROTOR_QUAD_X, MULTI_ROTOR_QUAD_PLUS, MULTI_ROTOR_QUAD_H,
  64                             MULTI_ROTOR_HEXA, MULTI_ROTOR_HEXA_H, MULTI_ROTOR_HEXA_X, MULTI_ROTOR_HEXA_COAX_Y, MULTI_ROTOR_OCTO,
  65                             MULTI_ROTOR_OCTO_X, MULTI_ROTOR_OCTO_V, MULTI_ROTOR_OCTO_COAX_X, MULTI_ROTOR_OCTO_COAX_PLUS,
  66                             FIXED_WING_DUAL_AILERON, FIXED_WING_AILERON, FIXED_WING_ELEVON, FIXED_WING_VTAIL, HELI_CCPM,
  67                             GROUNDVEHICLE_MOTORCYCLE, GROUNDVEHICLE_CAR, GROUNDVEHICLE_DIFFERENTIAL, GROUNDVEHICLE_BOAT, GROUNDVEHICLE_DIFFERENTIAL_BOAT };
  68     enum ESC_TYPE { ESC_DSHOT1200, ESC_DSHOT600, ESC_DSHOT150, ESC_MULTISHOT, ESC_ONESHOT42, ESC_ONESHOT125, ESC_SYNCHED, ESC_RAPID, ESC_STANDARD300, ESC_STANDARD, ESC_UNKNOWN };
  69     enum SERVO_TYPE { SERVO_ANALOG, SERVO_DIGITAL, SERVO_UNKNOWN };
  70     enum INPUT_TYPE { INPUT_PWM, INPUT_PPM, INPUT_SBUS, INPUT_DSM, INPUT_SRXL, INPUT_HOTT_SUMD, INPUT_EXBUS, INPUT_IBUS, INPUT_UNKNOWN };
  71     enum AIRSPEED_TYPE { AIRSPEED_ESTIMATE, AIRSPEED_EAGLETREE, AIRSPEED_MS4525, AIRSPEED_DISABLED };
  72     enum GPS_TYPE { GPS_PLATINUM, GPS_NAZA, GPS_UBX_FLEXI_I2CMAG, GPS_UBX, GPS_NMEA, GPS_DISABLED };
  73     enum RADIO_SETTING { RADIO_TELEMETRY, RADIO_DISABLED };
  74
  75     virtual VehicleConfigurationSource::CONTROLLER_TYPE getControllerType() const  = 0;
  76     virtual VehicleConfigurationSource::VEHICLE_TYPE getVehicleType() const = 0;
  77     virtual VehicleConfigurationSource::VEHICLE_SUB_TYPE getVehicleSubType() const = 0;
  78     virtual VehicleConfigurationSource::INPUT_TYPE getInputType() const = 0;
  79     virtual VehicleConfigurationSource::ESC_TYPE getEscType() const     = 0;
  80     virtual VehicleConfigurationSource::SERVO_TYPE getServoType() const = 0;
  81     virtual VehicleConfigurationSource::AIRSPEED_TYPE getAirspeedType() const = 0;
  82     virtual VehicleConfigurationSource::GPS_TYPE getGpsType() const     = 0;
  83     virtual VehicleConfigurationSource::RADIO_SETTING getRadioSetting() const = 0;
  84     virtual QJsonObject *getVehicleTemplate() const  = 0;
  85
  86     virtual bool isCalibrationPerformed() const      = 0;
  87     virtual accelGyroBias getCalibrationBias() const = 0;
  88
  89     virtual bool isMotorCalibrationPerformed() const = 0;
  90     virtual QList<actuatorChannelSettings> getActuatorSettings() const = 0;
  91
  92     virtual bool isRestartNeeded() const = 0;
  93
  94     virtual QString getSummaryText()     = 0;
  95 };
  96
  97 #endif // VEHICLECONFIGURATIONSOURCE_H