Skip to content

Update documentation to cover Explicit DemoMode #821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

guido4096
Copy link

@guido4096 guido4096 commented Jun 15, 2025

Documentation for evcc-io/evcc#21848

Note: cli update also includes --custom-css

@guido4096
Copy link
Author

Propose to work on German documentation, once that is all fine, I can handle translation to english.

@naltatis naltatis added the waiting for release Documents a yet unreleased feature label Jun 20, 2025
@naltatis
Copy link
Member

Looks nice 👍.
Can you transfer this to the English translation as well? I think then we're ready to roll this out.

@guido4096
Copy link
Author

@nataltis, this should be ready now. I made one more change in the german version, in file "docs/installation/home-configuration.mdx", to make the wording consistent with "docs/installation/home-assistant.mdx"

@@ -38,7 +38,7 @@ Wenn du evcc ohne Paketmanager installieren willst oder eine nightly Version tes
brew services start evcc
```

- Prüfe die Installation und öffne einen Browser und gib die folgende URL ein: [http://localhost:7070](http://localhost:7070). Die evcc Oberfläche sollte im Demo Modus zu sehen sein.
- Prüfe die Installation und öffne einen Browser und gib die folgende URL ein: [http://localhost:7070](http://localhost:7070). Die evcc Oberfläche fordert dich auf ein Password zu vergeben und die Einrichtung zu starten..
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Prüfe die Installation und öffne einen Browser und gib die folgende URL ein: [http://localhost:7070](http://localhost:7070). Die evcc Oberfläche fordert dich auf ein Password zu vergeben und die Einrichtung zu starten..
- Prüfe die Installation und öffne einen Browser und gib die folgende URL ein: [http://localhost:7070](http://localhost:7070). Die evcc Oberfläche fordert dich auf ein Password zu vergeben und die Einrichtung zu starten.

- [Visual Studio Code](https://github.com/hassio-addons/addon-vscode), in Visual Studio Code wähle das Hamburger-Menü oben links aus und wähle "File", "Open Folder...", select `/addon_configs/49686a9f_evcc`
- [File Editor](https://github.com/home-assistant/addons/tree/master/configurator), stelle sicher, dass Du die Option "Enforce Basepath" in der Addon Konfiguration deaktiviert hast, starte das Addon neu und navigiere nach `/addon_configs/49686a9f_evcc`
- [Advanced SSH & Web Terminal](https://github.com/hassio-addons/addon-ssh), navigiere nach `/addon_configs/49686a9f_evcc` und verwende z. B. nano

Unter [Konfiguration](./configuration) findest du eine Anleitung, wie du den Inhalt für die `evcc.yaml` erstellen kannst.

Wenn du erstmal mit einer Demo starten möchtest, kopiere den Inhalt dieser [Demo](https://github.com/evcc-io/evcc/blob/master/cmd/demo.yaml) in deine `evcc.yaml` Datei.
Wenn du erstmal mit einer Demo starten möchtest, starte evcc mit dem parameter --demo.
Copy link
Member

@naltatis naltatis Jun 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Wenn du erstmal mit einer Demo starten möchtest, starte evcc mit dem parameter --demo.
Wenn du erstmal mit einer Demo starten möchtest, starte evcc mit dem Parameter `--demo`.

@@ -219,3 +220,6 @@ Ausführlichere Erklärungen zu den Optionen findest du unter [Referenz → evcc
Willst du eine dynamische Demo sehen kannst du dir auch den Inhalt der Datei [demo.yaml](https://github.com/evcc-io/evcc/blob/master/cmd/demo.yaml) ansehen.
Diese Datei beinhaltet JavaScript-basierte Demo-Geräte, die eine eingeschränkte Funktionalität simulieren.
Sie wird auch für [demo.evcc.io](https://demo.evcc.io) genutzt.

Willst du deine eigene Installation im Demo mode ausführen, dann starte evcc mit dem Parameter --demo .
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Willst du deine eigene Installation im Demo mode ausführen, dann starte evcc mit dem Parameter --demo .
Willst du deine eigene Installation im Demomodus ausführen, dann starte evcc mit dem Parameter `--demo`.

It is also used for [demo.evcc.io](https://demo.evcc.io).

To run your own installation in Demo mode, just start evcc with the parameter --demo .
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To run your own installation in Demo mode, just start evcc with the parameter --demo .
To run your own installation in demo mode, just start evcc with the parameter `--demo`.

- [Visual Studio Code](https://github.com/hassio-addons/addon-vscode), in Visual Studio Code select the hamburger menu in the top left and choose "File", "Open Folder...", select `/addon_configs/49686a9f_evcc`
- [File Editor](https://github.com/home-assistant/addons/tree/master/configurator), make sure you have disabled the "Enforce Basepath" option in the Addon configuration, restart the Addon and navigate to `/addon_configs/49686a9f_evcc`
- [Advanced SSH & Web Terminal](https://github.com/hassio-addons/addon-ssh), navigate to `/addon_configs/49686a9f_evcc` and use e.g. nano

Under [Configuration](./configuration) you'll find instructions on how to create the content for the `evcc.yaml`.

If you want to start with a demo, copy the content of this [demo](https://github.com/evcc-io/evcc/blob/master/cmd/demo.yaml) into your `evcc.yaml` file.
If you want to start with a demo, just start evcc with the parameter --demo .
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you want to start with a demo, just start evcc with the parameter --demo .
If you want to see the system running in demo mode, just start evcc with the parameter `--demo`.

@naltatis
Copy link
Member

this should be ready now

Perfect. Then the feature is ready for the next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting for release Documents a yet unreleased feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants