Standalone simulator startup options (#4164)
* [simulator] Save and restore Simulator window sizes and positions (based on current radio profile). * [simulator] Set startup throttle stick lock in standalone sim based on default mode in current Companion radio profile; Add new flag indicating standalone simulator; Unique titles for simulator console windows. * [simulator] New/updated Simulator startup options: Radio profile used for standalone Simulator can now be separate from Companion; Allow selecting a radio profile and EEPROM image file (in addition to radio type) at startup via GUI and CLI; All startup settings are saved between uses.
This commit is contained in:
Max Paperno
committed by
Bertrand Songis
Bertrand Songis
parent
fd01376f1e
commit
e204031ef6
+272
-100
@@ -19,20 +19,22 @@
|
||||
*/
|
||||
|
||||
#include <QApplication>
|
||||
#include <QTranslator>
|
||||
//#include <QTranslator>
|
||||
#include <QLocale>
|
||||
#include <QString>
|
||||
#include <QDir>
|
||||
#include <QFileInfo>
|
||||
#include <QSplashScreen>
|
||||
#include <QThread>
|
||||
#include <QDebug>
|
||||
#include <QTextStream>
|
||||
#include <QDialog>
|
||||
#include <QComboBox>
|
||||
#include <QLineEdit>
|
||||
#include <QToolButton>
|
||||
#if defined(JOYSTICKS) || defined(SIMU_AUDIO)
|
||||
#include <SDL.h>
|
||||
#undef main
|
||||
#endif
|
||||
#include "simulatordialog.h"
|
||||
#include "constants.h"
|
||||
#include "eeprominterface.h"
|
||||
#include "appdata.h"
|
||||
#include "qxtcommandoptions.h"
|
||||
@@ -62,13 +64,158 @@ class MyProxyStyle : public QProxyStyle
|
||||
};
|
||||
#endif
|
||||
|
||||
void showMessage(const QString & message, enum QMessageBox::Icon icon = QMessageBox::NoIcon) {
|
||||
typedef struct
|
||||
{
|
||||
int profileId;
|
||||
QString firmwareId;
|
||||
QString eepromFileName;
|
||||
} simulatorOptions_t;
|
||||
|
||||
|
||||
QDir g_eepromDirectory;
|
||||
|
||||
int finish(int exitCode);
|
||||
|
||||
void showMessage(const QString & message, enum QMessageBox::Icon icon = QMessageBox::NoIcon)
|
||||
{
|
||||
QMessageBox msgBox;
|
||||
msgBox.setText(message);
|
||||
msgBox.setIcon(icon);
|
||||
msgBox.exec();
|
||||
}
|
||||
|
||||
QString radioEepromFileName(QString firmwareId)
|
||||
{
|
||||
QString eepromFileName = "";
|
||||
QString radioId = firmwareId;
|
||||
int pos = firmwareId.indexOf("-");
|
||||
if (pos > 0) {
|
||||
radioId = firmwareId.mid(pos+1);
|
||||
pos = radioId.lastIndexOf("-");
|
||||
if (pos > 0) {
|
||||
radioId = radioId.mid(0, pos);
|
||||
}
|
||||
}
|
||||
eepromFileName = QString("eeprom-%1.bin").arg(radioId);
|
||||
eepromFileName = g_eepromDirectory.filePath(eepromFileName.toLatin1());
|
||||
// qDebug() << "radioId" << radioId << "eepromFileName" << eepromFileName;
|
||||
|
||||
return eepromFileName;
|
||||
}
|
||||
|
||||
bool startupOptionsDialog(simulatorOptions_t &opts)
|
||||
{
|
||||
bool ret = false;
|
||||
QString label;
|
||||
|
||||
QDialog * dialog = new QDialog();
|
||||
dialog->setWindowFlags(dialog->windowFlags() & (~ Qt::WindowContextHelpButtonHint));
|
||||
|
||||
QFormLayout * form = new QFormLayout(dialog);
|
||||
form->addRow(new QLabel(QObject::tr("Simulator Startup Options:")));
|
||||
|
||||
label = QObject::tr("Profile:");
|
||||
QComboBox * cbProf = new QComboBox();
|
||||
cbProf->setToolTip(QObject::tr("Existing radio profiles are shown here.<br/>" \
|
||||
"Create or edit profiles using the Companion application."));
|
||||
QMapIterator<int, QString> pi(g.getActiveProfiles());
|
||||
while (pi.hasNext()) {
|
||||
pi.next();
|
||||
cbProf->addItem(pi.value(), pi.key());
|
||||
if (pi.key() == opts.profileId)
|
||||
cbProf->setCurrentIndex(cbProf->count() - 1);
|
||||
}
|
||||
form->addRow(label, cbProf);
|
||||
|
||||
label = QObject::tr("Radio Type:");
|
||||
QComboBox * cbType = new QComboBox();
|
||||
cbType->setToolTip(QObject::tr("Existing radio simulators are shown here.<br/>" \
|
||||
"The radio type specified in the selected profile is used by default."));
|
||||
cbType->addItems(registered_simulators.keys());
|
||||
cbType->setCurrentIndex(cbType->findText(opts.firmwareId));
|
||||
form->addRow(label, cbType);
|
||||
|
||||
label = QObject::tr("EEPROM Image:");
|
||||
QLineEdit * fwFile = new QLineEdit(opts.eepromFileName, dialog);
|
||||
fwFile->setToolTip(QObject::tr("EEPROM image file to use. A new file with a default image will be created if necessary.<br />" \
|
||||
"<b>NOTE</b>: any existing EEPROM data incompatible with the selected radio type may be overwritten!"));
|
||||
QToolButton * fwBtn = new QToolButton(dialog);
|
||||
fwBtn->setText("...");
|
||||
fwBtn->setToolButtonStyle(Qt::ToolButtonTextOnly);
|
||||
fwBtn->setToolTip(QObject::tr("Select EEPROM image file..."));
|
||||
QWidget * fw = new QWidget(dialog);
|
||||
QHBoxLayout * hl = new QHBoxLayout(fw);
|
||||
hl->setContentsMargins(0, 0, 0, 0);
|
||||
hl->setSpacing(2);
|
||||
hl->addWidget(fwFile, 2);
|
||||
hl->addWidget(fwBtn, 0);
|
||||
form->addRow(label, fw);
|
||||
|
||||
QDialogButtonBox buttonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel, Qt::Horizontal, dialog);
|
||||
form->addRow(&buttonBox);
|
||||
|
||||
dialog->resize(400, dialog->sizeHint().height());
|
||||
|
||||
QObject::connect(&buttonBox, SIGNAL(accepted()), dialog, SLOT(accept()));
|
||||
QObject::connect(&buttonBox, SIGNAL(rejected()), dialog, SLOT(reject()));
|
||||
|
||||
// set new default radio type when profile choice changes
|
||||
QObject::connect(cbProf, static_cast<void(QComboBox::*)(int)>(&QComboBox::currentIndexChanged), [cbProf, cbType](int index) {
|
||||
if (index < 0)
|
||||
return;
|
||||
SimulatorFactory * sf = getSimulatorFactory(g.profile[index].fwType());
|
||||
if (sf) {
|
||||
int i = cbType->findText(sf->name());
|
||||
if (i > -1)
|
||||
cbType->setCurrentIndex(i);
|
||||
}
|
||||
});
|
||||
|
||||
// set new default firmware file when radio type changes
|
||||
QObject::connect(cbType, static_cast<void(QComboBox::*)(int)>(&QComboBox::currentIndexChanged), [cbType, fwFile](int index) {
|
||||
if (index < 0)
|
||||
return;
|
||||
fwFile->setText(radioEepromFileName(cbType->currentText()));
|
||||
});
|
||||
|
||||
// connect button to file selector dialog
|
||||
QObject::connect(fwBtn, &QToolButton::clicked, [dialog, fwFile, cbType, opts](bool) {
|
||||
QString filter = QObject::tr((cbType->currentText().contains("horus") ? OTX_FILES_FILTER : EEPROM_FILES_FILTER));
|
||||
filter += QObject::tr("All files (*.*)");
|
||||
QString file = QFileDialog::getSaveFileName(dialog, QObject::tr("Select EEPROM image"), opts.eepromFileName,
|
||||
filter, NULL, QFileDialog::DontConfirmOverwrite);
|
||||
if (!file.isEmpty())
|
||||
fwFile->setText(file);
|
||||
});
|
||||
|
||||
// go
|
||||
if (dialog->exec() == QDialog::Accepted) {
|
||||
opts.profileId = cbProf->currentData().toInt();
|
||||
opts.firmwareId = cbType->currentText();
|
||||
opts.eepromFileName = fwFile->text();
|
||||
ret = true;
|
||||
}
|
||||
|
||||
dialog->deleteLater();
|
||||
return ret;
|
||||
}
|
||||
|
||||
void sharedHelpText(QTextStream &stream)
|
||||
{
|
||||
// list all available profiles
|
||||
stream << endl << QObject::tr("Available profiles:") << endl;
|
||||
QMapIterator<int, QString> pi(g.getActiveProfiles());
|
||||
while (pi.hasNext()) {
|
||||
pi.next();
|
||||
stream << "\t" << QObject::tr("ID: ") << pi.key() << QObject::tr(" Name: ") << pi.value() << endl;
|
||||
}
|
||||
// list all available radios
|
||||
stream << endl << QObject::tr("Available radios:") << endl;
|
||||
foreach(QString name, registered_simulators.keys()) {
|
||||
stream << "\t" << name << endl;
|
||||
}
|
||||
}
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
Q_INIT_RESOURCE(companion);
|
||||
@@ -77,6 +224,7 @@ int main(int argc, char *argv[])
|
||||
#endif
|
||||
#if defined(WIN32) && defined(WIN_USE_CONSOLE_STDIO)
|
||||
AllocConsole();
|
||||
SetConsoleTitle("Simulator Console");
|
||||
freopen("conin$", "r", stdin);
|
||||
freopen("conout$", "w", stdout);
|
||||
freopen("conout$", "w", stderr);
|
||||
@@ -117,120 +265,144 @@ int main(int argc, char *argv[])
|
||||
#endif
|
||||
|
||||
SimulatorDialog *dialog;
|
||||
QString eepromFileName;
|
||||
QDir eedir;
|
||||
QFile file;
|
||||
simulatorOptions_t simOptions;
|
||||
QxtCommandOptions cliOptions;
|
||||
bool cliOptsFound = false;
|
||||
|
||||
g_eepromDirectory = QDir(QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation));
|
||||
if (!g_eepromDirectory.exists("OpenTX")) {
|
||||
if (!g_eepromDirectory.mkpath("OpenTX")) {
|
||||
showMessage(QObject::tr("WARNING: couldn't create directory for EEPROM:\n%1").arg(g_eepromDirectory.absoluteFilePath("OpenTX")), QMessageBox::Warning);
|
||||
}
|
||||
}
|
||||
g_eepromDirectory.cd("OpenTX");
|
||||
|
||||
registerSimulators();
|
||||
registerOpenTxFirmwares();
|
||||
|
||||
eedir = QDir(QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation));
|
||||
if (!eedir.exists("OpenTX")) {
|
||||
if (!eedir.mkpath("OpenTX")) {
|
||||
showMessage(QObject::tr("WARNING: couldn't create directory for EEPROM:\n%1").arg(eedir.absoluteFilePath("OpenTX")), QMessageBox::Warning);
|
||||
}
|
||||
}
|
||||
eedir.cd("OpenTX");
|
||||
|
||||
QStringList firmwareIds;
|
||||
int currentIdx = 0;
|
||||
foreach(SimulatorFactory *factory, registered_simulators) {
|
||||
firmwareIds << factory->name();
|
||||
if (factory->name() == g.lastSimulator()) {
|
||||
currentIdx = firmwareIds.size() - 1;
|
||||
}
|
||||
if (!registered_simulators.size()) {
|
||||
showMessage(QObject::tr("ERROR: No simulator libraries available."), QMessageBox::Critical);
|
||||
return finish(3);
|
||||
}
|
||||
|
||||
QxtCommandOptions options;
|
||||
options.add("radio", "radio to simulate", QxtCommandOptions::ValueRequired);
|
||||
options.alias("radio", "r");
|
||||
options.add("help", "show this help text");
|
||||
options.alias("help", "h");
|
||||
options.parse(QCoreApplication::arguments());
|
||||
if (options.count("help") || options.showUnrecognizedWarning()) {
|
||||
cliOptions.add("profile", QObject::tr("Radio profile ID or Name to use for simulator."), QxtCommandOptions::ValueRequired);
|
||||
cliOptions.alias("profile", "p");
|
||||
cliOptions.add("radio", QObject::tr("Radio type to simulate (usually defined in profile)."), QxtCommandOptions::ValueRequired);
|
||||
cliOptions.alias("radio", "r");
|
||||
cliOptions.add("help", QObject::tr("show this help text"));
|
||||
cliOptions.alias("help", "h");
|
||||
cliOptions.parse(QCoreApplication::arguments());
|
||||
if (cliOptions.count("help") || cliOptions.showUnrecognizedWarning()) {
|
||||
QString msg;
|
||||
QTextStream stream(&msg);
|
||||
stream << "Usage: simulator [OPTION]... [EEPROM.BIN FILE] " << endl << endl;
|
||||
stream << "Options:" << endl;
|
||||
options.showUsage(false, stream);
|
||||
// list all available radios
|
||||
stream << endl << "Available radios:" << endl;
|
||||
foreach(QString name, firmwareIds) {
|
||||
stream << "\t" << name << endl;
|
||||
}
|
||||
stream << QObject::tr("Usage: simulator [OPTION]... [EEPROM.BIN FILE] ") << endl << endl;
|
||||
stream << QObject::tr("Options:") << endl;
|
||||
cliOptions.showUsage(false, stream);
|
||||
sharedHelpText(stream);
|
||||
// display
|
||||
showMessage(msg, QMessageBox::Information);
|
||||
return 1;
|
||||
return finish(1);
|
||||
}
|
||||
|
||||
|
||||
bool ok = false;
|
||||
QString firmwareId;
|
||||
if (options.count("radio") == 1) {
|
||||
firmwareId = options.value("radio").toString();
|
||||
if (firmwareIds.contains(firmwareId)) {
|
||||
ok = true;
|
||||
}
|
||||
}
|
||||
if (!ok) {
|
||||
firmwareId = QInputDialog::getItem(0, QObject::tr("Radio type"),
|
||||
QObject::tr("Which radio type do you want to simulate?"),
|
||||
firmwareIds, currentIdx, false, &ok);
|
||||
}
|
||||
qDebug() << "firmwareId" << firmwareId;
|
||||
|
||||
if (ok && !firmwareId.isEmpty()) {
|
||||
if (firmwareId != g.lastSimulator()) {
|
||||
g.lastSimulator(firmwareId);
|
||||
}
|
||||
QString radioId;
|
||||
int pos = firmwareId.indexOf("-");
|
||||
if (pos > 0) {
|
||||
radioId = firmwareId.mid(pos+1);
|
||||
pos = radioId.lastIndexOf("-");
|
||||
if (pos > 0) {
|
||||
radioId = radioId.mid(0, pos);
|
||||
}
|
||||
}
|
||||
qDebug() << "radioId" << radioId;
|
||||
current_firmware_variant = GetFirmware(firmwareId);
|
||||
qDebug() << "current_firmware_variant" << current_firmware_variant->getName();
|
||||
|
||||
if (options.positional().isEmpty()) {
|
||||
eepromFileName = QString("eeprom-%1.bin").arg(radioId);
|
||||
eepromFileName = eedir.filePath(eepromFileName.toLatin1());
|
||||
}
|
||||
else {
|
||||
eepromFileName = options.positional()[0];
|
||||
}
|
||||
qDebug() << "eepromFileName" << eepromFileName;
|
||||
// TODO display used eeprom filename somewhere
|
||||
|
||||
SimulatorFactory * factory = getSimulatorFactory(firmwareId);
|
||||
if (!factory) {
|
||||
showMessage(QObject::tr("ERROR: Simulator %1 not found").arg(firmwareId), QMessageBox::Critical);
|
||||
return 2;
|
||||
}
|
||||
if (factory->type() == BOARD_HORUS)
|
||||
dialog = new SimulatorDialogHorus(NULL, factory->create());
|
||||
else if (factory->type() == BOARD_FLAMENCO)
|
||||
dialog = new SimulatorDialogFlamenco(NULL, factory->create());
|
||||
else if (factory->type() == BOARD_TARANIS_X9D || factory->type() == BOARD_TARANIS_X9DP || factory->type() == BOARD_TARANIS_X9E)
|
||||
dialog = new SimulatorDialogTaranis(NULL, factory->create(), SIMULATOR_FLAGS_S1|SIMULATOR_FLAGS_S2);
|
||||
else
|
||||
dialog = new SimulatorDialog9X(NULL, factory->create());
|
||||
if (cliOptions.count("radio") == 1) {
|
||||
simOptions.firmwareId = cliOptions.value("radio").toString();
|
||||
cliOptsFound = true;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
simOptions.firmwareId = g.lastSimulator();
|
||||
}
|
||||
|
||||
dialog->show();
|
||||
dialog->start(eepromFileName.toLatin1().constData());
|
||||
if (cliOptions.count("profile") == 1) {
|
||||
bool chk;
|
||||
int pid = cliOptions.value("profile").toInt(&chk);
|
||||
if (chk) {
|
||||
simOptions.profileId = pid;
|
||||
}
|
||||
else {
|
||||
simOptions.profileId = g.getActiveProfiles().key(cliOptions.value("profile").toString(), -1);
|
||||
}
|
||||
// load default radio for this profile if not already passed on command line
|
||||
if (!cliOptsFound) {
|
||||
SimulatorFactory * sf = getSimulatorFactory(g.profile[simOptions.profileId].fwType());
|
||||
if (sf)
|
||||
simOptions.firmwareId = sf->name();
|
||||
}
|
||||
cliOptsFound = true;
|
||||
}
|
||||
else if (g.simuLastProfId() != -1) {
|
||||
simOptions.profileId = g.simuLastProfId();
|
||||
}
|
||||
else {
|
||||
simOptions.profileId = g.id();
|
||||
}
|
||||
|
||||
if (!cliOptions.positional().isEmpty()) {
|
||||
simOptions.eepromFileName = cliOptions.positional()[0];
|
||||
cliOptsFound = true;
|
||||
}
|
||||
else if (cliOptsFound || g.simuLastEepe().isEmpty()) {
|
||||
simOptions.eepromFileName = radioEepromFileName(simOptions.firmwareId);
|
||||
}
|
||||
else {
|
||||
simOptions.eepromFileName = g.simuLastEepe();
|
||||
}
|
||||
|
||||
if (!cliOptsFound || simOptions.profileId == -1 || simOptions.firmwareId.isEmpty() || simOptions.eepromFileName.isEmpty()) {
|
||||
if (!startupOptionsDialog(simOptions)) {
|
||||
return finish(0);
|
||||
}
|
||||
}
|
||||
qDebug() << "firmwareId" << simOptions.firmwareId << "profileId" << simOptions.profileId << "eepromFileName" << simOptions.eepromFileName;
|
||||
|
||||
if (simOptions.profileId < 0 || simOptions.firmwareId.isEmpty() || simOptions.eepromFileName.isEmpty()) {
|
||||
showMessage(QObject::tr("ERROR: Couldn't start simulator, missing radio/profile/EEPROM file.\nProfile ID: [%1]; Radio ID: [%2]\nEEPROM File: [%3]")
|
||||
.arg(simOptions.profileId).arg(simOptions.firmwareId).arg(simOptions.eepromFileName), QMessageBox::Critical);
|
||||
return finish(1);
|
||||
}
|
||||
if (!g.getActiveProfiles().contains(simOptions.profileId) || !registered_simulators.keys().contains(simOptions.firmwareId)) {
|
||||
QString msg;
|
||||
QTextStream stream(&msg);
|
||||
stream << QObject::tr("ERROR: Radio profile or simulator firmware not found.\nProfile ID: [%1]; Radio ID: [%2]")
|
||||
.arg(simOptions.profileId).arg(simOptions.firmwareId);
|
||||
sharedHelpText(stream);
|
||||
showMessage(msg, QMessageBox::Critical);
|
||||
return finish(2);
|
||||
}
|
||||
|
||||
SimulatorFactory * factory = getSimulatorFactory(simOptions.firmwareId);
|
||||
if (!factory) {
|
||||
showMessage(QObject::tr("ERROR: Simulator %1 not found").arg(simOptions.firmwareId), QMessageBox::Critical);
|
||||
return finish(2);
|
||||
}
|
||||
|
||||
g.simuLastProfId(simOptions.profileId);
|
||||
g.lastSimulator(simOptions.firmwareId);
|
||||
g.simuLastEepe(simOptions.eepromFileName);
|
||||
|
||||
uint32_t flags = SIMULATOR_FLAGS_STANDALONE;
|
||||
|
||||
if (factory->type() == BOARD_HORUS)
|
||||
dialog = new SimulatorDialogHorus(NULL, factory->create(), flags);
|
||||
else if (factory->type() == BOARD_FLAMENCO)
|
||||
dialog = new SimulatorDialogFlamenco(NULL, factory->create(), flags);
|
||||
else if (factory->type() == BOARD_TARANIS_X9D || factory->type() == BOARD_TARANIS_X9DP || factory->type() == BOARD_TARANIS_X9E)
|
||||
dialog = new SimulatorDialogTaranis(NULL, factory->create(), flags | SIMULATOR_FLAGS_S1 | SIMULATOR_FLAGS_S2);
|
||||
else
|
||||
dialog = new SimulatorDialog9X(NULL, factory->create(), flags);
|
||||
|
||||
dialog->setRadioProfileId(simOptions.profileId);
|
||||
dialog->start(simOptions.eepromFileName.toLatin1().constData());
|
||||
|
||||
dialog->show();
|
||||
int result = app.exec();
|
||||
|
||||
delete dialog;
|
||||
dialog->deleteLater();
|
||||
|
||||
return finish(result);
|
||||
}
|
||||
|
||||
int finish(int exitCode)
|
||||
{
|
||||
unregisterSimulators();
|
||||
unregisterOpenTxFirmwares();
|
||||
|
||||
@@ -241,5 +413,5 @@ int main(int argc, char *argv[])
|
||||
FreeConsole();
|
||||
#endif
|
||||
|
||||
return result;
|
||||
return exitCode;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user