https://wiki.eeros.org/ 2026-05-06T11:39:41+00:00 https://wiki.eeros.org/ https://wiki.eeros.org/_media/logo.png text/html 2020-06-26T12:52:39+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/bugfixprocess?rev=1593175959&do=diff Bug Fix Release Process The following is a step-by-step procedure for creating a bug fix release. All the planning work is done on Trello on the EEROS Tasks Board. New developers have to request access rights by submitting the contact form. 1. Announcement of a bug fix release text/html 2024-08-12T13:43:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/commit_guidelines?rev=1723470239&do=diff Git Commit Guidelines The EEROS Framework is developed using the following git commit guidelines. 1. Changes are as small and atomic as possible * Commit each fix or task as a separate change * Only commit when a block of work is complete * Commit a new feature as joint commit when the additions belong together text/html 2019-01-25T14:16:26+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/contribute?rev=1548425786&do=diff Contribute to EEROS The development on the EEROS Framework is done with the workflow “develop with a fork”. For contribution, EEROS must be forked. The implementation is done in the fork. Afterwards, the changes are merged into the master branch of the main project repository. The merge is initiated by the pull request feature of GitHub. This workflow allows an easy way to contribute for everyone. It also improves the code quality since the pull requests are reviewed before the merge. text/html 2024-03-14T11:16:57+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/json_parser?rev=1710415017&do=diff JSON Parser We use libucl as JSON parser for EEROS. But we use our own fork of the libucl-Repository. There is an additional function added to libucl to support parsing with strategy function from a file. This was not supported by default but we need it to detect duplicate entries of devices, subdevices or channels and throw a Fault. text/html 2026-04-22T08:54:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/releaseprocess?rev=1776848062&do=diff Release Process The following is a step-by-step procedure for releasing a new version of EEROS. All the planning work is done on Trello on the EEROS Tasks Board. New developers have to request access rights by submitting the contact form. 1. Announcement of a new release text/html 2019-01-30T10:04:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/releases?rev=1548842652&do=diff Releases EEROS is released in the form of the source code via GitHub. All releases are found here. The release workflow supports multiple active releases. Every active release has its own release branch. The actual release commit is tagged with the version number. EEROS is versioned according to the text/html 2015-04-07T13:22:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/sharing_data?rev=1428412974&do=diff Sharing Data Different processes and threads need to exchange data among them. The control system together with the safety system is executed by different threads in the same process. The simulator and various services run in their own processes to acquire signal information during runtime such as scopes. text/html 2017-05-04T06:58:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/simulator?rev=1493881102&do=diff Extending the Simulator How to add a new device type to sim-eeros? * create class derived from SimBehaviour.hpp * implement member functions according to your needs * constructor: create your simulation channels * run() : implement your desired simulation function text/html 2019-09-10T09:03:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/start?rev=1568106217&do=diff For Developers This page is intended for developers. It contains material which show how to extend EEROS itself. Interfacing with Hardware * Create new Wrapper Library * JSON Parser libucl * Extending the Simulator Various * Coding Style Guide * Git Commit Guidelines * Contribute * Release Process * Bug Fix Release Process * Releases * Sharing Data * EEROS types are defined in includes/types.hpp text/html 2021-06-09T16:31:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/style_guide?rev=1623256313&do=diff Coding Style Guide EEROS is written primarily in C++, and its developers follow the Google C++ Style Guide with some modifications: #define Guards We use define guards with a naming similar to Java package names. For example, lets look at the class Block using the following source files: text/html 2026-04-02T15:36:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/testing?rev=1775144206&do=diff Testing We use Google Test as our test framework. Read <https://google.github.io/googletest/primer.html> to understand how to use the available macros for defining test cases. Naming All the tests must be named in the following manner. TEST(testName, testMethodName) { ... } testName should include the name of the package, e.g. controlDeMuxBlock or safetyEventTest. This allows for running only the tests in a certain package. text/html 2026-04-12T14:50:20+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/thread_safety?rev=1776005420&do=diff Thread Safety In EEROS, blocks are basically accessed by multiple threads. EEROS blocks feature thread safety by providing exclusive access to critical memory locations by a mutex. Concurrency can not be tested by Google Test framework. Therefore, test executables are needed which can be executed manually or via bash scripts. text/html 2017-04-18T10:43:02+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.eeros.org/for_developers/wrapper_lib?rev=1492512182&do=diff Create new Wrapper Library The following steps have to be taken in order to create a custom wrapper library. See also flink-eeros or comedi-eeros. * Create new CMake project for a shared library. * Include and link against EEROS: find_package(EEROS REQUIRED) include_directories(${EEROS_INCLUDE_DIR}) link_directories(${EEROS_LIB_DIR})