Add extracted tools: CitrineOS, OpenOCPP, ShapeShifter

- CitrineOS core extracted (CSMS OCPP 2.0.1)
- OpenOCPP extracted (firmware OCPP 1.6J/2.0.1)
- ShapeShifter library installed (pip install -e)
- ShapeShifter specification extracted
- EVerest extracted

TODO updated with progress

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/CMakeLists.txt

@@ -0,0 +1,32 @@
+#
+# AUTO GENERATED - MARKED REGIONS WILL BE KEPT
+# template version 3
+#
+
+# module setup:
+#   - ${MODULE_NAME}: module name
+ev_setup_cpp_module()
+
+# ev@bcc62523-e22b-41d7-ba2f-825b493a3c97:v1
+# insert your custom targets and additional config variables here
+
+target_compile_options(${MODULE_NAME}
+  PUBLIC  -Wall -Wextra -pedantic -Werror=switch)
+
+target_link_libraries(${MODULE_NAME}
+  PRIVATE
+    atomic
+    everest::everest_api_types
+    everest::everest_api_module_helpers
+)
+# ev@bcc62523-e22b-41d7-ba2f-825b493a3c97:v1
+
+target_sources(${MODULE_NAME}
+    PRIVATE
+        "main/ocpp_data_transferImpl.cpp"
+        "generic_error/generic_errorImpl.cpp"
+)
+
+# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1
+# insert other things like install cmds etc here
+# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/docs/index.rst

@@ -0,0 +1,11 @@
+.. _everest_modules_handwritten_ocpp_consumer_API:
+
+.. *******************************************
+.. ocpp_consumer_API
+.. *******************************************
+
+The complete API specification can be found in the
+
+``docs/source/reference/EVerest_API/ocpp_consumer_API.yaml``
+
+file in the source repository, or in the `AsyncAPI HTML documentation <../../../../api/ocpp_consumer_API/index.html>`_ automatically generated from it.

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/generic_error/generic_errorImpl.cpp

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2020 - 2025 Pionix GmbH and Contributors to EVerest
+
+#include "generic_errorImpl.hpp"
+
+namespace module {
+namespace generic_error {
+
+void generic_errorImpl::init() {
+}
+
+void generic_errorImpl::ready() {
+}
+
+} // namespace generic_error
+} // namespace module

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/generic_error/generic_errorImpl.hpp

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2020 - 2025 Pionix GmbH and Contributors to EVerest
+#ifndef GENERIC_ERROR_GENERIC_ERROR_IMPL_HPP
+#define GENERIC_ERROR_GENERIC_ERROR_IMPL_HPP
+
+//
+// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
+// template version 3
+//
+
+#include <generated/interfaces/generic_error/Implementation.hpp>
+
+#include "../ocpp_consumer_API.hpp"
+
+// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
+// insert your custom include headers here
+// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
+
+namespace module {
+namespace generic_error {
+
+struct Conf {};
+
+class generic_errorImpl : public generic_errorImplBase {
+public:
+    generic_errorImpl() = delete;
+    generic_errorImpl(Everest::ModuleAdapter* ev, const Everest::PtrContainer<ocpp_consumer_API>& mod, Conf& config) :
+        generic_errorImplBase(ev, "generic_error"), mod(mod), config(config){};
+
+    // ev@8ea32d28-373f-4c90-ae5e-b4fcc74e2a61:v1
+    // insert your public definitions here
+    // ev@8ea32d28-373f-4c90-ae5e-b4fcc74e2a61:v1
+
+protected:
+    // no commands defined for this interface
+
+    // ev@d2d1847a-7b88-41dd-ad07-92785f06f5c4:v1
+    // insert your protected definitions here
+    // ev@d2d1847a-7b88-41dd-ad07-92785f06f5c4:v1
+
+private:
+    const Everest::PtrContainer<ocpp_consumer_API>& mod;
+    const Conf& config;
+
+    virtual void init() override;
+    virtual void ready() override;
+
+    // ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
+    // insert your private definitions here
+    // ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
+};
+
+// ev@3d7da0ad-02c2-493d-9920-0bbbd56b9876:v1
+// insert other definitions here
+// ev@3d7da0ad-02c2-493d-9920-0bbbd56b9876:v1
+
+} // namespace generic_error
+} // namespace module
+
+#endif // GENERIC_ERROR_GENERIC_ERROR_IMPL_HPP

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/main/ocpp_data_transferImpl.cpp

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
+
+#include "ocpp_data_transferImpl.hpp"
+
+#include <everest_api_types/ocpp/codec.hpp>
+#include <everest_api_types/ocpp/json_codec.hpp>
+#include <everest_api_types/ocpp/wrapper.hpp>
+#include <everest_api_types/utilities/AsyncApiRequestReply.hpp>
+
+using namespace everest::lib::API;
+namespace API_types_ext = everest::lib::API::V1_0::types::ocpp;
+
+namespace module {
+namespace main {
+
+void ocpp_data_transferImpl::init() {
+    timeout_s = mod->config.cfg_request_reply_to_s;
+}
+
+void ocpp_data_transferImpl::ready() {
+}
+
+template <class T, class ReqT>
+auto ocpp_data_transferImpl::generic_request_reply(T const& default_value, ReqT const& request,
+                                                   std::string const& topic) {
+    using namespace API_types_ext;
+    using ExtT = decltype(to_external_api(std::declval<T>()));
+    auto result = everest::lib::API::request_reply_handler<ExtT>(mod->mqtt_v, mod->helper.get_topics(), request, topic,
+                                                                 timeout_s);
+    if (!result) {
+        return default_value;
+    }
+    return result.value();
+}
+
+types::ocpp::DataTransferResponse
+ocpp_data_transferImpl::handle_data_transfer(types::ocpp::DataTransferRequest& request) {
+    types::ocpp::DataTransferResponse default_response{types::ocpp::DataTransferStatus::Offline, {}, {}};
+    return generic_request_reply(default_response, API_types_ext::to_external_api(request), "data_transfer_incoming");
+}
+
+} // namespace main
+} // namespace module

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/main/ocpp_data_transferImpl.hpp

@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2020 - 2025 Pionix GmbH and Contributors to EVerest
+#ifndef MAIN_OCPP_DATA_TRANSFER_IMPL_HPP
+#define MAIN_OCPP_DATA_TRANSFER_IMPL_HPP
+
+//
+// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
+// template version 3
+//
+
+#include <generated/interfaces/ocpp_data_transfer/Implementation.hpp>
+
+#include "../ocpp_consumer_API.hpp"
+
+// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
+// insert your custom include headers here
+// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
+
+namespace module {
+namespace main {
+
+struct Conf {};
+
+class ocpp_data_transferImpl : public ocpp_data_transferImplBase {
+public:
+    ocpp_data_transferImpl() = delete;
+    ocpp_data_transferImpl(Everest::ModuleAdapter* ev, const Everest::PtrContainer<ocpp_consumer_API>& mod,
+                           Conf& config) :
+        ocpp_data_transferImplBase(ev, "main"), mod(mod), config(config){};
+
+    // ev@8ea32d28-373f-4c90-ae5e-b4fcc74e2a61:v1
+    // insert your public definitions here
+    // ev@8ea32d28-373f-4c90-ae5e-b4fcc74e2a61:v1
+
+protected:
+    // command handler functions (virtual)
+    virtual types::ocpp::DataTransferResponse handle_data_transfer(types::ocpp::DataTransferRequest& request) override;
+
+    // ev@d2d1847a-7b88-41dd-ad07-92785f06f5c4:v1
+    // insert your protected definitions here
+    // ev@d2d1847a-7b88-41dd-ad07-92785f06f5c4:v1
+
+private:
+    const Everest::PtrContainer<ocpp_consumer_API>& mod;
+    const Conf& config;
+
+    virtual void init() override;
+    virtual void ready() override;
+
+    // ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
+    // insert your private definitions here
+    template <class T, class ReqT>
+    auto generic_request_reply(T const& default_value, ReqT const& request, std::string const& topic);
+    int timeout_s{5};
+    // ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
+};
+
+// ev@3d7da0ad-02c2-493d-9920-0bbbd56b9876:v1
+// insert other definitions here
+// ev@3d7da0ad-02c2-493d-9920-0bbbd56b9876:v1
+
+} // namespace main
+} // namespace module
+
+#endif // MAIN_OCPP_DATA_TRANSFER_IMPL_HPP

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/manifest.yaml

@@ -0,0 +1,37 @@
+description: API for OCPP (consumer API)
+config:
+  cfg_communication_check_to_s:
+    description: "Maximum time between two communication check events. Values <= 0 disables communication checks."
+    type: integer
+    default: 5
+  cfg_heartbeat_interval_ms:
+    description: "Interval between two heartbeat messages send by the API. Values <= 0 disable heartbeat."
+    type: integer
+    default: 1000
+  cfg_request_reply_to_s:
+    description: "Maximum time between request and reply. After timeout the request is answered with a default response."
+    type: integer
+    default: 550
+    minimum: 1
+    maximum: 550
+
+provides:
+  main:
+    interface: ocpp_data_transfer
+    description: "Allows API clients to provide processed OCPP data transfers to EVerest."
+  generic_error:
+    interface: generic_error
+    description: "Provides errors types for module communication status."
+requires:
+  ocpp:
+    interface: ocpp
+  data_transfer:
+    interface: ocpp_data_transfer
+
+enable_external_mqtt: true
+metadata:
+  license: https://opensource.org/licenses/Apache-2.0
+  authors:
+    - James Chapman
+    - Jan Christoph Habig
+    - Florin Mihut

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/ocpp_consumer_API.cpp

@@ -0,0 +1,166 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
+
+#include "ocpp_consumer_API.hpp"
+
+#include <everest_api_types/generic/API.hpp>
+#include <everest_api_types/generic/codec.hpp>
+#include <everest_api_types/ocpp/API.hpp>
+#include <everest_api_types/ocpp/codec.hpp>
+#include <everest_api_types/ocpp/wrapper.hpp>
+#include <everest_api_types/utilities/codec.hpp>
+
+namespace {
+template <class T> T const& to_external_api(T const& val) {
+    return val;
+}
+} // namespace
+
+namespace module {
+
+namespace API_types_ext = API_types::ocpp;
+namespace API_generic = API_types::generic;
+using ev_API::deserialize;
+
+void ocpp_consumer_API::init() {
+    invoke_init(*p_main);
+    invoke_init(*p_generic_error);
+
+    API_types_entry::CommunicationParameters comm_params{};
+    comm_params.heartbeat_period_ms = config.cfg_heartbeat_interval_ms;
+    comm_params.communication_check_period_s = config.cfg_communication_check_to_s;
+    comm_params.request_reply_timeout_s = config.cfg_request_reply_to_s;
+    helper.init(comm_params);
+}
+
+void ocpp_consumer_API::ready() {
+    invoke_ready(*p_main);
+    invoke_ready(*p_generic_error);
+
+    generate_api_cmd_data_transfer();
+    generate_api_cmd_get_variables();
+    generate_api_cmd_set_variables();
+    generate_api_cmd_monitor_variables();
+    generate_api_var_security_event();
+    generate_api_var_is_connected();
+    generate_api_var_boot_notification_response();
+    generate_api_var_ocpp_transaction_event();
+    generate_api_var_event_data();
+    generate_api_var_charging_schedules();
+    generate_api_var_ocpp_message();
+
+    helper.generate_api_var_communication_check(&comm_check);
+    comm_check.start(config.cfg_communication_check_to_s);
+    helper.setup_heartbeat_generator(&comm_check, config.cfg_heartbeat_interval_ms);
+    helper.publish_ready_beacon();
+}
+
+auto ocpp_consumer_API::forward_api_var(std::string const& var) {
+    using namespace API_types_ext;
+    using namespace API_generic;
+    const auto topic = helper.get_topics().everest_to_extern(var);
+    return [this, topic](auto const& val) {
+        try {
+            auto&& external = to_external_api(val);
+            auto&& payload = serialize(external);
+            mqtt_v.publish(topic, payload);
+        } catch (const std::exception& e) {
+            EVLOG_warning << "Variable: '" << topic << "' failed with -> " << e.what();
+        } catch (...) {
+            EVLOG_warning << "Invalid data: Cannot convert internal to external or serialize it.\n" << topic;
+        }
+    };
+}
+
+void ocpp_consumer_API::generate_api_cmd_data_transfer() {
+    using namespace API_types_ext;
+    helper.subscribe_api_topic("data_transfer_outgoing", [=](std::string const& data) {
+        API_generic::RequestReply msg;
+        if (deserialize(data, msg)) {
+            DataTransferRequest request;
+            if (deserialize(msg.payload, request)) {
+                auto int_reply = r_data_transfer->call_data_transfer(to_internal_api(request));
+                auto reply = to_external_api(int_reply);
+                mqtt_v.publish(msg.replyTo, serialize(reply));
+                return true;
+            }
+        }
+        return false;
+    });
+}
+
+void ocpp_consumer_API::generate_api_cmd_get_variables() {
+    using namespace API_types_ext;
+    helper.subscribe_api_topic("get_variables", [=](std::string const& data) {
+        API_generic::RequestReply msg;
+        if (deserialize(data, msg)) {
+            GetVariableRequestList request;
+            if (deserialize(msg.payload, request)) {
+                auto int_reply = r_ocpp->call_get_variables(to_internal_api(request));
+                auto reply = to_external_api(int_reply);
+                mqtt_v.publish(msg.replyTo, serialize(reply));
+                return true;
+            }
+        }
+        return false;
+    });
+}
+
+void ocpp_consumer_API::generate_api_cmd_set_variables() {
+    using namespace API_types_ext;
+    helper.subscribe_api_topic("set_variables", [=](std::string const& data) {
+        API_generic::RequestReply msg;
+        if (deserialize(data, msg)) {
+            SetVariablesArgs request;
+            if (deserialize(msg.payload, request)) {
+                auto int_reply = r_ocpp->call_set_variables(to_internal_api(request.variables), request.source);
+                auto reply = to_external_api(int_reply);
+                mqtt_v.publish(msg.replyTo, serialize(reply));
+                return true;
+            }
+        }
+        return false;
+    });
+}
+
+void ocpp_consumer_API::generate_api_cmd_monitor_variables() {
+    using namespace API_types_ext;
+    helper.subscribe_api_topic("monitor_variables", [=](std::string const& data) {
+        MonitorVariableRequestList request;
+        if (deserialize(data, request)) {
+            r_ocpp->call_monitor_variables(to_internal_api(request));
+            return true;
+        }
+        return false;
+    });
+}
+
+void ocpp_consumer_API::generate_api_var_security_event() {
+    r_ocpp->subscribe_security_event(forward_api_var("security_event"));
+}
+
+void ocpp_consumer_API::generate_api_var_is_connected() {
+    r_ocpp->subscribe_is_connected(forward_api_var("is_connected"));
+}
+
+void ocpp_consumer_API::generate_api_var_boot_notification_response() {
+    r_ocpp->subscribe_boot_notification_response(forward_api_var("boot_notification_response"));
+}
+
+void ocpp_consumer_API::generate_api_var_ocpp_transaction_event() {
+    r_ocpp->subscribe_ocpp_transaction_event(forward_api_var("ocpp_transaction_event"));
+}
+
+void ocpp_consumer_API::generate_api_var_event_data() {
+    r_ocpp->subscribe_event_data(forward_api_var("event_data"));
+}
+
+void ocpp_consumer_API::generate_api_var_charging_schedules() {
+    r_ocpp->subscribe_charging_schedules(forward_api_var("charging_schedules"));
+}
+
+void ocpp_consumer_API::generate_api_var_ocpp_message() {
+    r_ocpp->subscribe_ocpp_message(forward_api_var("ocpp_message"));
+}
+
+} // namespace module

tools/EVerest-main/modules/API/EVerestAPI/ocpp_consumer_API/ocpp_consumer_API.hpp

@@ -0,0 +1,105 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
+#ifndef OCPP_CONSUMER_API_HPP
+#define OCPP_CONSUMER_API_HPP
+
+//
+// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
+// template version 2
+//
+
+#include "ld-ev.hpp"
+
+// headers for provided interface implementations
+#include <generated/interfaces/generic_error/Implementation.hpp>
+#include <generated/interfaces/ocpp_data_transfer/Implementation.hpp>
+
+// headers for required interface implementations
+#include <generated/interfaces/ocpp/Interface.hpp>
+#include <generated/interfaces/ocpp_data_transfer/Interface.hpp>
+
+// ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
+// insert your custom include headers here
+#include <everest_api_module_helpers/ApiHelper.hpp>
+#include <everest_api_types/entrypoint/API.hpp>
+
+namespace ev_API = everest::lib::API;
+namespace API_types = ev_API::V1_0::types;
+namespace API_types_entry = API_types::entrypoint;
+// ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
+
+namespace module {
+
+struct Conf {
+    int cfg_communication_check_to_s;
+    int cfg_heartbeat_interval_ms;
+    int cfg_request_reply_to_s;
+};
+
+class ocpp_consumer_API : public Everest::ModuleBase {
+public:
+    ocpp_consumer_API() = delete;
+    ocpp_consumer_API(const ModuleInfo& info, Everest::MqttProvider& mqtt_provider,
+                      std::unique_ptr<ocpp_data_transferImplBase> p_main,
+                      std::unique_ptr<generic_errorImplBase> p_generic_error, std::unique_ptr<ocppIntf> r_ocpp,
+                      std::unique_ptr<ocpp_data_transferIntf> r_data_transfer, Conf& config) :
+        ModuleBase(info),
+        mqtt(mqtt_provider),
+        p_main(std::move(p_main)),
+        p_generic_error(std::move(p_generic_error)),
+        r_ocpp(std::move(r_ocpp)),
+        r_data_transfer(std::move(r_data_transfer)),
+        config(config){};
+
+    Everest::MqttProvider& mqtt;
+    const std::unique_ptr<ocpp_data_transferImplBase> p_main;
+    const std::unique_ptr<generic_errorImplBase> p_generic_error;
+    const std::unique_ptr<ocppIntf> r_ocpp;
+    const std::unique_ptr<ocpp_data_transferIntf> r_data_transfer;
+    const Conf& config;
+
+    // ev@1fce4c5e-0ab8-41bb-90f7-14277703d2ac:v1
+    // insert your public definitions here
+    ev_API::Mqtt::ValidatingMqttProxy mqtt_v{mqtt};
+    ev_API::ApiHelper helper{info, mqtt_v, {{"ocpp_consumer", 1}}, get_config_service_client()};
+    // ev@1fce4c5e-0ab8-41bb-90f7-14277703d2ac:v1
+
+protected:
+    // ev@4714b2ab-a24f-4b95-ab81-36439e1478de:v1
+    // insert your protected definitions here
+    // ev@4714b2ab-a24f-4b95-ab81-36439e1478de:v1
+
+private:
+    friend class LdEverest;
+    void init();
+    void ready();
+
+    // ev@211cfdbe-f69a-4cd6-a4ec-f8aaa3d1b6c8:v1
+    // insert your private definitions here
+    auto forward_api_var(std::string const& var);
+
+    void generate_api_cmd_data_transfer();
+    void generate_api_cmd_get_variables();
+    void generate_api_cmd_set_variables();
+    void generate_api_cmd_monitor_variables();
+
+    void generate_api_var_security_event();
+    void generate_api_var_is_connected();
+    void generate_api_var_boot_notification_response();
+    void generate_api_var_ocpp_transaction_event();
+    void generate_api_var_event_data();
+    void generate_api_var_charging_schedules();
+    void generate_api_var_ocpp_message();
+
+    ev_API::CommCheckHandler<generic_errorImplBase> comm_check{"generic/CommunicationFault",
+                                                               ev_API::bridge_connection_lost_message, p_generic_error};
+    // ev@211cfdbe-f69a-4cd6-a4ec-f8aaa3d1b6c8:v1
+};
+
+// ev@087e516b-124c-48df-94fb-109508c7cda9:v1
+// insert other definitions here
+// ev@087e516b-124c-48df-94fb-109508c7cda9:v1
+
+} // namespace module
+
+#endif // OCPP_CONSUMER_API_HPP