DCState: send EVENT_CLASS::STATE as eventName "Mxxxx"

Ticket helper methods e.g. string format helpers.
Currently only on method for getting a date string in short format
according to selected language.

DCPlugin.pro

@@ -88,7 +88,8 @@ HEADERS += \
     src/ATBAPP/support/JSON.h \
     src/ATBAPP/support/PTUSystem.h \
     src/ATBAPP/support/PersistentData.h \
-    src/ATBAPP/support/Ticket.h
+    src/ATBAPP/support/Ticket.h \
+    src/ATBAPP/support/TicketUtils.h
 
 SOURCES += \
     src/ATBAPP/ATBHealthEvent.cpp \
@@ -101,7 +102,8 @@ SOURCES += \
     src/ATBAPP/support/JSON.cpp \
     src/ATBAPP/support/PTUSystem.cpp \
     src/ATBAPP/support/PersistentData.cpp \
-    src/ATBAPP/support/Ticket.cpp
+    src/ATBAPP/support/Ticket.cpp \
+    src/ATBAPP/support/TicketUtils.cpp
 
 DISTFILES += \
     generate-version.sh

src/ATBAPP/ATBDeviceControllerPlugin.cpp

@@ -6,6 +6,7 @@
 #include "src/ATBAPP/support/DBusControllerInterface.h"
 #include "src/ATBAPP/support/PTUSystem.h"
 #include "src/ATBAPP/support/CashUtils.h"
+#include "src/ATBAPP/support/TicketUtils.h"
 
 #include <QTimer>
 #include <QThread>
@@ -310,6 +311,73 @@ void ATBDeviceControllerPlugin::cashCollect()
     }
 }
 
+
+void ATBDeviceControllerPlugin::cashCollect(const QString & amount)
+{
+    if (this->coinProcessor() != nsDeviceControllerInterface::COIN_PROCESSOR::CHANGER) {
+        this->cashCollect();
+        return;
+    }
+
+    // check if we must change coins:
+
+    // inserted amount
+    uint32_t amountInsertedInt = this->hw->getInsertedAmount();
+
+    bool ok;
+    uint32_t amountToPayInt = amount.toInt(&ok);
+
+    // check if we must change coins:
+    if (amountInsertedInt > amountToPayInt) {
+
+        uint32_t amountToChangeInt = amountInsertedInt - amountToPayInt;
+
+        qCritical() << "cashCollect(" << amount << ")";
+        qCritical() << "             amount to change: " << QString::number(amountToChangeInt);
+
+
+        // trigger changer:
+        emit this->cashPaymentChanging(nsDeviceControllerInterface::RESULT_STATE::SUCCESS,
+                                       QString::number(amountToChangeInt),
+                                       "",    // ErrorCode
+                                       "");   // ErrorDescription
+
+        // change
+        hw->changer_returnCoins(amountToChangeInt);
+
+        QTimer::singleShot(1000, this, &ATBDeviceControllerPlugin::onCashChangerState);
+
+    }
+    else {
+        // nothing to change:
+
+        qCritical() << "cashCollect(" << amount << ")";
+        qCritical() << "             nothing to change. ";
+
+
+        hw->vend_success();
+
+        QString amountString = QString::number(amountInsertedInt);
+
+        // inserted coins
+        uint32_t amountCoinsInt = CashUtils::getAmountOfInsertedCoins(this->hw);
+        QString amountCoinsString = QString::number(amountCoinsInt);
+
+        // inserted notes
+        uint32_t amountNotesInt = CashUtils::getAmountOfInsertedNotes(this->hw);
+        QString amountNotesString = QString::number(amountNotesInt);
+
+        emit this->cashPaymentFinished(nsDeviceControllerInterface::RESULT_STATE::SUCCESS,
+                                  amountString,
+                                  amountCoinsString,        // coins
+                                  amountNotesString,        // notes
+                                  0,                        // proposed change
+                                  "",
+                                  "");
+        this->currentCashState = CASH_STATE::CACHE_EMPTY;
+    }
+}
+
 void ATBDeviceControllerPlugin::cashAbort()
 {
     hw->vend_failed();
@@ -579,7 +647,7 @@ void ATBDeviceControllerPlugin::onNewVoltage(uint32_t voltage)
     json = JSON::objectBuilder()
                   ->set("Name", "batt")
                   ->set("Value", voltageString)
-                  ->set("Unit", "V")
+                  ->set("Unit", "mV")
             ->create();
 
 
@@ -724,15 +792,31 @@ void ATBDeviceControllerPlugin::requestPrintTicket(const QHash<QString, QVariant
 
     qCritical() << "ATBDeviceControllerPlugin::requestPrintTicket( "         << endl
                 << "     licenseplate = " << printingData["licenseplate"]    << endl
+                << "      productText = " << printingData["productText"]     << endl
                 << "           amount = " << printingData["amount"]          << endl
                 << "       parkingEnd = " << printingData["parkingEnd"]      << endl
-                << "  currentDateTime = " << printingData["currentDateTime"] << endl;
+                << "  currentDateTime = " << printingData["currentDateTime"] << endl
+                << "     ticketNumber = " << printingData["ticketNumber"]    << endl;
 
-    QDateTime parkingEndDateTime = QDateTime::fromString(printingData["parkingEnd"].toString(),  Qt::ISODate);
+    QDateTime parkingEndDateTime = QDateTime::fromString(printingData["parkingEnd"].toString(),      Qt::ISODate);
     QDateTime currentDateTime    = QDateTime::fromString(printingData["currentDateTime"].toString(), Qt::ISODate);
 
-    QString parkingEndDateString = this->printerLocale.toString(parkingEndDateTime.date(), QLocale::ShortFormat);
-    QString currentDateString    = this->printerLocale.toString(currentDateTime.date(),    QLocale::ShortFormat);
+    QString parkingEndDateString = TicketUtils::getLocaleDateString(this->printerLocale, parkingEndDateTime.date());
+    QString currentDateString    = TicketUtils::getLocaleDateString(this->printerLocale, currentDateTime.date());
+
+    /*******************************************************************************************
+     *  TEST date formate strings:
+    QLocale ltLocale("lt_LT");
+    QLocale deLocale("de_DE");
+
+    QString ltShortDate = ltLocale.toString(currentDateTime.date(), QLocale::ShortFormat);
+    QString deShortDate = deLocale.toString(currentDateTime.date(), QLocale::ShortFormat);
+
+    qCritical() << "*********************************************************************";
+    qCritical() << "   ltShortDate = " << ltShortDate;
+    qCritical() << "   deShortDate = " << deShortDate;
+    qCritical() << "*********************************************************************";
+     */
 
     /* -----------------------------------------------------------------------------------------
      * note: the following highly depends on printer template files!
@@ -758,6 +842,13 @@ void ATBDeviceControllerPlugin::requestPrintTicket(const QHash<QString, QVariant
     QByteArray ba_currentDate = codec->fromUnicode(currentDateString);
     memcpy((char*)dynTicketData->currentDate,  ba_currentDate.data(), std::min(ba_currentDate.size(),8));
 
+    // Product-Text
+    QByteArray ba_productText = codec->fromUnicode(printingData["productText"].toString());
+    memcpy((char*)dynTicketData->dynDat5,      ba_productText.data(), std::min(ba_productText.size(),8));
+
+    // Ticket-Number
+    QByteArray ba_ticketNumber = codec->fromUnicode(printingData["ticketNumber"].toString());
+    memcpy((char*)dynTicketData->dynDat7,      ba_ticketNumber.data(), std::min(ba_ticketNumber.size(),8));
 
     // DEBUG
     /*
@@ -791,7 +882,8 @@ void ATBDeviceControllerPlugin::requestPrintTicket(const QHash<QString, QVariant
                     << "           amount = " << printingData["amount"]         << endl
                     << "       parkingEnd = " << printingData["parkingEnd"]     << endl
                     << "      currentTime = " << printingData["currentTime"]    << endl
-                    << "      currentDate = " << printingData["currentDate"]    << endl;
+                    << "      currentDate = " << printingData["currentDate"]    << endl
+                    << "     ticketNumber = " << printingData["ticketNumber"]   << endl;
 
 
         this->onPrintFinishedERR();
@@ -1051,9 +1143,8 @@ void ATBDeviceControllerPlugin::private_setupDynTemplateData_START_RECEIPT(struc
     QDateTime parkingEndDateTime = QDateTime::fromString(ticket->getPrintingData()["parkingEnd"].toString(),  Qt::ISODate);
     QDateTime currentDateTime    = QDateTime::fromString(ticket->getPrintingData()["currentDateTime"].toString(), Qt::ISODate);
 
-    QString parkingEndDateString = this->printerLocale.toString(parkingEndDateTime.date(), QLocale::ShortFormat);
-    QString currentDateString    = this->printerLocale.toString(currentDateTime.date(),    QLocale::ShortFormat);
-
+    QString parkingEndDateString = TicketUtils::getLocaleDateString(this->printerLocale, parkingEndDateTime.date());
+    QString currentDateString    = TicketUtils::getLocaleDateString(this->printerLocale, currentDateTime.date());
 
     // set dynamic printer data:
     QByteArray ba_licenseplate = codec->fromUnicode(ticket->getPrintingData()["licenseplate"].toString());
@@ -1147,7 +1238,7 @@ void ATBDeviceControllerPlugin::private_setupDynTemplatData_FINE_PAYMENT(struct
     memcpy((char*)dynTicketData->currentDate,   ba_currentDate.data(), std::min(ba_currentDate.size(),8));
 
     QByteArray ba_ticketId = codec->fromUnicode(ticket->getPrintingData()["ticketId"].toString());
-    memcpy((char*)dynTicketData->dynDat7,       ba_amount.data(), std::min(ba_ticketId.size(),8));
+    memcpy((char*)dynTicketData->dynDat7,       ba_ticketId.data(), std::min(ba_ticketId.size(),8));
 }
 
 
@@ -1178,7 +1269,7 @@ void ATBDeviceControllerPlugin::private_setupDynTemplatData_FREE_TICKET(struct T
     QByteArray ba_parkingEndTime = codec->fromUnicode(parkingEndDateTime.toString("hh:mm"));
     memcpy((char*)dynTicketData->parkingEnd,  ba_parkingEndTime.data(), std::min(ba_parkingEndTime.size(),8));
 
-    QString parkingEndDateString = this->printerLocale.toString(parkingEndDateTime.date(), QLocale::ShortFormat);
+    QString parkingEndDateString = TicketUtils::getLocaleDateString(this->printerLocale, parkingEndDateTime.date());
 
     QByteArray ba_parkingEndDate = codec->fromUnicode(parkingEndDateString);
     memcpy((char*)dynTicketData->currentTime,  ba_parkingEndDate.data(), std::min(ba_parkingEndDate.size(),8));
@@ -1242,8 +1333,8 @@ void ATBDeviceControllerPlugin::onCashPayStopByEscrow()
                               "",
                               "",
                               "",
-                              "",
-                              "");
+                              "CashPayStopByEscrow",
+                              "CashPayStopByEscrow");
 }
 
 void ATBDeviceControllerPlugin::onCashPayStopByError()
@@ -1260,8 +1351,8 @@ void ATBDeviceControllerPlugin::onCashPayStopByError()
                               "",
                               "",
                               "",
-                              "",
-                              "");
+                              "onCashPayStopByError",
+                              "onCashPayStopByError");
 }
 
 void ATBDeviceControllerPlugin::onCashPayStopByTimeout()
@@ -1278,8 +1369,8 @@ void ATBDeviceControllerPlugin::onCashPayStopByTimeout()
                               "",
                               "",
                               "",
-                              "",
-                              "");
+                              "CashPayStopByTimeout",
+                              "CashPayStopByTimeout");
 }
 
 void ATBDeviceControllerPlugin::onCashPayStopedSuccess()
@@ -1424,6 +1515,10 @@ void ATBDeviceControllerPlugin::onCashChangerState()
                                   "");
         changerStateRequestCounter = 0;
         lastChangerResult = 0;
+
+        // finalize vending:
+        hw->vend_success();
+
         return;
     }
     else
@@ -1478,6 +1573,10 @@ void ATBDeviceControllerPlugin::onCashChangerState()
                                   errorDescription);
         changerStateRequestCounter = 0;
         lastChangerResult = 0;
+
+        // finalize vending:
+        hw->vend_success();
+
         return;
     }
 
@@ -1617,6 +1716,7 @@ void ATBDeviceControllerPlugin::onWokeUp(uchar source)
 {
     if (source == 0x01 || source == 0xFE) {
         // woke up from device controller
+        hw->dc_autoRequest(true);
         this->diag->diagRequest();
     }
 }

src/ATBAPP/ATBDeviceControllerPlugin.h

@@ -50,6 +50,7 @@ public:
     void requestStartCashInput(const QString & amount);
     void requestStopCashInput();
     void cashCollect();
+    void cashCollect(const QString & amount);
     void cashAbort();
 
     // read coin/cash processing variants -----------------------------------------

src/ATBAPP/DeviceControllerDiag.cpp

@@ -135,6 +135,7 @@ void DeviceControllerDiag::private_startDiag()
         qCritical() << "DeviceControllerDiag::private_startDiag() DCdata is +++not+++ valid";
 
         // try it again
+        hw->dc_autoRequest(true);
         QTimer::singleShot(200, this, &DeviceControllerDiag::private_startDiag);
     }
 }
@@ -142,8 +143,8 @@ void DeviceControllerDiag::private_startDiag()
 void DeviceControllerDiag::sys_superviseSystem()
 {    // this function proofs if vending is possible depending of doors state
 
-    struct T_dynamicCondition dynMaCond;
-    struct T_moduleCondition  modCond;
+    struct T_dynamicCondition dynMaCond = {};
+    struct T_moduleCondition  modCond = {};
 
 
     qCritical() << "      sys_superviseSystem()";
@@ -164,7 +165,8 @@ void DeviceControllerDiag::sys_superviseSystem()
     {
         // es gibt keinerlei gültige Daten vom DC
         qCritical() << "DeviceControllerDiag::sys_superviseSystem() no valid data!";
-        this->private_sendDiagEvent(DeviceController::State::E254);
+        hw->dc_autoRequest(true);
+        this->private_sendDiagEvent(DeviceController::State::M0254);
         this->diagRequestTimeoutTimer->stop();
         this->isRequestRunning  = false;
         if (this->E255counter > 5) { this->restartCArun(); }
@@ -202,13 +204,13 @@ void DeviceControllerDiag::sub_componentAssessment()
 {
     bool flag_sendOperate = true;
 
-    struct T_moduleCondition modCond;
+    struct T_moduleCondition modCond = {};
     hw->sys_getDeviceConditions(&modCond);
 
-    struct T_dynamicCondition dynMaCond;
+    struct T_dynamicCondition dynMaCond = {};
     hw->sys_getDynMachineConditions(&dynMaCond);
 
-    struct T_devices devPara;
+    struct T_devices devPara = {};
     hw->sys_restoreDeviceParameter(&devPara);
 
     // store some interesting results:
@@ -230,13 +232,13 @@ void DeviceControllerDiag::sub_componentAssessment()
         // Service or battery door is open
         flag_sendOperate = false;
         qCritical() << "DeviceControllerDiag::sys_superviseSystem() Service or battery door is open, goto INTRUSION MODE";
-        this->private_sendDiagEvent(DeviceController::State::E253);
+        this->private_sendDiagEvent(DeviceController::State::M0253);
     }
     if (dynMaCond.middleDoor) {
         // vault door is open
         flag_sendOperate = false;
         qCritical() << "DeviceControllerDiag::sys_superviseSystem() vault door is open, goto INTRUSION MODE";
-        this->private_sendDiagEvent(DeviceController::State::E252);
+        this->private_sendDiagEvent(DeviceController::State::M0252);
     }
 
     // check for invalid states:
@@ -364,12 +366,12 @@ void DeviceControllerDiag::sub_componentAssessment()
 
     if (dynMaCond.nowCardTest>0) {
         flag_sendOperate = false;
-        this->private_sendDiagEvent(DeviceController::State::E072);
+        this->private_sendDiagEvent(DeviceController::State::M0072);
     }
 
     if (dynMaCond.startupTestIsRunning>0) {
         flag_sendOperate = false;
-        this->private_sendDiagEvent(DeviceController::State::E073);
+        this->private_sendDiagEvent(DeviceController::State::M0073);
     }
 
     if (modCond.voltage>=200) {
@@ -524,28 +526,28 @@ void DeviceControllerDiag::private_sendDiagEvent(DeviceController::State result)
         this->_isErrorState = true;
         break;
 
-    case DeviceController::State::E071:   // cash box change is ongoing
+    case DeviceController::State::M0071:   // cash box change is ongoing
         eventClass = EVENT_CLASS::STATE;
         parameter  = "cash box change is ongoing";
         break;
-    case DeviceController::State::E072:   // card test running
+    case DeviceController::State::M0072:   // card test running
         eventClass = EVENT_CLASS::STATE;
         parameter  = "card test running";
         break;
-    case DeviceController::State::E073:   // startup-test is running
+    case DeviceController::State::M0073:   // startup-test is running
         eventClass = EVENT_CLASS::STATE;
         parameter  = "startup-test is running";
         break;
 
-    case DeviceController::State::E252:   // cash box door open
+    case DeviceController::State::M0252:   // cash box door open
         eventClass = EVENT_CLASS::STATE;
         parameter  = "cash box door open";
         break;
-    case DeviceController::State::E253:   // service or battery door open
+    case DeviceController::State::M0253:   // service or battery door open
         eventClass = EVENT_CLASS::STATE;
         parameter  = "service or battery door open";
         break;
-    case DeviceController::State::E254:   // no valid data from DeviceController
+    case DeviceController::State::M0254:   // no valid data from DeviceController
         eventClass = EVENT_CLASS::STATE;
         parameter  = "no valid data from DeviceController";
         break;
@@ -606,7 +608,7 @@ void DeviceControllerDiag::private_sendDiagEvent(DeviceController::State result)
                 "DC",
                 eventClass,
                 eventName,
-                1,
+                1,         // eventState
                 parameter,
                 ""         // second level info
                 );

src/ATBAPP/DeviceControllerDiag.h

@@ -41,13 +41,14 @@ namespace DeviceController {
 
         E034,
 
-        E071,
-        E072,
-        E073,
+        M0071, // cashbox change is ongoing
+        M0072, // cardtest is running
+        M0073, // startup-test is running
+
+        M0252, // cashbox door open
+        M0253, // service or battery door is open
+        M0254, // no valid data from DC
 
-        E252,
-        E253,
-        E254,
         E255,
 
         W001,

src/ATBAPP/DeviceControllerInterface.h

@@ -60,9 +60,10 @@ public:
     virtual void requestStopCashInput() = 0;
 
     /**
-     * called e.g. on Button "NEXT" in pay-up (direct coin input)
+     * called e.g. after printing
      */
     virtual void cashCollect() = 0;
+    virtual void cashCollect(const QString & amount) = 0;
     virtual void cashAbort() = 0;
 
     // TASKS: Account -------------------------------------------------------------
@@ -138,6 +139,14 @@ signals:
                                      const QString & errorCode,
                                      const QString & errorDescription);
 
+    /**
+     * emitted if cashPayment has been finished, e.g. in result to task cashCollect():
+     * if coins in changer must be given back to user.
+     */
+    void cashPaymentChanging(nsDeviceControllerInterface::RESULT_STATE resultState,
+                                     const QString & changeValue,        // amount changed by changer/escrow
+                                     const QString & errorCode,
+                                     const QString & errorDescription);
     /**
      * emitted if cashPayment has been finished, e.g. in result to task cashCollect():
      *  -> ticket should be printed sucessfully
@@ -145,7 +154,7 @@ signals:
      * Provides data for logging, especially changed value
      */
     void cashPaymentFinished(nsDeviceControllerInterface::RESULT_STATE resultState,
-                                     const QString & newCashValue,  // total inserted amount amount
+                                     const QString & newCashValue,  // total inserted amount
                                      const QString & coinValue,     // inserted amount, paid with coins
                                      const QString & noteValue,     // inserted amount, paid with notes
                                      const QString & changeValue,   // amount changed by changer/escrow
@@ -203,7 +212,7 @@ signals:
 
 
 Q_DECLARE_INTERFACE(DeviceControllerInterface,
-                    "eu.atb.ptu.plugin.DeviceControllerInterface/1.1.6")
+                    "eu.atb.ptu.plugin.DeviceControllerInterface/1.2.0")
 
 
 namespace nsDeviceControllerInterface {

src/ATBAPP/support/Ticket.cpp

@@ -172,6 +172,9 @@ QDebug operator<<(QDebug debug, TICKET_VARIANT ticketVariant)
         case TICKET_VARIANT::FOOD_STAMP:
             debug << "TICKET_VARIANT::FOOD_STAMP";
             break;
+        case TICKET_VARIANT::FREE_TICKET:
+            debug << "TICKET_VARIANT::FREE_TICKET";
+            break;
     }
 
     return debug;

src/ATBAPP/support/TicketUtils.cpp

@@ -0,0 +1,26 @@
+#include "TicketUtils.h"
+
+#include <QLocale>
+#include <QDate>
+
+TicketUtils::TicketUtils(QObject *parent) : QObject(parent)
+{
+
+}
+
+
+QString TicketUtils::getLocaleDateString(const QLocale & qLocale, const QDate & qDate)
+{
+    QString dateString;
+
+    if (qLocale.language() == QLocale::Lithuanian) {
+        // QLocale::ShortFormat produces date string: "yyyy-mm-dd" ...
+        // this is to long for the printer.
+        dateString = qDate.toString("yy-MM-dd");
+    }
+    else {
+        dateString = qLocale.toString(qDate, QLocale::ShortFormat);
+    }
+
+    return dateString;
+}

src/ATBAPP/support/TicketUtils.h

@@ -0,0 +1,34 @@
+#ifndef TICKETUTILS_H
+#define TICKETUTILS_H
+
+#include <QObject>
+
+class TicketUtils : public QObject
+{
+    Q_OBJECT
+public:
+    explicit TicketUtils(QObject *parent = nullptr);
+
+    /**
+     * @brief getLocaleDateString
+     * @param qLocale
+     * @param qDate
+     * @return a localized date string short format
+     *
+     * Note QLocale::ShortFormat does not result to the
+     * string we need for ticket printing therefore this
+     * helper method was created.
+     *
+     * e.g. using Lithuanian (lt_LT) we get a date in short format:
+     *      "2024-08-08" unfortunately this is to long, we need
+     * the year with only two digits.
+     * e.g. in German (de_DE) it is enought: "08.08.24"
+     *
+     */
+    static QString getLocaleDateString(const QLocale &qLocale, const QDate &qDate);
+
+signals:
+
+};
+
+#endif // TICKETUTILS_H