Add detailed module concept documentation #1575
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pietfried
requested review from
SebaLukas,
andistorm,
corneliusclaussen and
hikinggrass
as code owners
…tory. (#1380) It is the foundation for the integration of more documentation bits from https://github.com/EVerest/EVerest into this structure. Changes include: * Docs build process and Sphinx configuration * Diataxis skeleton dividing every part of the documentation into: Explaination, How-to-guide, Tutorial, Reference * Added instructions how to build the documentation to everest-core README * Generation of reference documentation Signed-off-by: Krealyt <manuel.ziegler@pionix.de> Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
* doc(explanation): Add community channels to docs Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
…inx (#1477) * Refactor _find_sphinx_build macro to allow system installation of sphinx Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> * Fix setting of _SPHINX_BUILD_EXECUTABLE It needs to be a list, otherwise cmake will escape all whitespace which would then lead to a failure executing the command Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de> --------- Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de> Co-authored-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Added Plug&Charge tutorial to docs --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(how-to): Add Configure Plug&Charge in EVerest --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Add OCPP1.6 tutorial --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
* doc(how-to): Add debug ISO15118 documentation --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Add develop new modules --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(linux/yocto): Added several documentation parts for Linux/Yocto integration --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
…ging Regulations to documentation (#1494) Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(how-to): Add Renesas MPU docs --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
… as part of EVerest doc (#1564) * docs(api): Move asyncapi spec and provide HTMLs as part of EVerest doc --------- Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
…nt) (#1581) Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
* doc(how-to): Add BringUp documentation for basic, ac, dc and powermeter bringup --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(explanation): Add adapt EVerest documentation --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(getting-started): Added Getting Started guides for SW and HW --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Pietfried
force-pushed
the
feature/docs-migration
branch
from
17b5f96 to
972c091
Compare
Pietfried
requested review from
a-w50,
cburandt,
djchhp,
dorezyuk,
james-ctc and
rckstrh
as code owners
Pietfried
force-pushed
the
docs/add-detailed-module-concept
branch
from
bb12a66 to
e816b19
Compare
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
hikinggrass
reviewed
Dec 2, 2025
Comment on lines
+152
to
+156
| The MQTT topic for commands is: | ||
| ``everest/{module instance ID}/{interface implementation ID}/cmd`` | ||
| Similarly, the MQTT topic for variables is: | ||
| ``everest/{module instance ID}/{interface implementation ID}/var`` | ||
| Note that the path prefix ``everest`` may differ in some end-to-end tests. |
Member
There was a problem hiding this comment.
TODO: once everest-framework 0.25 is integrated this needs to be updated
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
…tory. (#1380) It is the foundation for the integration of more documentation bits from https://github.com/EVerest/EVerest into this structure. Changes include: * Docs build process and Sphinx configuration * Diataxis skeleton dividing every part of the documentation into: Explaination, How-to-guide, Tutorial, Reference * Added instructions how to build the documentation to everest-core README * Generation of reference documentation Signed-off-by: Krealyt <manuel.ziegler@pionix.de> Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Manuel Ziegler <113091917+krealyt@users.noreply.github.com> Co-authored-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Pietfried
force-pushed
the
docs/add-detailed-module-concept
branch
from
191042e to
9a67d5d
Compare
Pietfried
force-pushed
the
feature/docs-migration
branch
from
8d0bce3 to
78eeca2
Compare
Pietfried
force-pushed
the
feature/docs-migration
branch
from
55cca87 to
eacde18
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Adds https://github.com/EVerest/EVerest/blob/main/docs/general/04_detail_module_concept.rst to docs
Issue ticket number and link
Original PR: #1431
Checklist before requesting a review