- Restructured libocpp into seperate parts for OCPP1.6 and OCPP2.0.1 and common functionality

- Updated code generator to generate schemas for 1.6 and 2.0.1
- Generalized Websocket, PkiHandler, MessageQueue, types and ChargePoint (all used as common base for 1.6 ChargePoint and 2.0.1 ChargePoint)
- Very basic implementation of OCPP2.0.1 ChargePoint (BootNotification) ; Generated Datatypes and Enums are already included
- Templated CiString type with length as template parameter
- Templated MessageQueue, EnhancedMessage and ControlMessage with OCPP version
- MessageQueue now handles message timeouts and respects retry attempts and retry intervals

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
Signed-off-by: pietfried <piet.goempel@pionix.de>

Author: hikinggrass

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.14)
 
 project(ocpp
-    VERSION 0.4.1
+    VERSION 0.5
     DESCRIPTION "A C++ implementation of the Open Charge Point Protocol"
     LANGUAGES CXX
 )
@@ -45,8 +45,8 @@ endif()
 # library code
 add_subdirectory(lib)
 
-# auxillary files
-add_subdirectory(aux)
+# config and auxillary files
+add_subdirectory(config)
 
 
 # packaging
@@ -74,11 +74,11 @@ if (OCPP_INSTALL)
 endif()
 
 
-if(LIBOCPP_BUILD_EXAMPLES)
-    message("Building libocpp example binaries.")
+if(LIBOCPP16_BUILD_EXAMPLES)
+    message("Building libocpp 1.6 example binaries.")
     add_subdirectory(src)
 else()
-    message("Not building libocpp example binaries.")
+    message("Not building libocpp 1.6 example binaries.")
 endif()
 
 # configure clang-tidy if requested

README.md

@@ -1,14 +1,19 @@
-# C++ implementation of OCPP (currently 1.6 JSON)
+# C++ implementation of OCPP
 
-This is a C++ library implementation of OCPP, currently in Version 1.6 (https://www.openchargealliance.org/protocols/ocpp-16/). It enables charging stations to communicate with cloud backends for remote control, monitoring and billing of charging processes.
+This is a C++ library implementation of OCPP for version 1.6 (https://www.openchargealliance.org/protocols/ocpp-16/) and 2.0.1 (https://www.openchargealliance.org/protocols/ocpp-201/). It enables charging stations to communicate with cloud backends for remote control, monitoring and billing of charging processes.
 
 Libocpp can be used for the communication of one charging station and multiple EVSE using a single websocket connection.
 
-## Feature Profile Support
+Libocpp provides a complete implementation of OCPP 1.6. The implementation of OCPP 2.0.1 is currently under development.
+## Feature Support
 
-The following table shows the current support for the listed feature profiles and application notes. The goal is to fully support all of these in the future.
+The following tables show the current support for the listed feature profiles / functional blocks and application notes.
 
-| Feature-Profile            | Supported                 |
+All documentation and the issue tracking can be found in our main repository here: https://github.com/EVerest/
+
+### Feature Profile Support OCPP 1.6
+
+| Feature Profile            | Supported                 |
 | -------------------------- | ------------------------- |
 | Core                       | :heavy_check_mark: yes    |
 | Firmware Management        | :heavy_check_mark: yes    |
@@ -23,10 +28,31 @@ The following table shows the current support for the listed feature profiles an
 | [Using ISO 15118 Plug & Charge with OCPP 1.6](https://www.openchargealliance.org/uploads/files/ocpp_1_6_ISO_15118_v10.pdf)                | :x:                    |
 | [Autocharge](https://github.com/openfastchargingalliance/openfastchargingalliance/blob/master/autocharge-final.pdf)                       | :heavy_check_mark: yes |
 
-All documentation and the issue tracking can be found in our main repository here: https://github.com/EVerest/
+### Functional Block support OCPP 2.0.1
+
+| Functional Block                      | Supported                            |
+| ------------------------------------- | ------------------------------------ |
+| Provisioning                          | :x:                                  |
+| Security                              | :x:                                  |
+| Authorization                         | :x:                                  |
+| LocalAuthorizationList Management     | :x:                                  |
+| Transactions                          | :x:                                  |
+| RemoteControl                         | :x:                                  |
+| Availability                          | :x:                                  |
+| Reservation                           | :x:                                  |
+| TariffAndCost                         | :x:                                  |
+| MeterValues                           | :x:                                  |
+| SmartCharging                         | :x:                                  |
+| FirmwareManagement                    | :x:                                  |
+| ISO 15118 CertificateManagement       | :x:                                  |
+| Diagnositcs                           | :x:                                  |
+| DisplayMessage                        | :x:                                  |
+| DataTransfer                          | :x:                                  |
 
 ## CSMS Compatibility
 
+### CSMS Compatibility OCPP 1.6
+
 The following table shows CSMS with which this library was tested. If you provide a CSMS that is not yet listed here, feel free to [contact us](https://lists.lfenergy.org/g/everest)!
 
 -   chargecloud
@@ -51,9 +77,13 @@ The following table shows CSMS with which this library was tested. If you provid
 -   ubitricity
 -   Weev Energy
 
+### CSMS Compatibility OCPP 2.0.1
+
+The implementation of OCPP 2.0.1 has not yet been tested against any CSMS.
+
 ## Integration with EVerest
 
-This library is automatically integrated as the OCPP module within [everest-core](https://github.com/EVerest/everest-core) - the complete software stack for your charging station. It is recommended to use EVerest together with this OCPP implementation.
+This library is automatically integrated as the OCPP and OCPP201 module within [everest-core](https://github.com/EVerest/everest-core) - the complete software stack for your charging station. It is recommended to use EVerest together with this OCPP implementation.
 
 If you run libocpp with EVerest, the build process of [everest-core](https://github.com/EVerest/everest-core) will take care of installing all necessary dependencies for you.
 
@@ -67,7 +97,7 @@ Libocpp needs registered **callbacks** in order to execute control commands defi
 
 The implementation must call **event handlers** of libocpp so that the library can track the state of the charging station and trigger OCPP messages accordingly (e.g. MeterValues.req , StatusNotification.req)
 
-Your reference within libocpp to interact is a single instance to the class [ChargePoint](include/ocpp1_6/charge_point.hpp).
+Your reference within libocpp to interact is a single instance to the class [ChargePoint](include/ocpp/v16/charge_point.hpp) for OCPP 1.6 or to the class [ChargePoint](include/ocpp/v201/charge_point.hpp) for OCPP 2.0.1.
 
 ### Install libocpp
 
@@ -92,13 +122,13 @@ Execute cmake and then make install:
   make install
 ```
 
-## Quickstart
+## Quickstart for OCPP 1.6
 
-Libocpp provides a small standalone OCPP client that you can control using command line.
+Libocpp provides a small standalone OCPP1.6 client that you can control using command line.
 
 Install the dependencies and libocpp as described in [Install libocpp](#install-libocpp).
 
-Make sure you modify the following config entries in the [aux/config.json](aux/config.json) file according to the CSMS you want to connect to before executing make install.
+Make sure you modify the following config entries in the [config.json](config/v16/config.json) file according to the CSMS you want to connect to before executing make install.
 
 ```json
 {
@@ -109,15 +139,15 @@ Make sure you modify the following config entries in the [aux/config.json](aux/c
 }
 ```
 
-Cd into libocpp/build and execute cmake and then make install:
+Change into libocpp/build and execute cmake and then make install:
 
 ```bash
   cd build
-  cmake -DLIBOCPP_BUILD_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=./dist ..
-  make install
+  cmake -DLIBOCPP16_BUILD_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=./dist ..
+  make -j$(nproc) install
 ```
 
-Use the following command to start the charge point. Replace the config with [config-docker.json](aux/config-docker.json) if you want to test with the [SteVe](https://github.com/steve-community/steve#docker) CSMS running in a docker container.
+Use the following command to start the charge point. Replace the config with [config-docker.json](config/v16/config-docker.json) if you want to test with the [SteVe](https://github.com/steve-community/steve#docker) CSMS running in a docker container.
 
 ```bash
   ./dist/bin/charge_point \

config/CMakeLists.txt

@@ -0,0 +1,3 @@
+
+add_subdirectory(v16)
+add_subdirectory(v201)

aux/certs/.gitignore config/certs/.gitignore

@@ -1,7 +1,7 @@
-set(OCPP1_6_PROFILE_SCHEMAS_DIR "profile_schemas/ocpp1_6/")
-set(USER_CONFIG_FILE "${CMAKE_CURRENT_SOURCE_DIR}/user_config/user_config.json")
+set(OCPP1_6_PROFILE_SCHEMAS_DIR "profile_schemas/")
+set(USER_CONFIG_FILE "user_config/user_config.json")
 set(SQL_INIT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/init.sql")
-set(CERTS_DIR "certs/")
+set(CERTS_DIR "../certs/")
 
 list(APPEND OCPP1_6_PROFILE_SCHEMAS
      Config.json
@@ -19,14 +19,14 @@ list(TRANSFORM OCPP1_6_PROFILE_SCHEMAS
 
 install(
      FILES ${OCPP1_6_PROFILE_SCHEMAS}
-     DESTINATION ${CMAKE_INSTALL_DATADIR}/everest/ocpp/profile_schemas/ocpp1_6
+     DESTINATION ${CMAKE_INSTALL_DATADIR}/everest/ocpp/profile_schemas
 )
 
 list(APPEND CONFIGS
      config.json
      config-docker.json
      config-docker-tls.json
-     logging.ini
+     ../logging.ini
 )
 
 install(

aux/logging.ini config/logging.ini

@@ -0,0 +1,52 @@
+set(OCPP2_0_1_PROFILE_SCHEMAS_DIR "component_schemas/")
+
+list(APPEND OCPP2_0_1_PROFILE_SCHEMAS
+     AlignedDataCtrlr.json
+     AuthCacheCtrlr.json
+     AuthCtrlr.json
+     CHAdeMOCtrlr.json
+     CPPWMController.json
+     ChargingStation.json
+     ClockCtrlr.json
+     Config.json
+     ConnectedEV.json
+     Connector.json
+     Controller.json
+     CustomizationCtrlr.json
+     DeviceDataCtrlr.json
+     DisplayMessageCtrlr.json
+     DistributionPanel.json
+     EVSE.json
+     FiscalMetering.json
+     ISO15118Ctrlr.json
+     InternalCtrlr.json
+     LocalAuthListCtrlr.json
+     LocalEnergyStorage.json
+     MonitoringCtrlr.json
+     OCPPCommCtrlr.json
+     ReservationCtrlr.json
+     SampledDataCtrlr.json
+     SecurityCtrlr.json
+     SmartChargingCtrlr.json
+     TariffCostCtrlr.json
+     TokenReader.json
+     TxCtrlr.json
+)
+
+list(TRANSFORM OCPP2_0_1_PROFILE_SCHEMAS
+     PREPEND ${OCPP2_0_1_PROFILE_SCHEMAS_DIR})
+
+install(
+     FILES ${OCPP2_0_1_PROFILE_SCHEMAS}
+     DESTINATION ${CMAKE_INSTALL_DATADIR}/everest/ocpp201/component_schemas
+)
+
+list(APPEND CONFIGS
+     config.json
+     ../logging.ini
+)
+
+install(
+     FILES ${CONFIGS}
+     DESTINATION ${CMAKE_INSTALL_DATADIR}/everest/ocpp201
+)

aux/CMakeLists.txt config/v16/CMakeLists.txt

@@ -0,0 +1,127 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Schema for AlignedDataCtrlr",
+  "type": "object",
+  "properties": {
+    "Available": {
+      "characteristics": {
+        "supportsMonitoring": true,
+        "dataType": "boolean"
+      },
+      "attributes": [
+        {
+          "type": "Actual",
+          "mutability": "ReadOnly"
+        }
+      ],
+      "description": "If this variable reports a value of true",
+      "type": "boolean"
+    },
+    "Enabled": {
+      "characteristics": {
+        "supportsMonitoring": true,
+        "dataType": "boolean"
+      },
+      "attributes": [
+        {
+          "type": "Actual",
+          "mutability": "ReadWrite"
+        }
+      ],
+      "description": "If this variable reports a value of true",
+      "type": "boolean"
+    },
+    "Interval": {
+      "characteristics": {
+        "unit": "s",
+        "supportsMonitoring": true,
+        "dataType": "integer"
+      },
+      "attributes": [
+        {
+          "type": "Actual",
+          "mutability": "ReadWrite"
+        }
+      ],
+      "description": "Size (in seconds) of the clock-aligned data interval",
+      "type": "integer"
+    },
+    "Measurands": {
+      "characteristics": {
+        "supportsMonitoring": true,
+        "dataType": "MemberList"
+      },
+      "attributes": [
+        {
+          "type": "Actual",
+          "mutability": "ReadWrite"
+        }
+      ],
+      "description": "Clock-aligned measurand(s) to be included in MeterValuesRequest",
+      "type": "string"
+    },
+    "SendDuringIdle": {
+      "characteristics": {
+        "supportsMonitoring": true,
+        "dataType": "boolean"
+      },
+      "attributes": [
+        {
+          "type": "Actual",
+          "mutability": "ReadWrite"
+        }
+      ],
+      "description": "If set to true",
+      "type": "boolean"
+    },
+    "SignReadings": {
+      "characteristics": {
+        "supportsMonitoring": true,
+        "dataType": "boolean"
+      },
+      "attributes": [
+        {
+          "type": "Actual",
+          "mutability": "ReadWrite"
+        }
+      ],
+      "description": "If set to true",
+      "type": "boolean"
+    },
+    "TxEndedInterval": {
+      "characteristics": {
+        "unit": "s",
+        "supportsMonitoring": true,
+        "dataType": "integer"
+      },
+      "attributes": [
+        {
+          "type": "Actual",
+          "mutability": "ReadWrite"
+        }
+      ],
+      "description": "Size (in seconds) of the clock-aligned data interval",
+      "type": "integer"
+    },
+    "TxEndedMeasurands": {
+      "characteristics": {
+        "supportsMonitoring": true,
+        "dataType": "MemberList"
+      },
+      "attributes": [
+        {
+          "type": "Actual",
+          "mutability": "ReadWrite"
+        }
+      ],
+      "description": "Clock-aligned measurands to be included in the meterValues element of TransactionEventRequest (eventType = Ended)",
+      "type": "string"
+    }
+  },
+  "required": [
+    "Interval",
+    "Measurands",
+    "TxEndedInterval",
+    "TxEndedMeasurands"
+  ]
+}