companion/src/firmwares/customfunctiondata.cpp

   1 /*
   2  * Copyright (C) OpenTX
   3  *
   4  * Based on code named
   5  *   th9x - http://code.google.com/p/th9x
   6  *   er9x - http://code.google.com/p/er9x
   7  *   gruvin9x - http://code.google.com/p/gruvin9x
   8  *
   9  * License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  */
  20
  21 #include "customfunctiondata.h"
  22 #include "eeprominterface.h"
  23 #include "radiodata.h"
  24 #include "radiodataconversionstate.h"
  25
  26 void CustomFunctionData::clear()
  27 {
  28   memset(reinterpret_cast<void *>(this), 0, sizeof(CustomFunctionData));
  29   if (!getCurrentFirmware()->getCapability(SafetyChannelCustomFunction)) {
  30     func = FuncTrainer;
  31   }
  32 }
  33
  34 bool CustomFunctionData::isEmpty() const
  35 {
  36   return (swtch.type == SWITCH_TYPE_NONE);
  37 }
  38
  39 QString CustomFunctionData::nameToString(int index, bool globalContext) const
  40 {
  41   return RadioData::getElementName((globalContext ? tr("GF") : tr("SF")), index+1, 0, true);
  42 }
  43
  44 QString CustomFunctionData::funcToString(const ModelData * model) const
  45 {
  46   if (func >= FuncOverrideCH1 && func <= FuncOverrideCH32)
  47     return tr("Override %1").arg(RawSource(SOURCE_TYPE_CH, func).toString(model));
  48   else if (func == FuncTrainer)
  49     return tr("Trainer");
  50   else if (func == FuncTrainerRUD)
  51     return tr("Trainer RUD");
  52   else if (func == FuncTrainerELE)
  53     return tr("Trainer ELE");
  54   else if (func == FuncTrainerTHR)
  55     return tr("Trainer THR");
  56   else if (func == FuncTrainerAIL)
  57     return tr("Trainer AIL");
  58   else if (func == FuncInstantTrim)
  59     return tr("Instant Trim");
  60   else if (func == FuncPlaySound)
  61     return tr("Play Sound");
  62   else if (func == FuncPlayHaptic)
  63     return tr("Haptic");
  64   else if (func == FuncReset)
  65     return tr("Reset");
  66   else if (func >= FuncSetTimer1 && func <= FuncSetTimer3)
  67     return tr("Set Timer %1").arg(func-FuncSetTimer1+1);
  68   else if (func == FuncVario)
  69     return tr("Vario");
  70   else if (func == FuncPlayPrompt)
  71     return tr("Play Track");
  72   else if (func == FuncPlayBoth)
  73     return tr("Play Both");
  74   else if (func == FuncPlayValue)
  75     return tr("Play Value");
  76   else if (func == FuncPlayScript)
  77     return tr("Play Script");
  78   else if (func == FuncLogs)
  79     return tr("SD Logs");
  80   else if (func == FuncVolume)
  81     return tr("Volume");
  82   else if (func == FuncBacklight)
  83     return tr("Backlight");
  84   else if (func == FuncScreenshot)
  85     return tr("Screenshot");
  86   else if (func == FuncBackgroundMusic)
  87     return tr("Background Music");
  88   else if (func == FuncBackgroundMusicPause)
  89     return tr("Background Music Pause");
  90   else if (func >= FuncAdjustGV1 && func <= FuncAdjustGVLast)
  91     return tr("Adjust %1").arg(RawSource(SOURCE_TYPE_GVAR, func-FuncAdjustGV1).toString(model));
  92   else if (func == FuncSetFailsafeInternalModule)
  93     return tr("SetFailsafe Int. Module");
  94   else if (func == FuncSetFailsafeExternalModule)
  95     return tr("SetFailsafe Ext. Module");
  96   else if (func == FuncRangeCheckInternalModule)
  97     return tr("RangeCheck Int. Module");
  98   else if (func == FuncRangeCheckExternalModule)
  99     return tr("RangeCheck Ext. Module");
 100   else if (func == FuncBindInternalModule)
 101     return tr("Bind Int. Module");
 102   else if (func == FuncBindExternalModule)
 103     return tr("Bind Ext. Module");
 104   else {
 105     return QString("???"); // Highlight unknown functions with output of question marks.(BTW should not happen that we do not know what a function is)
 106   }
 107 }
 108
 109 void CustomFunctionData::populateResetParams(const ModelData * model, QComboBox * b, unsigned int value = 0)
 110 {
 111   int val = 0;
 112   Firmware * firmware = Firmware::getCurrentVariant();
 113   Board::Type board = firmware->getBoard();
 114
 115   b->addItem(tr("Timer1"), val++);
 116   b->addItem(tr("Timer2"), val++);
 117   if (IS_ARM(board)) {
 118     b->addItem( tr("Timer3"), val++);
 119   }
 120   b->addItem(tr("Flight"), val++);
 121   b->addItem(tr("Telemetry"), val++);
 122   int reCount = firmware->getCapability(RotaryEncoders);
 123   if (reCount == 1) {
 124     b->addItem(tr("Rotary Encoder"), val++);
 125   }
 126   else if (reCount == 2) {
 127     b->addItem(tr("REa"), val++);
 128     b->addItem(tr("REb"), val++);
 129   }
 130   if ((int)value < b->count()) {
 131     b->setCurrentIndex(value);
 132   }
 133   if (model && IS_ARM(board)) {
 134     for (unsigned i=0; i<CPN_MAX_SENSORS; ++i) {
 135       if (model->sensorData[i].isAvailable()) {
 136         RawSource item = RawSource(SOURCE_TYPE_TELEMETRY, 3*i);
 137         b->addItem(item.toString(model), val+i);
 138         if (value == val+i) {
 139           b->setCurrentIndex(b->count()-1);
 140         }
 141       }
 142     }
 143   }
 144 }
 145
 146 void CustomFunctionData::populatePlaySoundParams(QStringList & qs)
 147 {
 148   qs <<"Beep 1" << "Beep 2" << "Beep 3" << "Warn1" << "Warn2" << "Cheep" << "Ratata" << "Tick" << "Siren" << "Ring" ;
 149   qs << "SciFi" << "Robot" << "Chirp" << "Tada" << "Crickt"  << "AlmClk"  ;
 150 }
 151
 152 void CustomFunctionData::populateHapticParams(QStringList & qs)
 153 {
 154   qs << "0" << "1" << "2" << "3";
 155 }
 156
 157 QString CustomFunctionData::paramToString(const ModelData * model) const
 158 {
 159   QStringList qs;
 160   if (func <= FuncInstantTrim) {
 161     return QString("%1").arg(param);
 162   }
 163   else if (func==FuncLogs) {
 164     return QString("%1").arg(param/10.0) + tr("s");
 165   }
 166   else if (func==FuncPlaySound) {
 167     CustomFunctionData::populatePlaySoundParams(qs);
 168     if (param>=0 && param<(int)qs.count())
 169       return qs.at(param);
 170     else
 171       return tr("<font color=red><b>Inconsistent parameter</b></font>");
 172   }
 173   else if (func==FuncPlayHaptic) {
 174     CustomFunctionData::populateHapticParams(qs);
 175     if (param>=0 && param<(int)qs.count())
 176       return qs.at(param);
 177     else
 178       return tr("<font color=red><b>Inconsistent parameter</b></font>");
 179   }
 180   else if (func==FuncReset) {
 181     QComboBox cb;
 182     CustomFunctionData::populateResetParams(model, &cb);
 183     int pos = cb.findData(param);
 184     if (pos >= 0)
 185       return cb.itemText(pos);
 186     else
 187       return tr("<font color=red><b>Inconsistent parameter</b></font>");
 188   }
 189   else if ((func==FuncVolume)|| (func==FuncPlayValue)) {
 190     RawSource item(param);
 191     return item.toString(model);
 192   }
 193   else if ((func==FuncPlayPrompt) || (func==FuncPlayBoth)) {
 194     if ( getCurrentFirmware()->getCapability(VoicesAsNumbers)) {
 195       return QString("%1").arg(param);
 196     }
 197     else {
 198       return paramarm;
 199     }
 200   }
 201   else if ((func>=FuncAdjustGV1) && (func<FuncCount)) {
 202     switch (adjustMode) {
 203       case FUNC_ADJUST_GVAR_CONSTANT:
 204         return tr("Value ")+QString("%1").arg(param);
 205       case FUNC_ADJUST_GVAR_SOURCE:
 206       case FUNC_ADJUST_GVAR_GVAR:
 207         return RawSource(param).toString();
 208       case FUNC_ADJUST_GVAR_INCDEC:
 209         float val;
 210         QString unit;
 211         if (IS_ARM(getCurrentBoard())) {
 212           val = param * model->gvarData[func - FuncAdjustGV1].multiplierGet();
 213           unit = model->gvarData[func - FuncAdjustGV1].unitToString();
 214         }
 215         else {
 216           val = param;
 217           unit = "";
 218         }
 219         return QString("Increment: %1%2").arg(val).arg(unit);
 220     }
 221   }
 222   return "";
 223 }
 224
 225 QString CustomFunctionData::repeatToString() const
 226 {
 227   if (repeatParam == -1) {
 228     return tr("played once, not during startup");
 229   }
 230   else if (repeatParam == 0) {
 231     return "";
 232   }
 233   else {
 234     unsigned int step = IS_ARM(getCurrentBoard()) ? 1 : 10;
 235     return tr("repeat(%1s)").arg(step*repeatParam);
 236   }
 237 }
 238
 239 QString CustomFunctionData::enabledToString() const
 240 {
 241   if ((func>=FuncOverrideCH1 && func<=FuncOverrideCH32) ||
 242       (func>=FuncAdjustGV1 && func<=FuncAdjustGVLast) ||
 243       (func==FuncReset) ||
 244       (func>=FuncSetTimer1 && func<=FuncSetTimer2) ||
 245       (func==FuncVolume) ||
 246       (func <= FuncInstantTrim)) {
 247     if (!enabled) {
 248       return tr("DISABLED");
 249     }
 250   }
 251   return "";
 252 }
 253
 254 void CustomFunctionData::convert(RadioDataConversionState & cstate)
 255 {
 256   cstate.setComponent(tr("CFN"), 8);
 257   cstate.setSubComp(nameToString(cstate.subCompIdx, (cstate.toModel() ? false : true)));
 258   swtch.convert(cstate);
 259   if (func == FuncVolume || func == FuncPlayValue || (func >= FuncAdjustGV1 && func <= FuncAdjustGVLast && adjustMode == 1)) {
 260     param = RawSource(param).convert(cstate.withComponentField("PARAM")).toValue();
 261   }
 262 }