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,31 @@
#
# 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/systemImpl.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,11 @@
.. _everest_modules_handwritten_system_API:
.. *******************************************
.. system_API
.. *******************************************
The complete API specification can be found in the
``docs/source/reference/EVerest_API/system_API.yaml``
file in the source repository, or in the `AsyncAPI HTML documentation <../../../../api/system_API/index.html>`_ automatically generated from it.

View File

@@ -0,0 +1,85 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
#include "systemImpl.hpp"
#include <everest_api_types/system/API.hpp>
#include <everest_api_types/system/codec.hpp>
#include <everest_api_types/system/json_codec.hpp>
#include <everest_api_types/system/wrapper.hpp>
#include <everest_api_types/utilities/AsyncApiRequestReply.hpp>
#include <generated/types/system.hpp>
namespace API_types_ext = ev_API::V1_0::types::system;
namespace {
bool to_external_api(bool value) {
return value;
}
} // namespace
namespace module {
namespace main {
void systemImpl::init() {
timeout_s = mod->config.cfg_request_reply_to_s;
}
void systemImpl::ready() {
}
template <class T, class ReqT>
auto systemImpl::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::system::UpdateFirmwareResponse
systemImpl::handle_update_firmware(types::system::FirmwareUpdateRequest& firmware_update_request) {
static const types::system::UpdateFirmwareResponse default_response =
types::system::UpdateFirmwareResponse::Rejected;
return generic_request_reply(default_response, API_types_ext::to_external_api(firmware_update_request),
"update_firmware");
}
void systemImpl::handle_allow_firmware_installation() {
static const auto topic = mod->helper.get_topics().everest_to_extern("allow_firmware_installation");
mod->mqtt_v.publish(topic, "");
}
types::system::UploadLogsResponse
systemImpl::handle_upload_logs(types::system::UploadLogsRequest& upload_logs_request) {
static const types::system::UploadLogsResponse default_response =
types::system::UploadLogsResponse{types::system::UploadLogsStatus::Rejected, {}};
return generic_request_reply(default_response, API_types_ext::to_external_api(upload_logs_request), "upload_logs");
}
bool systemImpl::handle_is_reset_allowed(types::system::ResetType& type) {
static const bool default_response = false;
return generic_request_reply(default_response, API_types_ext::to_external_api(type), "is_reset_allowed");
}
void systemImpl::handle_reset(types::system::ResetType& type, bool& scheduled) {
static const auto topic = mod->helper.get_topics().everest_to_extern("reset");
json args = API_types_ext::ResetRequest{API_types_ext::to_external_api(type), scheduled};
mod->mqtt_v.publish(topic, args.dump());
}
bool systemImpl::handle_set_system_time(std::string& timestamp) {
static const bool default_response = false;
return generic_request_reply(default_response, timestamp, "set_system_time");
}
types::system::BootReason systemImpl::handle_get_boot_reason() {
static const types::system::BootReason default_respone = types::system::BootReason::Unknown;
return generic_request_reply(default_respone, ev_API::internal::empty_payload, "get_boot_reason");
}
} // namespace main
} // namespace module

View File

@@ -0,0 +1,73 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
#ifndef MAIN_SYSTEM_IMPL_HPP
#define MAIN_SYSTEM_IMPL_HPP
//
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
// template version 3
//
#include <generated/interfaces/system/Implementation.hpp>
#include "../system_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 systemImpl : public systemImplBase {
public:
systemImpl() = delete;
systemImpl(Everest::ModuleAdapter* ev, const Everest::PtrContainer<system_API>& mod, Conf& config) :
systemImplBase(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::system::UpdateFirmwareResponse
handle_update_firmware(types::system::FirmwareUpdateRequest& firmware_update_request) override;
virtual void handle_allow_firmware_installation() override;
virtual types::system::UploadLogsResponse
handle_upload_logs(types::system::UploadLogsRequest& upload_logs_request) override;
virtual bool handle_is_reset_allowed(types::system::ResetType& type) override;
virtual void handle_reset(types::system::ResetType& type, bool& scheduled) override;
virtual bool handle_set_system_time(std::string& timestamp) override;
virtual types::system::BootReason handle_get_boot_reason() override;
// ev@d2d1847a-7b88-41dd-ad07-92785f06f5c4:v1
// insert your protected definitions here
// ev@d2d1847a-7b88-41dd-ad07-92785f06f5c4:v1
private:
const Everest::PtrContainer<system_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_SYSTEM_IMPL_HPP

View File

@@ -0,0 +1,30 @@
description: API for system modules
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: system
description: "Allows EVerest to access system wide operations via API clients."
enable_external_mqtt: true
metadata:
license: https://opensource.org/licenses/Apache-2.0
authors:
- James Chapman
- Cornelius Claussen
- Jan Christoph Habig
- Florin Mihut

View File

@@ -0,0 +1,64 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
#include "system_API.hpp"
#include <everest_api_types/generic/codec.hpp>
#include <everest_api_types/generic/string.hpp>
#include <everest_api_types/system/API.hpp>
#include <everest_api_types/system/codec.hpp>
#include <everest_api_types/system/wrapper.hpp>
#include <everest_api_types/utilities/codec.hpp>
#include <everest/logging.hpp>
namespace module {
namespace API_types_ext = API_types::system;
namespace API_generic = API_types::generic;
using ev_API::deserialize;
void system_API::init() {
invoke_init(*p_main);
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 system_API::ready() {
invoke_ready(*p_main);
generate_api_var_firmware_update_status();
generate_api_var_log_status();
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();
}
void system_API::generate_api_var_firmware_update_status() {
helper.subscribe_api_topic("firmware_update_status", [this](std::string const& data) {
API_types_ext::FirmwareUpdateStatus payload;
if (deserialize(data, payload)) {
p_main->publish_firmware_update_status(to_internal_api(payload));
return true;
}
return false;
});
}
void system_API::generate_api_var_log_status() {
helper.subscribe_api_topic("log_status", [this](std::string const& data) {
API_types_ext::LogStatus payload;
if (deserialize(data, payload)) {
p_main->publish_log_status(to_internal_api(payload));
return true;
}
return false;
});
}
} // namespace module

View File

@@ -0,0 +1,77 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2020 - 2026 Pionix GmbH and Contributors to EVerest
#ifndef SYSTEM_API_HPP
#define SYSTEM_API_HPP
//
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
// template version 2
//
#include "ld-ev.hpp"
// headers for provided interface implementations
#include <generated/interfaces/system/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 system_API : public Everest::ModuleBase {
public:
system_API() = delete;
system_API(const ModuleInfo& info, Everest::MqttProvider& mqtt_provider, std::unique_ptr<systemImplBase> p_main,
Conf& config) :
ModuleBase(info), mqtt(mqtt_provider), p_main(std::move(p_main)), config(config){};
Everest::MqttProvider& mqtt;
const std::unique_ptr<systemImplBase> p_main;
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, {{"system", 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
void generate_api_var_firmware_update_status();
void generate_api_var_log_status();
ev_API::CommCheckHandler<systemImplBase> comm_check{"system/CommunicationFault",
ev_API::bridge_connection_lost_message, p_main};
// 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 // SYSTEM_API_HPP