[Simulator] Asynchronous SimulatorInterface & a few new features. (#4738)

* [Simulator] Create RadioKeyWidget class for UI buttons & refactor ButtonsWidget; Refactor SimulatedUIWidget (and subtypes) to use new RadioKeyWidgets/ButtonsWidget; Centralize help text for key mappings and get creative with some icons; Simplify some radio UI setups with rectangular buttons.

* [Simulator] Convert all simulator data I/O to signals/slots mechanism:
    * SimulatorInterface/OpenTxSimulator:
       - Now inherits from QObject to allow signal/slot interface;
       - Allows data exchange on a per-item basis (eg. each I/O value is treated separately instead of sending whole arrays or structs of data);
       - Checks for data changes and only emits signals when change is detected (GUI can now assume only new values are being sent);
       - Manages its own 10ms timer (doesn't rely on GUI to do that);
       - Sends "heartbeat" signals @ 1Hz for status monitoring;
    * Simulator GUI:
       - All data is exchanged between GUI elements as well as SimulatorInterface via signals/slots using standardized methods;
       - Data is sent immediately, and only, when actually changed (eg. a control is moved) instead of in bulk at specific time intervals;
       - Similarly, an asynchronous method is used for reading incoming data, w/out timers or loops;
       - Improve VirtualJoystickWidget to be more encapsulated and configurable;
       - Pause telemetry simulator if window is hidden;

* [Simulator] Move SimulatorInterface instance to separate thread, ensure safe asynchronous operations & proper timer interactions; Protect/remove some functions, & reorganize the order (cosmetics).

* [Simulator] Traces are now delivered to OpenTxSimulator and one or more QIODevice(s) can be added as recipient(s); Add SimulatorInterface::getCapability() for compile-time settings; Remove reversed POT1/SLIDER1 mixer exception (Taranis) requirement for SIMU; Fix plus/minus key delay on wheel event w/out encoder.

* [Simulator] Add current knob/slider/trim input value in tool-tips (KnobWidget and SliderWidget).

* [Simulator] Fix trims widget internal value not properly updating, and remove trim influence on virtual joystick X/Y value display (closes #4671).

* [SimulatorInterface] Add handling of transmitter input voltage, including a rough conversion of volts to ADC value for different boards, and default battery volts lookup function; Clear analogs array before starting.

* [Simulator] Add SimulatorInterface::init() method to separate pre-startup tasks; Report actual trim range, not just extended on/off; Change how radio widget states are restored; VirtualJoystickWidget: Connect trim changes directly from simulator, connect joystick events directly, report stick mode directly instead of setting values/constraints externally.

* [Simulator] Calculate default Tx V input based on configured range in radio settings (or warning V+2 for radios which don't support a range).

* [Simulator] Add functional aux. trims for Horus (closes #4699).

* [Companion] Remove problematic QMessageLogContext from AppDebugMessageHandler::messageOutput().

* [Simulator] Prevent trim change via slider if disabled for flight mode (closes #4600).

* [OpenTxSimulator] Fixes for Qt < 5.4.

* [OpenTxSimulator] Fix slot name.

companion/src/simulation/radiooutputswidget.cpp

@@ -26,39 +26,32 @@
 #include "eeprominterface.h"
 #include "radiodata.h"
 #include "simulator.h"
-#include "simulatorinterface.h"
 
 extern AppData g;  // ensure what "g" means
 
-const int RadioOutputsWidget::m_dataUpdateFreqDefault = 10;  // ms
 const quint16 RadioOutputsWidget::m_savedViewStateVersion = 1;
 
 RadioOutputsWidget::RadioOutputsWidget(SimulatorInterface * simulator, Firmware * firmware, QWidget *parent) :
   QWidget(parent),
   m_simulator(simulator),
   m_firmware(firmware),
-  m_tmrUpdateData(new QTimer),
   m_radioProfileId(g.sessionId()),
-  m_lastFlightPhase(-1),
-  m_started(false),
   ui(new Ui::RadioOutputsWidget)
 {
   ui->setupUi(this);
 
   restoreState();
 
-  m_dataUpdateFreq = m_dataUpdateFreqDefault;
-  m_tmrUpdateData->setInterval(m_dataUpdateFreq);
-
-  connect(m_tmrUpdateData, &QTimer::timeout, this, &RadioOutputsWidget::setValues);
+  connect(m_simulator, &SimulatorInterface::channelOutValueChange, this, &RadioOutputsWidget::onChannelOutValueChange);
+  connect(m_simulator, &SimulatorInterface::virtualSwValueChange, this, &RadioOutputsWidget::onVirtSwValueChange);
+  connect(m_simulator, &SimulatorInterface::gVarValueChange, this, &RadioOutputsWidget::onGVarValueChange);
+  connect(m_simulator, &SimulatorInterface::phaseChanged, this, &RadioOutputsWidget::onPhaseChanged);
 }
 
 RadioOutputsWidget::~RadioOutputsWidget()
 {
-  stop();
+  //stop();
   saveState();
-  if (m_tmrUpdateData)
-    delete m_tmrUpdateData;
   delete ui;
 }
 
@@ -74,36 +67,20 @@ void RadioOutputsWidget::changeEvent(QEvent *e)
   }
 }
 
-void RadioOutputsWidget::showEvent(QShowEvent * event)
-{
-  if (m_started)
-    m_tmrUpdateData->start();
-}
-
-void RadioOutputsWidget::hideEvent(QHideEvent * event)
-{
-  m_tmrUpdateData->stop();
-}
-
 void RadioOutputsWidget::start()
 {
   setupChannelsDisplay();
   setupGVarsDisplay();
   setupLsDisplay();
-  m_lastFlightPhase = -1;
-  m_tmrUpdateData->start();
-  m_started = true;
 }
 
-void RadioOutputsWidget::stop()
-{
-  m_tmrUpdateData->stop();
-  m_started = false;
-}
+//void RadioOutputsWidget::stop()
+//{
+//}
 
 void RadioOutputsWidget::restart()
 {
-  stop();
+  //stop();
   start();
 }
 
@@ -139,7 +116,6 @@ void RadioOutputsWidget::restoreState()
     ui->splitter->restoreState(splitterState);
 }
 
-
 void RadioOutputsWidget::setupChannelsDisplay()
 {
   int outputs = std::min(32, m_firmware->getCapability(Capability(Outputs)));
@@ -297,68 +273,73 @@ QWidget * RadioOutputsWidget::createLogicalSwitch(QWidget * parent, int switchNo
   return swtch;
 }
 
-// Read various values from firmware simulator and populate values in this UI
-void RadioOutputsWidget::setValues()
+void RadioOutputsWidget::onChannelOutValueChange(quint8 index, qint32 value)
 {
-  static TxOutputs prevOutputs = TxOutputs();
-  int currentPhase;
-  TxOutputs outputs;
-  QFont font;
-
-  m_simulator->getValues(outputs);
-  currentPhase = m_simulator->getPhase();
-
-  if (ui->channelsWidget->isVisible()) {
-    QHash<int, QPair<QLabel *, QSlider *> >::const_iterator ch;
-    for (ch = m_channelsMap.constBegin(); ch != m_channelsMap.constEnd(); ++ch) {
-      if (ch.key() >= CPN_MAX_CHNOUT)
-        continue;
-      ch.value().first->setText(QString("%1%").arg(calcRESXto100(outputs.chans[ch.key()])));
-      ch.value().second->setValue(qMin(1024, qMax(-1024, outputs.chans[ch.key()])));
-    }
+  if (m_channelsMap.contains(index)) {
+    QPair<QLabel *, QSlider *> ch = m_channelsMap.value(index);
+    ch.first->setText(QString("%1%").arg(calcRESXto100(value)));
+    ch.second->setValue(qMin(1024, qMax(-1024, value)));
   }
+  //qDebug() << index << value;
+}
 
-  if (ui->logicalSwitchesWidget->isVisible()) {
-    QHash<int, QLabel* >::const_iterator ls;
-    for (ls = m_logicSwitchMap.constBegin(); ls != m_logicSwitchMap.constEnd(); ++ls) {
-      if (ls.key() >= CPN_MAX_LOGICAL_SWITCHES || (prevOutputs.vsw[ls.key()] == outputs.vsw[ls.key()] && m_lastFlightPhase > -1))
-        continue;
-      ls.value()->setBackgroundRole(outputs.vsw[ls.key()] ? QPalette::Dark : QPalette::Background);
-      ls.value()->setForegroundRole(outputs.vsw[ls.key()] ? QPalette::BrightText : QPalette::WindowText);
-      ls.value()->setFrameShadow(outputs.vsw[ls.key()] ? QFrame::Sunken : QFrame::Raised);
-      font = ls.value()->font();
-      font.setBold(outputs.vsw[ls.key()]);
-      ls.value()->setFont(font);
-      prevOutputs.vsw[ls.key()] = outputs.vsw[ls.key()];
-    }
+void RadioOutputsWidget::onVirtSwValueChange(quint8 index, qint32 value)
+{
+  if (!m_logicSwitchMap.contains(index))
+    return;
+
+  QLabel * ls = m_logicSwitchMap.value(index);
+  ls->setBackgroundRole(value ? QPalette::Dark : QPalette::Background);
+  ls->setForegroundRole(value ? QPalette::BrightText : QPalette::WindowText);
+  ls->setFrameShadow(value ? QFrame::Sunken : QFrame::Raised);
+  QFont font = ls->font();
+  font.setBold((bool)value);
+  ls->setFont(font);
+  //qDebug() << index << value;
+}
+
+void RadioOutputsWidget::onGVarValueChange(quint8 index, qint32 value)
+{
+  if (!m_globalVarsMap.contains(index))
+    return;
+
+  QHash<int, QLabel *> fmMap = m_globalVarsMap.value(index);
+  SimulatorInterface::gVarMode_t gv(value);
+
+  if (fmMap.contains(gv.mode)) {
+    QLabel * lbl = fmMap.value(gv.mode);
+    if (lbl)
+      lbl->setText(QString::number(gv.value));
   }
+  //qDebug() << index << value << gv.mode << gv.value;
+}
+
+void RadioOutputsWidget::onPhaseChanged(qint32 phase, const QString &)
+{
+  QPalette::ColorRole fgrole, bgrole;
+  QLabel * lbl;
+  QFont font;
+  QHash<int, QHash<int, QLabel *> >::const_iterator gv;
+  QHash<int, QLabel *>::const_iterator fm;
 
-  if (ui->globalVarsWidget->isVisible()) {
-    QPalette::ColorRole bgrole;
-    QHash<int, QHash<int, QLabel *> >::const_iterator gv;
-    QHash<int, QLabel *>::const_iterator fm;
-    for (gv = m_globalVarsMap.constBegin(); gv != m_globalVarsMap.constEnd(); ++gv) {
-      if (gv.key() >= CPN_MAX_GVARS)
-        continue;
-      for (fm = gv.value().constBegin(); fm != gv.value().constEnd(); ++fm) {
-        if (fm.key() >= CPN_MAX_FLIGHT_MODES)
-          continue;
-        if (currentPhase != m_lastFlightPhase || prevOutputs.gvars[fm.key()][gv.key()] != outputs.gvars[fm.key()][gv.key()]) {
-          if (fm.key() == currentPhase)
-            bgrole = QPalette::Dark;
-          else
-            bgrole = ((gv.key() % 2) ? QPalette::Background : QPalette::AlternateBase);
-          fm.value()->setBackgroundRole(bgrole);
-          fm.value()->setForegroundRole(fm.key() == currentPhase ? QPalette::BrightText : QPalette::WindowText);
-          font = fm.value()->font();
-          font.setBold(fm.key() == currentPhase);
-          fm.value()->setFont(font);
-          fm.value()->setText(QString::number(outputs.gvars[fm.key()][gv.key()]));
-          prevOutputs.gvars[fm.key()][gv.key()] = outputs.gvars[fm.key()][gv.key()];
-        }
+  for (gv = m_globalVarsMap.constBegin(); gv != m_globalVarsMap.constEnd(); ++gv) {
+    for (fm = gv.value().constBegin(); fm != gv.value().constEnd(); ++fm) {
+      lbl = fm.value();
+      font = lbl->font();
+      if (fm.key() == phase) {
+        fgrole =  QPalette::BrightText;
+        bgrole = QPalette::Dark;
+        font.setBold(true);
       }
+      else {
+        fgrole =  QPalette::WindowText;
+        bgrole = ((gv.key() % 2) ? QPalette::Background : QPalette::AlternateBase);
+        font.setBold(false);
+      }
+      lbl->setForegroundRole(fgrole);
+      lbl->setBackgroundRole(bgrole);
+      lbl->setFont(font);
     }
   }
-
-  m_lastFlightPhase = currentPhase;
+  //qDebug() << phase;
 }