CCC: introduce generic chapters by FaHaGit · Pull Request #33 · chargebyte/chargebyte-docs

FaHaGit · 2025-03-05T09:55:16Z

This is the preparation to integrate the chapters in Charge SOM user guide.

lategoodbye · 2025-03-05T14:34:19Z

includes/troubleshooting_contact.inc

+`Zulip <https://lfenergy.zulipchat.com/>`_.
+
+Do you have questions about the chargebyte BSP (incl. Yocto), please use
+`our support desk <https://chargebyte.com/support>`_.


Maybe we should guide them directly to:
https://chargebyte.atlassian.net/servicedesk/customer/portal/13

lategoodbye · 2025-03-05T14:38:32Z

docs/source/development.rst

-The custom image should now include the new EVerest module.
+.. include:: ../../includes/development.inc

 .. _cross_compiling_for_tarragon:


Please make this section more generic e.g. Cross compiling, so we can reference it from generic pages

lategoodbye · 2025-03-05T15:11:27Z

Just a note, in case you make text changes. Please make it a separate commit, otherwise it's impossible to review after moving the complete content to includes.

includes/development.inc

includes/everest_basic_configuration.inc

includes/everest_overview_of_everest_modules.inc

barsnick · 2025-03-06T10:20:27Z

includes/everest_overview_of_everest_modules.inc

+
+**DummyTokenProvider** (`view on GitHub <https://github.com/EVerest/everest-core/tree/main/modules/DummyTokenValidator>`__)
+
+This module listens to AuthRequired event from evse_manager module and then publishes one token.


This module is used for automatically providing an authorization token, instead of requiring e.g. an actual RFID reader.

It listens to the AuthRequired...

I would still like the "the". ;-)

barsnick · 2025-03-06T11:19:25Z

includes/cb_energy.inc

+.. figure:: ../../includes/_static/images/cbenergy/discover.png
+	:height: 600px
+
+If the discovery has not found any wallbox in the local network you can try to setup an manual connection as described in :ref:`connection_option`.


Suggested change

If the discovery has not found any wallbox in the local network you can try to setup an manual connection as described in :ref:`connection_option`.

If the discovery has not found any wallbox in the local network you can try to setup n manual connection as described in :ref:`connection_option`.

barsnick · 2025-03-06T11:20:26Z

includes/cb_energy.inc

+.. figure:: ../../includes/_static/images/cbenergy/user.png
+	:height: 600px
+
+It is time to create login credentials to keep the CB energy setup protected. When connecting to the system for the first time, it will prompt for a username and a password. Optionally, you can also provide your name and E-Mail address.


Suggested change

It is time to create login credentials to keep the CB energy setup protected. When connecting to the system for the first time, it will prompt for a username and a password. Optionally, you can also provide your name and E-Mail address.

It is time to create login credentials to keep the CB energy setup protected. When connecting to the system for the first time, it will prompt for a username and a password. Optionally, you can also provide your name and e-mail address.

barsnick · 2025-03-06T11:20:52Z

includes/cb_energy.inc

+Setup of ecosystem
+=========================
+
+In the next step, nymea:core starts a discovery for EV Chargers. This might be the same machine (localhost) or any other supported Charger in the local network.


Suggested change

In the next step, nymea:core starts a discovery for EV Chargers. This might be the same machine (localhost) or any other supported Charger in the local network.

In the next step, nymea:core starts a discovery for EV chargers. This might be the same machine (localhost) or any other supported charger in the local network.

barsnick · 2025-03-06T11:21:08Z

includes/cb_energy.inc

+If you are trying CB energy on a chargebyte controller an EVerest connector will be discovered.
+
+
+After discovering and setting up the  wallbox, CB Energy tries to discover other assets like solar inverters and meters. If there aren't any of these devices around, you can skip this step.


Suggested change

After discovering and setting up the wallbox, CB Energy tries to discover other assets like solar inverters and meters. If there aren't any of these devices around, you can skip this step.

After discovering and setting up the wallbox, CB Energy tries to discover other assets like solar inverters and meters. If there aren't any of these devices around, you can skip this step.

barsnick · 2025-03-06T11:22:18Z

includes/cb_energy.inc

+Manual connection option
+========================
+
+If Discovery between CB energy app (client) and nymea:core (server) fails for some reason (e.g. blocked UPnP/ZeroConf in company network), you can still enter the endpoints manually.


Suggested change

If Discovery between CB energy app (client) and nymea:core (server) fails for some reason (e.g. blocked UPnP/ZeroConf in company network), you can still enter the endpoints manually.

If discovery between CB energy app (client) and nymea:core (server) fails for some reason (e.g. blocked UPnP/ZeroConf in company network), you can still enter the endpoints manually.

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

FaHaGit requested review from barsnick and lategoodbye March 5, 2025 09:55

lategoodbye reviewed Mar 5, 2025

View reviewed changes

This comment was marked as resolved.

Sign in to view

FaHaGit force-pushed the everest/ccc_introduce_generic_chapters branch 2 times, most recently from 582f52a to 3a3dfed Compare March 6, 2025 10:47

lategoodbye approved these changes Mar 6, 2025

View reviewed changes

barsnick requested changes Mar 6, 2025

View reviewed changes

FaHaGit force-pushed the everest/ccc_introduce_generic_chapters branch from a89239b to 07bd9ef Compare March 6, 2025 12:21

FaHaGit added 12 commits March 6, 2025 13:49

Prepare generic chapters for everest_charging_stack.rst

3a7ca36

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

Introduce generic chapters for everest_charing_stack.rst

f3340a6

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

Introduce generic chapter for troubleshooting.rst

7238f10

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

development: add alternative command for extracting firmware images

c21d23e

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

Prepare generic chapters for development.rst

e3fa2ac

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

Introduce generic chapter for development.rst

2d9a410

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

Introduce generic chapter for cb_energy.rst

922c951

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

Update support desk link in troubleshooting contact section

e599d8b

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

everest: fix: correct minor grammatical errors in documentation

2af3107

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

development: fix: correct capitalization of hardware platform names

8c54d3d

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

energy: fix: correct minor grammatical errors

ebd2ddb

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

energy: fix: correct capitalization and grammatical errors

99ac1ab

Signed-off-by: Fabian Hartung <fabian.hartung@chargebyte.com>

FaHaGit force-pushed the everest/ccc_introduce_generic_chapters branch from 07bd9ef to 99ac1ab Compare March 6, 2025 12:49

FaHaGit merged commit a85afd2 into everest/charge_control_c Mar 6, 2025
1 check passed

FaHaGit deleted the everest/ccc_introduce_generic_chapters branch March 6, 2025 12:51


		DummyTokenProvider (`view on GitHub <https://github.com/EVerest/everest-core/tree/main/modules/DummyTokenValidator>`__)

		This module listens to AuthRequired event from evse_manager module and then publishes one token.

	If the discovery has not found any wallbox in the local network you can try to setup an manual connection as described in :ref:`connection_option`.
	If the discovery has not found any wallbox in the local network you can try to setup n manual connection as described in :ref:`connection_option`.

	It is time to create login credentials to keep the CB energy setup protected. When connecting to the system for the first time, it will prompt for a username and a password. Optionally, you can also provide your name and E-Mail address.
	It is time to create login credentials to keep the CB energy setup protected. When connecting to the system for the first time, it will prompt for a username and a password. Optionally, you can also provide your name and e-mail address.

	In the next step, nymea:core starts a discovery for EV Chargers. This might be the same machine (localhost) or any other supported Charger in the local network.
	In the next step, nymea:core starts a discovery for EV chargers. This might be the same machine (localhost) or any other supported charger in the local network.

		If you are trying CB energy on a chargebyte controller an EVerest connector will be discovered.


		After discovering and setting up the wallbox, CB Energy tries to discover other assets like solar inverters and meters. If there aren't any of these devices around, you can skip this step.

	If Discovery between CB energy app (client) and nymea:core (server) fails for some reason (e.g. blocked UPnP/ZeroConf in company network), you can still enter the endpoints manually.
	If discovery between CB energy app (client) and nymea:core (server) fails for some reason (e.g. blocked UPnP/ZeroConf in company network), you can still enter the endpoints manually.

Conversation

FaHaGit commented Mar 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

lategoodbye commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lategoodbye commented Mar 5, 2025 •

edited

Loading