Refactor/rename v201 to v2 #991

Pietfried · 2025-02-20T10:46:57Z

Describe your changes

Since OCPP2.1 is backwards compatible with OCPP2.0.1 and we are reusing a lot of code and configuration that is now in v201 directories and namespaces for the implementation of OCPP2.1, the name v201 is missleading. We therefore decided to rename all directories and namespaces from v201 to v2. v2 can then cover the implementation of OCPP2.0.1 and OCPP2.1. All files that are only introduced for the implementation of OCPP2.1 will go into a v21 directory (e.g. generated messages).

This PR renames all directories with the name v201 to v2 and all occurances of v201 or V201 to v2 and V2.

I added a clarification for the directory structure and namespaces here

Issue ticket number and link

Checklist before requesting a review

I have performed a self-review of my code
I have made corresponding changes to the documentation
If OCPP 2.0.1: I have updated the OCPP 2.0.1 status document
I read the contribution documentation and made sure that my changes meet its requirements

maaikez

I tried, it builds, the tests run and the integration tests seem to run as well.

I had some minor changes I would do as well and at least one important thing (OcppProtocolVersion)

maaikez · 2025-02-20T11:20:34Z

CMakeLists.txt

@@ -19,10 +19,10 @@ option(OCPP_INSTALL "Install the library (shared data might be installed anyway)
 option(LIBOCPP_ENABLE_DEPRECATED_WEBSOCKETPP "Websocket++ has been removed from the project" OFF)

 option(LIBOCPP_ENABLE_V16 "Enable OCPP 1.6 in the ocpp library" ON)
-option(LIBOCPP_ENABLE_V201 "Enable OCPP 2.0.1 in the ocpp library" ON)
+option(LIBOCPP_ENABLE_V2 "Enable OCPP 2.0.1 in the ocpp library" ON)


"Enable OCPP 2.0.1 / 2.1 in the ocpp library"

Because we will forget later on to add 2.1 there :)

maaikez · 2025-02-20T13:31:53Z

config/v2/CMakeLists.txt

-set(MIGRATION_FILES_DEVICE_MODEL_SOURCE_DIR_V201 ${MIGRATION_FILES_DEVICE_MODEL_LOCATION} PARENT_SCOPE)
+set(MIGRATION_DEVICE_MODEL_FILE_VERSION_V2 ${TARGET_MIGRATION_FILE_VERSION} PARENT_SCOPE)
+set(MIGRATION_FILES_SOURCE_DIR_V2 ${MIGRATION_FILES_LOCATION} PARENT_SCOPE)
+set(MIGRATION_FILES_DEVICE_MODEL_SOURCE_DIR_V2 ${MIGRATION_FILES_DEVICE_MODEL_LOCATION} PARENT_SCOPE)

 option(LIBOCPP_INSTALL_DEVICE_MODEL_DATABASE "Install device model database for OCPP201" ON)


for OCPP2x ?

maaikez · 2025-02-20T13:33:27Z

doc/common/getting_started.md

@@ -60,4 +69,4 @@ Please see the [Getting Started documentation for OCPP2.0.1](../v201/getting_sta
 You will find the generated doxygen documentation at:
 `build/dist/docs/html/index.html`

-The main reference for the integration of libocpp for OCPP1.6 is the ocpp::v16::ChargePoint class defined in `v16/charge_point.hpp` , for OCPP2.0.1 that is the ocpp::v201::ChargePoint class defined in `v201/charge_point.hpp` .
+The main reference for the integration of libocpp for OCPP1.6 is the ocpp::v16::ChargePoint class defined in `v16/charge_point.hpp` , for OCPP2.0.1 that is the ocpp::v2::ChargePoint class defined in `v2/charge_point.hpp` .


2.0.1/2.1 ?
Because otherwise we will forget it anyway.

maaikez · 2025-02-20T13:35:22Z

include/ocpp/common/types.hpp

@@ -610,7 +610,7 @@ std::ostream& operator<<(std::ostream& os, const CertificateHashDataChain& k);

 enum class OcppProtocolVersion {
    v16,
-    v201,
+    v2,


Nope, this one should still be v201

maaikez · 2025-02-20T13:36:28Z

include/ocpp/v2/charge_point.hpp

@@ -126,7 +126,7 @@ class ChargePointInterface {
    /// \param charging_state   The new charging state
    virtual void
    on_transaction_started(const int32_t evse_id, const int32_t connector_id, const std::string& session_id,
-                           const DateTime& timestamp, const ocpp::v201::TriggerReasonEnum trigger_reason,
+                           const DateTime& timestamp, const ocpp::v2::TriggerReasonEnum trigger_reason,


You can remove ocpp::v2:: here anyway if you want.

maaikez · 2025-02-20T13:38:49Z

include/ocpp/v2/functional_blocks/transaction.hpp

-                                       const std::optional<ocpp::v201::EVSE>& evse,
-                                       const std::optional<ocpp::v201::IdToken>& id_token,
-                                       const std::optional<std::vector<ocpp::v201::MeterValue>>& meter_value,
+                                       const std::optional<ocpp::v2::EVSE>& evse,


In this file, if you want to, ocpp::v2:: can be removed (it is already in this namespace).

maaikez · 2025-02-20T13:46:05Z

src/code_generator/common/generate_cpp.py

@@ -613,8 +613,8 @@ def parse_schemas(version: str, schema_dir: Path = Path('schemas/json/'),

    if version == '1.6' or version == '16' or version == 'v16':
        version_path = 'v16'
-    elif version == '2.0.1' or version == '201' or version == 'v201':
-        version_path = 'v201'
+    elif version == '2.0.1' or version == '201' or version == 'v2':


That does not seem correct. I would revert (so change back to v201) and add the 2.1 cases here (or version == '2.1' or version == '21' or version == 'v21')

the version is used in the templates for namespaces etc. so setting the version_path to v2 here should be correct. In the condition I changed it back to version == 'v2' though

maaikez · 2025-02-20T14:06:18Z

Maybe this has to be changed as well:

libocpp/config/v2/CMakeLists.txt

Line 9 in 9b3af7a

    
           INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/everest/modules/OCPP201/core_migrations

libocpp/config/v2/CMakeLists.txt

Line 16 in 9b3af7a

    
           INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/everest/modules/OCPP201/device_model_migrations

libocpp/config/v2/CMakeLists.txt

Line 23 in 9b3af7a

    
           option(LIBOCPP_INSTALL_DEVICE_MODEL_DATABASE "Install device model database for OCPP201" ON)

libocpp/config/v2/CMakeLists.txt

Line 31 in 9b3af7a

DESTINATION ${CMAKE_INSTALL_DATADIR}/everest/modules/OCPP201

libocpp/config/v2/CMakeLists.txt

Line 43 in 9b3af7a

    
                install(DIRECTORY ${LIBOCPP_COMPONENT_CONFIG_PATH} DESTINATION ${CMAKE_INSTALL_DATADIR}/everest/modules/OCPP201)

libocpp/tests/libocpp-unittests.cmake

Line 10 in 9b3af7a

    
           set(DEVICE_MODEL_DB_LOCATION_V2 "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/everest/modules/OCPP201/device_model_storage.db")

But I am not sure if everything will go well then?

libocpp/include/ocpp/v2/charge_point.hpp

Line 80 in 9b3af7a

/// \addtogroup ocpp201_handlers OCPP 2.0.1 handlers

libocpp/include/ocpp/v2/charge_point_callbacks.hpp

Line 23 in 9b3af7a

/// @addtogroup ocpp201_callbacks OCPP 2.0.1 callbacks

libocpp/include/ocpp/v2/charge_point_callbacks.hpp

Line 169 in 9b3af7a

/// @} // End ocpp 201 callbacks group / topic

libocpp/lib/ocpp/v2/charge_point.cpp

Line 266 in 9b3af7a

    
           !log_formats.empty(), message_log_path, "libocpp_201", log_to_console, detailed_log_to_console, log_to_file,

Not very interesting:

libocpp/tests/lib/ocpp/v2/functional_blocks/test_smart_charging.cpp

Line 264 in 9b3af7a

    
           std::make_unique<common::DatabaseConnection>(fs::path("/tmp/ocpp201") / "cp.db");

libocpp/tests/lib/ocpp/v2/test_charge_point.cpp

Line 32 in 9b3af7a

static const std::string TEMP_OUTPUT_PATH = "/tmp/ocpp201";

libocpp/tests/lib/ocpp/v2/test_charge_point.cpp

Line 131 in 9b3af7a

    
           auto database_connection = std::make_unique<common::DatabaseConnection>(fs::path("/tmp/ocpp201") / "cp.db");

libocpp/tests/lib/ocpp/v2/test_composite_schedule.cpp

Line 190 in 9b3af7a

    
           std::make_unique<common::DatabaseConnection>(fs::path("/tmp/ocpp201") / "cp.db");

maaikez · 2025-02-20T15:21:20Z

And some more things (to think about, not necessarily needed now):

libocpp/src/code_generator/common/generate_cpp.py

Line 609 in 9b3af7a

help="Version of OCPP [1.6 or 2.0.1]", required=True)

libocpp/CMakeLists.txt

Line 22 in 9b3af7a

option(LIBOCPP_ENABLE_V2 "Enable OCPP 2.0.1 in the ocpp library" ON)

Comment change? :

libocpp/tests/libocpp-unittests.cmake

Line 66 in 9b3af7a

    
           # If the test is not linked against the ocpp library, those default sources for ocpp v2.0.1 can be linked against, they

libocpp/lib/ocpp/v2/functional_blocks/tariff_and_cost.cpp

Line 209 in 9b3af7a

    
           // In 2.0.1, the cost and transaction id are already part of the CostUpdatedRequest, so they need to be added to

libocpp/lib/ocpp/v2/functional_blocks/tariff_and_cost.cpp

Line 232 in 9b3af7a

// In OCPP 2.0.1, the chargepoint status trigger is not used.

libocpp/lib/ocpp/v2/functional_blocks/provisioning.cpp

Line 591 in 9b3af7a

    
           // handles required behavior specified within OCPP2.0.1 (e.g. reconnect when BasicAuthPassword has changed)

libocpp/lib/ocpp/v2/connectivity_manager.cpp

Line 84 in 9b3af7a

    
           EVLOG_error << "security_profile 0 not officially allowed in OCPP 2.0.1, skipping profile";

libocpp/lib/ocpp/v2/connectivity_manager.cpp

Line 430 in 9b3af7a

    
           "All profiles configured have security_profile 0 which is not officially allowed in OCPP 2.0.1");

???

libocpp/include/ocpp/v2/types.hpp

Line 14 in 9b3af7a

/// \brief Contains all supported OCPP 2.0.1 message types

libocpp/include/ocpp/v2/message_handler.hpp

Line 11 in 9b3af7a

    
           /// \brief Interface for handling OCPP2.0.1 CALL messages from the CSMS. Classes implementing a functional block shall

libocpp/include/ocpp/v2/device_model.hpp

Line 144 in 9b3af7a

    
           /// should only be called for variables that have a role standardized in the OCPP2.0.1 specification.

libocpp/include/ocpp/v2/ctrlr_component_variables.hpp

Line 41 in 9b3af7a

// Provides access to standardized variables of OCPP2.0.1 spec

libocpp/include/ocpp/v2/charge_point.hpp

Line 56 in 9b3af7a

/// \brief Interface class for OCPP2.0.1 Charging Station

libocpp/include/ocpp/v2/charge_point.hpp

Line 326 in 9b3af7a

/// \brief Class implements OCPP2.0.1 Charging Station

libocpp/include/ocpp/v2/charge_point.hpp

Line 447 in 9b3af7a

/// @name Constructors for 2.0.1

libocpp/include/ocpp/v2/charge_point.hpp

Line 502 in 9b3af7a

/// @} // End chargepoint 2.0.1 member group

libocpp/include/ocpp/v2/charge_point.hpp

Line 504 in 9b3af7a

/// @} // End chargepoint 2.0.1 topic

libocpp/include/ocpp/common/charging_station_base.hpp

Line 15 in 9b3af7a

/// \brief Common base class for OCPP1.6 and OCPP2.0.1 charging stations

Maybe add 2.1 to the dropdown? Although I think that's a bit early probably (but then we don't forget).

libocpp/.github/ISSUE_TEMPLATE/feature_request.yaml

Line 12 in 9b3af7a

- OCPP2.0.1

libocpp/.github/ISSUE_TEMPLATE/bug_report.yaml

Line 12 in 9b3af7a

- OCPP2.0.1

Signed-off-by: Piet Gömpel <[email protected]>

* Added clarifications of directory structure in getting started guide Signed-off-by: Piet Gömpel <[email protected]>

Pietfried force-pushed the refactor/rename-v201-to-v2 branch from 3d63d48 to 9b3af7a Compare February 20, 2025 10:51

Pietfried mentioned this pull request Feb 20, 2025

Rename v201 to v2 for OCPP modules EVerest/everest-core#1058

Merged

3 tasks

maaikez requested changes Feb 20, 2025

View reviewed changes

Pietfried marked this pull request as ready for review February 21, 2025 10:45

Pietfried requested review from hikinggrass and marcemmers as code owners February 21, 2025 10:45

maaikez approved these changes Feb 24, 2025

View reviewed changes

Renamed v201 directories to v2

4dc12f2

Signed-off-by: Piet Gömpel <[email protected]>

Pietfried force-pushed the refactor/rename-v201-to-v2 branch from 7cc099b to 245a75d Compare February 24, 2025 16:24

* Renamed all occurances of v201 to v2 and V201 to V2

7c69398

* Added clarifications of directory structure in getting started guide Signed-off-by: Piet Gömpel <[email protected]>

Pietfried force-pushed the refactor/rename-v201-to-v2 branch from 245a75d to 7c69398 Compare February 24, 2025 16:47

Pietfried merged commit 04059e2 into main Feb 24, 2025
7 of 8 checks passed

Pietfried deleted the refactor/rename-v201-to-v2 branch February 24, 2025 17:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor/rename v201 to v2 #991

Refactor/rename v201 to v2 #991

Pietfried commented Feb 20, 2025 •

edited

Loading

maaikez left a comment

maaikez Feb 20, 2025

maaikez Feb 20, 2025

maaikez Feb 20, 2025

maaikez Feb 20, 2025

Pietfried Feb 21, 2025

maaikez Feb 20, 2025

maaikez Feb 20, 2025

maaikez Feb 20, 2025

Pietfried Feb 21, 2025

maaikez commented Feb 20, 2025

maaikez commented Feb 20, 2025 •

edited

Loading

Refactor/rename v201 to v2 #991

Refactor/rename v201 to v2 #991

Conversation

Pietfried commented Feb 20, 2025 • edited Loading

Describe your changes

Issue ticket number and link

Checklist before requesting a review

maaikez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maaikez commented Feb 20, 2025

maaikez commented Feb 20, 2025 • edited Loading

Pietfried commented Feb 20, 2025 •

edited

Loading

maaikez commented Feb 20, 2025 •

edited

Loading