[xpressnet] Report hardware info in interface window like in Z21

Author: gfgit

server/src/hardware/interface/xpressnetinterface.cpp

@@ -38,6 +38,7 @@
 #include "../../core/objectproperty.tpp"
 #include "../../log/log.hpp"
 #include "../../log/logmessageexception.hpp"
+#include "../../utils/category.hpp"
 #include "../../utils/displayname.hpp"
 #include "../../utils/inrange.hpp"
 #include "../../utils/makearray.hpp"
@@ -96,6 +97,8 @@ XpressNetInterface::XpressNetInterface(World& world, std::string_view _id)
   , s88StartAddress{this, "s88_start_address", XpressNet::RoSoftS88XpressNetLI::S88StartAddress::startAddressDefault, PropertyFlags::ReadWrite | PropertyFlags::Store}
   , s88ModuleCount{this, "s88_module_count", XpressNet::RoSoftS88XpressNetLI::S88ModuleCount::moduleCountDefault, PropertyFlags::ReadWrite | PropertyFlags::Store}
   , xpressnet{this, "xpressnet", nullptr, PropertyFlags::ReadOnly | PropertyFlags::Store | PropertyFlags::SubObject}
+  , xbusVersion{this, "xbus_version", "", PropertyFlags::ReadOnly | PropertyFlags::NoStore}
+  , commandStationType{this, "command_station_type", "", PropertyFlags::ReadOnly | PropertyFlags::NoStore}
   , luaSendMsg{*this, "send_msg", MethodFlags::ScriptCallable,
       [this](const std::string &msgHexStr)
       {
@@ -159,6 +162,12 @@ XpressNetInterface::XpressNetInterface(World& world, std::string_view _id)
 
   m_interfaceItems.insertBefore(outputs, notes);
 
+  Attributes::addCategory(xbusVersion, Category::info);
+  m_interfaceItems.insertBefore(xbusVersion, notes);
+
+  Attributes::addCategory(commandStationType, Category::info);
+  m_interfaceItems.insertBefore(commandStationType, notes);
+
   m_interfaceItems.add(luaSendMsg);
 
   decoderAddedRemovedConn = std::static_pointer_cast<Object>(decoders.value())->propertyChanged.connect(
@@ -356,6 +365,20 @@ bool XpressNetInterface::setOnline(bool& value, bool simulation)
           setState(InterfaceState::Error);
           online = false; // communication no longer possible
         });
+      m_kernel->setOnHardwareInfoChanged(
+        [this](XpressNet::HardwareType hwType, uint8_t versionMajor, uint8_t versionMinor)
+        {
+          commandStationType.setValueInternal(std::string(XpressNet::toString(hwType)));
+          Log::log(*this, LogMessage::I2002_HARDWARE_TYPE_X, commandStationType.value());
+
+          if(versionMajor != 0)
+          {
+            xbusVersion.setValueInternal(std::to_string(versionMajor).append(".").append(std::to_string(versionMinor)));
+            Log::log(*this, LogMessage::I2003_FIRMWARE_VERSION_X, xbusVersion.value());
+          }
+          else
+            xbusVersion.setValueInternal("");
+        });
       m_kernel->setOnTrackPowerChanged(
         [this](bool powerOn, bool isStopped)
         {
@@ -431,6 +454,8 @@ bool XpressNetInterface::setOnline(bool& value, bool simulation)
     EventLoop::deleteLater(m_kernel.release());
 
     setState(InterfaceState::Offline);
+    xbusVersion.setValueInternal("");
+    commandStationType.setValueInternal("");
   }
   return true;
 }

server/src/hardware/interface/xpressnetinterface.hpp

@@ -85,6 +85,8 @@ class XpressNetInterface final
     Property<uint8_t> s88StartAddress;
     Property<uint8_t> s88ModuleCount;
     ObjectProperty<XpressNet::Settings> xpressnet;
+    Property<std::string> xbusVersion;
+    Property<std::string> commandStationType;
 
     Method<void(std::string)> luaSendMsg;
 

server/src/hardware/protocol/xpressnet/kernel.cpp

@@ -139,13 +139,18 @@ void Kernel::pollDecoders()
   }
 }
 
-void Kernel::setCentralVersion(uint8_t version)
+void Kernel::setCentralVersion(uint8_t version, uint8_t commandStationId)
 {
   assert(isKernelThread());
   m_centralVersion = CentralVersion(version);
-  EventLoop::call([this, version]()
+  EventLoop::call([this, version, commandStationId]()
   {
     m_centralVersionEventLoop = CentralVersion(version);
+
+    if(m_onHardwareInfoChanged)
+      m_onHardwareInfoChanged(HardwareType(commandStationId),
+                              xbusVersionMajor(version),
+                              xbusVersionMinor(version));
   });
 }
 
@@ -347,15 +352,15 @@ void Kernel::receive(const Message& message)
         const auto& reply = static_cast<const CentralVersionReplyOLD&>(message);
         if(reply.db1 == idCentralVersion)
         {
-          setCentralVersion(reply.versionHex);
+          setCentralVersion(reply.versionHex, HardwareType::HWT_UNKNOWN);
         }
       }
       else if(message.header == REPLY_VERSION_3_0)
       {
         const auto& reply = static_cast<const CentralVersionReplyV3&>(message);
         if(reply.db1 == idCentralVersion)
         {
-          setCentralVersion(reply.versionHex);
+          setCentralVersion(reply.versionHex, reply.commandStationId());
         }
       }
       break;

server/src/hardware/protocol/xpressnet/kernel.hpp

@@ -43,6 +43,7 @@ class OutputController;
 namespace XpressNet {
 
 struct Message;
+enum HardwareType : uint8_t;
 
 class Kernel : public ::KernelBase
 {
@@ -71,6 +72,8 @@ class Kernel : public ::KernelBase
     std::unique_ptr<IOHandler> m_ioHandler;
     const bool m_simulation;
 
+    std::function<void(HardwareType, uint8_t, uint8_t)> m_onHardwareInfoChanged;
+
     /*!
      * \brief m_trackPowerOn caches command station track power state.
      *
@@ -137,7 +140,7 @@ class Kernel : public ::KernelBase
     void onPendingQueryTimeout(const boost::system::error_code &ec);
     uint16_t popAddressQuerySendNext(PendingQuery::QueryType type);
     void pollDecoders();
-    void setCentralVersion(uint8_t version);
+    void setCentralVersion(uint8_t version, uint8_t commandStationId);
 
     Kernel(std::string logId_, const Config& config, bool simulation);
 
@@ -202,6 +205,17 @@ class Kernel : public ::KernelBase
      */
     void setConfig(const Config& config);
 
+    /**
+     * @brief ...
+     * @param[in] callback ...
+     * @note This function may not be called when the kernel is running.
+     */
+    inline void setOnHardwareInfoChanged(std::function<void(HardwareType, uint8_t, uint8_t)> callback)
+    {
+      assert(!m_started);
+      m_onHardwareInfoChanged = std::move(callback);
+    }
+
     /**
      * @brief ...
      * @param[in] callback ...

server/src/hardware/protocol/xpressnet/messages.cpp

@@ -116,9 +116,9 @@ std::string toString(const Message& message, bool raw, const PendingQuery &pendi
       {
         s = "CS_VERSION_OLD";
         s.append(" version=");
-        s.append(std::to_string(reply.versionMajor()));
+        s.append(std::to_string(xbusVersionMajor(reply.versionHex)));
         s.append(".");
-        s.append(std::to_string(reply.versionMinor()));
+        s.append(std::to_string(xbusVersionMinor(reply.versionHex)));
       }
       else
         raw = true;
@@ -131,9 +131,9 @@ std::string toString(const Message& message, bool raw, const PendingQuery &pendi
     {
       s = "CS_VERSION_V3";
       s.append(" version=");
-      s.append(std::to_string(reply.versionMajor()));
+      s.append(std::to_string(xbusVersionMajor(reply.versionHex)));
       s.append(".");
-      s.append(std::to_string(reply.versionMinor()));
+      s.append(std::to_string(xbusVersionMinor(reply.versionHex)));
       s.append(" id=");
       s.append(std::to_string(reply.commandStationId()));
     }

server/src/hardware/protocol/xpressnet/messages.hpp

@@ -88,6 +88,39 @@ enum Header : uint8_t
   LOCO_INFO = 0xEF
 };
 
+enum HardwareType : uint8_t
+{
+  HWT_LZ100 = 0x00,
+  HWT_LZ200 = 0x01,
+  HWT_DPC = 0x02,
+  HWT_multiMAUS = 0x10,
+  HWT_UNKNOWN = 0xFF
+};
+
+constexpr std::string_view toString(HardwareType value)
+{
+  switch(value)
+  {
+    case HWT_LZ100:
+      return "Lenz LZ100";
+
+    case HWT_LZ200:
+      return "Lenz LZ200";
+
+    case HWT_DPC:
+      return "Lenz DPC (Compact und Commander)";
+
+    case HWT_multiMAUS:
+      return "ROCO multiMAUS";
+
+    case HWT_UNKNOWN:
+    default:
+      break;
+  }
+
+  return {};
+}
+
 struct Message;
 
 inline uint8_t calcChecksum(const Message& msg);
@@ -189,16 +222,6 @@ struct CentralVersionReplyOLD : Message
     versionHex = versionHex_;
     updateChecksum();
   }
-
-  uint8_t versionMajor() const
-  {
-    return (versionHex >> 4) & 0x0F;
-  }
-
-  uint8_t versionMinor() const
-  {
-    return versionHex & 0x0F;
-  }
 } ATTRIBUTE_PACKED;
 static_assert(sizeof(CentralVersionReplyOLD) == 4);
 
@@ -218,19 +241,9 @@ struct CentralVersionReplyV3 : Message
     updateChecksum();
   }
 
-  uint8_t versionMajor() const
-  {
-    return (versionHex >> 4) & 0x0F;
-  }
-
-  uint8_t versionMinor() const
-  {
-    return versionHex & 0x0F;
-  }
-
-  uint8_t commandStationId() const
+  HardwareType commandStationId() const
   {
-    return db_csId;
+    return HardwareType(db_csId);
   }
 } ATTRIBUTE_PACKED;
 static_assert(sizeof(CentralVersionReplyV3) == 5);

server/src/hardware/protocol/xpressnet/utils.hpp

@@ -40,6 +40,16 @@ struct PendingQuery
   QueryType type = QueryType::LocoInfoAndF0F12;
 };
 
+static constexpr uint8_t xbusVersionMajor(uint8_t versionHex)
+{
+  return (versionHex >> 4) & 0x0F;
+}
+
+static constexpr uint8_t xbusVersionMinor(uint8_t versionHex)
+{
+  return versionHex & 0x0F;
+}
+
 }
 
 #endif