Skip to content

Commit 6d617f5

Browse files
committed
Various minor whitespace fixes
Signed-off-by: Michael Heimpold <michael.heimpold@chargebyte.com>
1 parent f94058d commit 6d617f5

7 files changed

Lines changed: 34 additions & 31 deletions

File tree

README.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ This documentation is hosted on Read the Docs and can be accessed at
77
https://chargebyte-docs.readthedocs.io/en/latest/.
88

99

10-
Contents:
11-
---------
10+
Contents
11+
--------
1212

1313
- Charge SOM User Guide
1414

15-
Repo initialization:
15+
16+
Repo Initialization
1617
-------------------
18+
1719
This repository is using git submodules to share documents between the user guides.
1820
After cloning of the project please execute the following commands:
1921

@@ -22,8 +24,8 @@ git checkout everest/charge_som
2224
git submodule update --init --force --remote
2325

2426

25-
Building the documentation locally:
26-
-----------------------------------
27+
Building the Documentation Locally
28+
----------------------------------
2729

2830
To build the documentation locally, you need to have Python and pip installed on your system.
2931
You can install the required dependencies by running the following command:
@@ -37,8 +39,8 @@ sphinx-build -a docs/source {output_directory}
3739
The output directory is the directory where the generated HTML files will be stored.
3840

3941

40-
Contributing:
41-
-------------
42+
Contributing
43+
------------
4244

4345
If you would like to contribute to the documentation, please fork the repository and create a pull
4446
request with your changes. Please make sure to follow the guidelines for contributing to the
@@ -56,14 +58,14 @@ documentation:
5658
- First letters of section and chapter titles should be capitalized (e.g. "Charge SOM User Guide")
5759

5860

59-
License:
60-
--------
61+
License
62+
-------
6163

6264
See the LICENSE file for license rights and limitations (Apache 2.0).
6365

6466

65-
Contact:
66-
--------
67+
Contact
68+
-------
6769

6870
If you have any questions or inquiries, please contact our support team at https://chargebyte.com/support.
6971

docs/source/cb_energy.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _cb_energy.rst:
22

3-
**********************
4-
CB energy
5-
**********************
3+
*********
4+
CB Energy
5+
*********
66

77
.. note::
88
CB Energy is currently intended only for connecting an EVerest AC charger. In the future, bi-directional

docs/source/development.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The following steps describe how to cross-compile a module for the Charge SOM pl
3030
Alternatively, if the above command does not work, you can use the following command:
3131

3232
.. code-block:: console
33-
33+
3434
unsquashfs -d bundle-staging <shipped_firmware>.image
3535
3636
However, this will not verify the signature of the firmware image.
@@ -42,7 +42,7 @@ The following steps describe how to cross-compile a module for the Charge SOM pl
4242
sudo mkdir -p /mnt/rootfs
4343
sudo mount bundle-staging/core-image-minimal-chargesom.ext4 /mnt/rootfs
4444
45-
#. Create a new directory in your `everest-workspace` directory (in parallel to the `everest-core` directory) and
45+
#. Create a new directory in your `everest-workspace` directory (in parallel to the `everest-core` directory) and
4646
create a new file named :code:`toolchain.cmake`:
4747

4848
.. code-block:: console
@@ -113,8 +113,8 @@ The following steps describe how to cross-compile a module for the Charge SOM pl
113113
dist/libexec/everest/modules/{MyEVerestModule}/{MyEVerestModule}: ELF 64-bit LSB pie executable, ARM aarch64, version 1 (SYSV),
114114
dynamically linked, interpreter /lib/ld-linux-aarch64.so.1, BuildID[sha1]=ad2342fdd3b8fb1949fc3e13b77382d3da72f28a, for GNU/Linux 3.7.0, stripped
115115
116-
#. The resulting binary and manifest can be found in the :code:`dist/libexec/everest/modules/{MyEVerestModule}`
117-
directory. If you want to test the module on the target system, you can copy the module directory using
116+
#. The resulting binary and manifest can be found in the :code:`dist/libexec/everest/modules/{MyEVerestModule}`
117+
directory. If you want to test the module on the target system, you can copy the module directory using
118118
:code:`scp` or :code:`rsync`:
119119

120120
.. code-block:: console
@@ -139,7 +139,7 @@ The following steps describe how to cross-compile a module for the Charge SOM pl
139139
140140
fsck.ext4 -f bundle-staging/core-image-minimal-chargesom.ext4
141141
142-
#. Follow the steps under the section :ref:`firmware_customization` to install your PKI certificate, repackage
142+
#. Follow the steps under the section :ref:`firmware_customization` to install your PKI certificate, repackage
143143
the modified root filesystem into a firmware update image, and test the new firmware.
144144

145145
.. _creating_fw_images:

docs/source/everest_charging_stack.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _everest_charging_stack.rst:
22

33
**********************
4-
EVerest charging stack
4+
EVerest Charging Stack
55
**********************
66

77
.. include:: ../../includes/everest_introduction_to_everest.inc

docs/source/getting_started.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Getting Started
44
===============
55

66
This chapter is intended to help you get started as easily as possible with EV charging together
7-
with the Charge SOM Evaluation Kit and the EVerest charging stack. For this purpose, a basic DC
7+
with the Charge SOM Evaluation Kit and the EVerest charging stack. For this purpose, a basic DC
88
charger is set up as an example and explained step by step.
99

1010

@@ -71,7 +71,7 @@ carrier board provide information about the current status of the boot process.
7171
shows the meaning of the LED status indicators:
7272

7373
.. raw:: html
74-
74+
7575
<div style="text-align: center;">
7676
Table: Charge SOM Evaluation Kit LED Status Indicators
7777
</div>
@@ -87,6 +87,7 @@ shows the meaning of the LED status indicators:
8787

8888
.. include:: ../../includes/connecting.inc
8989

90+
.. include:: ../../includes/first_fw_update.inc
9091

9192
Initial Configuration
9293
---------------------
@@ -287,7 +288,7 @@ The EVerest log messages should look like this:
287288
2024-12-13T15:52:03.155499+0100 chargesom manager[263]: [INFO] connector:EvseM :: EVSE IEC Transaction Started (0 kWh)
288289
2024-12-13T15:52:03.156415+0100 chargesom manager[263]: [INFO] connector:EvseM :: EVSE IEC DC mode. We are in 5percent mode so we can continue without further action.
289290
2024-12-13T15:52:03.156895+0100 chargesom manager[263]: [INFO] connector:EvseM :: EVSE IEC Charger state: Wait for Auth->PrepareCharging
290-
291+
291292
After that, the EV simulator should establish a powerline connection to the Charge SOM via SLAC.
292293
293294
.. code-block:: sh

docs/source/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@
44
contain the root `toctree` directive.
55
66
Welcome to Charge SOM User Guide!
7-
=======================================================
7+
=================================
88

99
**Charge SOM** is an IEC 61851 and ISO 15118 compliant charging controller, born to beat in
1010
every kind of electric DC vehicle charging station. This user guide explains the possibilities of
11-
setting up such a system with the Charge SOM, based on the open source charging stack
12-
EVerest.
11+
setting up such a system with the Charge SOM, based on the open source charging stack EVerest.
1312

1413
This documentation starts with a short introduction and then goes straight into a hands-on chapter
1514
:doc:`getting_started` with a simple example of how to set up a simple DC charger based on the

docs/source/troubleshooting.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ connected to USB.
2525

2626

2727
Is it possible to use the Charge SOM as an EV simulator?
28-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
28+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2929

3030
The Charge SOM hardware is not designed to be used as an EV simulator. Please refer to our
3131
`website <https://www.chargebyte.com/>`_ for more suitable products.
@@ -80,22 +80,22 @@ The device tree sources of the Charge SOM are divided into multiple layers:
8080

8181

8282
How can I access the EVerest admin panel on Charge SOM?
83-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
83+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8484

8585
Currently, the Charge SOM does not have integrated the `EVerest admin panel <https://github.com/EVerest/everest-admin-panel>`_
8686
Please use your development environment to set up your configuration file. Alternatively, you can use a plain text
8787
editor.
8888

8989

9090
Does EVerest on Charge SOM support ISO 15118-20 yet?
91-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
91+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9292

9393
The required module for ISO 15118-20 has been included in the image since the Charge SOM EVerest release 0.2.0.
9494
Please note that the implementation is still under development.
9595

9696

9797
How do I set up OCPP 2.0.1 on Charge SOM with EVerest?
98-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9999

100100
To support OCPP 2.0.1, the EVerest OCPP201 module must be integrated into the EVerest configuration.
101101
This module uses the `libocpp library <https://github.com/EVerest/libocpp>`_ to implement the OCPP 2.0.1
@@ -107,7 +107,7 @@ and the initial creation of the OCPP 2.0.1 database.
107107
The most important points are summarised here:
108108

109109
1. The OCPP201 module must be included in your EVerest configuration.
110-
2. The CbSystem module can be used to fulfill the requirement of the system interface.
110+
2. The CbSystem module can be used to fulfill the requirement of the system interface.
111111
3. While configuring the OCPP 2.0.1 module, ensure that you are using OCPP configuration and database
112112
paths which are covered by the update mechanism. The following paths are recommended:
113113

@@ -133,6 +133,7 @@ The most important points are summarised here:
133133
For further information about the device model initialization, please refer to the
134134
`libocpp documentation <https://github.com/EVerest/libocpp/blob/main/doc/v2/ocpp_201_device_model_initialization.md>`_.
135135

136+
136137
I tried to compile chargebyte's Hardware EVerest Modules, but it fails to build. How can it fix this?
137138
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
138139

0 commit comments

Comments
 (0)