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:
@@ -0,0 +1,5 @@
|
||||
ev_add_module(ExampleErrorRaiser)
|
||||
ev_add_module(ExampleErrorSubscriber)
|
||||
ev_add_module(ExampleErrorGlobalSubscriber)
|
||||
ev_add_module(PyExampleErrorRaiser)
|
||||
ev_add_module(PyExampleErrorSubscriber)
|
||||
@@ -0,0 +1,21 @@
|
||||
#
|
||||
# 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
|
||||
# ev@bcc62523-e22b-41d7-ba2f-825b493a3c97:v1
|
||||
|
||||
target_sources(${MODULE_NAME}
|
||||
PRIVATE
|
||||
"example_global_subscriber/example_error_frameworkImpl.cpp"
|
||||
)
|
||||
|
||||
# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1
|
||||
# insert other things like install cmds etc here
|
||||
# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1
|
||||
@@ -0,0 +1,15 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#include "ExampleErrorGlobalSubscriber.hpp"
|
||||
|
||||
namespace module {
|
||||
|
||||
void ExampleErrorGlobalSubscriber::init() {
|
||||
invoke_init(*p_example_global_subscriber);
|
||||
}
|
||||
|
||||
void ExampleErrorGlobalSubscriber::ready() {
|
||||
invoke_ready(*p_example_global_subscriber);
|
||||
}
|
||||
|
||||
} // namespace module
|
||||
@@ -0,0 +1,60 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#ifndef EXAMPLE_ERROR_GLOBAL_SUBSCRIBER_HPP
|
||||
#define EXAMPLE_ERROR_GLOBAL_SUBSCRIBER_HPP
|
||||
|
||||
//
|
||||
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
|
||||
// template version 2
|
||||
//
|
||||
|
||||
#include "ld-ev.hpp"
|
||||
|
||||
// headers for provided interface implementations
|
||||
#include <generated/interfaces/example_error_framework/Implementation.hpp>
|
||||
|
||||
// ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
|
||||
// insert your custom include headers here
|
||||
// ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
|
||||
|
||||
namespace module {
|
||||
|
||||
struct Conf {};
|
||||
|
||||
class ExampleErrorGlobalSubscriber : public Everest::ModuleBase {
|
||||
public:
|
||||
ExampleErrorGlobalSubscriber() = delete;
|
||||
ExampleErrorGlobalSubscriber(const ModuleInfo& info,
|
||||
std::unique_ptr<example_error_frameworkImplBase> p_example_global_subscriber,
|
||||
Conf& config) :
|
||||
ModuleBase(info), p_example_global_subscriber(std::move(p_example_global_subscriber)), config(config){};
|
||||
|
||||
const std::unique_ptr<example_error_frameworkImplBase> p_example_global_subscriber;
|
||||
const Conf& config;
|
||||
|
||||
// ev@1fce4c5e-0ab8-41bb-90f7-14277703d2ac:v1
|
||||
// insert your public definitions here
|
||||
// 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@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 // EXAMPLE_ERROR_GLOBAL_SUBSCRIBER_HPP
|
||||
@@ -0,0 +1,30 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
|
||||
#include "example_error_frameworkImpl.hpp"
|
||||
|
||||
namespace module {
|
||||
namespace example_global_subscriber {
|
||||
|
||||
void example_error_frameworkImpl::init() {
|
||||
Everest::error::ErrorCallback error_callback = [this](const Everest::error::Error& error) {
|
||||
EVLOG_info << "received error: " << error.type;
|
||||
this->test_state_monitor();
|
||||
};
|
||||
Everest::error::ErrorCallback error_cleared_callback = [this](const Everest::error::Error& error) {
|
||||
EVLOG_info << "received error cleared: " << error.type;
|
||||
this->test_state_monitor();
|
||||
};
|
||||
subscribe_global_all_errors(error_callback, error_cleared_callback);
|
||||
}
|
||||
|
||||
void example_error_frameworkImpl::test_state_monitor() {
|
||||
EVLOG_info << "Currently there are " << get_global_error_state_monitor()->get_active_errors().size()
|
||||
<< " errors active.";
|
||||
}
|
||||
|
||||
void example_error_frameworkImpl::ready() {
|
||||
}
|
||||
|
||||
} // namespace example_global_subscriber
|
||||
} // namespace module
|
||||
@@ -0,0 +1,61 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#ifndef EXAMPLE_GLOBAL_SUBSCRIBER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
#define EXAMPLE_GLOBAL_SUBSCRIBER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
|
||||
//
|
||||
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
|
||||
// template version 3
|
||||
//
|
||||
|
||||
#include <generated/interfaces/example_error_framework/Implementation.hpp>
|
||||
|
||||
#include "../ExampleErrorGlobalSubscriber.hpp"
|
||||
|
||||
// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
|
||||
// insert your custom include headers here
|
||||
// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
|
||||
|
||||
namespace module {
|
||||
namespace example_global_subscriber {
|
||||
|
||||
struct Conf {};
|
||||
|
||||
class example_error_frameworkImpl : public example_error_frameworkImplBase {
|
||||
public:
|
||||
example_error_frameworkImpl() = delete;
|
||||
example_error_frameworkImpl(Everest::ModuleAdapter* ev,
|
||||
const Everest::PtrContainer<ExampleErrorGlobalSubscriber>& mod, Conf& config) :
|
||||
example_error_frameworkImplBase(ev, "example_global_subscriber"), 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<ExampleErrorGlobalSubscriber>& mod;
|
||||
const Conf& config;
|
||||
|
||||
virtual void init() override;
|
||||
virtual void ready() override;
|
||||
|
||||
// ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
|
||||
void test_state_monitor();
|
||||
// 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 example_global_subscriber
|
||||
} // namespace module
|
||||
|
||||
#endif // EXAMPLE_GLOBAL_SUBSCRIBER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
@@ -0,0 +1,10 @@
|
||||
description: Simple example module written in C++ to demonstrate error framework on global subscriber side
|
||||
provides:
|
||||
example_global_subscriber:
|
||||
interface: example_error_framework
|
||||
description: This implements the example interface
|
||||
enable_global_errors: true
|
||||
metadata:
|
||||
license: https://opensource.org/licenses/Apache-2.0
|
||||
authors:
|
||||
- Andreas Heinrich
|
||||
@@ -0,0 +1,21 @@
|
||||
#
|
||||
# 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
|
||||
# ev@bcc62523-e22b-41d7-ba2f-825b493a3c97:v1
|
||||
|
||||
target_sources(${MODULE_NAME}
|
||||
PRIVATE
|
||||
"example_raiser/example_error_frameworkImpl.cpp"
|
||||
)
|
||||
|
||||
# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1
|
||||
# insert other things like install cmds etc here
|
||||
# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1
|
||||
@@ -0,0 +1,15 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#include "ExampleErrorRaiser.hpp"
|
||||
|
||||
namespace module {
|
||||
|
||||
void ExampleErrorRaiser::init() {
|
||||
invoke_init(*p_example_raiser);
|
||||
}
|
||||
|
||||
void ExampleErrorRaiser::ready() {
|
||||
invoke_ready(*p_example_raiser);
|
||||
}
|
||||
|
||||
} // namespace module
|
||||
@@ -0,0 +1,59 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#ifndef EXAMPLE_ERROR_RAISER_HPP
|
||||
#define EXAMPLE_ERROR_RAISER_HPP
|
||||
|
||||
//
|
||||
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
|
||||
// template version 2
|
||||
//
|
||||
|
||||
#include "ld-ev.hpp"
|
||||
|
||||
// headers for provided interface implementations
|
||||
#include <generated/interfaces/example_error_framework/Implementation.hpp>
|
||||
|
||||
// ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
|
||||
// insert your custom include headers here
|
||||
// ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
|
||||
|
||||
namespace module {
|
||||
|
||||
struct Conf {};
|
||||
|
||||
class ExampleErrorRaiser : public Everest::ModuleBase {
|
||||
public:
|
||||
ExampleErrorRaiser() = delete;
|
||||
ExampleErrorRaiser(const ModuleInfo& info, std::unique_ptr<example_error_frameworkImplBase> p_example_raiser,
|
||||
Conf& config) :
|
||||
ModuleBase(info), p_example_raiser(std::move(p_example_raiser)), config(config){};
|
||||
|
||||
const std::unique_ptr<example_error_frameworkImplBase> p_example_raiser;
|
||||
const Conf& config;
|
||||
|
||||
// ev@1fce4c5e-0ab8-41bb-90f7-14277703d2ac:v1
|
||||
// insert your public definitions here
|
||||
// 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@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 // EXAMPLE_ERROR_RAISER_HPP
|
||||
@@ -0,0 +1,94 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
|
||||
#include "example_error_frameworkImpl.hpp"
|
||||
|
||||
#include <utils/error/error_factory.hpp>
|
||||
#include <utils/error/error_state_monitor.hpp>
|
||||
|
||||
#include <vector>
|
||||
|
||||
using Error = Everest::error::Error;
|
||||
using Condition = Everest::error::ErrorStateMonitor::StateCondition;
|
||||
namespace module {
|
||||
namespace example_raiser {
|
||||
|
||||
std::list<Condition> condition_0 = {Condition("example/ExampleErrorA", "some custom sub_type", true),
|
||||
Condition("example/ExampleErrorB", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorC", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorD", "some custom sub_type", false)};
|
||||
|
||||
std::list<Condition> condition_1 = {Condition("example/ExampleErrorA", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorB", "some custom sub_type", true),
|
||||
Condition("example/ExampleErrorC", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorD", "some custom sub_type", false)};
|
||||
|
||||
std::list<Condition> condition_2 = {Condition("example/ExampleErrorA", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorB", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorC", "some custom sub_type", true),
|
||||
Condition("example/ExampleErrorD", "some custom sub_type", true)};
|
||||
|
||||
std::list<Condition> condition_3 = {Condition("example/ExampleErrorA", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorB", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorC", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorD", "some custom sub_type", false)};
|
||||
|
||||
std::vector<std::list<Condition>> conditions = {condition_0, condition_1, condition_2, condition_3};
|
||||
|
||||
void example_error_frameworkImpl::check_conditions() {
|
||||
for (std::vector<std::list<Condition>>::size_type i = 0; i < conditions.size(); i++) {
|
||||
if (this->error_state_monitor->is_condition_satisfied(conditions.at(i))) {
|
||||
EVLOG_info << "Condition " << i << " satisfied";
|
||||
} else {
|
||||
EVLOG_info << "Condition " << i << " not satisfied";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void example_error_frameworkImpl::init() {
|
||||
}
|
||||
|
||||
void example_error_frameworkImpl::ready() {
|
||||
Error error_a = this->error_factory->create_error("example/ExampleErrorA", "some custom sub_type",
|
||||
"This error is raised to test the error handling");
|
||||
raise_error(error_a);
|
||||
check_conditions();
|
||||
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||
clear_error("example/ExampleErrorA", "some custom sub_type");
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::seconds(2));
|
||||
|
||||
Error error_b = this->error_factory->create_error("example/ExampleErrorB", "some custom sub_type",
|
||||
"This error is raised to test the error handling",
|
||||
Everest::error::Severity::High);
|
||||
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||
raise_error(error_b);
|
||||
check_conditions();
|
||||
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||
clear_error("example/ExampleErrorB", "some custom sub_type");
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::seconds(2));
|
||||
|
||||
Error error_c = this->error_factory->create_error("example/ExampleErrorC", "some custom sub_type",
|
||||
"This error is raised to test the error handling",
|
||||
Everest::error::Severity::Medium);
|
||||
raise_error(error_c);
|
||||
check_conditions();
|
||||
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||
|
||||
Error error_d = this->error_factory->create_error("example/ExampleErrorD", "some custom sub_type",
|
||||
"This error is raised to test the error handling",
|
||||
Everest::error::Severity::Medium);
|
||||
raise_error(error_d);
|
||||
check_conditions();
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::seconds(2));
|
||||
|
||||
clear_all_errors_of_impl();
|
||||
check_conditions();
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::seconds(2));
|
||||
}
|
||||
|
||||
} // namespace example_raiser
|
||||
} // namespace module
|
||||
@@ -0,0 +1,61 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#ifndef EXAMPLE_RAISER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
#define EXAMPLE_RAISER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
|
||||
//
|
||||
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
|
||||
// template version 3
|
||||
//
|
||||
|
||||
#include <generated/interfaces/example_error_framework/Implementation.hpp>
|
||||
|
||||
#include "../ExampleErrorRaiser.hpp"
|
||||
|
||||
// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
|
||||
// insert your custom include headers here
|
||||
// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
|
||||
|
||||
namespace module {
|
||||
namespace example_raiser {
|
||||
|
||||
struct Conf {};
|
||||
|
||||
class example_error_frameworkImpl : public example_error_frameworkImplBase {
|
||||
public:
|
||||
example_error_frameworkImpl() = delete;
|
||||
example_error_frameworkImpl(Everest::ModuleAdapter* ev, const Everest::PtrContainer<ExampleErrorRaiser>& mod,
|
||||
Conf& config) :
|
||||
example_error_frameworkImplBase(ev, "example_raiser"), 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<ExampleErrorRaiser>& mod;
|
||||
const Conf& config;
|
||||
|
||||
virtual void init() override;
|
||||
virtual void ready() override;
|
||||
|
||||
// ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
|
||||
void check_conditions();
|
||||
// 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 example_raiser
|
||||
} // namespace module
|
||||
|
||||
#endif // EXAMPLE_RAISER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
@@ -0,0 +1,9 @@
|
||||
description: Simple example module written in C++ to demonstrate error handling on raiser side
|
||||
provides:
|
||||
example_raiser:
|
||||
interface: example_error_framework
|
||||
description: This implements an example interface
|
||||
metadata:
|
||||
license: https://opensource.org/licenses/Apache-2.0
|
||||
authors:
|
||||
- Andreas Heinrich
|
||||
@@ -0,0 +1,21 @@
|
||||
#
|
||||
# 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
|
||||
# ev@bcc62523-e22b-41d7-ba2f-825b493a3c97:v1
|
||||
|
||||
target_sources(${MODULE_NAME}
|
||||
PRIVATE
|
||||
"example_subscriber/example_error_frameworkImpl.cpp"
|
||||
)
|
||||
|
||||
# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1
|
||||
# insert other things like install cmds etc here
|
||||
# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1
|
||||
@@ -0,0 +1,15 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#include "ExampleErrorSubscriber.hpp"
|
||||
|
||||
namespace module {
|
||||
|
||||
void ExampleErrorSubscriber::init() {
|
||||
invoke_init(*p_example_subscriber);
|
||||
}
|
||||
|
||||
void ExampleErrorSubscriber::ready() {
|
||||
invoke_ready(*p_example_subscriber);
|
||||
}
|
||||
|
||||
} // namespace module
|
||||
@@ -0,0 +1,67 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#ifndef EXAMPLE_ERROR_SUBSCRIBER_HPP
|
||||
#define EXAMPLE_ERROR_SUBSCRIBER_HPP
|
||||
|
||||
//
|
||||
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
|
||||
// template version 2
|
||||
//
|
||||
|
||||
#include "ld-ev.hpp"
|
||||
|
||||
// headers for provided interface implementations
|
||||
#include <generated/interfaces/example_error_framework/Implementation.hpp>
|
||||
|
||||
// headers for required interface implementations
|
||||
#include <generated/interfaces/example_error_framework/Interface.hpp>
|
||||
|
||||
// ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
|
||||
// insert your custom include headers here
|
||||
// ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
|
||||
|
||||
namespace module {
|
||||
|
||||
struct Conf {};
|
||||
|
||||
class ExampleErrorSubscriber : public Everest::ModuleBase {
|
||||
public:
|
||||
ExampleErrorSubscriber() = delete;
|
||||
ExampleErrorSubscriber(const ModuleInfo& info,
|
||||
std::unique_ptr<example_error_frameworkImplBase> p_example_subscriber,
|
||||
std::unique_ptr<example_error_frameworkIntf> r_example_raiser, Conf& config) :
|
||||
ModuleBase(info),
|
||||
p_example_subscriber(std::move(p_example_subscriber)),
|
||||
r_example_raiser(std::move(r_example_raiser)),
|
||||
config(config){};
|
||||
|
||||
const std::unique_ptr<example_error_frameworkImplBase> p_example_subscriber;
|
||||
const std::unique_ptr<example_error_frameworkIntf> r_example_raiser;
|
||||
const Conf& config;
|
||||
|
||||
// ev@1fce4c5e-0ab8-41bb-90f7-14277703d2ac:v1
|
||||
// insert your public definitions here
|
||||
// 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@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 // EXAMPLE_ERROR_SUBSCRIBER_HPP
|
||||
@@ -0,0 +1,66 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
|
||||
#include "example_error_frameworkImpl.hpp"
|
||||
|
||||
#include <utils/error/error_factory.hpp>
|
||||
#include <utils/error/error_state_monitor.hpp>
|
||||
|
||||
#include <vector>
|
||||
|
||||
using Condition = Everest::error::ErrorStateMonitor::StateCondition;
|
||||
|
||||
namespace module {
|
||||
namespace example_subscriber {
|
||||
|
||||
std::list<Condition> condition_0 = {Condition("example/ExampleErrorA", "some custom sub_type", true),
|
||||
Condition("example/ExampleErrorB", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorC", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorD", "some custom sub_type", false)};
|
||||
|
||||
std::list<Condition> condition_1 = {Condition("example/ExampleErrorA", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorB", "some custom sub_type", true),
|
||||
Condition("example/ExampleErrorC", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorD", "some custom sub_type", false)};
|
||||
|
||||
std::list<Condition> condition_2 = {Condition("example/ExampleErrorA", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorB", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorC", "some custom sub_type", true),
|
||||
Condition("example/ExampleErrorD", "some custom sub_type", true)};
|
||||
|
||||
std::list<Condition> condition_3 = {Condition("example/ExampleErrorA", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorB", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorC", "some custom sub_type", false),
|
||||
Condition("example/ExampleErrorD", "some custom sub_type", false)};
|
||||
|
||||
std::vector<std::list<Condition>> conditions = {condition_0, condition_1, condition_2, condition_3};
|
||||
|
||||
void example_error_frameworkImpl::check_conditions() {
|
||||
for (std::vector<std::list<Condition>>::size_type i = 0; i < conditions.size(); i++) {
|
||||
if (this->mod->r_example_raiser->error_state_monitor->is_condition_satisfied(conditions.at(i))) {
|
||||
EVLOG_info << "Condition " << i << " satisfied";
|
||||
} else {
|
||||
EVLOG_info << "Condition " << i << " not satisfied";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void example_error_frameworkImpl::init() {
|
||||
Everest::error::ErrorCallback error_callback = [this](const Everest::error::Error& error) {
|
||||
EVLOG_info << "received error: " << error.type;
|
||||
check_conditions();
|
||||
};
|
||||
Everest::error::ErrorCallback error_cleared_callback = [this](const Everest::error::Error& error) {
|
||||
EVLOG_info << "received error cleared: " << error.type;
|
||||
check_conditions();
|
||||
};
|
||||
mod->r_example_raiser->subscribe_error("example/ExampleErrorA", error_callback, error_cleared_callback);
|
||||
mod->r_example_raiser->subscribe_all_errors(error_callback, error_cleared_callback);
|
||||
}
|
||||
|
||||
void example_error_frameworkImpl::ready() {
|
||||
check_conditions();
|
||||
}
|
||||
|
||||
} // namespace example_subscriber
|
||||
} // namespace module
|
||||
@@ -0,0 +1,61 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// Copyright Pionix GmbH and Contributors to EVerest
|
||||
#ifndef EXAMPLE_SUBSCRIBER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
#define EXAMPLE_SUBSCRIBER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
|
||||
//
|
||||
// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
|
||||
// template version 3
|
||||
//
|
||||
|
||||
#include <generated/interfaces/example_error_framework/Implementation.hpp>
|
||||
|
||||
#include "../ExampleErrorSubscriber.hpp"
|
||||
|
||||
// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
|
||||
// insert your custom include headers here
|
||||
// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
|
||||
|
||||
namespace module {
|
||||
namespace example_subscriber {
|
||||
|
||||
struct Conf {};
|
||||
|
||||
class example_error_frameworkImpl : public example_error_frameworkImplBase {
|
||||
public:
|
||||
example_error_frameworkImpl() = delete;
|
||||
example_error_frameworkImpl(Everest::ModuleAdapter* ev, const Everest::PtrContainer<ExampleErrorSubscriber>& mod,
|
||||
Conf& config) :
|
||||
example_error_frameworkImplBase(ev, "example_subscriber"), 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<ExampleErrorSubscriber>& mod;
|
||||
const Conf& config;
|
||||
|
||||
virtual void init() override;
|
||||
virtual void ready() override;
|
||||
|
||||
// ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
|
||||
void check_conditions();
|
||||
// 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 example_subscriber
|
||||
} // namespace module
|
||||
|
||||
#endif // EXAMPLE_SUBSCRIBER_EXAMPLE_ERROR_FRAMEWORK_IMPL_HPP
|
||||
@@ -0,0 +1,12 @@
|
||||
description: Simple example module written in C++ to demonstrate error framework on subscriber side
|
||||
provides:
|
||||
example_subscriber:
|
||||
interface: example_error_framework
|
||||
description: This implements the example interface
|
||||
requires:
|
||||
example_raiser:
|
||||
interface: example_error_framework
|
||||
metadata:
|
||||
license: https://opensource.org/licenses/Apache-2.0
|
||||
authors:
|
||||
- Andreas Heinrich
|
||||
@@ -0,0 +1,9 @@
|
||||
description: Simple example module written in Python to demonstrate error handling on raiser side
|
||||
provides:
|
||||
example_raiser:
|
||||
interface: example_error_framework
|
||||
description: This implements an example interface
|
||||
metadata:
|
||||
license: https://opensource.org/licenses/Apache-2.0
|
||||
authors:
|
||||
- Andreas Heinrich
|
||||
@@ -0,0 +1,108 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# Copyright Pionix GmbH and Contributors to EVerest
|
||||
|
||||
from everest.framework import Module, RuntimeSession, log, error
|
||||
import time, threading
|
||||
|
||||
condition_lists = [
|
||||
{
|
||||
"name": "Only A is active",
|
||||
"conditions": [
|
||||
error.ErrorStateCondition("example/ExampleErrorA", "example sub type", True),
|
||||
error.ErrorStateCondition("example/ExampleErrorB", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorC", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorD", "example sub type", False),
|
||||
],
|
||||
},
|
||||
{
|
||||
"name": "Only B is active",
|
||||
"conditions": [
|
||||
error.ErrorStateCondition("example/ExampleErrorA", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorB", "example sub type", True),
|
||||
error.ErrorStateCondition("example/ExampleErrorC", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorD", "example sub type", False),
|
||||
],
|
||||
},
|
||||
{
|
||||
"name": "Only C & D are active",
|
||||
"conditions": [
|
||||
error.ErrorStateCondition("example/ExampleErrorA", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorB", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorC", "example sub type", True),
|
||||
error.ErrorStateCondition("example/ExampleErrorD", "example sub type", True),
|
||||
],
|
||||
},
|
||||
{
|
||||
"name": "No error is active",
|
||||
"conditions": [
|
||||
error.ErrorStateCondition("example/ExampleErrorA", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorB", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorC", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorD", "example sub type", False),
|
||||
],
|
||||
}
|
||||
]
|
||||
|
||||
class PyExampleErrorRaiserModule():
|
||||
def __init__(self) -> None:
|
||||
self._session = RuntimeSession()
|
||||
m = Module(self._session)
|
||||
|
||||
log.update_process_name(m.info.id)
|
||||
|
||||
self._ready_event = threading.Event()
|
||||
|
||||
self._setup = m.say_hello()
|
||||
|
||||
self._mod = m
|
||||
self._mod.init_done(self._ready)
|
||||
|
||||
def _ready(self):
|
||||
log.debug("ready!")
|
||||
self._ready_event.set()
|
||||
|
||||
def check_conditions(self):
|
||||
monitor = self._mod.get_error_state_monitor_impl("example_raiser")
|
||||
for entry in condition_lists:
|
||||
if monitor.is_condition_satisfied(entry["conditions"]):
|
||||
log.info(f"Condition '{entry['name']}' is satisfied")
|
||||
else:
|
||||
log.info(f"Condition '{entry['name']}' is not satisfied")
|
||||
|
||||
def start_example(self):
|
||||
while True:
|
||||
self._ready_event.wait()
|
||||
try:
|
||||
error_factory = self._mod.get_error_factory("example_raiser")
|
||||
error = error_factory.create_error("example/ExampleErrorA", "example sub type", "example error message")
|
||||
self._mod.raise_error("example_raiser", error)
|
||||
self.check_conditions()
|
||||
time.sleep(1)
|
||||
self._mod.clear_error("example_raiser", "example/ExampleErrorA", "example sub type")
|
||||
self.check_conditions()
|
||||
time.sleep(1)
|
||||
error = error_factory.create_error("example/ExampleErrorB", "example sub type", "example error message")
|
||||
self._mod.raise_error("example_raiser", error)
|
||||
self.check_conditions()
|
||||
time.sleep(1)
|
||||
self._mod.clear_error("example_raiser", "example/ExampleErrorB", "example sub type")
|
||||
self.check_conditions()
|
||||
time.sleep(1)
|
||||
error = error_factory.create_error("example/ExampleErrorC", "example sub type", "example error message")
|
||||
self._mod.raise_error("example_raiser", error)
|
||||
self.check_conditions()
|
||||
time.sleep(1)
|
||||
error = error_factory.create_error("example/ExampleErrorD", "example sub type", "example error message")
|
||||
self._mod.raise_error("example_raiser", error)
|
||||
self.check_conditions()
|
||||
time.sleep(1)
|
||||
self._mod.clear_all_errors_of_impl("example_raiser")
|
||||
self.check_conditions()
|
||||
time.sleep(1)
|
||||
except KeyboardInterrupt:
|
||||
log.debug("Example program terminated manually")
|
||||
break
|
||||
self._ready_event.clear()
|
||||
|
||||
py_example_error_raiser = PyExampleErrorRaiserModule()
|
||||
py_example_error_raiser.start_example()
|
||||
@@ -0,0 +1,12 @@
|
||||
description: Simple example module written in Python to demonstrate error framework on subscriber side
|
||||
provides:
|
||||
example_subscriber:
|
||||
interface: example_error_framework
|
||||
description: This implements the example interface
|
||||
requires:
|
||||
example_raiser:
|
||||
interface: example_error_framework
|
||||
metadata:
|
||||
license: https://opensource.org/licenses/Apache-2.0
|
||||
authors:
|
||||
- Andreas Heinrich
|
||||
@@ -0,0 +1,107 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# Copyright Pionix GmbH and Contributors to EVerest
|
||||
|
||||
from everest.framework import Module, RuntimeSession, log, error
|
||||
import threading
|
||||
|
||||
condition_lists = [
|
||||
{
|
||||
"name": "Only A is active",
|
||||
"conditions": [
|
||||
error.ErrorStateCondition("example/ExampleErrorA", "example sub type", True),
|
||||
error.ErrorStateCondition("example/ExampleErrorB", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorC", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorD", "example sub type", False),
|
||||
],
|
||||
},
|
||||
{
|
||||
"name": "Only B is active",
|
||||
"conditions": [
|
||||
error.ErrorStateCondition("example/ExampleErrorA", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorB", "example sub type", True),
|
||||
error.ErrorStateCondition("example/ExampleErrorC", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorD", "example sub type", False),
|
||||
],
|
||||
},
|
||||
{
|
||||
"name": "Only C & D are active",
|
||||
"conditions": [
|
||||
error.ErrorStateCondition("example/ExampleErrorA", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorB", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorC", "example sub type", True),
|
||||
error.ErrorStateCondition("example/ExampleErrorD", "example sub type", True),
|
||||
],
|
||||
},
|
||||
{
|
||||
"name": "No error is active",
|
||||
"conditions": [
|
||||
error.ErrorStateCondition("example/ExampleErrorA", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorB", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorC", "example sub type", False),
|
||||
error.ErrorStateCondition("example/ExampleErrorD", "example sub type", False),
|
||||
],
|
||||
}
|
||||
]
|
||||
|
||||
class PyExampleErrorSubscriberModule():
|
||||
def __init__(self) -> None:
|
||||
self._session = RuntimeSession()
|
||||
m = Module(self._session)
|
||||
|
||||
log.update_process_name(m.info.id)
|
||||
|
||||
self._setup = m.say_hello()
|
||||
|
||||
self._ready_event = threading.Event()
|
||||
|
||||
self._req_example_raiser = self._setup.connections['example_raiser'][0]
|
||||
m.subscribe_error(
|
||||
self._req_example_raiser,
|
||||
'example/ExampleErrorA',
|
||||
self.handle_error,
|
||||
self.handle_error_cleared
|
||||
)
|
||||
m.subscribe_all_errors(
|
||||
self._req_example_raiser,
|
||||
self.handle_error,
|
||||
self.handle_error_cleared
|
||||
)
|
||||
|
||||
self._mod = m
|
||||
self._mod.init_done(self._ready)
|
||||
|
||||
def handle_error(self, error):
|
||||
log.info("Received error: '" + error.type + "' '" + error.sub_type + "' '" + error.message + "'")
|
||||
self.check_conditions()
|
||||
|
||||
def handle_error_cleared(self, error):
|
||||
log.info("Received error cleared: '" + error.type + "' '" + error.sub_type + "' '" + error.message + "'")
|
||||
self.check_conditions()
|
||||
|
||||
def _ready(self):
|
||||
self._ready_event.set()
|
||||
log.debug("ready!")
|
||||
|
||||
def start_example(self):
|
||||
while True:
|
||||
self._ready_event.wait()
|
||||
try:
|
||||
log.info("Example program started")
|
||||
|
||||
except KeyboardInterrupt:
|
||||
log.debug("Example program terminated manually")
|
||||
break
|
||||
self._ready_event.clear()
|
||||
|
||||
def check_conditions(self):
|
||||
monitor = self._mod.get_error_state_monitor_req(self._req_example_raiser)
|
||||
for entry in condition_lists:
|
||||
if monitor.is_condition_satisfied(entry["conditions"]):
|
||||
log.info(f"Condition '{entry['name']}' is satisfied")
|
||||
else:
|
||||
log.info(f"Condition '{entry['name']}' is not satisfied")
|
||||
log.info("")
|
||||
log.info("")
|
||||
|
||||
py_example_error_subscriber = PyExampleErrorSubscriberModule()
|
||||
py_example_error_subscriber.start_example()
|
||||
Reference in New Issue
Block a user