do some experiments

DCPlugin.pro

@@ -9,7 +9,7 @@ QT += serialport
 INCLUDEPATH += $${PWD}/plugins
 INCLUDEPATH += $${PWD}/include
 
-QMAKE_CXXFLAGS += -Wno-deprecated-copy
+QMAKE_CXXFLAGS += -Wno-deprecated-copy -O
 
 # default
 ARCH = PTU5
@@ -49,6 +49,8 @@ INTERFACE_DEFINITION = $${PWD}/src/ATBAPP/DeviceControllerInterface.h
 
 DEFINES += DEVICECONTROLLERPLUGIN_LIBRARY
 
+DEFINES += USE_DC_VMC_UNIFICATION
+
 # The following define makes your compiler emit warnings if you use
 # any Qt feature that has been marked deprecated (the exact warnings
 # depend on your compiler). Please consult the documentation of the
@@ -77,6 +79,7 @@ HEADERS += \
     src/ATBAPP/ATBMachineEvent.h \
     src/ATBAPP/ATBDeviceControllerPlugin.h \
     src/ATBAPP/Utils.h \
+    src/ATBAPP/UnifiedDCVMCInterface.h \
     src/ATBAPP/support/DBusControllerInterface.h \
     src/ATBAPP/support/JSON.h \
     src/ATBAPP/support/PTUSystem.h

include/interfaces.h

@@ -193,7 +193,7 @@ struct T_moduleCondition
         uint8_t	coinChecker;		// EMP, OMP or mei-cashflow
 
         uint8_t	coinEscrow;
-        uint8_t	mifareReader;
+        uint8_t	mifareReader;       // 0: unknown  1=OK  200=no response  201=wrong response   202: Reader reports HW-error
         uint8_t	creditTerm;
         uint8_t	coinReject;
 
@@ -818,7 +818,7 @@ public:
 // --------------------------------------------- MIFARE -----------------------------------------------------
 // ----------------------------------------------------------------------------------------------------------
 
-
+// obsolete
     virtual uint8_t mif_returnReaderStateAndCardType(uint8_t *buf, uint8_t maxBufferSize) const =0;
         // retval 0=OK 1=error host buffer too small
     /* data description, new fast version:
@@ -840,13 +840,16 @@ public:
     virtual bool mif_readerIsOK(void) const =0;
 
     virtual bool mif_cardAttached(void) const =0;
+        // not working! use mif_cardIsAttached() instead
 
     virtual uint8_t mif_readResult(void) const =0;
         // result: 0: unknown or still in progress
         //         1: card read successful
         //         2: reading error
+        // not working!
 
     virtual QString mif_cardUID(void) const =0;
+        // not working
 
     virtual uint8_t mif_getCardDataDec(uint8_t blkNr, uint8_t *buf, uint8_t maxBufferSize) const =0;
 
@@ -1289,7 +1292,7 @@ public:
         // 1= wrong length    2=wrong start sign           5= wrong crc
         // 6= slave: master cmd was wrong       7: slave: could not write/read data
         // 8=timeout, got no response from slave
-
+        // 0,8 work, 1..6 not yet tested. 8 comes immed. and stays 8 until reconnect
 
     // use for important and extended commands (print several templates, print ticket...)
     virtual void log_startSupervision(void) const =0;
@@ -1299,6 +1302,7 @@ public:
         // 0: started, in progress
         // 1: done and OK
         // 2: done and error
+        // not working properly, always 0
 
     virtual bool log_getVaultData(uint8_t *data) const =0;
         // get vault record in linear 8bit buffer with 384 byte
@@ -1343,6 +1347,37 @@ public:
 
 
 
+    // new functions from 8.9.23
+    virtual QString mif_getReaderType(void) const =0;
+        // return "SL025" if correct reader is connected
+
+    virtual void mif_getCardSize(uint8_t *cardSize, uint8_t *idLeng) const =0;
+        // cardSize=1k or 4kByte
+        // idLeng =4Byte or 7 byte
+
+    virtual char mif_getAtbCardData(uint8_t *buf, uint8_t maxBuffSiz) const =0;
+        // return complete buffer binary, just for test purpose
+
+    virtual bool mif_isValidAtbCard(void) const =0;
+
+    virtual uint32_t mif_getAtbCardCuNu(void) const =0;
+
+    virtual uint8_t mif_getAtbCardTyp(void) const =0;
+        // return 1=upper door card     1=lower door    3=printer-test   4=coin-test
+        //          0: not a valid atb2020 card
+
+    virtual QString mif_getAtbCardPerso(void) const =0;
+        // e.g. "PNsax001" used for personal number, name shortcode, card number
+        // free to use, can be set in AtbMcw23.exe tool
+
+    virtual void mif_getAtbCardExpire(uint8_t *year, uint8_t *month, uint8_t *day, uint8_t *hour, uint8_t *minute) const =0;
+
+
+
+
+
+
+
 signals:
     virtual void hwapi_templatePrintFinished_OK(void) const=0;
     virtual void hwapi_templatePrintFinished_Err(void) const=0;
@@ -1413,9 +1448,15 @@ signals:
 //#define HWINF_iid "Atb.Psa1256ptu5.software.HWapi/4.1"
 //#define HWINF_iid "Atb.Psa1256ptu5.software.HWapi/4.2"
 //#define HWINF_iid "Atb.Psa1256ptu5.software.HWapi/4.3"
-#define HWINF_iid "Atb.Psa1256ptu5.software.HWapi/4.4"
+//#define HWINF_iid "Atb.Psa1256ptu5.software.HWapi/4.4"
-
+    // 8.9.2023 two new functions (end of file) for mifare test
+//#define HWINF_iid "Atb.Psa1256ptu5.software.HWapi/4.5"
+    // 18.9.2023 major improvements for DC data exchange
+    // verification of door and cash box signals
+    // intensive verification of Json-Programming Master-Slave (PTU to DC), 100% ok
 
+#define HWINF_iid "Atb.Psa1256ptu5.software.HWapi/4.6"
+    // 20.9.2023: speeding up door and cash box signals
 
 
 Q_DECLARE_INTERFACE(hwinf, HWINF_iid)

src/ATBAPP/ATBDeviceControllerPlugin.cpp

@@ -362,7 +362,7 @@ void ATBDeviceControllerPlugin::onVaultDoorOpened()
     // this is started here because we want to keep ptu awake in order to get
     // coin box removed / inserted etc.
     // BackgroundTask("ACCOUNT") is finished, if account message is sent to ISMAS!
-    this->dbus->startBackgroundTask("ACCOUNT");
+    this->dbus->startBackgroundTask("DOOR_OPEN");
 
     // do not: emit this->requestModeSERVICE();
 }
@@ -371,6 +371,9 @@ void ATBDeviceControllerPlugin::onCoinBoxRemoved()
 {
     qCritical() << "ATBDeviceControllerPlugin::onCoinBoxRemoved()";
 
+    // BackgroundTask("ACCOUNT") is finished, if account message is sent to ISMAS!
+    this->dbus->startBackgroundTask("ACCOUNT");
+
     QTimer::singleShot(4000, this, SLOT(private_startAccount()));
 }
 
@@ -379,19 +382,31 @@ void ATBDeviceControllerPlugin::onCoinBoxInserted()
     qCritical() << "ATBDeviceControllerPlugin::onCoinBoxInserted()";
 }
 
+/**
+ * This is called, when all CoinBox is inserted and all doors
+ * are closed.
+ */
 void ATBDeviceControllerPlugin::onCBinAndAllDoorsClosed()
 {
     qCritical() << "ATBDeviceControllerPlugin::onCBinAndAllDoorsClosed()";
 
     QTimer::singleShot(2000, this, SIGNAL(requestModeIDLE()));
+
+    this->dbus->finishedBackgroundTask("DOOR_OPEN");
 }
 
-
+/**
+ *  This is called, when all no coinbox is inserted and all doors are
+ *  closed.
+ */
 void ATBDeviceControllerPlugin::onAllDoorsClosed()
 {
     qCritical() << "ATBDeviceControllerPlugin::onAllDoorsClosed()";
 
     emit this->requestModeIDLE();
+    this->dbus->finishedBackgroundTask("DOOR_OPEN");
+
+    // TODO: check for errors and create a machine event
 }
 
 void ATBDeviceControllerPlugin::onNewVoltage(uint32_t voltage)
@@ -1030,12 +1045,12 @@ PLUGIN_STATE ATBDeviceControllerPlugin::getState()
     return this->pluginState;
 }
 
-QString & ATBDeviceControllerPlugin::getLastError()
+QString ATBDeviceControllerPlugin::getLastError()
 {
     return this->errorCode;
 }
 
-const QString & ATBDeviceControllerPlugin::getLastErrorDescription()
+QString ATBDeviceControllerPlugin::getLastErrorDescription()
 {
     return this->errorDescription;
 }
@@ -1046,7 +1061,7 @@ const QString & ATBDeviceControllerPlugin::getPluginInfo()
 }
 
 
-const QString ATBDeviceControllerPlugin::getString(nsDeviceControllerInterface::RESULT_STATE resultState)
+QString ATBDeviceControllerPlugin::getString(nsDeviceControllerInterface::RESULT_STATE resultState)
 {
     QString str;
 

src/ATBAPP/ATBDeviceControllerPlugin.h

@@ -58,25 +58,25 @@ public:
     void requestAccount();
 
     // mandantory ATBAPP plugin methods: ------------------------------------------
-    nsDeviceControllerInterface::PLUGIN_STATE getState();
+    nsDeviceControllerInterface::PLUGIN_STATE getState() override;
-    QString & getLastError();
+    QString getLastError() override;
-    const QString & getLastErrorDescription();
+    QString getLastErrorDescription() override;
 
-    const QString & getPluginInfo();
+    virtual const QString & getPluginInfo() override;
 
     // helpers e.g. for debug / log
-    const QString getString(nsDeviceControllerInterface::RESULT_STATE resultState);;
+    virtual QString getString(nsDeviceControllerInterface::RESULT_STATE resultState) override;
 
 public slots:
-    void onChangedProgramModeToSELL();
+    virtual void onChangedProgramModeToSELL() override;
-    void onChangedProgramModeToSERVICE();
+    virtual void onChangedProgramModeToSERVICE() override;
-    void onChangedProgramModeToIDLE();
+    virtual void onChangedProgramModeToIDLE() override;
-    void onChangedProgramModeToOOO();
+    virtual void onChangedProgramModeToOOO() override;
 
-    void startPhysicalLayer();
+    void startPhysicalLayer() override;
-    void stopPhysicalLayer();
+    void stopPhysicalLayer() override;
-    void reboot();
+    void reboot() override;
-    void reset();
+    void reset() override;
 
 
 

src/ATBAPP/DeviceControllerInterface.h

@@ -7,22 +7,27 @@
 #include <QString>
 
 #include "ATBAPPplugin.h"
+#include "UnifiedDCVMCInterface.h"
 
 namespace nsDeviceControllerInterface {
-    enum class PLUGIN_STATE : quint8;
+    using PLUGIN_STATE = UnifiedDCVMCInterface::PLUGIN_STATE;
-    enum class RESULT_STATE : quint8;
+    using RESULT_STATE = UnifiedDCVMCInterface::RESULT_STATE;
-    enum class CASH_STATE   : quint8;
+    using CASH_STATE = UnifiedDCVMCInterface::CASH_STATE;
-    enum class TICKET_VARIANT : quint8;
+    using TICKET_VARIANT = UnifiedDCVMCInterface::TICKET_VARIANT;
 }
 
-
+class DeviceControllerInterface : public UnifiedDCVMCInterface
-class DeviceControllerInterface : public QObject
-                                , public ATBAPPplugin
 {
     Q_OBJECT
     Q_INTERFACES(ATBAPPplugin)
+    Q_INTERFACES(UnifiedDCVMCInterface)
 
 public:
+
+    virtual PLUGIN_STATE initPlugin(QObject *eventReceiver, QSettings const &settings) override {
+        return initDCPlugin(eventReceiver, settings);
+    }
+
     virtual ~DeviceControllerInterface() {}
 
     /**
@@ -31,8 +36,7 @@ public:
      * @param settings
      * @return
      */
-    virtual nsDeviceControllerInterface::PLUGIN_STATE initDCPlugin(QObject *eventReceiver,
+    virtual PLUGIN_STATE initDCPlugin(QObject *eventReceiver, const QSettings & settings) = 0;
-                                                                   const QSettings & settings) = 0;
 
     // TASKS: Cash handling -------------------------------------------------------
     /**
@@ -60,140 +64,12 @@ public:
 
     // TASKS: printing ------------------------------------------------------------
     virtual void requestPrintTicket(const QHash<QString, QVariant> & printingData) = 0;
-    virtual void requestPrintTicket(nsDeviceControllerInterface::TICKET_VARIANT ticketVariant, const QHash<QString, QVariant> & printingData) = 0;
+    virtual void requestPrintTicket(TICKET_VARIANT ticketVariant, const QHash<QString, QVariant> & printingData) = 0;
     virtual void requestPrintReceipt(const QHash<QString, QVariant> & printingData) = 0;
     virtual void requestPrintReceipt(const QString & printingString) = 0;
-
-    // mandantory ATBAPP plugin methods:
-    virtual nsDeviceControllerInterface::PLUGIN_STATE getState() = 0;
-    virtual const QString & getLastError() = 0;
-    virtual const QString & getLastErrorDescription() = 0;
-
-    // return a plugin description in JSON or XML
-    // -> ATBAPPplugin::getPluginInfo()
-
-    // helpers e.g. for debug / log
-    virtual const QString getString(nsDeviceControllerInterface::RESULT_STATE resultState) = 0;
-
-public slots:
-    virtual void onChangedProgramModeToSELL() = 0;
-    virtual void onChangedProgramModeToSERVICE() = 0;
-    virtual void onChangedProgramModeToIDLE() = 0;
-    virtual void onChangedProgramModeToOOO() = 0;
-
-    virtual void startPhysicalLayer() = 0;
-    virtual void stopPhysicalLayer() = 0;
-    virtual void reboot() = 0;
-    virtual void reset() = 0;
-
-
-signals:
-    void printTicketFinished(nsDeviceControllerInterface::RESULT_STATE resultState,
-                                     const QString & errorCode,
-                                     const QString & errorDescription);
-    void printReceiptFinished(nsDeviceControllerInterface::RESULT_STATE resultState,
-                                     const QString & errorCode,
-                                     const QString & errorDescription);
-
-    /**
-     * emitted on e.g. a coin input
-     */
-    void cashInputEvent(nsDeviceControllerInterface::RESULT_STATE resultState,
-                                nsDeviceControllerInterface::CASH_STATE cashState,
-                                const QString & newCashValue,
-                                /* additional variables? */
-                                const QString & errorCode,
-                                const QString & errorDescription);
-
-    /**
-     * emitted if cashInput has been stopped, e.g. in result to task requestStopCashInput():
-     *  -> shutter is blocked
-     *  -> no cash input is possible
-     *  -> coins are in cache
-     */
-    void cashInputFinished(nsDeviceControllerInterface::RESULT_STATE resultState,
-                                     const QString & newCashValue,
-                                     /*  additional variables? */
-                                     const QString & errorCode,
-                                     const QString & errorDescription);
-
-
-    /**
-     * emitted e.g. if service door is opened
-     */
-    void requestModeSERVICE();
-
-    /**
-     * emitted e.g. if doors are closed
-     */
-    void requestModeIDLE();
-
-    /**
-     * emitted e.g. on severe errors
-     */
-    void requestModeOOO();
-
-    /**
-     * emitted e.g. if service door is opened
-     */
-    void requestAccountResponse(const QHash<QString, QVariant> & accountData);
-
-
-
-
-
-    /**
-     * emitted on error
-     * depending on errorCode:
-     * -> interrupt selling process
-     * -> machine can go to state OOO
-     * -> send error event to ISMAS
-     * -> ...
-     */
-    void Error(
-            /*  additional variables? */
-            const QString & errorCode,
-            const QString & errorDescription);
-
 };
 
-
 Q_DECLARE_INTERFACE(DeviceControllerInterface,
                     "eu.atb.ptu.plugin.DeviceControllerInterface/1.0")
 
-
-namespace nsDeviceControllerInterface {
-
-    enum class PLUGIN_STATE : quint8 {
-        NOT_INITIALIZED = 0,
-        INITIALIZED = 1
-    };
-
-    enum class RESULT_STATE : quint8 {
-        SUCCESS = 1,                // operation was successfull
-        ERROR_BACKEND,              // error from backend (e.g. backend replies with error)
-        ERROR_TIMEOUT,              // the operation timed out
-        ERROR_PROCESS,              // internal plugin error, should not occur (this is a bug in implementation)
-        ERROR_RETRY,                // retry operation
-        INFO                        // informational (e.g. display a message, log something etc.)
-    };
-
-    enum class CASH_STATE   : quint8 {
-        CACHE_EMPTY,                // Cache still empty, default state
-        CACHE_INPUT,                // Coins are in Cache
-        OVERPAYED,
-        /* t.b.d. */
-    };
-
-
-    enum class TICKET_VARIANT : quint8 {
-        PARKING_TICKET,
-        RECEIPT,
-        ERROR_RECEIPT,
-        START_RECEIPT,   // e.g. Szeged Start
-        STOP_RECEIPT,    // e.g. Szeged Stop
-    };
-
-}
-
 #endif // DEVICECONTROLLERINTERFACE_H

src/ATBAPP/UnifiedDCInterface.cpp

@@ -0,0 +1,19 @@
+#include "DeviceControllerInterface.h"
+
+
+using UNIFIED_PLUGIN_STATE = UnifiedDCVMCInterface<DeviceControllerInterface>::UNIFIED_PLUGIN_STATE;
+
+
+template<>
+UNIFIED_PLUGIN_STATE UnifiedDCVMCInterface<DeviceControllerInterface>::initPlugin(QObject *eventReceiver, QSettings const &settings) {
+
+
+    switch(static_cast<DeviceControllerInterface*>(this)->initDCPlugin(eventReceiver, settings)) {
+    case nsDeviceControllerInterface::PLUGIN_STATE::INITIALIZED:
+        return UNIFIED_PLUGIN_STATE::INITIALIZED;
+    case nsDeviceControllerInterface::PLUGIN_STATE::NOT_INITIALIZED:
+        return UNIFIED_PLUGIN_STATE::NOT_INITIALIZED;
+    }
+
+    return UNIFIED_PLUGIN_STATE::NOT_INITIALIZED;
+}

src/ATBAPP/UnifiedDCVMCInterface.h

@@ -0,0 +1,147 @@
+#ifndef UNIFIED_DCVMC_INTERFACE_H_INCLUDED
+#define UNIFIED_DCVMC_INTERFACE_H_INCLUDED
+
+#include <QObject>
+#include <QSettings>
+
+#include <QtPlugin>
+
+#include <QSettings>
+#include <QString>
+
+#include "ATBAPPplugin.h"
+
+class UnifiedDCVMCInterface : public QObject, public ATBAPPplugin {
+
+    Q_OBJECT
+    Q_INTERFACES(ATBAPPplugin)
+
+public:
+    enum class PLUGIN_STATE : quint8 {
+        NOT_INITIALIZED = 0,
+        INITIALIZED = 1
+    };
+    enum class RESULT_STATE : quint8 {
+        SUCCESS = 1,                // operation was successfull
+        ERROR_BACKEND,              // error from backend (e.g. backend replies with error)
+        ERROR_TIMEOUT,              // the operation timed out
+        ERROR_PROCESS,              // internal plugin error, should not occur (this is a bug in implementation)
+        ERROR_RETRY,                // retry operation
+        INFO                        // informational (e.g. display a message, log something etc.)
+    };
+    enum class CASH_STATE   : quint8 {
+        CACHE_EMPTY,                // Cache still empty, default state
+        CACHE_INPUT,                // Coins are in Cache
+        OVERPAYED,
+        /* t.b.d. */
+    };
+    enum class TICKET_VARIANT : quint8 {
+        PARKING_TICKET,
+        RECEIPT,
+        ERROR_RECEIPT,
+        START_RECEIPT,   // e.g. Szeged Start
+        STOP_RECEIPT,    // e.g. Szeged Stop
+    };
+
+    explicit UnifiedDCVMCInterface() = default;
+    virtual ~UnifiedDCVMCInterface() {}
+
+    virtual PLUGIN_STATE initPlugin(QObject *eventReceiver, QSettings const &settings) = 0;
+
+    // mandantory ATBAPP plugin methods:
+    virtual PLUGIN_STATE getState() = 0;
+    virtual QString getLastError() = 0;
+    virtual QString getLastErrorDescription() = 0;
+
+    virtual QString getString(RESULT_STATE resultState) = 0;
+
+public slots:
+    virtual void onChangedProgramModeToSELL() = 0;
+    virtual void onChangedProgramModeToSERVICE() = 0;
+    virtual void onChangedProgramModeToIDLE() = 0;
+    virtual void onChangedProgramModeToOOO() = 0;
+
+    virtual void startPhysicalLayer() = 0;
+    virtual void stopPhysicalLayer() = 0;
+    virtual void reboot() = 0;
+    virtual void reset() = 0;
+
+signals:
+    void printTicketFinished(RESULT_STATE resultState,
+                             const QString & errorCode,
+                             const QString & errorDescription);
+    void printReceiptFinished(RESULT_STATE resultState,
+                              const QString & errorCode,
+                              const QString & errorDescription);
+
+    /**
+     * emitted on e.g. a coin input
+     */
+    void cashInputEvent(RESULT_STATE resultState,
+                                CASH_STATE cashState,
+                                const QString & newCashValue,
+                                /* additional variables? */
+                                const QString & errorCode,
+                                const QString & errorDescription);
+
+    /**
+     * emitted if cashInput has been stopped, e.g. in result to task requestStopCashInput():
+     *  -> shutter is blocked
+     *  -> no cash input is possible
+     *  -> coins are in cache
+     */
+    void cashInputFinished(RESULT_STATE resultState,
+                                     const QString & newCashValue,
+                                     /*  additional variables? */
+                                     const QString & errorCode,
+                                     const QString & errorDescription);
+
+
+    /**
+     * emitted e.g. if service door is opened
+     */
+    void requestModeSERVICE();
+
+    /**
+     * emitted e.g. if doors are closed
+     */
+    void requestModeIDLE();
+
+    /**
+     * emitted e.g. on severe errors
+     */
+    void requestModeOOO();
+
+    /**
+     * emitted e.g. if service door is opened
+     */
+    void requestAccountResponse(const QHash<QString, QVariant> & accountData);
+
+
+
+
+
+    /**
+     * emitted on error
+     * depending on errorCode:
+     * -> interrupt selling process
+     * -> machine can go to state OOO
+     * -> send error event to ISMAS
+     * -> ...
+     */
+    void Error(
+            /*  additional variables? */
+            const QString & errorCode,
+            const QString & errorDescription);
+
+};
+
+Q_DECLARE_INTERFACE(UnifiedDCVMCInterface,
+                    "eu.atb.ptu.plugin.UnifiedDCVMCInterface/1.0")
+
+using PLUGIN_STATE = UnifiedDCVMCInterface::PLUGIN_STATE;
+using RESULT_STATE = UnifiedDCVMCInterface::RESULT_STATE;
+using CASH_STATE = UnifiedDCVMCInterface::CASH_STATE;
+using TICKET_VARIANT = UnifiedDCVMCInterface::TICKET_VARIANT;
+
+#endif // UNIFIED_DCVMC_INTERFACE_H_INCLUDED