Skip to content

Commit 8edb19d

Browse files
guido4096naltatis
andauthored
Update documentation to cover Explicit DemoMode (#821)
Co-authored-by: Michael Geers <[email protected]>
1 parent 440d3d1 commit 8edb19d

39 files changed

+147
-60
lines changed

docs/installation/configuration.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
sidebar_position: 10
33
---
4+
45
import Tabs from "@theme/Tabs";
56
import TabItem from "@theme/TabItem";
67

@@ -46,6 +47,7 @@ Für deine erste Konfiguration ist das aber nicht notwendig.
4647
```sh
4748
evcc configure --advanced
4849
```
50+
4951
:::
5052

5153
Teste, ob die Konfiguration funktioniert
@@ -190,7 +192,6 @@ Oft sind es auch Einrückungs- oder Tippfehler.
190192
Die Datei ist im [YAML Format](https://wikipedia.org/wiki/YAML) verfasst.
191193
Mit dem Online-Tool [YAML Lint](https://www.yamllint.com/) kannst du prüfen ob deine Datei das richtige Format einhält.
192194

193-
194195
### Anpassen
195196

196197
Die Datei beinhaltet lediglich Demo-Geräte (`demo-charger`, `demo-meter`, `demo-battery`, `offline`).
@@ -219,3 +220,6 @@ Ausführlichere Erklärungen zu den Optionen findest du unter [Referenz → evcc
219220
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.
220221
Diese Datei beinhaltet JavaScript-basierte Demo-Geräte, die eine eingeschränkte Funktionalität simulieren.
221222
Sie wird auch für [demo.evcc.io](https://demo.evcc.io) genutzt.
223+
224+
Willst du deine eigene Installation im Demomodus ausführen, dann starte evcc mit dem Parameter `--demo`.
225+
Weitere Informationen findest du unter [CLI Referenz](/docs/reference/cli/evcc).

docs/installation/home-assistant.mdx

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,37 +40,37 @@ Siehe [Home Assistant Dokumentation](https://www.home-assistant.io/installation/
4040
<TabItem value="Release" label="Release" default>
4141
Die aktuelle stabile Version.
4242

43-
1. Repository automatisch hinzufügen: Klicke auf den nachfolgenden Button und dann auf **Open link**, dann auf **Hinzufügen**.
44-
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon)
45-
2. Repository manuell hinzufügen:
46-
1. Klicke auf **Einstellungen****Addons****Addon Store**
47-
2. Klicke auf die **drei Punkte****Repositories**
48-
3. Füge die Repository-URL ein und klicke auf **Hinzufügen**
49-
```
50-
https://github.com/evcc-io/hassio-addon
51-
```
52-
3. Webseite neu laden
53-
4. Finde das Addon **evcc** und klicke es an
54-
5. Klicke auf die Schaltfläche **Installieren**
43+
1. Repository automatisch hinzufügen: Klicke auf den nachfolgenden Button und dann auf **Open link**, dann auf **Hinzufügen**.
44+
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon)
45+
2. Repository manuell hinzufügen:
46+
1. Klicke auf **Einstellungen****Addons****Addon Store**
47+
2. Klicke auf die **drei Punkte****Repositories**
48+
3. Füge die Repository-URL ein und klicke auf **Hinzufügen**
49+
```
50+
https://github.com/evcc-io/hassio-addon
51+
```
52+
3. Webseite neu laden
53+
4. Finde das Addon **evcc** und klicke es an
54+
5. Klicke auf die Schaltfläche **Installieren**
5555

5656
</TabItem>
5757
<TabItem value="Nightly" label="Nightly">
5858
Die aktuelle Entwicklerversion. Täglich aktualisiert. Kann instabil sein.
5959
Kann zwar parallel zur Release Version installiert werden, aber es kann immer nur eine Version gleichzeitig laufen.
60-
Falls du das Nightly nutzt, ändern sich auch die in dieser Anleitung genannten Pfade bzw. Docker Container Namen, d.h. statt `evcc` muss `evcc-nightly` verwendet werden.
61-
62-
1. Repository automatisch hinzufügen: Klicke auf den nachfolgenden Button und dann auf **Open link**, dann auf **Hinzufügen**.
63-
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon)
64-
2. Repository manuell hinzufügen:
65-
1. Klicke auf **Einstellungen****Addons****Addon Store**
66-
2. Klicke auf die **drei Punkte****Repositories**
67-
3. Füge die Repository-URL ein und klicke auf **Hinzufügen**
68-
```
69-
https://github.com/evcc-io/hassio-addon
70-
```
71-
3. Webseite neu laden
72-
4. Finde das Addon **evcc (nightly)** und klicke es an
73-
5. Klicke auf die Schaltfläche **Installieren**
60+
Falls du das Nightly nutzt, ändern sich auch die in dieser Anleitung genannten Pfade bzw. Docker Container Namen, d.h. statt `evcc` muss `evcc-nightly` verwendet werden.
61+
62+
1. Repository automatisch hinzufügen: Klicke auf den nachfolgenden Button und dann auf **Open link**, dann auf **Hinzufügen**.
63+
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon)
64+
2. Repository manuell hinzufügen:
65+
1. Klicke auf **Einstellungen****Addons****Addon Store**
66+
2. Klicke auf die **drei Punkte****Repositories**
67+
3. Füge die Repository-URL ein und klicke auf **Hinzufügen**
68+
```
69+
https://github.com/evcc-io/hassio-addon
70+
```
71+
3. Webseite neu laden
72+
4. Finde das Addon **evcc (nightly)** und klicke es an
73+
5. Klicke auf die Schaltfläche **Installieren**
7474

7575
</TabItem>
7676
</Tabs>
@@ -94,13 +94,15 @@ Lege eine leere Konfigurationsdatei `evcc.yaml` in deinem Addon-Stammkonfigurati
9494
Falls dieser Ordner noch nicht exisiert, erstelle ihn manuell.
9595

9696
Um die Konfigurationsdatei anzulegen bzw. zu editieren, hast du verschiedene Möglichkeiten, hier ein paar zur Auswahl:
97+
9798
- [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`
9899
- [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`
99100
- [Advanced SSH & Web Terminal](https://github.com/hassio-addons/addon-ssh), navigiere nach `/addon_configs/49686a9f_evcc` und verwende z. B. nano
100101

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

103-
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.
104+
Wenn du erstmal mit einer Demo starten möchtest, starte evcc mit dem Parameter `--demo`.
105+
Weitere Informationen findest du unter [CLI Referenz](/docs/reference/cli/evcc).
104106

105107
Jetzt bist du bereit und kannst das Addon starten.
106108

@@ -120,28 +122,33 @@ Um die folgenden Funktionen auszuführen, benötigst du SSH Zugriff auf Home Ass
120122
### Wie komme ich an die evcc Datenbank?
121123

122124
Zeige die Dateien in `/data` an:
125+
123126
```sh
124127
docker exec addon_49686a9f_evcc ls -la /data
125128
```
126129

127130
Kopiere die `evcc.db` nach `/addon_configs/49686a9f_evcc`:
131+
128132
```sh
129133
docker cp addon_49686a9f_evcc:/data/evcc.db /addon_configs/49686a9f_evcc/
130134
```
131135

132136
### Wie kann ich das evcc CLI nutzen?
133137

134138
Öffne eine Shell zum evcc Docker Container:
139+
135140
```sh
136141
docker exec -it addon_49686a9f_evcc /bin/sh
137142
```
138143

139144
Starte evcc CLI Befehle (hier als Beispiel `checkconfig`):
145+
140146
```sh
141147
evcc -c /config/evcc.yaml checkconfig
142148
```
143149

144150
Schließe die Shell im evcc Docker Container wenn du fertig bist:
151+
145152
```sh
146153
exit
147154
```

docs/installation/linux.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Cloudsmith ist ein Service, welcher die Entwicklung von Software und Dienstleist
6868
sudo systemctl start evcc
6969
```
7070

71-
- 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.
71+
- 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.
7272

7373
- Stoppe den evcc-Server:
7474

@@ -231,6 +231,7 @@ Neben dem Debian/Ubuntu APT Paket, stellen wir auch weitere Binaries für Linux
231231
### Installation
232232

233233
- Lade die entsprechende Datei auf dein System herunter:
234+
234235
- 64-Bit Intel CPU: [evcc_X.XX_linux_amd64.tar.gz](https://github.com/evcc-io/evcc/releases/latest)
235236
- 64-Bit ARM CPU: [evcc_X.XX_linux_arm64.tar.gz](https://github.com/evcc-io/evcc/releases/latest)
236237
- 32-Bit ARM CPU (e.g. Raspberry Pi 32-Bit OS): [evcc_X.XX_linux_armv6.tar.gz](https://github.com/evcc-io/evcc/releases/latest)
@@ -317,4 +318,4 @@ Diese Dokumentation geht davon aus, dass Linux `systemd` unterstützt.
317318

318319
- Fertig :-)
319320

320-
Weitere Informationen findest du oben im Abschnitt [Systemdienst](#systemd).
321+
Weitere Informationen findest du oben im Abschnitt [Systemdienst](#systemd).

docs/installation/macos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Wenn du evcc ohne Paketmanager installieren willst oder eine nightly Version tes
3838
brew services start evcc
3939
```
4040

41-
- 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.
41+
- 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.
4242
- Stoppe den evcc-Server:
4343

4444
```sh

docs/reference/cli/evcc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ evcc [flags]
1010

1111
```
1212
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
13+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
1314
--database string Database location (default "~/.evcc/evcc.db")
15+
--demo Enter demo mode. Disables auth, config ui and restart
1416
--disable-auth Disable authentication (dangerous)
1517
-h, --help Help
1618
--ignore-db Run command ignoring service database

docs/reference/cli/evcc_charger.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ evcc charger [name] [flags]
2121

2222
```
2323
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
24+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
2425
--database string Database location (default "~/.evcc/evcc.db")
26+
--demo Enter demo mode. Disables auth, config ui and restart
2527
-h, --help Help
2628
--ignore-db Run command ignoring service database
2729
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")

docs/reference/cli/evcc_charger_ramp.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ evcc charger ramp [name] [flags]
1717

1818
```
1919
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
20+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
2021
--database string Database location (default "~/.evcc/evcc.db")
22+
--demo Enter demo mode. Disables auth, config ui and restart
2123
-h, --help Help
2224
--ignore-db Run command ignoring service database
2325
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")

docs/reference/cli/evcc_checkconfig.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ evcc checkconfig [flags]
1616

1717
```
1818
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
19+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
1920
--database string Database location (default "~/.evcc/evcc.db")
21+
--demo Enter demo mode. Disables auth, config ui and restart
2022
-h, --help Help
2123
--ignore-db Run command ignoring service database
2224
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")

docs/reference/cli/evcc_completion.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ See each sub-command's help for details on how to use the generated script.
1212

1313
```
1414
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
15+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
1516
--database string Database location (default "~/.evcc/evcc.db")
17+
--demo Enter demo mode. Disables auth, config ui and restart
1618
-h, --help Help
1719
--ignore-db Run command ignoring service database
1820
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")

docs/reference/cli/evcc_completion_bash.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ evcc completion bash
4646

4747
```
4848
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
49+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
4950
--database string Database location (default "~/.evcc/evcc.db")
51+
--demo Enter demo mode. Disables auth, config ui and restart
5052
-h, --help Help
5153
--ignore-db Run command ignoring service database
5254
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")

0 commit comments

Comments
 (0)