diff --git a/docs/installation/configuration.mdx b/docs/installation/configuration.mdx index 4f250e4da..331ac51dc 100644 --- a/docs/installation/configuration.mdx +++ b/docs/installation/configuration.mdx @@ -1,6 +1,7 @@ --- sidebar_position: 10 --- + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -46,6 +47,7 @@ Für deine erste Konfiguration ist das aber nicht notwendig. ```sh evcc configure --advanced ``` + ::: Teste, ob die Konfiguration funktioniert @@ -190,7 +192,6 @@ Oft sind es auch Einrückungs- oder Tippfehler. Die Datei ist im [YAML Format](https://wikipedia.org/wiki/YAML) verfasst. Mit dem Online-Tool [YAML Lint](https://www.yamllint.com/) kannst du prüfen ob deine Datei das richtige Format einhält. - ### Anpassen 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 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 Demomodus ausführen, dann starte evcc mit dem Parameter `--demo`. +Weitere Informationen findest du unter [CLI Referenz](/docs/reference/cli/evcc). diff --git a/docs/installation/home-assistant.mdx b/docs/installation/home-assistant.mdx index 03c6a0450..9eda7a641 100644 --- a/docs/installation/home-assistant.mdx +++ b/docs/installation/home-assistant.mdx @@ -40,37 +40,37 @@ Siehe [Home Assistant Dokumentation](https://www.home-assistant.io/installation/ <TabItem value="Release" label="Release" default> Die aktuelle stabile Version. - 1. Repository automatisch hinzufügen: Klicke auf den nachfolgenden Button und dann auf **Open link**, dann auf **Hinzufügen**. - [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon) - 2. Repository manuell hinzufügen: - 1. Klicke auf **Einstellungen** → **Addons** → **Addon Store** - 2. Klicke auf die **drei Punkte** → **Repositories** - 3. Füge die Repository-URL ein und klicke auf **Hinzufügen** - ``` - https://github.com/evcc-io/hassio-addon - ``` - 3. Webseite neu laden - 4. Finde das Addon **evcc** und klicke es an - 5. Klicke auf die Schaltfläche **Installieren** +1. Repository automatisch hinzufügen: Klicke auf den nachfolgenden Button und dann auf **Open link**, dann auf **Hinzufügen**. + [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon) +2. Repository manuell hinzufügen: + 1. Klicke auf **Einstellungen** → **Addons** → **Addon Store** + 2. Klicke auf die **drei Punkte** → **Repositories** + 3. Füge die Repository-URL ein und klicke auf **Hinzufügen** + ``` + https://github.com/evcc-io/hassio-addon + ``` +3. Webseite neu laden +4. Finde das Addon **evcc** und klicke es an +5. Klicke auf die Schaltfläche **Installieren** </TabItem> <TabItem value="Nightly" label="Nightly"> Die aktuelle Entwicklerversion. Täglich aktualisiert. Kann instabil sein. Kann zwar parallel zur Release Version installiert werden, aber es kann immer nur eine Version gleichzeitig laufen. - 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. - - 1. Repository automatisch hinzufügen: Klicke auf den nachfolgenden Button und dann auf **Open link**, dann auf **Hinzufügen**. - [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon) - 2. Repository manuell hinzufügen: - 1. Klicke auf **Einstellungen** → **Addons** → **Addon Store** - 2. Klicke auf die **drei Punkte** → **Repositories** - 3. Füge die Repository-URL ein und klicke auf **Hinzufügen** - ``` - https://github.com/evcc-io/hassio-addon - ``` - 3. Webseite neu laden - 4. Finde das Addon **evcc (nightly)** und klicke es an - 5. Klicke auf die Schaltfläche **Installieren** + 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. + +1. Repository automatisch hinzufügen: Klicke auf den nachfolgenden Button und dann auf **Open link**, dann auf **Hinzufügen**. + [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon) +2. Repository manuell hinzufügen: + 1. Klicke auf **Einstellungen** → **Addons** → **Addon Store** + 2. Klicke auf die **drei Punkte** → **Repositories** + 3. Füge die Repository-URL ein und klicke auf **Hinzufügen** + ``` + https://github.com/evcc-io/hassio-addon + ``` +3. Webseite neu laden +4. Finde das Addon **evcc (nightly)** und klicke es an +5. Klicke auf die Schaltfläche **Installieren** </TabItem> </Tabs> @@ -94,13 +94,15 @@ Lege eine leere Konfigurationsdatei `evcc.yaml` in deinem Addon-Stammkonfigurati Falls dieser Ordner noch nicht exisiert, erstelle ihn manuell. Um die Konfigurationsdatei anzulegen bzw. zu editieren, hast du verschiedene Möglichkeiten, hier ein paar zur Auswahl: + - [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`. +Weitere Informationen findest du unter [CLI Referenz](/docs/reference/cli/evcc). Jetzt bist du bereit und kannst das Addon starten. @@ -120,11 +122,13 @@ Um die folgenden Funktionen auszuführen, benötigst du SSH Zugriff auf Home Ass ### Wie komme ich an die evcc Datenbank? Zeige die Dateien in `/data` an: + ```sh docker exec addon_49686a9f_evcc ls -la /data ``` Kopiere die `evcc.db` nach `/addon_configs/49686a9f_evcc`: + ```sh docker cp addon_49686a9f_evcc:/data/evcc.db /addon_configs/49686a9f_evcc/ ``` @@ -132,16 +136,19 @@ docker cp addon_49686a9f_evcc:/data/evcc.db /addon_configs/49686a9f_evcc/ ### Wie kann ich das evcc CLI nutzen? Öffne eine Shell zum evcc Docker Container: + ```sh docker exec -it addon_49686a9f_evcc /bin/sh ``` Starte evcc CLI Befehle (hier als Beispiel `checkconfig`): + ```sh evcc -c /config/evcc.yaml checkconfig ``` Schließe die Shell im evcc Docker Container wenn du fertig bist: + ```sh exit ``` diff --git a/docs/installation/linux.mdx b/docs/installation/linux.mdx index 551d30d76..19affbce4 100644 --- a/docs/installation/linux.mdx +++ b/docs/installation/linux.mdx @@ -68,7 +68,7 @@ Cloudsmith ist ein Service, welcher die Entwicklung von Software und Dienstleist sudo systemctl 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. - Stoppe den evcc-Server: @@ -231,6 +231,7 @@ Neben dem Debian/Ubuntu APT Paket, stellen wir auch weitere Binaries für Linux ### Installation - Lade die entsprechende Datei auf dein System herunter: + - 64-Bit Intel CPU: [evcc_X.XX_linux_amd64.tar.gz](https://github.com/evcc-io/evcc/releases/latest) - 64-Bit ARM CPU: [evcc_X.XX_linux_arm64.tar.gz](https://github.com/evcc-io/evcc/releases/latest) - 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. - Fertig :-) -Weitere Informationen findest du oben im Abschnitt [Systemdienst](#systemd). \ No newline at end of file +Weitere Informationen findest du oben im Abschnitt [Systemdienst](#systemd). diff --git a/docs/installation/macos.md b/docs/installation/macos.md index 6b219b26b..ac1e1230e 100644 --- a/docs/installation/macos.md +++ b/docs/installation/macos.md @@ -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. - Stoppe den evcc-Server: ```sh diff --git a/docs/reference/cli/evcc.md b/docs/reference/cli/evcc.md index 95d31a938..217e363b3 100644 --- a/docs/reference/cli/evcc.md +++ b/docs/reference/cli/evcc.md @@ -10,7 +10,9 @@ evcc [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart --disable-auth Disable authentication (dangerous) -h, --help Help --ignore-db Run command ignoring service database diff --git a/docs/reference/cli/evcc_charger.md b/docs/reference/cli/evcc_charger.md index cfb5cd767..2a6a031dd 100644 --- a/docs/reference/cli/evcc_charger.md +++ b/docs/reference/cli/evcc_charger.md @@ -21,7 +21,9 @@ evcc charger [name] [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_charger_ramp.md b/docs/reference/cli/evcc_charger_ramp.md index dbd9fe9da..847b75271 100644 --- a/docs/reference/cli/evcc_charger_ramp.md +++ b/docs/reference/cli/evcc_charger_ramp.md @@ -17,7 +17,9 @@ evcc charger ramp [name] [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_checkconfig.md b/docs/reference/cli/evcc_checkconfig.md index 571db9009..53eb2c5e3 100644 --- a/docs/reference/cli/evcc_checkconfig.md +++ b/docs/reference/cli/evcc_checkconfig.md @@ -16,7 +16,9 @@ evcc checkconfig [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_completion.md b/docs/reference/cli/evcc_completion.md index f06704867..f7df5c818 100644 --- a/docs/reference/cli/evcc_completion.md +++ b/docs/reference/cli/evcc_completion.md @@ -12,7 +12,9 @@ See each sub-command's help for details on how to use the generated script. ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_completion_bash.md b/docs/reference/cli/evcc_completion_bash.md index 3bd3ddc3a..2d346a2aa 100644 --- a/docs/reference/cli/evcc_completion_bash.md +++ b/docs/reference/cli/evcc_completion_bash.md @@ -46,7 +46,9 @@ evcc completion bash ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_completion_fish.md b/docs/reference/cli/evcc_completion_fish.md index d99b9644f..5c9a9af3f 100644 --- a/docs/reference/cli/evcc_completion_fish.md +++ b/docs/reference/cli/evcc_completion_fish.md @@ -35,7 +35,9 @@ evcc completion fish [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_completion_powershell.md b/docs/reference/cli/evcc_completion_powershell.md index 3cb0e6c35..a984552b2 100644 --- a/docs/reference/cli/evcc_completion_powershell.md +++ b/docs/reference/cli/evcc_completion_powershell.md @@ -30,7 +30,9 @@ evcc completion powershell [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_completion_zsh.md b/docs/reference/cli/evcc_completion_zsh.md index f5a564e1e..79c32b5ed 100644 --- a/docs/reference/cli/evcc_completion_zsh.md +++ b/docs/reference/cli/evcc_completion_zsh.md @@ -50,7 +50,9 @@ evcc completion zsh [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_config.md b/docs/reference/cli/evcc_config.md index 4e5dd5d93..b5aead7aa 100644 --- a/docs/reference/cli/evcc_config.md +++ b/docs/reference/cli/evcc_config.md @@ -16,7 +16,9 @@ evcc config [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_config_delete.md b/docs/reference/cli/evcc_config_delete.md index 29c962c4f..b13168b5c 100644 --- a/docs/reference/cli/evcc_config_delete.md +++ b/docs/reference/cli/evcc_config_delete.md @@ -10,7 +10,9 @@ evcc config delete <id> [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_configure.md b/docs/reference/cli/evcc_configure.md index 9fa7c3e25..d07cd8b4b 100644 --- a/docs/reference/cli/evcc_configure.md +++ b/docs/reference/cli/evcc_configure.md @@ -19,7 +19,9 @@ evcc configure [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_detect.md b/docs/reference/cli/evcc_detect.md index e46702140..0952cc824 100644 --- a/docs/reference/cli/evcc_detect.md +++ b/docs/reference/cli/evcc_detect.md @@ -18,7 +18,9 @@ evcc detect [host ...] [subnet ...] [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_device.md b/docs/reference/cli/evcc_device.md index db52461fc..6e0431bd7 100644 --- a/docs/reference/cli/evcc_device.md +++ b/docs/reference/cli/evcc_device.md @@ -10,7 +10,9 @@ evcc device [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_discuss.md b/docs/reference/cli/evcc_discuss.md index 53b85e68f..14c8ed9ab 100644 --- a/docs/reference/cli/evcc_discuss.md +++ b/docs/reference/cli/evcc_discuss.md @@ -10,7 +10,9 @@ evcc discuss [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_dump.md b/docs/reference/cli/evcc_dump.md index ba84e503a..8b1066f4e 100644 --- a/docs/reference/cli/evcc_dump.md +++ b/docs/reference/cli/evcc_dump.md @@ -16,7 +16,9 @@ evcc dump [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_eebus-cert.md b/docs/reference/cli/evcc_eebus-cert.md index 689bc7de7..0d0895e88 100644 --- a/docs/reference/cli/evcc_eebus-cert.md +++ b/docs/reference/cli/evcc_eebus-cert.md @@ -10,7 +10,9 @@ evcc eebus-cert [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_health.md b/docs/reference/cli/evcc_health.md index 4fba9b89d..195bf0186 100644 --- a/docs/reference/cli/evcc_health.md +++ b/docs/reference/cli/evcc_health.md @@ -10,7 +10,9 @@ evcc health [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_meter.md b/docs/reference/cli/evcc_meter.md index 4efadc4f5..a90db5128 100644 --- a/docs/reference/cli/evcc_meter.md +++ b/docs/reference/cli/evcc_meter.md @@ -19,7 +19,9 @@ evcc meter [name] [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_migrate.md b/docs/reference/cli/evcc_migrate.md index a73f38bfc..ab9fccdc4 100644 --- a/docs/reference/cli/evcc_migrate.md +++ b/docs/reference/cli/evcc_migrate.md @@ -16,7 +16,9 @@ evcc migrate [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_password.md b/docs/reference/cli/evcc_password.md index 5baf79db0..2775a5b2b 100644 --- a/docs/reference/cli/evcc_password.md +++ b/docs/reference/cli/evcc_password.md @@ -6,7 +6,9 @@ Password administration ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_password_reset.md b/docs/reference/cli/evcc_password_reset.md index 0282ce167..9d760683c 100644 --- a/docs/reference/cli/evcc_password_reset.md +++ b/docs/reference/cli/evcc_password_reset.md @@ -10,7 +10,9 @@ evcc password reset [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_password_set.md b/docs/reference/cli/evcc_password_set.md index 705724b53..d254ce6fb 100644 --- a/docs/reference/cli/evcc_password_set.md +++ b/docs/reference/cli/evcc_password_set.md @@ -10,7 +10,9 @@ evcc password set [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_settings.md b/docs/reference/cli/evcc_settings.md index 57a99489c..f7be38e82 100644 --- a/docs/reference/cli/evcc_settings.md +++ b/docs/reference/cli/evcc_settings.md @@ -6,7 +6,9 @@ Manage configuration settings ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_settings_get.md b/docs/reference/cli/evcc_settings_get.md index ecdda4a36..6eeee321b 100644 --- a/docs/reference/cli/evcc_settings_get.md +++ b/docs/reference/cli/evcc_settings_get.md @@ -10,7 +10,9 @@ evcc settings get [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_settings_set.md b/docs/reference/cli/evcc_settings_set.md index 53f65c625..e67f15778 100644 --- a/docs/reference/cli/evcc_settings_set.md +++ b/docs/reference/cli/evcc_settings_set.md @@ -16,7 +16,9 @@ evcc settings set [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_sponsor.md b/docs/reference/cli/evcc_sponsor.md index 56d4075b0..9eab073c7 100644 --- a/docs/reference/cli/evcc_sponsor.md +++ b/docs/reference/cli/evcc_sponsor.md @@ -10,7 +10,9 @@ evcc sponsor [name] [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_sunspec.md b/docs/reference/cli/evcc_sunspec.md index 704e531e7..a480721ff 100644 --- a/docs/reference/cli/evcc_sunspec.md +++ b/docs/reference/cli/evcc_sunspec.md @@ -16,7 +16,9 @@ evcc sunspec <connection> [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_tariff.md b/docs/reference/cli/evcc_tariff.md index 867bbd0c7..ccec35657 100644 --- a/docs/reference/cli/evcc_tariff.md +++ b/docs/reference/cli/evcc_tariff.md @@ -10,7 +10,9 @@ evcc tariff [name] [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_token.md b/docs/reference/cli/evcc_token.md index 919f8d22e..6af1e94df 100644 --- a/docs/reference/cli/evcc_token.md +++ b/docs/reference/cli/evcc_token.md @@ -10,7 +10,9 @@ evcc token [vehicle name] [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/docs/reference/cli/evcc_vehicle.md b/docs/reference/cli/evcc_vehicle.md index 6bfc1960c..168a580ce 100644 --- a/docs/reference/cli/evcc_vehicle.md +++ b/docs/reference/cli/evcc_vehicle.md @@ -21,7 +21,9 @@ evcc vehicle [name] [flags] ``` -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + --custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees. --database string Database location (default "~/.evcc/evcc.db") + --demo Enter demo mode. Disables auth, config ui and restart -h, --help Help --ignore-db Run command ignoring service database -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx index 30c5c8ea7..51032456e 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx @@ -1,6 +1,7 @@ --- sidebar_position: 10 --- + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -46,6 +47,7 @@ However, this is not necessary for your first configuration. ```sh evcc configure --advanced ``` + ::: Test if the configuration works: @@ -217,4 +219,7 @@ More detailed explanations of the options can be found under [Reference → evcc If you want to see a dynamic demo, you can also look at the contents of the [demo.yaml](https://github.com/evcc-io/evcc/blob/master/cmd/demo.yaml) file. This file contains JavaScript-based demo devices that simulate limited functionality. -It is also used for [demo.evcc.io](https://demo.evcc.io). \ No newline at end of file +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`. +See [CLI Referenz](/docs/reference/cli/evcc) for more information. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/home-assistant.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/home-assistant.mdx index c84328db6..5426a7224 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/home-assistant.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/home-assistant.mdx @@ -40,18 +40,18 @@ See [Home Assistant Documentation](https://www.home-assistant.io/installation/#a <TabItem value="Release" label="Release" default> The current stable version. - 1. Automatically add repository: Click on the following button and then on **Open link**, then on **Add**. - [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon) - 2. Manually add repository: - 1. Click on **Settings** → **Addons** → **Add-on Store** - 2. Click on the **three dots** → **Repositories** - 3. Add the repository URL and click **Add** - ``` - https://github.com/evcc-io/hassio-addon - ``` - 3. Reload the webpage - 4. Find the **evcc** addon and click on it - 5. Click on the **INSTALL** button +1. Automatically add repository: Click on the following button and then on **Open link**, then on **Add**. + [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon) +2. Manually add repository: + 1. Click on **Settings** → **Addons** → **Add-on Store** + 2. Click on the **three dots** → **Repositories** + 3. Add the repository URL and click **Add** + ``` + https://github.com/evcc-io/hassio-addon + ``` +3. Reload the webpage +4. Find the **evcc** addon and click on it +5. Click on the **INSTALL** button </TabItem> <TabItem value="Nightly" label="Nightly"> @@ -59,18 +59,18 @@ See [Home Assistant Documentation](https://www.home-assistant.io/installation/#a Although it can be installed alongside the release version, only one version can run at a time. If you use the nightly version, the paths and Docker container names mentioned in this guide will change, i.e., instead of `evcc`, you must use `evcc-nightly`. - 1. Automatically add repository: Click on the following button and then on **Open link**, then on **Add**. - [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon) - 2. Manually add repository: - 1. Click on **Settings** → **Addons** → **Add-on Store** - 2. Click on the **three dots** → **Repositories** - 3. Add the repository URL and click **Add** - ``` - https://github.com/evcc-io/hassio-addon - ``` - 3. Reload the webpage - 4. Find the **evcc (nightly)** addon and click on it - 5. Click on the **INSTALL** button +1. Automatically add repository: Click on the following button and then on **Open link**, then on **Add**. + [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fevcc-io%2Fhassio-addon) +2. Manually add repository: + 1. Click on **Settings** → **Addons** → **Add-on Store** + 2. Click on the **three dots** → **Repositories** + 3. Add the repository URL and click **Add** + ``` + https://github.com/evcc-io/hassio-addon + ``` +3. Reload the webpage +4. Find the **evcc (nightly)** addon and click on it +5. Click on the **INSTALL** button </TabItem> </Tabs> @@ -94,13 +94,15 @@ Create an empty evcc configuration file `evcc.yaml` in your Addon root configura If this folder does not exist, create it manually. To create or edit the configuration file, you have many options, here are a few: + - [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 see the system running in demo mode, just start evcc with the parameter `--demo`. +See [CLI Referenz](/docs/reference/cli/evcc) for more information. Now you are ready and can start the addon. @@ -120,11 +122,13 @@ To perform the following functions, you need SSH access to Home Assistant. You c ### How do I access the evcc database? Show the files in `/data`: + ```sh docker exec addon_49686a9f_evcc ls -la /data ``` Copy the `evcc.db` to `/addon_configs/49686a9f_evcc`: + ```sh docker cp addon_49686a9f_evcc:/data/evcc.db /addon_configs/49686a9f_evcc/ ``` @@ -132,16 +136,19 @@ docker cp addon_49686a9f_evcc:/data/evcc.db /addon_configs/49686a9f_evcc/ ### How can I use the evcc CLI? Open a shell to the evcc Docker container: + ```sh docker exec -it addon_49686a9f_evcc /bin/sh ``` Run evcc CLI commands (here as an example `checkconfig`): + ```sh evcc -c /config/evcc.yaml checkconfig ``` Close the shell in the evcc Docker container if you are done: + ```sh exit ``` diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/linux.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/linux.mdx index 2e261d297..a8525bcef 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/linux.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/linux.mdx @@ -68,7 +68,7 @@ Cloudsmith provides services to support the development of free software and pla sudo systemctl start evcc ``` -- Now check the installation by opening a browser to `http://localhost:7070`. You should see the evcc web interface in demo mode. +- Now check the installation by opening a browser to `http://localhost:7070`. The evcc application will ask you to set a password and start the configuration. - Stop the server: @@ -231,6 +231,7 @@ In addition to the Debian/Ubuntu APT package, we also provide other binaries for ### Installation - Download the appropriate file for your system: + - 64-bit Intel CPU: [evcc_X.XX_linux_amd64.tar.gz](https://github.com/evcc-io/evcc/releases/latest) - 64-bit ARM CPU: [evcc_X.XX_linux_arm64.tar.gz](https://github.com/evcc-io/evcc/releases/latest) - 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) @@ -265,4 +266,4 @@ This ensures evcc starts when the computer boots and automatically restarts in c :::note This documentation assumes Linux supports `systemd`. -::: \ No newline at end of file +::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/macos.md b/i18n/en/docusaurus-plugin-content-docs/current/installation/macos.md index 5ab16146b..77bb6587b 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/macos.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/macos.md @@ -38,7 +38,7 @@ If you want to install evcc without a package manager or test a nightly version, brew services start evcc ``` -- Check the installation by opening a browser and entering the following URL: [http://localhost:7070](http://localhost:7070). You should see the evcc interface in demo mode. +- Check the installation by opening a browser and entering the following URL: [http://localhost:7070](http://localhost:7070). The evcc application will ask you to set a password and start the configuration. - Stop the evcc server: ```sh