Updated OCPP module documentation

* Revised existing module documentation * Moved module documentation to doc.rst files * Removed unused provides empty of OCPP201 module Signed-off-by: pietfried <[email protected]>
EVerest · Oct 14, 2024 · d2379fc · d2379fc
1 parent 8f8a6f7
commit d2379fc
Show file tree

Hide file tree

Showing 9 changed files with 564 additions and 132 deletions.
diff --git a/modules/OCPP/doc.rst b/modules/OCPP/doc.rst
diff --git a/modules/OCPP/manifest.yaml b/modules/OCPP/manifest.yaml
@@ -1,19 +1,26 @@
 description: A OCPP charge point / charging station module, currently targeting OCPP-J 1.6
 config:
   ChargePointConfigPath:
-    description: Path to the configuration file
+    description: >- 
+      Path to the ocpp configuration file. Libocpp defines a JSON schema for this file. Please refer to the documentation
+      of libocpp for more information about the configuration options.  
     type: string
     default: ocpp-config.json
   UserConfigPath:
-    description: Path to the file of the OCPP user config
+    description: >-
+      Path to the file of the OCPP user config. The user config is used as an overlay for the original config defined
+      by the ChargePointConfigPath. Any changes to configuration keys turned out internally or by the CSMS will be 
+      written to the user config file.
     type: string
     default: user_config.json
   DatabasePath:
-    description: Path to the persistent SQLite database folder
+    description: >-
+      Path to the persistent SQLite database directory. Please refer to the libocpp documentation for more information
+      about the database and its structure.
     type: string
     default: /tmp/ocpp_1_6_charge_point
   EnableExternalWebsocketControl:
-    description: If true websocket can be disconnected and connected externally
+    description: If true websocket can be disconnected and connected externally. This parameter is for debug and testing purposes.
     type: boolean
     default: false
   PublishChargingScheduleIntervalS:
@@ -28,11 +35,13 @@ config:
     type: integer
     default: 600
   MessageLogPath:
-    description: Path to folder where logs of all OCPP messages get written to
+    description: Path to directory where logs of all OCPP messages are written to
     type: string
     default: /tmp/everest_ocpp_logs
   MessageQueueResumeDelay:
-    description: Time (seconds) to delay resuming the message queue after reconnecting
+    description: >-
+      Time (seconds) to delay resuming the message queue after reconnecting. This parameter was introduced because
+      some OCTT test cases require that the first message after a reconnect is sent by the CSMS.
     type: integer
     default: 0
 provides:

diff --git a/modules/OCPP201/CMakeLists.txt b/modules/OCPP201/CMakeLists.txt
@@ -29,7 +29,6 @@ target_compile_options(${MODULE_NAME}
 
 target_sources(${MODULE_NAME}
     PRIVATE
-        "main/emptyImpl.cpp"
         "auth_validator/auth_token_validatorImpl.cpp"
         "auth_provider/auth_token_providerImpl.cpp"
         "data_transfer/ocpp_data_transferImpl.cpp"

diff --git a/modules/OCPP201/OCPP201.cpp b/modules/OCPP201/OCPP201.cpp
@@ -272,7 +272,6 @@ bool OCPP201::all_evse_ready() {
 }
 
 void OCPP201::init() {
-    invoke_init(*p_main);
     invoke_init(*p_auth_provider);
     invoke_init(*p_auth_validator);
 
@@ -311,7 +310,6 @@ void OCPP201::init() {
 }
 
 void OCPP201::ready() {
-    invoke_ready(*p_main);
     invoke_ready(*p_auth_provider);
     invoke_ready(*p_auth_validator);
 

diff --git a/modules/OCPP201/OCPP201.hpp b/modules/OCPP201/OCPP201.hpp
@@ -13,7 +13,6 @@
 // headers for provided interface implementations
 #include <generated/interfaces/auth_token_provider/Implementation.hpp>
 #include <generated/interfaces/auth_token_validator/Implementation.hpp>
-#include <generated/interfaces/empty/Implementation.hpp>
 #include <generated/interfaces/ocpp/Implementation.hpp>
 #include <generated/interfaces/ocpp_data_transfer/Implementation.hpp>
 #include <generated/interfaces/session_cost/Implementation.hpp>
@@ -53,7 +52,7 @@ struct Conf {
 class OCPP201 : public Everest::ModuleBase {
 public:
     OCPP201() = delete;
-    OCPP201(const ModuleInfo& info, Everest::MqttProvider& mqtt_provider, std::unique_ptr<emptyImplBase> p_main,
+    OCPP201(const ModuleInfo& info, Everest::MqttProvider& mqtt_provider,
             std::unique_ptr<auth_token_validatorImplBase> p_auth_validator,
             std::unique_ptr<auth_token_providerImplBase> p_auth_provider,
             std::unique_ptr<ocpp_data_transferImplBase> p_data_transfer, std::unique_ptr<ocppImplBase> p_ocpp_generic,
@@ -65,7 +64,6 @@ class OCPP201 : public Everest::ModuleBase {
             std::vector<std::unique_ptr<display_messageIntf>> r_display_message, Conf& config) :
         ModuleBase(info),
         mqtt(mqtt_provider),
-        p_main(std::move(p_main)),
         p_auth_validator(std::move(p_auth_validator)),
         p_auth_provider(std::move(p_auth_provider)),
         p_data_transfer(std::move(p_data_transfer)),
@@ -82,7 +80,6 @@ class OCPP201 : public Everest::ModuleBase {
     }
 
     Everest::MqttProvider& mqtt;
-    const std::unique_ptr<emptyImplBase> p_main;
     const std::unique_ptr<auth_token_validatorImplBase> p_auth_validator;
     const std::unique_ptr<auth_token_providerImplBase> p_auth_provider;
     const std::unique_ptr<ocpp_data_transferImplBase> p_data_transfer;