Refactor Energy Management integration of OCPP and API modules #872

Pietfried · 2024-09-22T12:56:10Z

This PR refactors the energy management integration of the API module and the OCPP modules.

A little bit of energy management background

The evse_manager interface exposed a command set_external_limits to apply EVSE specific limits received from the OCPP CSMS or the API module. If both modules (API, OCPP) use this command to write limits, they override each other. This command was therefore removed from the evse_manager interface.

The Energymanagement implementation was already designed to use the external_energy_limits interface and EnergyNode modules instead of that to build up energy trees. This design is more flexible and can be customized for different charging station setups. The API and OCPP modules have been changed to require the external_energy_limits interface and use this to populate the charging limits they receive via their respective channels.

This introduces a breaking change to the Energymanagement integration in EVerest. It is now required to connect modules that implement the external_energy_limits interface to the API and OCPP modules in order to apply the received limits.

A recommended setup is to load one EnergyNode module per EVSE and an additional one representing the energy sink for the whole charging station (addressed by EVSE id zero in OCPP). These EnergyNode modules must be configured with an EVSE mapping in order to allow the API or OCPP modules to retrieve the correct evse id:
https://everest.github.io/nightly/general/05_existing_modules.html#tier-module-mappings

Summary of changes

Adjust manifests of API and OCPP modules to optionally require (0-128) modules implementing the external_energy_limits interface
Changed the integration of charging limits in these modules to use the new requirement
Changed all OCPP configuration files to by loading the additional EnergyNode modules and to address the changes required for the module connections
Added documentation to all modules to explain the energy management integration

Related PRs

EVerest/everest-framework#206
EVerest/everest-utils#154

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
I read the contribution documentation and made sure that my changes meet its requirements

modules/API/API.cpp

config/config-sil-ocpp.yaml

modules/API/API.cpp

modules/OCPP/OCPP.cpp

a-w50 · 2024-09-22T20:48:40Z

config/config-sil-ocpp.yaml

+        - module_id: evse_manager_1_sink
+          implementation_id: external_limits


This kind of solution, i.e. to plugin one more instance of an EnergyNode mode in between the energy flow graph is pretty overkill! It is a complete running process, which won't do more than just receive a command and forward it as some limits. Maybe we should consider to have a single module for the energy flow which has a much more flexible and expressive configuration.

modules/OCPP/doc.rst

modules/API/API.cpp

Pietfried · 2024-10-15T13:34:24Z

modules/OCPP/manifest.yaml

    interface: external_energy_limits
    min_connections: 0
-    max_connections: 1
+    max_connections: 129


verify that the evse_sink vector does not contain multiple elements with the same evse mapping

barsnick

Just some typos found while browsing the doc markdown.

modules/OCPP/doc.rst

modules/OCPP201/doc.rst

…erface This adapts for the following PR in everest-core: - EVerest/everest-core#872 - EVerest/everest-core#924 Signed-off-by: Michael Heimpold <mhei@heimpold.de>

a-w50

From perspective of code style, I can approve this PR.
If possible I might factor out the duplicated code, but it is not clear yet how to do that - i.e. how multiple modules can share some unit of functionality.

a-w50 · 2024-10-21T15:53:31Z

modules/API/API.cpp

+            auto& evse_energy_sink = this->get_evse_sink_by_evse_id(evse_id);
+
+            this->mqtt.subscribe(cmd_set_limit, [&evse_manager_check = this->evse_manager_check,
+                                                 &evse_energy_sink = evse_energy_sink](const std::string& data) {


&evse_energy_sink = evse_energy_sink should be the same as &evse_energy_sink

modules/OCPP/OCPP.cpp

modules/OCPP201/OCPP201.cpp

…terface This adapts for the following PR in everest-core: - EVerest/everest-core#872 Signed-off-by: Michael Heimpold <mhei@heimpold.de>

* Remove set_external_limits from evse_manager inteface * Change requirement to apply limits of API and OCPP modules from evse_manager to external_energy_limits TODOs: * Adjust all EVerest configuration files * Add documentation to API and OCPP modules * EnergyManager currently seg faults Signed-off-by: pietfried <pietgoempel@gmail.com>

Signed-off-by: pietfried <pietgoempel@gmail.com>

Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

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

…of children to unique_ptr Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

…r the energy management * Using the mapping of the requirement to determine the connect requirement to call based on the evse id Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

cmake/ev-cli.cmake

cmake/everest-generate.cmake

modules/OCPP201/OCPP201.cpp

modules/OCPP/manifest.yaml

modules/OCPP201/manifest.yaml

hikinggrass · 2024-11-05T11:58:57Z

TODO: needs updates in dependencies.yaml for everest-framework and everest-utils (once versions are tagged there)

that would be:
everest-framework: v0.18.0
everest-utils: v0.4.0

Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

…g external_energy_limits reference by evse id Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

Pietfried · 2024-11-05T14:07:23Z

lib/staging/CMakeLists.txt

@@ -1,4 +1,5 @@
 add_subdirectory(can_dpm1000)
+add_subdirectory(external_energy_limits)


@hikinggrass probably we can include this only when either API, OCPP or OCPP201 are build but Im not quite sure how. Can you help with that?

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

modules/API/API.cpp

modules/OCPP/OCPP.cpp

modules/OCPP201/OCPP201.cpp

…tegration-ocpp-and-api # Conflicts: # lib/staging/CMakeLists.txt Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

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

SirVer · 2024-11-06T10:03:36Z

will review today!

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

SirVer

Looks good for Rust & Bazel.

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

a-w50 reviewed Sep 22, 2024

View reviewed changes

Pietfried linked an issue Oct 7, 2024 that may be closed by this pull request

Refactor Integration of Charging Limits for EVSEs #852

Closed

Pietfried force-pushed the feature/energymgmt-integration-ocpp-and-api branch from faeef1e to b88570e Compare October 10, 2024 13:00

a-w50 reviewed Oct 10, 2024

View reviewed changes

modules/API/API.cpp Outdated Show resolved Hide resolved

Pietfried force-pushed the feature/energymgmt-integration-ocpp-and-api branch 2 times, most recently from 78f2c21 to a904613 Compare October 14, 2024 16:16

Pietfried mentioned this pull request Oct 14, 2024

Expose mappings of requirements, provides and modules to modules EVerest/everest-framework#206

Merged

Pietfried force-pushed the feature/energymgmt-integration-ocpp-and-api branch from 9a2164b to 85c918b Compare October 15, 2024 09:43

Pietfried requested a review from a-w50 October 15, 2024 09:48

Pietfried marked this pull request as ready for review October 15, 2024 09:48

Pietfried requested review from hikinggrass, maaikez, corneliusclaussen and SebaLukas as code owners October 15, 2024 09:48

Pietfried commented Oct 15, 2024

View reviewed changes

Pietfried added the include-in-release Tag that this PR should be included in the current merge window for the upcoming release if possible label Oct 16, 2024

barsnick reviewed Oct 18, 2024

View reviewed changes

a-w50 approved these changes Oct 22, 2024

View reviewed changes

Pietfried removed the include-in-release Tag that this PR should be included in the current merge window for the upcoming release if possible label Oct 23, 2024

Pietfried self-assigned this Oct 29, 2024

Pietfried force-pushed the feature/energymgmt-integration-ocpp-and-api branch from b2d33cf to 126a345 Compare October 30, 2024 09:53

Pietfried and others added 7 commits November 4, 2024 15:42

extended documentation for OCPP module

94227c5

Signed-off-by: pietfried <pietgoempel@gmail.com>

addressed requested changes

250a0c4

Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

Install ev-cli locally and depend on templates files for generation

84c1a2e

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

Fixed issue when recursively creating Market objects. Changed vector …

f852602

…of children to unique_ptr Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

* Changed all ocpp configs to meet the new connection requirements fo…

0e2c47b

…r the energy management * Using the mapping of the requirement to determine the connect requirement to call based on the evse id Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

Revert changes accidentally added during rebase

b40c355

Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

hikinggrass requested changes Nov 5, 2024

View reviewed changes

Pietfried added 2 commits November 5, 2024 15:04

Addressed requested changes

fedd0e0

Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

Moved duplicated code to seperate library in lib/staging for accessin…

1f86326

…g external_energy_limits reference by evse id Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

Pietfried commented Nov 5, 2024

View reviewed changes

hikinggrass added 2 commits November 5, 2024 15:58

Update everest-framework to v0.18.0 and everest-utils to v0.4.0

26d3344

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

Update everestrs in Cargo.tom and Cargo.lock

4c812ad

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

hikinggrass requested review from SirVer and dorezyuk as code owners November 5, 2024 15:19

hikinggrass added 4 commits November 5, 2024 17:00

Bump required ev-cli version to 0.4.0

31734a7

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

Replace removed Requirement constructor usage in test

fae7422

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

Add missing nullopt for mapping in interface stub of test

e3afe4b

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

Adapt operator< of Requirement to new free function for test

3baf9e8

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

hikinggrass requested a review from james-ctc as a code owner November 5, 2024 17:05

hikinggrass added 2 commits November 5, 2024 19:36

Update everest-testing to fix integration test failures

1943b72

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

Bump everest-utils version to v0.4.1 to use fixed everest-testing

b5eda5f

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

hikinggrass approved these changes Nov 5, 2024

View reviewed changes

barsnick reviewed Nov 6, 2024

View reviewed changes

modules/API/API.cpp Outdated Show resolved Hide resolved

barsnick reviewed Nov 6, 2024

View reviewed changes

modules/OCPP/OCPP.cpp Outdated Show resolved Hide resolved

barsnick reviewed Nov 6, 2024

View reviewed changes

modules/OCPP201/OCPP201.cpp Outdated Show resolved Hide resolved

hikinggrass added 2 commits November 6, 2024 10:17

Merge remote-tracking branch 'origin/main' into feature/energymgmt-in…

df34c0c

…tegration-ocpp-and-api # Conflicts: # lib/staging/CMakeLists.txt Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Fix typos

2d17432

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

Bump ev-cli dependency

106a16d

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

SirVer approved these changes Nov 6, 2024

View reviewed changes

Bump everest-utils

adf275d

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

corneliusclaussen approved these changes Nov 7, 2024

View reviewed changes

Bump everest-utils to 0.4.2

57a8e38

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

Pietfried merged commit 01dee7b into main Nov 7, 2024
11 checks passed

Pietfried deleted the feature/energymgmt-integration-ocpp-and-api branch November 7, 2024 11:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Energy Management integration of OCPP and API modules #872

Refactor Energy Management integration of OCPP and API modules #872

Pietfried commented Sep 22, 2024 •

edited

Loading

a-w50 Sep 22, 2024

Pietfried Oct 15, 2024

barsnick left a comment

a-w50 left a comment

a-w50 Oct 21, 2024

hikinggrass commented Nov 5, 2024 •

edited

Loading

Pietfried Nov 5, 2024

SirVer commented Nov 6, 2024

SirVer left a comment

		- module_id: evse_manager_1_sink
		implementation_id: external_limits

		@@ -1,4 +1,5 @@
		add_subdirectory(can_dpm1000)
		add_subdirectory(external_energy_limits)

Refactor Energy Management integration of OCPP and API modules #872

Refactor Energy Management integration of OCPP and API modules #872

Conversation

Pietfried commented Sep 22, 2024 • edited Loading

A little bit of energy management background

Summary of changes

Related PRs

Issue ticket number and link

Checklist before requesting a review

a-w50 Sep 22, 2024

Choose a reason for hiding this comment

Pietfried Oct 15, 2024

Choose a reason for hiding this comment

barsnick left a comment

Choose a reason for hiding this comment

a-w50 left a comment

Choose a reason for hiding this comment

a-w50 Oct 21, 2024

Choose a reason for hiding this comment

hikinggrass commented Nov 5, 2024 • edited Loading

Pietfried Nov 5, 2024

Choose a reason for hiding this comment

SirVer commented Nov 6, 2024

SirVer left a comment

Choose a reason for hiding this comment

Pietfried commented Sep 22, 2024 •

edited

Loading

hikinggrass commented Nov 5, 2024 •

edited

Loading