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
This commit is contained in:
Eric F
2026-06-08 00:38:27 -04:00
parent 468cfeaa50
commit d398a6ced2
7326 changed files with 1177561 additions and 7 deletions

View File

@@ -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/display_messageImpl.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

View File

@@ -0,0 +1,42 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
#include "display_message_API.hpp"
#include <everest_api_types/display_message/API.hpp>
#include <everest_api_types/display_message/codec.hpp>
#include <everest_api_types/display_message/wrapper.hpp>
#include <everest_api_types/generic/codec.hpp>
#include <everest_api_types/utilities/codec.hpp>
#include <generated/types/display_message.hpp>
#include <string>
#include <utility>
namespace module {
namespace API_types_ext = API_types::display_message;
namespace API_generic = API_types::generic;
using ev_API::deserialize;
void display_message_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 display_message_API::ready() {
invoke_ready(*p_main);
invoke_ready(*p_generic_error);
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();
}
} // namespace module

View File

@@ -0,0 +1,82 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
#ifndef DISPLAY_MESSAGE_API_HPP
#define DISPLAY_MESSAGE_API_HPP
//
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
// template version 2
//
#include "ld-ev.hpp"
// headers for provided interface implementations
#include <generated/interfaces/display_message/Implementation.hpp>
#include <generated/interfaces/generic_error/Implementation.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 display_message_API : public Everest::ModuleBase {
public:
display_message_API() = delete;
display_message_API(const ModuleInfo& info, Everest::MqttProvider& mqtt_provider,
std::unique_ptr<display_messageImplBase> p_main,
std::unique_ptr<generic_errorImplBase> p_generic_error, Conf& config) :
ModuleBase(info),
mqtt(mqtt_provider),
p_main(std::move(p_main)),
p_generic_error(std::move(p_generic_error)),
config(config){};
Everest::MqttProvider& mqtt;
const std::unique_ptr<display_messageImplBase> p_main;
const std::unique_ptr<generic_errorImplBase> p_generic_error;
const Conf& config;
// ev@1fce4c5e-0ab8-41bb-90f7-14277703d2ac:v1
// insert your public definitions here
const ev_API::Topics& get_topics() const;
ev_API::Mqtt::ValidatingMqttProxy mqtt_v{mqtt};
ev_API::ApiHelper helper{info, mqtt_v, {{"display_message", 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
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 // DISPLAY_MESSAGE_API_HPP

View File

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

View File

@@ -0,0 +1,15 @@
// 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

View File

@@ -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 "../display_message_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<display_message_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<display_message_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

View File

@@ -0,0 +1,63 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
#include "display_messageImpl.hpp"
#include <everest_api_types/display_message/API.hpp>
#include <everest_api_types/display_message/codec.hpp>
#include <everest_api_types/display_message/json_codec.hpp>
#include <everest_api_types/display_message/wrapper.hpp>
#include <everest_api_types/system/wrapper.hpp>
#include <everest_api_types/utilities/AsyncApiRequestReply.hpp>
#include <generated/types/display_message.hpp>
namespace API_types_ext = ev_API::V1_0::types::display_message;
namespace module {
namespace main {
void display_messageImpl::init() {
timeout_s = mod->config.cfg_request_reply_to_s;
}
void display_messageImpl::ready() {
}
template <class T, class ReqT>
auto display_messageImpl::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 = ev_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::display_message::SetDisplayMessageResponse
display_messageImpl::handle_set_display_message(std::vector<types::display_message::DisplayMessage>& request) {
static const types::display_message::SetDisplayMessageResponse default_response{
types::display_message::DisplayMessageStatusEnum::UnknownTransaction, {}};
std::vector<API_types_ext::DisplayMessage> messages;
for (const auto& message : request) {
messages.push_back(API_types_ext::to_external_api(message));
}
return generic_request_reply(default_response, messages, "set_display_message");
}
types::display_message::GetDisplayMessageResponse
display_messageImpl::handle_get_display_messages(types::display_message::GetDisplayMessageRequest& request) {
types::display_message::GetDisplayMessageResponse default_response;
return generic_request_reply(default_response, API_types_ext::to_external_api(request), "get_display_message");
}
types::display_message::ClearDisplayMessageResponse
display_messageImpl::handle_clear_display_message(types::display_message::ClearDisplayMessageRequest& request) {
types::display_message::ClearDisplayMessageResponse default_response{
types::display_message::ClearMessageResponseEnum::Unknown, {}};
return generic_request_reply(default_response, API_types_ext::to_external_api(request), "clear_display_message");
}
} // namespace main
} // namespace module

View File

@@ -0,0 +1,72 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2020 - 2025 Pionix GmbH and Contributors to EVerest
#ifndef MAIN_DISPLAY_MESSAGE_IMPL_HPP
#define MAIN_DISPLAY_MESSAGE_IMPL_HPP
//
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
// template version 3
//
#include <generated/interfaces/display_message/Implementation.hpp>
#include "../display_message_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 display_messageImpl : public display_messageImplBase {
public:
display_messageImpl() = delete;
display_messageImpl(Everest::ModuleAdapter* ev, const Everest::PtrContainer<display_message_API>& mod,
Conf& config) :
display_messageImplBase(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::display_message::SetDisplayMessageResponse
handle_set_display_message(std::vector<types::display_message::DisplayMessage>& request) override;
virtual types::display_message::GetDisplayMessageResponse
handle_get_display_messages(types::display_message::GetDisplayMessageRequest& request) override;
virtual types::display_message::ClearDisplayMessageResponse
handle_clear_display_message(types::display_message::ClearDisplayMessageRequest& 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<display_message_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_DISPLAY_MESSAGE_IMPL_HPP

View File

@@ -0,0 +1,31 @@
description: API for display messages
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: display_message
description: "Allows API clients to receive messages to be displayed."
generic_error:
interface: generic_error
description: "Provides errors types for module communication status."
enable_external_mqtt: true
metadata:
license: https://opensource.org/licenses/Apache-2.0
authors:
- Jan Christoph Habig
- Florin Mihut