upgrade v201 compat in MicroOcpp.h

Author: matth-x

src/MicroOcpp.cpp

@@ -293,6 +293,8 @@ void mocpp_initialize(Connection& connection, const char *bootNotificationCreden
             new TransactionService(*context, filesystem, MO_NUM_EVSEID)));
         model.setRemoteControlService(std::unique_ptr<RemoteControlService>(
             new RemoteControlService(*context, MO_NUM_EVSEID)));
+        model.setResetServiceV201(std::unique_ptr<Ocpp201::ResetService>(
+            new Ocpp201::ResetService(*context)));
     } else
 #endif
     {
@@ -305,20 +307,24 @@ void mocpp_initialize(Connection& connection, const char *bootNotificationCreden
             connectors.emplace_back(new Connector(*context, filesystem, connectorId));
         }
         model.setConnectors(std::move(connectors));
-    }
-    model.setHeartbeatService(std::unique_ptr<HeartbeatService>(
-        new HeartbeatService(*context)));
 
 #if MO_ENABLE_LOCAL_AUTH
-    model.setAuthorizationService(std::unique_ptr<AuthorizationService>(
-        new AuthorizationService(*context, filesystem)));
+        model.setAuthorizationService(std::unique_ptr<AuthorizationService>(
+            new AuthorizationService(*context, filesystem)));
 #endif //MO_ENABLE_LOCAL_AUTH
 
 #if MO_ENABLE_RESERVATION
-    model.setReservationService(std::unique_ptr<ReservationService>(
-        new ReservationService(*context, MO_NUMCONNECTORS)));
+        model.setReservationService(std::unique_ptr<ReservationService>(
+            new ReservationService(*context, MO_NUMCONNECTORS)));
 #endif
 
+        model.setResetService(std::unique_ptr<ResetService>(
+            new ResetService(*context)));
+    }
+
+    model.setHeartbeatService(std::unique_ptr<HeartbeatService>(
+        new HeartbeatService(*context)));
+
 #if MO_ENABLE_CERT_MGMT && MO_ENABLE_CERT_STORE_MBEDTLS
     std::unique_ptr<CertificateStore> certStore = makeCertificateStoreMbedTLS(filesystem);
     if (certStore) {
@@ -330,18 +336,6 @@ void mocpp_initialize(Connection& connection, const char *bootNotificationCreden
     }
 #endif
 
-#if MO_ENABLE_V201
-    if (version.major == 2) {
-        //depends on VariableService
-        model.setResetServiceV201(std::unique_ptr<Ocpp201::ResetService>(
-            new Ocpp201::ResetService(*context)));
-    } else
-#endif
-    {
-        model.setResetService(std::unique_ptr<ResetService>(
-            new ResetService(*context)));
-    }
-
 #if !defined(MO_CUSTOM_UPDATER)
 #if MO_PLATFORM == MO_PLATFORM_ARDUINO && defined(ESP32) && MO_ENABLE_MBEDTLS
     model.setFirmwareService(
@@ -376,6 +370,12 @@ void mocpp_initialize(Connection& connection, const char *bootNotificationCreden
 
     configuration_load();
 
+#if MO_ENABLE_V201
+    if (version.major == 2) {
+        model.getVariableService()->load();
+    }
+#endif //MO_ENABLE_V201
+
     MO_DBG_INFO("initialized MicroOcpp v" MO_VERSION " running OCPP %i.%i.%i", version.major, version.minor, version.patch);
 }
 
@@ -422,48 +422,105 @@ void mocpp_loop() {
     context->loop();
 }
 
-std::shared_ptr<Transaction> beginTransaction(const char *idTag, unsigned int connectorId) {
+bool beginTransaction(const char *idTag, unsigned int connectorId) {
     if (!context) {
         MO_DBG_ERR("OCPP uninitialized"); //need to call mocpp_initialize before
-        return nullptr;
+        return false;
+    }
+
+    #if MO_ENABLE_V201
+    if (context->getVersion().major == 2) {
+        if (!idTag || strnlen(idTag, MO_IDTOKEN_LEN_MAX + 2) > MO_IDTOKEN_LEN_MAX) {
+            MO_DBG_ERR("idTag format violation. Expect c-style string with at most %u characters", MO_IDTOKEN_LEN_MAX);
+            return false;
+        }
+        TransactionService::Evse *evse = nullptr;
+        if (auto txService = context->getModel().getTransactionService()) {
+            evse = txService->getEvse(connectorId);
+        }
+        if (!evse) {
+            MO_DBG_ERR("could not find EVSE");
+            return false;
+        }
+        return evse->beginAuthorization(idTag, true);
     }
+    #endif
+
     if (!idTag || strnlen(idTag, IDTAG_LEN_MAX + 2) > IDTAG_LEN_MAX) {
         MO_DBG_ERR("idTag format violation. Expect c-style string with at most %u characters", IDTAG_LEN_MAX);
-        return nullptr;
+        return false;
     }
     auto connector = context->getModel().getConnector(connectorId);
     if (!connector) {
         MO_DBG_ERR("could not find connector");
-        return nullptr;
+        return false;
     }
 
-    return connector->beginTransaction(idTag);
+    return connector->beginTransaction(idTag) != nullptr;
 }
 
-std::shared_ptr<Transaction> beginTransaction_authorized(const char *idTag, const char *parentIdTag, unsigned int connectorId) {
+bool beginTransaction_authorized(const char *idTag, const char *parentIdTag, unsigned int connectorId) {
     if (!context) {
         MO_DBG_ERR("OCPP uninitialized"); //need to call mocpp_initialize before
-        return nullptr;
+        return false;
+    }
+
+    #if MO_ENABLE_V201
+    if (context->getVersion().major == 2) {
+        if (!idTag || strnlen(idTag, MO_IDTOKEN_LEN_MAX + 2) > MO_IDTOKEN_LEN_MAX) {
+            MO_DBG_ERR("idTag format violation. Expect c-style string with at most %u characters", MO_IDTOKEN_LEN_MAX);
+            return false;
+        }
+        TransactionService::Evse *evse = nullptr;
+        if (auto txService = context->getModel().getTransactionService()) {
+            evse = txService->getEvse(connectorId);
+        }
+        if (!evse) {
+            MO_DBG_ERR("could not find EVSE");
+            return false;
+        }
+        return evse->beginAuthorization(idTag, false);
     }
+    #endif
+
     if (!idTag || strnlen(idTag, IDTAG_LEN_MAX + 2) > IDTAG_LEN_MAX ||
         (parentIdTag && strnlen(parentIdTag, IDTAG_LEN_MAX + 2) > IDTAG_LEN_MAX)) {
         MO_DBG_ERR("(parent)idTag format violation. Expect c-style string with at most %u characters", IDTAG_LEN_MAX);
-        return nullptr;
+        return false;
     }
     auto connector = context->getModel().getConnector(connectorId);
     if (!connector) {
         MO_DBG_ERR("could not find connector");
-        return nullptr;
+        return false;
     }
 
-    return connector->beginTransaction_authorized(idTag, parentIdTag);
+    return connector->beginTransaction_authorized(idTag, parentIdTag) != nullptr;
 }
 
 bool endTransaction(const char *idTag, const char *reason, unsigned int connectorId) {
     if (!context) {
         MO_DBG_ERR("OCPP uninitialized"); //need to call mocpp_initialize before
         return false;
     }
+
+    #if MO_ENABLE_V201
+    if (context->getVersion().major == 2) {
+        if (!idTag || strnlen(idTag, MO_IDTOKEN_LEN_MAX + 2) > MO_IDTOKEN_LEN_MAX) {
+            MO_DBG_ERR("idTag format violation. Expect c-style string with at most %u characters", MO_IDTOKEN_LEN_MAX);
+            return false;
+        }
+        TransactionService::Evse *evse = nullptr;
+        if (auto txService = context->getModel().getTransactionService()) {
+            evse = txService->getEvse(connectorId);
+        }
+        if (!evse) {
+            MO_DBG_ERR("could not find EVSE");
+            return false;
+        }
+        return evse->endAuthorization(idTag, true);
+    }
+    #endif
+
     bool res = false;
     if (isTransactionActive(connectorId) && getTransactionIdTag(connectorId)) {
         //end transaction now if either idTag is nullptr (i.e. force stop) or the idTag matches beginTransaction
@@ -524,6 +581,25 @@ bool endTransaction_authorized(const char *idTag, const char *reason, unsigned i
         MO_DBG_ERR("OCPP uninitialized"); //need to call mocpp_initialize before
         return false;
     }
+
+    #if MO_ENABLE_V201
+    if (context->getVersion().major == 2) {
+        if (!idTag || strnlen(idTag, MO_IDTOKEN_LEN_MAX + 2) > MO_IDTOKEN_LEN_MAX) {
+            MO_DBG_ERR("idTag format violation. Expect c-style string with at most %u characters", MO_IDTOKEN_LEN_MAX);
+            return false;
+        }
+        TransactionService::Evse *evse = nullptr;
+        if (auto txService = context->getModel().getTransactionService()) {
+            evse = txService->getEvse(connectorId);
+        }
+        if (!evse) {
+            MO_DBG_ERR("could not find EVSE");
+            return false;
+        }
+        return evse->endAuthorization(idTag, false);
+    }
+    #endif
+
     auto connector = context->getModel().getConnector(connectorId);
     if (!connector) {
         MO_DBG_ERR("could not find connector");
@@ -1003,6 +1079,7 @@ void setOccupiedInput(std::function<bool()> occupied, unsigned int connectorId)
                 evse->setOccupiedInput(occupied);
             }
         }
+        return;
     }
 #endif
     auto connector = context->getModel().getConnector(connectorId);

src/MicroOcpp.h

@@ -127,6 +127,7 @@ void mocpp_loop();
 /*
  * Transaction management.
  * 
+ * OCPP 1.6 (2.0.1 see below):
  * Begin the transaction process and prepare it. When all conditions for the transaction are true,
  * eventually send a StartTransaction request to the OCPP server.
  * Conditions:
@@ -140,18 +141,24 @@ void mocpp_loop();
  * 
  * See beginTransaction_authorized for skipping steps 1) to 3)
  * 
- * Returns the transaction object if it was possible to create the transaction process. Returns
- * nullptr if either another transaction process is still active or you need to try it again later.
+ * Returns true if it was possible to create the transaction process. Returns
+ * false if either another transaction process is still active or you need to try it again later.
+ * 
+ * OCPP 2.0.1:
+ * Authorize a transaction. Like the OCPP 1.6 behavior, this should be called when the user swipes the
+ * card to start charging, but the semantic is slightly different. This function begins the authorized
+ * phase, but a transaction may already have started due to an earlier transaction start point.
  */
-std::shared_ptr<MicroOcpp::Transaction> beginTransaction(const char *idTag, unsigned int connectorId = 1);
+bool beginTransaction(const char *idTag, unsigned int connectorId = 1);
 
 /*
  * Begin the transaction process and skip the OCPP-side authorization. See beginTransaction(...) for a
  * complete description
  */
-std::shared_ptr<MicroOcpp::Transaction> beginTransaction_authorized(const char *idTag, const char *parentIdTag = nullptr, unsigned int connectorId = 1);
+bool beginTransaction_authorized(const char *idTag, const char *parentIdTag = nullptr, unsigned int connectorId = 1);
 
 /*
+ * OCPP 1.6 (2.0.1 see below):
  * End the transaction process if idTag is authorized to stop the transaction. The OCPP lib sends
  * a StopTransaction request if the following conditions are true:
  * Conditions:
@@ -181,6 +188,15 @@ std::shared_ptr<MicroOcpp::Transaction> beginTransaction_authorized(const char *
  *     `endTransaction_authorized(nullptr, reason);`
  * 
  * Returns true if there is a transaction which could eventually be ended by this action
+ * 
+ * OCPP 2.0.1:
+ * End the user authorization. Like when running with OCPP 1.6, this should be called when the user
+ * swipes the card to stop charging. The difference between the 1.6/2.0.1 behavior is that in 1.6,
+ * endTransaction always sets the transaction inactive so that it wants to stop. In 2.0.1, this only
+ * revokes the user authorization which may terminate the transaction but doesn't have to if the
+ * transaction stop point is set to EvConnected.
+ * 
+ * Note: the stop reason parameter is ignored when running with OCPP 2.0.1. It's always Local
  */
 bool endTransaction(const char *idTag = nullptr, const char *reason = nullptr, unsigned int connectorId = 1);
 
@@ -238,6 +254,14 @@ const char *getTransactionIdTag(unsigned int connectorId = 1);
  */
 std::shared_ptr<MicroOcpp::Transaction>& getTransaction(unsigned int connectorId = 1);
 
+#if MO_ENABLE_V201
+/*
+ * OCPP 2.0.1 version of getTransaction(). Note that the return transaction object is of another type
+ * and unlike the 1.6 version, this function does not give ownership.
+ */
+MicroOcpp::Ocpp201::Transaction *getTransactionV201(unsigned int evseId = 1);
+#endif //MO_ENABLE_V201
+
 /* 
  * Returns if the OCPP library allows the EVSE to charge at the moment.
  *

src/MicroOcpp/Model/Variables/VariableService.cpp

@@ -248,6 +248,18 @@ bool VariableService::addVariable(std::unique_ptr<Variable> variable) {
     return getContainerInternalByVariable(variable->getComponentId(), variable->getName()).add(std::move(variable));
 }
 
+bool VariableService::load() {
+    bool success = true;
+
+    for (size_t i = 0; i < MO_VARIABLESTORE_BUCKETS; i++) {
+        if (!containersInternal[i].load()) {
+            success = false;
+        }
+    }
+
+    return success;
+}
+
 bool VariableService::commit() {
     bool success = true;
 

src/MicroOcpp/Model/Variables/VariableService.h

@@ -77,6 +77,7 @@ class VariableService : public MemoryManaged {
     //Get Variable. If not existent, return nullptr
     Variable *getVariable(const ComponentId& component, const char *name);
 
+    bool load();
     bool commit();
 
     void addContainer(VariableContainer *container);

src/MicroOcpp_c.cpp

@@ -131,18 +131,18 @@ std::function<UnlockConnectorResult()> adaptFn(unsigned int connectorId, PollUnl
 }
 #endif //MO_ENABLE_CONNECTOR_LOCK
 
-void ocpp_beginTransaction(const char *idTag) {
-    beginTransaction(idTag);
+bool ocpp_beginTransaction(const char *idTag) {
+    return beginTransaction(idTag);
 }
-void ocpp_beginTransaction_m(unsigned int connectorId, const char *idTag) {
-    beginTransaction(idTag, connectorId);
+bool ocpp_beginTransaction_m(unsigned int connectorId, const char *idTag) {
+    return beginTransaction(idTag, connectorId);
 }
 
-void ocpp_beginTransaction_authorized(const char *idTag, const char *parentIdTag) {
-    beginTransaction_authorized(idTag, parentIdTag);
+bool ocpp_beginTransaction_authorized(const char *idTag, const char *parentIdTag) {
+    return beginTransaction_authorized(idTag, parentIdTag);
 }
-void ocpp_beginTransaction_authorized_m(unsigned int connectorId, const char *idTag, const char *parentIdTag) {
-    beginTransaction_authorized(idTag, parentIdTag, connectorId);
+bool ocpp_beginTransaction_authorized_m(unsigned int connectorId, const char *idTag, const char *parentIdTag) {
+    return beginTransaction_authorized(idTag, parentIdTag, connectorId);
 }
 
 bool ocpp_endTransaction(const char *idTag, const char *reason) {

src/MicroOcpp_c.h

@@ -78,11 +78,11 @@ void ocpp_loop();
  * Charging session management
  */
 
-void ocpp_beginTransaction(const char *idTag);
-void ocpp_beginTransaction_m(unsigned int connectorId, const char *idTag); //multiple connectors version
+bool ocpp_beginTransaction(const char *idTag);
+bool ocpp_beginTransaction_m(unsigned int connectorId, const char *idTag); //multiple connectors version
 
-void ocpp_beginTransaction_authorized(const char *idTag, const char *parentIdTag);
-void ocpp_beginTransaction_authorized_m(unsigned int connectorId, const char *idTag, const char *parentIdTag);
+bool ocpp_beginTransaction_authorized(const char *idTag, const char *parentIdTag);
+bool ocpp_beginTransaction_authorized_m(unsigned int connectorId, const char *idTag, const char *parentIdTag);
 
 bool ocpp_endTransaction(const char *idTag, const char *reason); //idTag, reason can be NULL
 bool ocpp_endTransaction_m(unsigned int connectorId, const char *idTag, const char *reason); //idTag, reason can be NULL