Files
cariflex/tools/EVerest-main/docs/source/how-to-guides/index.rst
Eric F d398a6ced2 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
2026-06-08 00:38:27 -04:00

132 lines
3.6 KiB
ReStructuredText

#############
How To Guides
#############
How-to guides are practical guides to solve dedicated problems.
If you already have some experience with EVerest, those guides might be for
you.
Find a fast way into a topic without going through all the basic details.
Have a look at this categorized list of all guides:
.. grid:: 1 2 2 3
:gutter: 2
.. grid-item-card:: Documenting EVerest
:link: documenting-everest/index
:link-type: doc
How to write documentation for EVerest.
.. grid-item-card:: Getting started with EVerest
:link: getting-started/index
:link-type: doc
Hands-on getting started with or without hardware.
.. grid-item-card:: Use the Error Framework
:link: error-framework-howto
:link-type: doc
How to use the error framework to raise/clear errors and listen to these events.
.. grid-item-card:: Configure Plug&Charge
:link: configure-pnc
:link-type: doc
How to enable Plug&Charge in a EVerest configuration.
.. grid-item-card:: Debug ISO 15118
:link: debug-iso15118
:link-type: doc
How to debug ISO15118 communication of EVerest using Wireshark.
.. grid-item-card:: Debug Modules
:link: debug-modules
:link-type: doc
How to debug a single EVerest module.
.. grid-item-card:: Cross-compile of EVerest
:link: yocto-cross-compilation
:link-type: doc
How to cross-compile EVerest for your Yocto image using a Yocto SDK.
.. grid-item-card:: Comply with Eichrecht
:link: eichrecht
:link-type: doc
How to be compliant with German Eichrecht.
.. grid-item-card:: Comply with UK Smart Charging Regulations
:link: uk-smart-charging-regulations
:link-type: doc
How to be compliant with UK Smart Charging Regulations.
.. grid-item-card:: Use Renesas MPU
:link: renesas-mpu/index
:link-type: doc
How to use EVerest on Renesas RZ/G2L-MPU microprocessors.
.. grid-item-card:: Apply Security Best Practices
:link: security-best-practices
:link-type: doc
How to apply security best practices when deploying EVerest in a production environment.
.. grid-item-card:: Bring up a Charger Setup
:link: bringup/index
:link-type: doc
How to bring up all hard and software components of a charger in isolated test cases.
.. grid-item-card:: Use the EVerest Development Container
:link: devcontainer-usage/index
:link-type: doc
How to use a development container for EVerest development and sil testing.
.. grid-item-card:: Choosing EVerest Version and Upgrading
:link: choosing-version-and-upgrading
:link-type: doc
How to choose the right EVerest version and plan upgrades.
.. grid-item-card:: Pionix Belay Box
:link: pionix-belay-box
:link-type: doc
How to get started with the Pionix Belay Box, an AC charging station dev kit based on EVerest.
.. grid-item-card:: Integrate Tariff and Cost
:link: integrate-tariff-and-cost
:link-type: doc
How to subscribe to tariff and session cost updates from the consumer APIs, including OCPP-specific configuration.
.. toctree::
:maxdepth: 1
:hidden:
documenting-everest/index
getting-started/index
error-framework-howto
configure-pnc
debug-iso15118
debug-modules
yocto-cross-compilation
eichrecht
uk-smart-charging-regulations
renesas-mpu/index
security-best-practices
bringup/index
choosing-version-and-upgrading
pionix-belay-box
integrate-tariff-and-cost
devcontainer-usage/index