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
169
tools/EVerest-main/docs/source/index.rst
Normal file
169
tools/EVerest-main/docs/source/index.rst
Normal file
@@ -0,0 +1,169 @@
|
||||
#######
|
||||
EVerest
|
||||
#######
|
||||
|
||||
********************
|
||||
Powering EV-Charging
|
||||
********************
|
||||
|
||||
EVerest is ...
|
||||
|
||||
* a full-stack environment for EV-charging,
|
||||
* a `Linux Foundation Energy project <https://lfenergy.org/projects/everest/>`_,
|
||||
* open-source,
|
||||
* modular and customizable,
|
||||
* licensed under the Apache 2.0 license to allow commercial-friendly use and
|
||||
* backed by strong industry partners via great compatibility.
|
||||
|
||||
The EVerest project was initiated by `Pionix GmbH <https://www.pionix.com/>`_ to help with the
|
||||
electrification of the mobility sector.
|
||||
|
||||
To engage with the **community** directly, feel free to join our EVerest contributor sessions.
|
||||
These live discussions are open to everyone; you can find the schedule in the
|
||||
`EVerest event calendar <https://zoom-lfx.platform.linuxfoundation.org/meetings/everest?view=week>`_.
|
||||
|
||||
*************************
|
||||
The EVerest Documentation
|
||||
*************************
|
||||
|
||||
Our documentation is structured according to the `Diátaxis <https://diataxis.fr/>`_ framework:
|
||||
|
||||
* *tutorials*: Learn by doing through guided practice.
|
||||
* *how-to guides*: Practical steps to achieve specific tasks.
|
||||
* *reference*: Technical facts, APIs, and configuration details.
|
||||
* *explanations*: Conceptual deep-dives and background theory.
|
||||
|
||||
You can find a comprehensive list under "All EVerest Documentation"
|
||||
:ref:`below <idx_all_everest_documentation>`, or navigate using the sidebar.
|
||||
|
||||
If you are **just getting started**, we recommend beginning with these essential topics:
|
||||
|
||||
.. grid:: 1 2 2 2
|
||||
:gutter: 2
|
||||
|
||||
.. grid-item-card:: High-level Overview
|
||||
:link: explanation/high-level-overview
|
||||
:link-type: doc
|
||||
|
||||
Get an understanding of the most important mechanisms and the
|
||||
architecture of EVerest. Best for everyone who enjoys some theory before
|
||||
the development work.
|
||||
|
||||
.. grid-item-card:: Quick Start Guides
|
||||
:link: how-to-guides/getting-started/index
|
||||
:link-type: doc
|
||||
|
||||
We provide several entry points for a fast first experience with EVerest.
|
||||
Whether you want to do a software-based simulation or start
|
||||
working with existing hardware, you will find your way here.
|
||||
|
||||
.. grid-item-card:: GitHub Source
|
||||
:link: https://github.com/everest
|
||||
:link-type: url
|
||||
|
||||
In case you want to dig directly into the sources of EVerest, go for it!
|
||||
The *EVerest* repository is the center of activity.
|
||||
|
||||
.. grid-item-card:: Discuss and Collaborate
|
||||
:link: project/community
|
||||
:link-type: doc
|
||||
|
||||
Meet the EVerest community on different channels like Zulip, live calls
|
||||
and others.
|
||||
Learn how to contribute, submit bugs or feature ideas.
|
||||
|
||||
.. _idx_all_everest_documentation:
|
||||
|
||||
*************************
|
||||
All EVerest Documentation
|
||||
*************************
|
||||
|
||||
We have organized our documentation snippets in the following structure for
|
||||
everybody to find their best way of learning:
|
||||
|
||||
.. grid:: 1 2 2 2
|
||||
:gutter: 2
|
||||
|
||||
.. grid-item-card:: 🎓 Tutorials
|
||||
:link: tutorials/index
|
||||
:link-type: doc
|
||||
|
||||
Learn a new skill by following our step-by-step experience.
|
||||
Best to start at the beginning.
|
||||
|
||||
Example: **"Write your first hardware driver"**
|
||||
|
||||
.. grid-item-card:: 🛠️ How-To Guides
|
||||
:link: how-to-guides/index
|
||||
:link-type: doc
|
||||
|
||||
Practical guides to solve dedicated problems that focus on the important
|
||||
aspects.
|
||||
Best for people who already have experience with EVerest and want to get
|
||||
a fast way into a topic.
|
||||
|
||||
Example: **"How can I activate the OCPP protocol?"**
|
||||
|
||||
.. grid-item-card:: 💡 Explanations
|
||||
:link: explanation/index
|
||||
:link-type: doc
|
||||
|
||||
More detailed information to deepen your knowledge.
|
||||
Go here for background information and concepts.
|
||||
|
||||
Example: **How is authorization done in EVerest?**
|
||||
|
||||
.. grid-item-card:: 📚 References
|
||||
:link: reference/index
|
||||
:link-type: doc
|
||||
|
||||
Technical overviews, API documentation, auto-generated class definitions - go here.
|
||||
|
||||
.. grid-item-card:: 💬 Q & A
|
||||
:link: qa/index
|
||||
:link-type: doc
|
||||
|
||||
There might be some questions open - here is the place to look for answers.
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
:caption: Getting Started
|
||||
|
||||
how-to-guides/getting-started/get-started-sw
|
||||
how-to-guides/getting-started/get-started-hw
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
:caption: Contents
|
||||
|
||||
tutorials/index
|
||||
how-to-guides/index
|
||||
explanation/index
|
||||
reference/index
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
:caption: Getting Help
|
||||
|
||||
qa/index
|
||||
project/index
|
||||
|
||||
***************
|
||||
Important links
|
||||
***************
|
||||
|
||||
.. grid:: 2
|
||||
:gutter: 3
|
||||
|
||||
.. grid-item::
|
||||
|
||||
* `GitHub Repository <https://github.com/everest>`_
|
||||
* `Linux Foundation Energy <https://lfenergy.org/>`_
|
||||
|
||||
.. grid-item::
|
||||
|
||||
* `Discussion Forum (Zulip) <https://lfenergy.zulipchat.com/>`_
|
||||
* `Live Events & Calendar <https://zoom-lfx.platform.linuxfoundation.org/meetings/everest?view=week>`_
|
||||
Reference in New Issue
Block a user