diff --git a/docs/_sponsortoken.mdx b/docs/_sponsortoken.mdx index d02dde226..001934b46 100644 --- a/docs/_sponsortoken.mdx +++ b/docs/_sponsortoken.mdx @@ -1,4 +1,4 @@ -```yaml title="evcc.yaml" +```yaml # trial token, valid until 2025-12-24 -sponsortoken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJldmNjLmlvIiwic3ViIjoidHJpYWwiLCJleHAiOjE3NjY1OTkyMDAsImlhdCI6MTc2NTk5NDQwMCwic3BlIjp0cnVlLCJzcmMiOiJtYSJ9.Ls6XxNahmQnolsSCLQuKVzY9uuK_PI9v559oxz5yT-k +eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJldmNjLmlvIiwic3ViIjoidHJpYWwiLCJleHAiOjE3NjY1OTkyMDAsImlhdCI6MTc2NTk5NDQwMCwic3BlIjp0cnVlLCJzcmMiOiJtYSJ9.Ls6XxNahmQnolsSCLQuKVzY9uuK_PI9v559oxz5yT-k ``` diff --git a/docs/devices/chargers.mdx b/docs/devices/chargers.mdx index 39f0f4674..e028afb1f 100644 --- a/docs/devices/chargers.mdx +++ b/docs/devices/chargers.mdx @@ -14,7 +14,15 @@ import DeviceFeatureFilter from "/src/components/DeviceFeatureFilter"; Zur Steuerung der Ladung muss evcc mit einer Wallbox kommunizieren. -In der Konfigurationsdatei gibt es hierzu den folgenden Bereich: +## Einrichtung + +**Empfohlen:** Richte deine Wallbox direkt über die Weboberfläche unter **Konfiguration** → **Laden & Heizen** ein. +Die Einrichtung erfolgt über einen geführten Assistenten. +Alle hier aufgelisteten Geräte sind über die Oberfläche auswählbar. +Nach Eingabe aller benötigten Daten kannst du die Verbindung prüfen und siehst welche Daten evcc vom Gerät ausliest. + +**Alternativ:** Du kannst deine Wallbox auch über die Konfigurationsdatei einrichten. +Auf dieser Seite findest du die YAML-Konfigurationen für alle derzeit von evcc unterstützten Wallboxen. ```yaml chargers: @@ -22,8 +30,9 @@ chargers: type: ... ``` -Auf dieser Seite findest du die Konfigurationen für alle derzeit von evcc direkt unterstützten Wallboxen. -Nachdem du das Code-Beispiel für deine Wallbox angepasst und in die `evcc.yaml` übernommen hast, kannst du die Verbindung mit dem Befehl `evcc charger` testen. Dabei werden alle konfigurierten Charger getestet. Mit dem Befehlt `evcc charger --name my_charger` kann man mittels des vergebenen Namens selektiv testen. +Nachdem du das Code-Beispiel für deine Wallbox angepasst und in die `evcc.yaml` übernommen hast, kannst du die Verbindung mit dem Befehl `evcc charger` testen. +Dabei werden alle konfigurierten Charger getestet. +Mit dem Befehlt `evcc charger --name my_charger` kann man mittels des vergebenen Namens selektiv testen. ``` $ ./evcc charger diff --git a/docs/devices/heating.mdx b/docs/devices/heating.mdx index ed0ff73d7..b4d2741ab 100644 --- a/docs/devices/heating.mdx +++ b/docs/devices/heating.mdx @@ -21,6 +21,16 @@ evcc unterstützt unterschiedliche Arten von Wärmeerzeugern. Einfache Geräte wie Heizlüfter oder Ventilatoren können über [Smarte Schalter](./smartswitches) ein/ausgeschaltet werden. Auf dieser Seite erfährst du, wie du auch **Wärmepumpen** oder **Heizstäbe** steuern kannst. +## Einrichtung + +**Empfohlen:** Richte deine Wärmepumpe oder deinen Heizstab direkt über die Weboberfläche unter **Konfiguration** → **Laden & Heizen** ein. +Die Einrichtung erfolgt über einen geführten Assistenten. +Alle hier aufgelisteten Geräte sind über die Oberfläche auswählbar. +Nach Eingabe aller benötigten Daten kannst du die Verbindung prüfen und siehst welche Daten evcc vom Gerät ausliest. + +**Alternativ:** Du kannst deine Wärmeerzeuger auch über die Konfigurationsdatei einrichten. +Auf dieser Seite findest du die YAML-Konfigurationen für alle derzeit von evcc unterstützten Geräte. + ## Wärmepumpen Viele Wärmepumpen unterstützen das SG-Ready-Modell, um ihren Betrieb an die Energiesituation vor Ort anzupassen. diff --git a/docs/devices/meters.mdx b/docs/devices/meters.mdx index 64cfc7407..f836de682 100644 --- a/docs/devices/meters.mdx +++ b/docs/devices/meters.mdx @@ -11,16 +11,36 @@ import SponsorshipRequired from "/docs/_sponsorship_required.mdx"; # PV, Batterie, Netz, Zähler -Die aufgelisteten Geräte können als `meter` für verschiedene Zwecke eingebunden werden: +Energiezähler erfassen den Stromfluss an verschiedenen Punkten deiner Installation und sind die Grundlage für die intelligente Steuerung durch evcc. -- `grid`: Netzanschluss (nur eins möglich) -- `pv`: PV Produktion -- `battery`: Hausbatterie -- `charge`: Ladeleistung an der Wallbox -- `aux`: intelligenter Verbraucher mit eigener Überschussregelung -- `ext`: weiterer Zähler, bspw. für [Lastmanagement](../features/loadmanagement) oder Datenerfassung +## Einrichtung -In der Konfigurationsdatei gibt es hierzu den folgenden Bereich: +**Empfohlen:** Richte deine Zähler direkt über die Weboberfläche unter **Konfiguration** ein. +Die Einrichtung erfolgt über einen geführten Assistenten. +Alle hier aufgelisteten Geräte sind über die Oberfläche auswählbar. +Nach Eingabe aller benötigten Daten kannst du die Verbindung prüfen und siehst welche Daten evcc vom Gerät ausliest. + +**Alternativ:** Du kannst deine Zähler auch über die Konfigurationsdatei einrichten. +Auf dieser Seite findest du die YAML-Konfigurationen für alle derzeit von evcc unterstützten Geräte. + +## Einsatzbereiche + +Die aufgelisteten Geräte können an mehreren Stellen eingebaut werden: + +- **Netzzähler** (`grid`): zentraler Hausanschluss (nur einmal möglich) +- **PV-Produktion** (`pv`): Energieerzeuger +- **Batterie** (`battery`): Hausbatterie +- **Laden & Heizen**: + - **Verbraucher / Ladegerät** (`charge`): Zusätzlicher Zähler für einen Ladepunkt, z. B. für Wallboxen ohne Zähler +- **Zusätzliche Zähler**: + - **Intelligenter Verbraucher** (`aux`): Verbraucher mit eigener Überschussregelung + - **Regulärer Verbraucher** (`ext`): Energiezähler für rein statistische Zwecke oder [Lastmanagement](../features/loadmanagement) + +## Hybridwechselrichter + +Hybridwechselrichter übernehmen in der Regel mehrere Messfunktionen gleichzeitig. +Sie erfassen typischerweise die PV-Erzeugung, den Batteriezustand und oft auch den Netzanschluss. +Daher musst du das Gerät an allen relevanten Stellen eintragen (z. B. als Netzzähler, Batteriezähler und PV-Zähler). ```yaml # Definition aller Geräte diff --git a/docs/devices/smartswitches.mdx b/docs/devices/smartswitches.mdx index b1bc90b5b..8e1b3f7dd 100644 --- a/docs/devices/smartswitches.mdx +++ b/docs/devices/smartswitches.mdx @@ -18,6 +18,16 @@ Hier steuert evcc lediglich den Ein-/Aus-Zustand der Steckdose. Ist genügend [Überschuss vorhanden](/docs/features/solar-charging) oder [günstige Energie](/docs/features/dynamic-prices) aus dem Netz verfügbar, wird automatisch geschaltet. Darüber hinaus ist auch eine manuelle Steuerung über "Aus" und "Schnell" möglich. +## Einrichtung + +**Empfohlen:** Richte deine smarten Schalter direkt über die Weboberfläche unter **Konfiguration** → **Laden & Heizen** ein. +Die Einrichtung erfolgt über einen geführten Assistenten. +Alle hier aufgelisteten Geräte sind über die Oberfläche auswählbar. +Nach Eingabe aller benötigten Daten kannst du die Verbindung prüfen und siehst welche Daten evcc vom Gerät ausliest. + +**Alternativ:** Du kannst deine Schalter auch über die Konfigurationsdatei einrichten. +Auf dieser Seite findest du die YAML-Konfigurationen für alle derzeit von evcc unterstützten Geräte. + ## Modus Abhängig vom Anwendungsfall gibt es zwei Modi, in denen geregelt wird. diff --git a/docs/devices/vehicles.mdx b/docs/devices/vehicles.mdx index 109834576..26c1fe7f1 100644 --- a/docs/devices/vehicles.mdx +++ b/docs/devices/vehicles.mdx @@ -11,7 +11,15 @@ import DeviceConfig from "/src/components/DeviceConfig"; Um die Ladung auf einen bestimmten Ladestand (SoC) zu begrenzen, und die meisten Wallboxen diesen nicht kennen, kann evcc direkt mit dem Fahrzeug über den Fahrzeughersteller kommunizieren. -In der Konfigurationsdatei gibt es hierzu den folgenden Bereich: +## Einrichtung + +**Empfohlen:** Richte dein Fahrzeug direkt über die Weboberfläche unter **Konfiguration** → **Fahrzeuge** ein. +Die Einrichtung erfolgt über einen geführten Assistenten. +Alle hier aufgelisteten Geräte sind über die Oberfläche auswählbar. +Nach Eingabe aller benötigten Daten kannst du die Verbindung prüfen und siehst welche Daten evcc vom Gerät ausliest. + +**Alternativ:** Du kannst dein Fahrzeug auch über die Konfigurationsdatei einrichten. +Auf dieser Seite findest du die YAML-Konfigurationen für alle derzeit von evcc unterstützten Fahrzeuge. ```yaml vehicles: @@ -19,8 +27,9 @@ vehicles: type: ... ``` -Auf dieser Seite findest du die Konfigurationen für alle von evcc unterstützten Fahrzeuge. -Nachdem du das Code-Beispiel für dein Fahrzeug angepasst und in die `evcc.yaml` übernommen hast, kannst du die Verbindung mit dem Befehl `evcc vehicle` testen. Dabei werden alle konfigurierten Fahrzeuge getestet. Mit dem Befehl `evcc vehicle --name my_ev` kann man mittels des vergebenen Namens selektiv testen. +Nachdem du das Code-Beispiel für dein Fahrzeug angepasst und in die `evcc.yaml` übernommen hast, kannst du die Verbindung mit dem Befehl `evcc vehicle` testen. +Dabei werden alle konfigurierten Fahrzeuge getestet. +Mit dem Befehl `evcc vehicle --name my_ev` kann man mittels des vergebenen Namens selektiv testen. ``` $ ./evcc vehicle diff --git a/docs/faq.mdx b/docs/faq.mdx index e11f22c17..7ac874243 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -7,6 +7,54 @@ toc_max_heading_level: 2 ## Einrichtung +### Soll ich evcc über die Weboberfläche oder mit der Konfigurationsdatei einrichten? + +Wir empfehlen die Einrichtung über die **Weboberfläche**. +Nach der Installation von evcc öffnest du die Oberfläche im Browser und konfigurierst deine Geräte direkt dort. +Die Einstellungen werden automatisch in der Datenbank gespeichert. + +Die **Konfigurationsdatei** (`evcc.yaml`) ist die traditionelle Methode und wird weiterhin unterstützt. + +**Wichtig**: Einige neuere Features sind ausschließlich über die Weboberfläche verfügbar. +Beide Methoden können auch parallel genutzt werden. + +Mehr Informationen findest du unter [Einrichtung](./installation/configuration). + +### Ich habe eine evcc.yaml Konfiguration. Wie migriere ich zur Weboberfläche? \{#ui-migration} + +Du kannst beide Konfigurationsmethoden parallel nutzen und schrittweise migrieren. + +**Vorgehen:** + +1. Konfiguriere ein neues Gerät direkt über die Weboberfläche unter **Konfiguration**. +2. Entferne den entsprechenden Eintrag aus deiner `evcc.yaml`. +3. Wiederhole dies für alle Geräte, bis deine `evcc.yaml` leer ist. + +**Zusammenführung von Geräten:** + +Ladepunkte, Netzzähler, PV-Anlagen, Batterien, Fahrzeuge und weitere Zähler werden aus beiden Quellen zusammengeführt. +Auf der Konfigurationsseite sind Geräte aus der `evcc.yaml` sichtbar, aber nicht bearbeitbar. +Du kannst Geräte sowohl aus der `evcc.yaml` als auch aus der UI gleichzeitig nutzen. + +**Vorrang der UI-Konfiguration:** + +Bei anderen Einstellungen (MQTT, Benachrichtigungen, InfluxDB, Tarife, ...) haben Werte aus der Weboberfläche Vorrang gegenüber Werten aus der `evcc.yaml`. +Wir empfehlen immer nur eine Quelle zu nutzen, um Verwirrung zu vermeiden. + +**Hinweis:** An einigen Stellen (HEMS, Sponsortoken) ist die UI-Konfiguration gesperrt, falls bereits über `evcc.yaml` konfiguriert wurde. +Lösche den Eintrag aus der `evcc.yaml`, um die UI-Bearbeitung zu ermöglichen. + +**Fazit:** + +Eine vollständige Migration ist nicht zwingend erforderlich. +Du kannst die `evcc.yaml` auch weiterhin für bestimmte Konfigurationen nutzen und neue Features über die Weboberfläche hinzufügen. + +:::note +Es gibt keine automatische Migration. +Der früher vorhandene `evcc migrate` Befehl wurde aufgrund hoher Komplexität entfernt. +Bitte migriere händisch. +::: + ### Kann ich evcc ohne Netzzähler betreiben? Der Netzzähler ist das Kernstück für evcc und sollte, wenn möglich, eingebunden werden. @@ -64,51 +112,41 @@ Damit evcc weiß, dass nicht mehr 3-phasig geladen werden kann muss die entsprec ## Fehlersuche -### Syntax-Fehler in der evcc.yaml finden - -yaml ist sehr syntax-empfindlich. Fehler fallen nicht immer sofort ins Auge. - -Eine schnelle Hilfe bieten yaml-Tester wie z. B. (https://onlineyamltools.com/validate-yaml) - ### Etwas funktioniert nicht. Was nun? -Bei evcc gibt es einen [Community Support](https://github.com/evcc-io/evcc/discussions). Hier helfen sowohl Entwickler als auch Anwender bei verschiedenen Problemen. Es wäre gut, dabei möglichst genaue Informationen zu folgenden Bereichen mitzuteilen: - -- Welche Geräte (Fahrzeug, Hausinstallation, Wallbox) verwendet werden. - -- Die Konfigurationsdatei `evcc.yaml`, - -
- - d.h. deren Inhalt (*bitte Benutzernamen, Passwörter und ähnliches entfernen*). - +Schau zuerst im [Community Forum](https://github.com/evcc-io/evcc/discussions) nach, ob dein Problem bereits diskutiert wurde. +Hier helfen sowohl Entwickler als auch Anwender bei verschiedenen Problemen. -`egrep -v '^#|^\s+#' evcc.yaml |grep . |sed -E 's/(password|user|token|url|host|broker|accessToken|refreshToken|vin).*/\1: *****/'` +Die einfachste Möglichkeit um Hilfe zu bekommen ist die **Problem melden** Funktion in der evcc Weboberfläche. +Klicke in der Oberfläche auf das Menü (oben rechts) und wähle **Hilfe benötigt?** → **Problem melden**. +Hier werden Details zu deiner Konfiguration, Datenbank, Logs und dem Zustand der Anwendung angezeigt. +Daraus kannst du direkt einen [GitHub Discussions](https://github.com/evcc-io/evcc/discussions) Beitrag oder ein [GitHub Issue](https://github.com/evcc-io/evcc/issues) erstellen. -
+Wenn du selbst einen Beitrag erstellst, gib bitte genaue Informationen an: -- alternativ kann mit `evcc dump --cfg >~/config.txt` eine anonymisierte Konfigurationsdatei erstellt und unter dem angegebenen Namen im Home-Verzeichnis gespeichert werden. +- Beschreibung des Problems mit reproduzierbaren Schritten. +- Welche Geräte (Fahrzeug, Hausinstallation, Wallbox) verwendet werden. -- Eine möglichst genaue Beschreibung was das Problem ist. +Eine gute Problembeschreibung führt zu schnellerer und besserer Hilfe. -**Erste Hilfe** +### Syntax-Fehler in der evcc.yaml finden -Zur Erleichterung wurde eine Erste-Hilfe Funktionalität entwickelt. Durch Eingabe von `evcc discuss` auf der Kommandozeile wird ein neuer Diskussionsbeitrag in der Rubrik "Erste Hilfe" erstellt. Dieser Beitrag beinhaltet automatisch die Fehlermeldung(en) und die anonymisierte Konfigurationsdatei. Ergänzt werden muss nur noch ein aussagekräftiger Titel und eine Problembeschreibung. -Diese Erste-Hilfe ist jeweils nur für die Erst-Erstellung eines Diskussionsbeitrages nutzbar. Sind im Zuge der Lösungsfindung weitere Informationen notwendig, müssen diese händisch erstellt werden. +yaml ist sehr syntax-empfindlich. +Fehler fallen nicht immer sofort ins Auge. -Wir versuchen natürlich Probleme so gut es geht zu vermeiden, aber das kann aufgrund der Komplexität leider nicht immer gelingen. +Eine schnelle Hilfe bieten yaml-Tester wie z. B. (https://onlineyamltools.com/validate-yaml) ### Wie kann ich ein Logfile zur Fehleranalyse erstellen? -evcc gibt in seiner Standard Konfiguration nur dann Fehlermeldungen aus, wenn ein Fehler auftritt (siehe auch [`log`](/docs/reference/configuration/log#log) Parameter in der `evcc.yaml`). - -Wenn evcc auf der Konsole ausgeführt wird, werden die `log` Nachrichten einfach in die normale Ausgabe geleitet. +Die einfachste Möglichkeit ist das **Log in der Weboberfläche** einzusehen und herunterzuladen. +Klicke im Menü (oben rechts) auf "Logs". +Dort kannst du auch nach verschiedenen Level und Bereichen filtern. -Mittels `evcc charger` oder `evcc meter` oder `evcc vehicle` können auf der Kommandozeile die verschiedenen Gerätetypen getestet werden. Dabei kommt der in `evcc.yaml` konfigurierte Log-Parameter (siehe oben) zum Einsatz. Will man davon abweichende Tests durchführen, kann der Log-Parameter beim Aufruf entsprechend ergänzt werden. +Das Log umfasst die letzten 10k Zeilen. -`Beispiel: evcc -l debug meter` +**Erweiterte Log-Optionen:** -Wird evcc als Linux Systemdienst, wie [hier beschrieben](/docs/installation/linux#systemd), ausgeführt, können die log-Nachrichten über folgende Befehle verfolgt, bzw. aufgelistet werden: +Wird evcc als Linux Systemdienst ausgeführt, können die log-Nachrichten über folgende Befehle verfolgt werden: - Kontinuierliche Anzeige der evcc log Meldungen `sudo journalctl -fau evcc` @@ -123,14 +161,6 @@ Weiterführende Hilfe: [wiki.ubuntuusers.de/systemd/journalctl](https://wiki.ubu Im Falle einer Docker Installation kann man über `docker logs` die Nachrichten anzeigen lassen, siehe [Docker Dokumentation](https://docs.docker.com/config/containers/logging/). -:::tip - -Als Ergänzung zu den Konsolenausgaben gibt es auch die Möglichkeit, das fortlaufenden Log im WebUI einzusehen und herunterzuladen. Dazu im Web-Menü (oben rechts) den Menüpunkt "Logs" auswählen. Dort kann auch nach verschiedenen Level und Bereichen gefiltert werden. - -Dieses Log umfasst allerdings nur die letzten 10k Zeilen. - -::: - ### Weiterführende Hilfe bei der Geräteerkennung `evcc detect` ist ein spezielles Kommando, welches eine Art Hardwareerkennung und Netzwerksuche für bestimmte Geräte ermöglicht. @@ -179,17 +209,10 @@ Eine Prüfung, ob mehrere evcc Prozesse laufen, kann unter Linux mithilfe von `h Sollte es Gründe geben, evcc auf der Kommandoebene zu starten, sollte vorher der Dienst mit `sudo systemctl stop evcc` beendet werden. -### evcc UI ist nicht erreichbar (Demo Modus funktioniert aber) - -Es kommt immer wieder vor, dass Fehler in der Konfiguration übersehen werden und der Service gestartet wird. -Dabei wird der Start von evcc abgebrochen, ohne das es dafür einen Hinweis gibt. -Ergebnis ist, dass das UI nicht erreichbar ist. - -In dem Fall sollte man evcc durch Eingabe von `evcc` auf der Kommandozeile starten. -Dort werden dann auch Fehlerhinweise gegeben, die den Start des Service verhindert haben. +### evcc UI ist nicht erreichbar -Mittels der oben genannten Tests kann man diesen Fehlern auf den Grund gehen und sie beheben. -Erst wenn alles fehlerfrei ist, sollte der Service gestartet werden. +Schaue ins Log, um die Fehlerursache zu finden. +Wie du das Log aufrufst, findest du in der [Installation](/docs/installation) unter deiner jeweiligen Installationsmethode. ### MQTT plugin gibt `outdated` Warnung @@ -268,7 +291,7 @@ service evcc start ### Wie kann ich meine Konfiguration sichern und wiederherstellen? {#backup-restore} -In der evcc UI findest du unter **Einstellungen** → **Experimentell aktivieren** → **Sichern & Wiederherstellen** folgende Optionen: +In der evcc Weboberfläche findest du unter **Konfiguration** → **Sichern & Wiederherstellen** folgende Optionen: **Sichern:** Lädt eine Kopie deiner Datenbank (evcc.db) herunter. @@ -291,7 +314,7 @@ Du kannst einzelne Bereiche deiner Datenbank löschen: :::warning Achtung Nach dem Zurücksetzen der Konfiguration musst du alle Geräte neu konfigurieren. -Deine `evcc.yaml` bleibt dabei unverändert. +Deine `evcc.yaml` (falls vorhanden) bleibt dabei unverändert. ::: Alternativ kannst du einzelne Caches über die Kommandozeile löschen: diff --git a/docs/installation/configuration.mdx b/docs/installation/configuration.mdx index 08267e8d4..65a4190ec 100644 --- a/docs/installation/configuration.mdx +++ b/docs/installation/configuration.mdx @@ -5,103 +5,68 @@ sidebar_position: 10 import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# evcc.yaml erstellen +# Einrichtung -Diese Anleitung beschreibt, wie du an eine funktionierende `evcc.yaml` Datei kommst. +Nach der Installation von evcc kannst du deine Geräte und Einstellungen konfigurieren. +Der empfohlene Weg ist die Konfiguration über die Weboberfläche. +Für fortgeschrittene Nutzer steht auch die dateibasierte Konfiguration zur Verfügung. -## Mit Assistenten +## über Weboberfläche -Über den `evcc configure` Befehl kannst du dir eine Konfigurationsdatei über einen Terminal-basierten Assistenten erstellen lassen. -In einem Frage-Antwort-Dialog kannst du deine jeweiligen Geräte konfigurieren. - -### Voraussetzungen - -Um den Assistenten nutzen zu können, muss evcc auf deinem System installiert sein. -Zudem musst du den `evcc` Befehl mit der Kommandozeile (Terminal, Shell, Eingabeaufforderung) ausführen können. -Läuft evcc auf einem System, wo du diesen Zugriff nicht hast (bspw. Home Assistant, Docker), kannst du den Assistenten leider nicht nutzen. - -:::note -`evcc configure` kann auch in einem Docker Container gestartet werden. -Siehe dafür die Erklärung in [Docker](./docker). +:::tip Empfohlen +Die Weboberfläche ist der einfachste und schnellste Weg, evcc einzurichten. ::: -### Assistent ausführen +### Erste Schritte -Starte die Konfiguration und folge den Anweisungen im Terminal Fenster: +1. **evcc starten**: Nach der [Installation](../installation) starte evcc gemäß der Anleitung für dein System +2. **Browser öffnen**: Gehe zu `http://:7070` (z.B. `http://evcc.local:7070` oder `http://192.168.1.50:7070`) +3. **Administrator-Passwort setzen**: Beim ersten Start wirst du aufgefordert, ein Passwort zu vergeben +4. **Einrichtung**: Folge den Anweisungen auf der Willkommensseite -```sh -evcc configure -``` +### Geräte hinzufügen -Du solltest eine Ausgabe wie die folgende sehen: +Im Konfigurationsbereich kannst du folgende Komponenten einrichten: -![evcc configure](./screenshots/configure.webp) +- **Laden & Heizen** (erforderlich): Wallboxen und Wärmepumpen – mindestens ein Gerät muss konfiguriert werden +- **Netzanschluss** (empfohlen): Hauszähler und Stromtarife – wichtig für korrektes Energiemanagement +- **PV & Batterie** (optional): Solaranlagen und Batteriespeicher +- **Fahrzeuge** (optional): Fahrzeugintegrationen für Akkugröße und Ladestand, ermöglicht intelligenteres Laden -Nach Abschluss der Konfiguration wird eine `evcc.yaml` Datei im aktuellen Verzeichnis erstellt. +### Integrationen -:::note -Mit `--advanced` kannst du den Assistenten auch in einem erweiterten Modus starten. -Dann bekommst du zusätzliche Einstellungsmöglichkeiten. -Für deine erste Konfiguration ist das aber nicht notwendig. +Zusätzlich kannst du verschiedene Dienste und Protokolle einbinden: -```sh -evcc configure --advanced -``` - -::: - -Teste, ob die Konfiguration funktioniert +- **MQTT**: Datenaustausch mit anderen Systemen im Netzwerk +- **Benachrichtigungen**: Push-Nachrichten und E-Mail-Benachrichtigungen +- **InfluxDB**: Datenexport für Langzeitauswertungen +- **EEBus**: Kommunikation mit anderen EEBus-Geräten +- **OCPP Server**: Verbindung mit OCPP-fähigen Wallboxen +- **Lastmanagement**: Stromkreisüberwachung und -steuerung +- **Modbus-Proxy**: Mehrfachzugriff auf Modbus-Geräte +- **Sunny Home Manager**: Integration via SEMP-Protokoll +- **HEMS**: Externe Steuerung und §14a EnWG-Integration -```sh -evcc -c evcc.yaml -``` - -Öffne einen Browser und gib die folgende URL ein: `http://localhost:7070`. -Die evcc Oberfläche sollte nun mit den eigenen Geräten zu sehen sein. +### Sichern & Wiederherstellen {#backup} -Wenn alles funktioniert kannst du deine `evcc.yaml` an die Stelle verschieben, die für deine Installation notwendig ist. +Die Weboberfläche bietet integrierte Funktionen für Datensicherung: -### Fehlersuche +- **Sichern**: Datenbank herunterladen zur Datensicherung +- **Wiederherstellen**: Daten aus einer Sicherungsdatei wiederherstellen +- **Zurücksetzen**: Konfiguration oder Ladehistorie löschen -Sollten Fehler auftreten, kannst du dir mit folgenden Befehlen weitere Informationen anzeigen lassen. - -- Syntaxprüfung - - ```sh - evcc -c evcc.yaml checkconfig - ``` - -- Zähler (Netz, PV, Batterie) +## über Konfigurationsdatei - ```sh - evcc -c evcc.yaml -l debug meter - ``` - -- Fahrzeuge - - ```sh - evcc -c evcc.yaml -l debug vehicle - ``` - -- Wallboxen - - ```sh - evcc -c evcc.yaml -l debug charger - ``` - -Überprüfe die Ausgaben der jeweiligen Befehle auf Plausibilität. - -Du kannst `evcc configure` auch erneut ausführen und deine Angaben korrigieren. -Beachte, dass der Assistent immer eine komplett neue Konfiguration erstellt. -Ein gezieltes Verändern einer bestehenden Konfiguration ist nicht möglich. -Nutze dafür die manuelle Konfiguration. +:::info Traditionelle Methode +Diese Methode nutzt eine `evcc.yaml` Datei und erfordert Kenntnisse im Umgang mit der Kommandozeile und YAML-Dateien. Einige neue Funktionen sind nur über die Weboberfläche konfigurierbar. +::: -## Manuell +### Manuell erstellen -Sollte der Assistent für dich nicht verfügbar sein, kannst du die `evcc.yaml` Datei manuell erstellen. +Du kannst die `evcc.yaml` Datei auch manuell erstellen. Hier findest du eine minimale Vorlage, die du als Ausgangspunkt nutzen kannst. -### Erstellen +#### Erstellen Kopiere den Inhalt in eine neue `evcc.yaml` Datei. @@ -182,7 +147,7 @@ tariffs: Mit dieser Datei kannst du evcc starten. Nutze dafür die jeweilige Anleitung für dein System. -### Testen +#### Testen Starte evcc neu und öffne deinen Browser unter `http://:7070`. Überprüfe, ob die Werte plausibel sind. @@ -192,7 +157,7 @@ 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 +#### Anpassen Die Datei beinhaltet lediglich Demo-Geräte (`demo-charger`, `demo-meter`, `demo-battery`, `offline`). Diese haben feste Werte. @@ -212,7 +177,7 @@ Führe diese Änderungen möglichst Schritt für Schritt durch. Starte nach jeder Änderung evcc neu und überprüfe die Ausgaben im Browser. Dann bemerkst du schnell, wenn du einen Fehler gemacht hast. -### Weitere Informationen +#### Weitere Informationen Die [evcc.dist.yaml](https://github.com/evcc-io/evcc/blob/master/evcc.dist.yaml) im Hauptprojekt beinhaltet eine vollständige Liste aller möglichen Konfigurations-Optionen. Ausführlichere Erklärungen zu den Optionen findest du unter [Referenz → evcc.yaml](../reference/configuration). @@ -223,3 +188,116 @@ 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). + +Die dateibasierte Konfiguration über `evcc.yaml` ermöglicht maximale Kontrolle über alle Einstellungen. Du kannst die Datei entweder mit dem Assistenten erstellen oder manuell schreiben. + +### Mit Assistenten + +Über den `evcc configure` Befehl kannst du dir eine Konfigurationsdatei über einen Terminal-basierten Assistenten erstellen lassen. +In einem Frage-Antwort-Dialog kannst du deine jeweiligen Geräte konfigurieren. + +:::warning +Der `evcc configure` Assistent ist veraltet und wird in einer der kommenden Versionen entfernt. Wir empfehlen die Konfiguration über die Weboberfläche. +::: + +#### Voraussetzungen + +Um den Assistenten nutzen zu können, muss evcc auf deinem System installiert sein. +Zudem musst du den `evcc` Befehl mit der Kommandozeile (Terminal, Shell, Eingabeaufforderung) ausführen können. + +#### Assistent ausführen + +Starte die Konfiguration und folge den Anweisungen im Terminal Fenster: + +```sh +evcc configure +``` + +Du solltest eine Ausgabe wie die folgende sehen: + +![evcc configure](./screenshots/configure.webp) + +Nach Abschluss der Konfiguration wird eine `evcc.yaml` Datei im aktuellen Verzeichnis erstellt. + +:::note +Mit `--advanced` kannst du den Assistenten auch in einem erweiterten Modus starten. +Dann bekommst du zusätzliche Einstellungsmöglichkeiten. +Für deine erste Konfiguration ist das aber nicht notwendig. + +```sh +evcc configure --advanced +``` + +::: + +### Mit Assistenten via Docker + +Du kannst den Konfigurationsassistenten auch in einem Docker Container ausführen. +Praktisch, wenn du das evcc Binary nicht direkt auf deinem Rechner laufen lassen willst oder kannst. + +#### Vorbereitung + +Erstelle eine leere `evcc.yaml` Datei: + +```sh +touch evcc.yaml +``` + +#### Assistent ausführen + +Führe den Konfigurationsassistenten direkt in Docker aus: + +```sh +docker run -v $(pwd)/evcc.yaml:/app/evcc.yaml -it evcc/evcc:latest evcc configure +``` + +Folge den Fragen des Assistenten. +Am Ende wird die Konfiguration in die erstellte `evcc.yaml` Datei geschrieben. + +## Testen + +Teste, ob die Konfiguration funktioniert: + +```sh +evcc -c evcc.yaml +``` + +Öffne einen Browser und gib die URL ein: `http://:7070` (z.B. `http://evcc.local:7070`). +Die evcc Oberfläche sollte nun mit den eigenen Geräten zu sehen sein. + +Wenn alles funktioniert, kannst du deine `evcc.yaml` an die Stelle verschieben, die für deine Installation notwendig ist. + +## Fehlersuche + +Sollten Fehler auftreten, kannst du dir mit folgenden Befehlen weitere Informationen anzeigen lassen. + +- Syntaxprüfung + + ```sh + evcc -c evcc.yaml checkconfig + ``` + +- Zähler (Netz, PV, Batterie) + + ```sh + evcc -c evcc.yaml -l debug meter + ``` + +- Fahrzeuge + + ```sh + evcc -c evcc.yaml -l debug vehicle + ``` + +- Wallboxen + + ```sh + evcc -c evcc.yaml -l debug charger + ``` + +Überprüfe die Ausgaben der jeweiligen Befehle auf Plausibilität. + +Du kannst `evcc configure` auch erneut ausführen und deine Angaben korrigieren. +Beachte, dass der Assistent immer eine komplett neue Konfiguration erstellt. +Ein gezieltes Verändern einer bestehenden Konfiguration ist nicht möglich. +Nutze dafür die manuelle Konfiguration. diff --git a/docs/installation/docker.mdx b/docs/installation/docker.mdx index 64ba63ca4..0e7ec18f4 100644 --- a/docs/installation/docker.mdx +++ b/docs/installation/docker.mdx @@ -22,37 +22,24 @@ Diese werden hier allerdings nicht behandelt. ## Vorbereitung -### Konfigurationsdatei +### Konfiguration -Du benötigst eine `evcc.yaml` Konfigurationsdatei für deine Komponenten (Zähler, Wallbox, Fahrzeug, ...). -Es gibt mehrere Möglichkeiten, diese zu erstellen: +evcc kann auf zwei Arten konfiguriert werden: -1. **Assistent auf anderem System:** Führe `evcc configure` vorher auf einem [Linux](./linux), [macOS](./macos) oder [Windows](./windows) System aus. - Verwende die damit erstellte `evcc.yaml` Datei für deine Docker Installation. +1. **Weboberfläche** (empfohlen): Starte den Container ohne `evcc.yaml`. Nach dem Start richtest du evcc direkt im Browser ein. Die Konfiguration wird automatisch in der Datenbank gespeichert. -2. **Manuell:** Erstelle die `evcc.yaml` manuell. - Hier findest du eine Anleitung unter [evcc.yaml erstellen](./configuration). - -3. **Assistent in Docker:** - Praktisch, wenn du Docker auf einem Linux System installiert hast. - Erstelle eine leere `evcc.yaml` Datei und führe den Konfigurationsassistenten direkt in Docker aus. - Folge den Fragen des Assistenten. - Am Ende wird die Konfiguration in die erstellte `evcc.yaml` Datei geschrieben. - - ```sh - touch evcc.yaml - docker run -v $(pwd)/evcc.yaml:/app/evcc.yaml -it evcc/evcc:latest evcc configure - ``` +2. **Konfigurationsdatei** (traditionelle Methode): Erstelle eine `evcc.yaml` Datei mit deinen Einstellungen. Eine Anleitung findest du unter [Einrichtung](./configuration). ### Volumes -Der evcc Docker Container benötigt zwei Volumes: +Der evcc Docker Container benötigt mindestens ein Volume: -- `/etc/evcc.yaml` für die Konfigurationsdatei -- `/root/.evcc/` Verzeichnis für die interne SQLite Datenbank. Die Datenbank wird automatisch in diesem Verzeichnis abgelegt. +- `/root/.evcc/` Verzeichnis für die interne SQLite Datenbank (erforderlich). Die Datenbank wird automatisch in diesem Verzeichnis abgelegt. +- `/etc/evcc.yaml` für die Konfigurationsdatei (optional - nur bei dateibasierter Konfiguration) -Erstelle diese Verzeichnisse auf deinem Host-System. -In dieser Anleitung verwenden wir exemplarisch die Pfade `/home/user/.evcc/` und `/home/user/evcc.yaml` +Erstelle das Datenbank-Verzeichnis auf deinem Host-System. +In dieser Anleitung verwenden wir exemplarisch den Pfad `/home/user/.evcc/`. +Falls du die dateibasierte Konfiguration nutzt, verwende zusätzlich `/home/user/evcc.yaml` ## Installation @@ -71,22 +58,22 @@ Hier sind die relevanten Angaben, die du eintragen musst: #### Volume Mounts {#volumes} -| Host Pfad | Container Pfad | Beschreibung | -| ---------------------- | ---------------- | --------------------------------- | -| `/home/user/evcc.yaml` | `/etc/evcc.yaml` | Konfigurationsdatei | -| `/home/user/.evcc/` | `/root/.evcc` | Verzeichnis für interne Datenbank | +| Host Pfad | Container Pfad | Beschreibung | Erfordert | +| ---------------------- | ---------------- | ---------------------------------------------------------- | --------- | +| `/home/user/evcc.yaml` | `/etc/evcc.yaml` | Konfigurationsdatei (nur bei dateibasierter Konfiguration) | nein | +| `/home/user/.evcc/` | `/root/.evcc` | Verzeichnis für interne Datenbank | ja | #### Ports {#ports} -| Host Port | Container Port | Beschreibung | Optional | -| --------- | -------------- | ---------------------- | -------- | -| 7070 | 7070/tcp | Web UI, API | | -| 8887 | 8887/tcp | OCPP Server | Yes | -| 9522 | 9522/udp | SMA Sunny Home Manager | Yes | -| 7090 | 7090/udp | KEBA Chargers | Yes | -| 5353 | 5353/udp | mDNS | Yes | -| 4712 | 4712/tcp | EEBus | Yes | -| 8899 | 8899/udp | Modbus UDP | Yes | +| Host Port | Container Port | Beschreibung | Erfordert | +| --------- | -------------- | ---------------------- | --------- | +| 7070 | 7070/tcp | Web UI, API | ja | +| 8887 | 8887/tcp | OCPP Server | nein | +| 9522 | 9522/udp | SMA Sunny Home Manager | nein | +| 7090 | 7090/udp | KEBA Chargers | nein | +| 5353 | 5353/udp | mDNS | nein | +| 4712 | 4712/tcp | EEBus | nein | +| 8899 | 8899/udp | Modbus UDP | nein | Öffne die Docker UI deines Systems und erstelle einen neuen Container mit den obigen Angaben und starte ihn. @@ -106,7 +93,7 @@ Sollten nach einer Aktualisierung bspw. deine Ladevorgänge nicht mehr angezeigt ### via Docker CLI -Installiere und starte den Docker Container der zu deiner Komponenten-Konstellation passt mit einem der folgenden Befehle. +Installiere und starte den Docker Container mit einem der folgenden Befehle. Ob du `sudo` benötigst, hängt von deinem System ab. @@ -114,7 +101,7 @@ Ob du `sudo` benötigst, hängt von deinem System ab. ```sh sudo docker run -d --name evcc \ --v /home/user/evcc.yaml:/etc/evcc.yaml \ +-v /home/user/evcc.yaml:/etc/evcc.yaml \ # optional -v /home/user/.evcc:/root/.evcc \ -p 7070:7070 \ -p 8887:8887 \ @@ -189,11 +176,11 @@ Springe zum Abschnitt [Testen](#test) um zu prüfen, ob die Installation erfolgr [docker-compose](https://docs.docker.com/compose) hat einige Vorteile gegenüber der direkten Ausführung in der Kommandozeile Alle Parameter werden in einer Datei hinterlegt. Zudem kannst du weitere Programme wie Traefik in Verbindung mit evcc konfigurieren und gemeinsam starten. -Im aktiven Verzeichnis legt man dazu einfach eine Konfigurationsdatei mit dem Namen `compose.yml` an. +Im aktiven Verzeichnis legt man dazu einfach eine Konfigurationsdatei mit dem Namen `compose.yml` an. Entsprechend der passenden Komponenten-Konstellation kopiert man eine der folgenden Konfigurationen in die `compose.yml` und speichert diese ab: - + ```yaml version: "3" @@ -207,8 +194,8 @@ services: - 7070:7070/tcp - 8887:8887/tcp volumes: - - /home/user/evcc.yaml:/etc/evcc.yaml - /home/user/.evcc:/root/.evcc + - /home/user/evcc.yaml:/etc/evcc.yaml # optional restart: unless-stopped # optional: #user: : @@ -277,11 +264,19 @@ sudo docker compose up -d Hast du deinen Container erfolgreich erstellt und gestartet, kannst du die evcc Web UI unter `http://:7070` aufrufen. `` ist hier die IP-Adresse oder der Hostname des Computers, auf dem der Container läuft. -Du solltest die evcc Oberfläche sehen und aufgefordert werden ein Administrations-Passwort zu setzen. +**Bei der ersten Verwendung:** + +- Wirst du aufgefordert ein Administrations-Passwort zu setzen +- Kannst du anschließend deine Geräte über die Weboberfläche einrichten (bei UI-Konfiguration) +- Oder siehst direkt deine konfigurierten Geräte (bei dateibasierter Konfiguration) Solltest du keine Verbindung herstellen können, überprüfe die Logs deines Containers. -Wenn du die Oberfläche siehst, aber eine Fehlermeldung angezeigt wird, überprüfe die Konfiguration in der `evcc.yaml` Datei. -Weitere Details findest du in [evcc.yaml erstellen](./configuration) oder in den [GitHub Diskussionen](https://github.com/evcc-io/evcc/discussions). +Wenn du die Oberfläche siehst, aber eine Fehlermeldung angezeigt wird, überprüfe: + +- Bei dateibasierter Konfiguration: die Einstellungen in der `evcc.yaml` Datei +- Bei UI-Konfiguration: die Geräteeinstellungen auf der Konfigurationsseite + +Weitere Details findest du in [Einrichtung](./configuration) oder in den [GitHub Diskussionen](https://github.com/evcc-io/evcc/discussions). ## Community Anleitungen diff --git a/docs/installation/home-assistant.mdx b/docs/installation/home-assistant.mdx index 6810d4cc5..bcceb24a0 100644 --- a/docs/installation/home-assistant.mdx +++ b/docs/installation/home-assistant.mdx @@ -75,7 +75,11 @@ Siehe [Home Assistant Dokumentation](https://www.home-assistant.io/installation/ -## Konfigurationsdatei +## Konfiguration + +evcc kann auf zwei Arten konfiguriert werden: + +### Weboberfläche (empfohlen) Gehe im **evcc** Add-on in den Tab **Information** und aktiviere **In Seitenleiste anzeigen** (evcc UI http://your-ha-instance-ip-address:7070) @@ -84,28 +88,43 @@ Gehe zum Tab **Konfiguration** und wähle dein Arbeitsverzeichnis aus (Beispiel) ![Image](screenshots/ha_configuration_ui.webp) ```sh -- config_file: /config/evcc.yaml - sqlite_file: /data/evcc.db ``` Lasse den Abschnitt Netzwerk unverändert. -Lege eine leere Konfigurationsdatei `evcc.yaml` in deinem Add-on-Stammkonfigurationsordner (`/addon_configs/49686a9f_evcc`) an. -Falls dieser Ordner noch nicht exisiert, erstelle ihn manuell. +Starte das Add-on. +Öffne dann die evcc Oberfläche über die Seitenleiste: + +- Du wirst aufgefordert ein Administrator-Passwort zu vergeben +- Anschließend kannst du deine Geräte direkt über die Weboberfläche einrichten +- Die Einstellungen werden automatisch in der Datenbank gespeichert + +### Konfigurationsdatei (traditionell) + +Alternativ kannst du eine `evcc.yaml` Konfigurationsdatei verwenden. + +Gehe zum Tab **Konfiguration** und füge die Konfigurationsdatei zu deinem Arbeitsverzeichnis hinzu: -Um die Konfigurationsdatei anzulegen bzw. zu editieren, hast du verschiedene Möglichkeiten, hier ein paar zur Auswahl: +```sh +- config_file: /config/evcc.yaml +- sqlite_file: /data/evcc.db +``` -- [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 Add-on Konfiguration deaktiviert hast, starte das Add-on 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 +Lege eine Konfigurationsdatei `evcc.yaml` in deinem Add-on-Stammkonfigurationsordner (`/addon_configs/49686a9f_evcc`) an. +Falls dieser Ordner noch nicht existiert, erstelle ihn manuell. -Unter [evcc.yaml erstellen](./configuration) findest du eine Anleitung, wie du den Inhalt für die `evcc.yaml` erstellen kannst. +Um die Konfigurationsdatei anzulegen bzw. zu editieren, hast du verschiedene Möglichkeiten: + +- [Visual Studio Code](https://github.com/hassio-addons/addon-vscode): 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 Add-on Konfiguration deaktiviert hast, starte das Add-on 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 + +Details zur Erstellung der Konfigurationsdatei findest du unter [Einrichtung](./configuration). 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 Add-on starten. - ## Aktualisierungen Die Aktualisierung auf die neueste Version von evcc ist in den Home Assistant Update-Prozess integriert. diff --git a/docs/installation/index.md b/docs/installation/index.md index 3d8f08b21..d1f618cd1 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -54,4 +54,4 @@ Falls du mehr über die Funktionsweise von Wallboxen und E-Auto-Laden erfahren m /> -Nach der Installation: [evcc.yaml erstellen](./installation/configuration) +Nach der Installation: [evcc einrichten](./installation/configuration) diff --git a/docs/installation/linux-image.mdx b/docs/installation/linux-image.mdx index 7fb09de2f..49d4918d1 100644 --- a/docs/installation/linux-image.mdx +++ b/docs/installation/linux-image.mdx @@ -5,14 +5,7 @@ sidebar_position: 3 # Raspberry Pi & Co. Die einfachste Art, evcc auf einem Raspberry Pi oder ähnlichen Kleincomputern zu installieren. -Fertig vorkonfiguriert! - -:::warning Experimentell -Mit den evcc Linux Images kannst du evcc komplett über die Web UI einrichten. -Im Regelfall brauchst du keine `evcc.yaml` oder Konsolen-Befehle. -Die UI-Einrichtung ist allerdings noch als experimentell gekennzeichnet. -Bei Problemen oder für Debugging sind ggf. weiterhin Konsolenbefehle erforderlich. -::: +Fertig vorkonfiguriert und einfach über die Web UI einzurichten! ## Schnellstart @@ -58,8 +51,9 @@ Das evcc Image findet man unter - Alternativ via IP-Adresse, z.B. `https://192.168.1.123/` (IP im Router ermitteln) - Administrator-Passwort vergeben (beim ersten Start) - Geräte einrichten (Wallbox, PV-Anlage, Hausbatterie, Fahrzeuge) - - "Experimentell" aktivieren - - Hinweis: Mindestens ein Ladepunkt muss angelegt werden, damit evcc läuft + - Hinweis: Mindestens ein Ladepunkt muss angelegt werden, damit evcc läuft. + +Weitere Details zur Einrichtung findest du in der [Konfigurationsanleitung](./configuration). ![evcc Willkommen](screenshots/evcc-welcome.webp) @@ -118,6 +112,7 @@ Bereits 1 GB RAM reichen völlig aus. **Unterstützte Geräte:** - Raspberry Pi 3, 4 und 5 - alle Modelle funktionieren gleich gut +- Raspberry Pi Zero 2 W - funktioniert gut - NanoPi R3S - kompakt, günstig und kommt mit Gehäuse und integriertem eMMC-Speicher **Speicher:** @@ -150,6 +145,9 @@ Du kannst dich via SSH mit dem `admin` Benutzer verbinden (gleiche Zugangsdaten - Verschlüsselt: https://evcc.local/ (empfohlen) - Unverschlüsselt: http://evcc.local:7070/ (falls Zertifikatmeldung stört) +**OCPP Server:** +Der OCPP Server läuft auf `ws://evcc.local:8887/` für die Verbindung mit OCPP-fähigen Wallboxen. + Weitere technische Details findest du im [GitHub Repository](https://github.com/evcc-io/images). ## Nächste Schritte diff --git a/docs/installation/linux.mdx b/docs/installation/linux.mdx index 2df7c3590..1dcb24ff5 100644 --- a/docs/installation/linux.mdx +++ b/docs/installation/linux.mdx @@ -72,13 +72,9 @@ 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 fordert dich auf ein Password zu vergeben und die Einrichtung zu starten. - -- Stoppe den evcc-Server: - - ```sh - sudo systemctl stop evcc - ``` +- Öffne die evcc Oberfläche in deinem Browser: [http://localhost:7070](http://localhost:7070) +- Die evcc Oberfläche fordert dich auf ein Administrator-Passwort zu vergeben +- Anschließend kannst du deine Geräte direkt über die Weboberfläche einrichten :::note Während der Installation wird ein Nutzer `evcc` angelegt, deshalb sollte der angemeldete Nutzer nicht den Namen `evcc` haben. @@ -90,44 +86,29 @@ Dieser Befehl fügt den Benutzer evcc zur Gruppe plugdev hinzu. Die Gruppe plugdev dient dazu, Zugriffsrechte für Plug-in-Geräte (wie USB, serielle Schnittstelle usw.) zu erteilen, ohne dass Root-Rechte erforderlich sind. ::: -## evcc.yaml erstellen - -Für den Betrieb musst du eine funktionierende `evcc.yaml` Konfigurationsdatei erstellen. -Neben allgemeinen Einstellungen beinhaltet die Konfiguration die Definition der einzelnen Komponenten (Zähler, Wallbox, Fahrzeug, ...). - -### Erstellen - -Wir empfehlen die Verwendung des Konfigurationsassistenten: - -- Starte den Konfigurationsassistenten und beantworte die Fragen: - - ```sh - sudo evcc configure - ``` - -- Kopiere die erstellte Konfigurationsdatei nach `/etc/evcc.yaml`: +## Konfiguration - ```sh - sudo mv evcc.yaml /etc - ``` +evcc kann über die Weboberfläche oder eine Konfigurationsdatei eingerichtet werden. -- Starte den evcc-Server: +:::tip Empfohlen +Die Konfiguration über die Weboberfläche ist der einfachste Weg, evcc einzurichten. +::: - ```sh - sudo systemctl restart evcc - ``` +### Weboberfläche (empfohlen) -- Rufe die evcc Oberfläche auf [http://localhost:7070](http://localhost:7070) +Nach dem ersten Start kannst du evcc direkt im Browser unter [http://localhost:7070](http://localhost:7070) konfigurieren. +Die Einstellungen werden automatisch in der Datenbank gespeichert. -### Anpassen +### Konfigurationsdatei (traditionell) -Benötigt deine Konfiguration noch Anpassungen kannst du entweder den Konfigurationsassistenten erneut ausführen (siehe oben) oder die Konfigurationsdatei manuell anpassen. +Alternativ kannst du eine `evcc.yaml` Konfigurationsdatei verwenden. +Details zur Erstellung der Konfigurationsdatei findest du unter [Einrichtung](./configuration). -- Konfigurationsdatei bearbeiten: +:::important +Die Konfigurationsdatei muss unter `/etc/evcc.yaml` abgelegt werden. +::: - ```sh - sudo nano /etc/evcc.yaml - ``` +- Erstelle die Konfigurationsdatei gemäß [Anleitung](./configuration) und speichere sie unter `/etc/evcc.yaml` - Starte den evcc-Server neu: @@ -135,7 +116,7 @@ Benötigt deine Konfiguration noch Anpassungen kannst du entweder den Konfigurat sudo systemctl restart evcc ``` -Unter [evcc.yaml erstellen](./configuration) findest du weitere Informationen und Beispiele zur Konfiguration von evcc. +- Rufe die evcc Oberfläche auf [http://localhost:7070](http://localhost:7070) ## Aktualisierung @@ -220,9 +201,16 @@ Prüfe die Installation Ersetze `127.0.0.1` mit der IP Adresse oder dem Hostnamen des Computers, falls der Browser nicht auf dem gleichen Computer geöffnet wurde. ::: -## Backup und Restore +## Backup und Restore {#backup} + +### Über die Weboberfläche (empfohlen) -Um nach einer Neuinstallation wieder den "Ursprungszustand" herzustellen zu können, reicht es die Konfigurationsdatei `evcc.yaml` und die Datenbankdatei `evcc.db` zu sichern. +Die einfachste Methode ist das Backup über die Weboberfläche. +Details findest du unter [Einrichtung → Sichern & Wiederherstellen](./configuration#backup). + +### Manuelles Backup + +Um nach einer Neuinstallation wieder den "Ursprungszustand" herzustellen zu können, reicht es die Konfigurationsdatei `evcc.yaml` (falls verwendet) und die Datenbankdatei `evcc.db` zu sichern. Der Speicherort wird im Logfile beim Programmstart angegeben. Üblicherweise liegt die Konfiguration unter `/etc/evcc.yaml` und die Datenbank unter `/var/lib/evcc/evcc.db`. @@ -234,6 +222,34 @@ yaml kopieren: `sudo cp /etc/evcc.yaml /home/pi/evcc.yaml.bak` db kopieren: `sudo cp /var/lib/evcc/evcc.db /home/pi/evcc.db.bak` +## Umgebungsvariablen & CLI-Optionen {#environment} + +Bei der Installation über APT läuft evcc als systemd-Dienst. +Du kannst das Verhalten über eine Override-Datei anpassen: + +```sh +sudo systemctl edit evcc +``` + +### Beispiel + +```ini title="/etc/systemd/system/evcc.service.d/override.conf" +[Service] +Environment="EVCC_LOG=debug,tariff:trace" +ExecStart= +ExecStart=/usr/bin/evcc --custom-css /path/to/my.css +``` + +:::note +Die erste leere `ExecStart=` Zeile ist wichtig, um den Standard-Befehl zu überschreiben. +::: + +:::tip +Alle Parameter aus `evcc.yaml` können als Umgebungsvariable gesetzt werden: `EVCC_` + Parametername in Großbuchstaben. + +Eine vollständige Liste aller CLI-Optionen findest du in der [CLI-Dokumentation](/docs/reference/cli/evcc). +::: + ## Manuelle Installation {#manual} Neben dem Debian/Ubuntu APT Paket, stellen wir auch weitere Binaries für Linux bereit. @@ -254,15 +270,19 @@ Neben dem Debian/Ubuntu APT Paket, stellen wir auch weitere Binaries für Linux ``` - Du solltest die aktuelle Version von evcc sehen (bspw. `evcc version 0.xxx.y`). -### evcc.yaml erstellen +### Konfiguration + +Du kannst evcc über die Weboberfläche oder eine Konfigurationsdatei einrichten. +Details findest du unter [Einrichtung](./configuration). -Erstelle dir nach der Anleitung unter [evcc.yaml erstellen](./configuration) eine funktionierende `evcc.yaml` Konfigurationsdatei. -Diese kannst du mit folgendem Befehl starten: +Starte evcc mit: ```sh -./evcc -c evcc.yaml +./evcc ``` +Öffne dann deinen Browser unter [http://localhost:7070](http://localhost:7070) und folge den Anweisungen. + ### Aktualisierung/Downgrade Führe die obigen Schritte aus und ersetze die evcc Programmdatei mit der neuen bzw. vorherigen Version. @@ -325,6 +345,4 @@ Diese Dokumentation geht davon aus, dass Linux `systemd` unterstützt. sudo systemctl enable evcc.service ``` -- Fertig :-) - Weitere Informationen findest du oben im Abschnitt [Systemdienst](#systemd). diff --git a/docs/installation/macos.md b/docs/installation/macos.md index 696934eb2..1f2cc6e8c 100644 --- a/docs/installation/macos.md +++ b/docs/installation/macos.md @@ -38,65 +38,21 @@ 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 fordert dich auf ein Password zu vergeben und die Einrichtung zu starten. -- Stoppe den evcc-Server: +- Öffne die evcc Oberfläche in deinem Browser: [http://localhost:7070](http://localhost:7070) +- Die evcc Oberfläche fordert dich auf ein Administrator-Passwort zu vergeben +- Anschließend kannst du deine Geräte direkt über die Weboberfläche einrichten - ```sh - brew services stop evcc - ``` - -## evcc.yaml erstellen - -Für den Betrieb musst du eine funktionierende `evcc.yaml` Konfigurationsdatei erstellen. -Neben allgemeinen Einstellungen beinhaltet die Konfiguration die Definition der einzelnen Komponenten (Zähler, Wallbox, Fahrzeug, ...). - -### Erstellen - -Wir empfehlen die Verwendung des Konfigurationsassistenten: - -- Starte den Konfigurationsassistenten und beantworte die Fragen: - - ```sh - sudo evcc configure - ``` - -- Kopiere die erstellte Konfigurationsdatei nach `/etc/evcc.yaml`: - - ```sh - sudo mv evcc.yaml /etc - ``` - -- Starte den evcc-Server: - - ```sh - brew services start evcc - ``` - -- Rufe die evcc Oberfläche auf [http://localhost:7070](http://localhost:7070) - -### Anpassen +## Konfiguration -Benötigt deine Konfiguration noch Anpassungen kannst du entweder den Konfigurationsassistenten erneut ausführen (siehe oben) oder die Konfigurationsdatei manuell anpassen. - -- Konfigurationsdatei bearbeiten: - - ```sh - sudo nano /etc/evcc.yaml - ``` - -- Starte den evcc-Server neu: - - ```sh - brew services restart evcc - ``` - -Unter [evcc.yaml erstellen](./configuration) findest du weitere Informationen und Beispiele zur Konfiguration von evcc. - -## evcc.yaml erstellen +:::tip Empfohlen +Richte evcc direkt im Browser ein. +::: -Es wird eine funktionierende evcc Konfiguration benötigt. +Nach dem ersten Start kannst du evcc unter [http://localhost:7070](http://localhost:7070) konfigurieren. +Die Einstellungen werden automatisch in der Datenbank gespeichert. -Folge nun der [Anleitung](./configuration) zur Erstellung einer Konfiguration mit dem Konfigurationsassistenten. +Alternativ kannst du eine `evcc.yaml` Konfigurationsdatei unter `/etc/evcc.yaml` ablegen. +Details findest du unter [Einrichtung](./configuration). ## Aktualisierung @@ -146,10 +102,11 @@ Hier findest du die Anleitung für die manuelle Installation von evcc auf macOS. ``` - Du solltest die aktuelle Version von evcc sehen (bspw. `evcc version 0.xxx.y`). -### evcc.yaml erstellen +### Konfiguration + +Nach dem ersten Start öffne [http://localhost:7070](http://localhost:7070) im Browser und richte evcc über die Weboberfläche ein. -Erstelle dir nach der Anleitung unter [evcc.yaml erstellen](./configuration) eine funktionierende `evcc.yaml` Konfigurationsdatei. -Diese kannst du mit folgendem Befehl starten: +Alternativ kannst du eine `evcc.yaml` Konfigurationsdatei erstellen (siehe [Einrichtung](./configuration)) und evcc damit starten: ```sh ./evcc -c evcc.yaml diff --git a/docs/installation/windows.mdx b/docs/installation/windows.mdx index acd896c05..34143b3ff 100644 --- a/docs/installation/windows.mdx +++ b/docs/installation/windows.mdx @@ -18,9 +18,9 @@ Allerdings wird evcc typischerweise in einer Linux-Umgebung (z.B. Raspberry Pi) - Lade die entsprechende Datei für dein System herunter - 64-Bit Intel CPU: [evcc_X.XX_windows_amd64.zip](https://github.com/evcc-io/evcc/releases/latest) - Entpacke die heruntergeladene Datei (z.B. per Doppelklick auf die Datei) -- Es gibt nun einen neuen Ordner mit der dem Programm `evcc`. +- Es gibt nun einen neuen Ordner mit dem Programm `evcc`. - Öffne ein Terminal/Eingabeaufforderung und gehe in den Ordner mit dem Programm `evcc` -- Starte die Konfiguration und folge den Anweisungen im Terminal Fenster: +- Prüfe die Installation mit folgendem Befehl: ```sh evcc -v @@ -28,10 +28,30 @@ Allerdings wird evcc typischerweise in einer Linux-Umgebung (z.B. Raspberry Pi) - Du solltest nun die aktuelle Version von evcc sehen (z.B. `evcc version 0.xxx.y`). -## evcc.yaml erstellen +## Konfiguration -Erstelle eine funktionierende `evcc.yaml` Konfigurationsdatei, indem du den Anweisungen unter [evcc.yaml erstellen](./configuration) befolgst. -Mit folgendem Befehl kannst du evcc starten: +evcc kann auf zwei Arten konfiguriert werden: + +### Weboberfläche (empfohlen) + +Starte evcc ohne weitere Parameter: + +```sh +./evcc +``` + +Öffne dann deinen Browser unter [http://localhost:7070](http://localhost:7070): + +- Du wirst aufgefordert ein Administrator-Passwort zu vergeben +- Anschließend kannst du deine Geräte direkt über die Weboberfläche einrichten +- Die Einstellungen werden automatisch in der Datenbank gespeichert + +### Konfigurationsdatei (traditionell) + +Alternativ kannst du eine `evcc.yaml` Konfigurationsdatei verwenden. +Details zur Erstellung der Konfigurationsdatei findest du unter [Einrichtung](./configuration). + +Starte evcc mit: ```sh ./evcc -c evcc.yaml @@ -39,28 +59,36 @@ Mit folgendem Befehl kannst du evcc starten: ## Aktualisierung/Downgrade -Führe die obigen Schritte aus und ersetze die evcc Programmdatei mit der neuen bzw. vorherigen Version. Die Konfiguration muss nicht erneut durchgeführt werden. +Führe die obigen Schritte aus und ersetze die evcc Programmdatei mit der neuen bzw. vorherigen Version. +Die Konfiguration muss nicht erneut durchgeführt werden. ## evcc als Hintergrunddienst :::note Diese Dokumentation geht davon aus, dass evcc in `c:\evcc` liegt. + Diese Anweisungen wurden mit Windows 10 erstellt. ::: -- Beginnt in der Suchleiste von Windows 10 mit der Eingabe des Wortes `Aufgabenplanung`. Bereits nach wenigen Buchstaben sollte diese als Treffer mit der höchsten Übereinstimmung angezeigt werden und kann auf der rechten Seite mit `Als Administrator ausführen` gestartet werden: +- Beginnt in der Suchleiste von Windows 10 mit der Eingabe des Wortes `Aufgabenplanung`. + Bereits nach wenigen Buchstaben sollte diese als Treffer mit der höchsten Übereinstimmung angezeigt werden und kann auf der rechten Seite mit `Als Administrator ausführen` gestartet werden: ![Windows 10 Aufgabenplanung](win10-srv/win10-srv-1.png) -- Nach dem Start der Aufgabenplanung obliegt es dir, ob du den neuen Service in einem eigenen Ordner oder der allgemeinen Aufgabenplanungsbibliothek anlegst. Für dieses Beispiel wird ein eigener Ordner `evcc` angelegt. Hierzu muss zunächst der Ordner "Aufgabenplanungsbibliothek" angewählt werden, um dann mit der rechten Maustaste das PopUp-Menü zu starten. Hier wählst du `Neuer Ordner` und benennst diesen evcc: +- Nach dem Start der Aufgabenplanung obliegt es dir, ob du den neuen Service in einem eigenen Ordner oder der allgemeinen Aufgabenplanungsbibliothek anlegst. + Für dieses Beispiel wird ein eigener Ordner `evcc` angelegt. + Hierzu muss zunächst der Ordner "Aufgabenplanungsbibliothek" angewählt werden, um dann mit der rechten Maustaste das PopUp-Menü zu starten. + Hier wählst du `Neuer Ordner` und benennst diesen evcc: ![Aufgabenplanungsbibliothek](win10-srv/win10-srv-2.png) -- Nun wählst du den neuen Ordner `evcc oder die allgemeine Aufgabenplanungsbibliothek` aus und öffnest erneut mit der rechten Maustaste das PopUp Menü, dort wählst du nun `Aufgabe erstellen`: +- Nun wählst du den neuen Ordner `evcc` oder die allgemeine Aufgabenplanungsbibliothek aus und öffnest erneut mit der rechten Maustaste das PopUp Menü, dort wählst du nun `Aufgabe erstellen`: ![Neue Aufgabe erstellen](win10-srv/win10-srv-3.png) -- Als Name `evcc` und zur besseren Zuordnung sollte eine kurze Beschreibung mit angegeben werden. Da du den Service als Systemdienst laufen lässt, öffnest du die Userverwaltung über 'Benutzer oder Gruppe ändern' und tippst dort `system`. Nach einem Klick auf `User überprüfen`, sollte der Account angezeigt und der Dialog kann mit OK geschlossen werden: +- Als Name `evcc` und zur besseren Zuordnung sollte eine kurze Beschreibung mit angegeben werden. + Da du den Service als Systemdienst laufen lässt, öffnest du die Userverwaltung über 'Benutzer oder Gruppe ändern' und tippst dort `system`. + Nach einem Klick auf `User überprüfen`, sollte der Account angezeigt und der Dialog kann mit OK geschlossen werden: ![Allgemein](win10-srv/win10-srv-4.png) ![Systemnutzer setzen](win10-srv/win10-srv-5.png) @@ -70,13 +98,17 @@ Diese Anweisungen wurden mit Windows 10 erstellt. ![Trigger](win10-srv/win10-srv-6.png) - Einstellungen des Reiters: `Aktionen` -- "Programm starten" belassen und über Durchsuchen die Datei "evcc.exe" auswählen. Es empfiehlt sich den Pfad zusätzlich in `Starten in` anzugeben, somit wird die dort abgelegte Konfigurationsdatei direkt gefunden: +- "Programm starten" belassen und über Durchsuchen die Datei "evcc.exe" auswählen. + Es empfiehlt sich den Pfad zusätzlich in `Starten in` anzugeben, somit wird die dort abgelegte Konfigurationsdatei direkt gefunden: ![Aktionen](win10-srv/win10-srv-7.png) - Einstellungen des Reiters: `Bedingungen` -- Diese Einstellungen können im Default belassen werden. Da evcc länger laufen sollte, als es der Akkubetrieb gewährleisten würde. -- `Tipp`: Da z.B. der SMA Home Manager über WLAN Probleme bereiten kann, sollte optional der Haken bei `Netzwerk` gesetzt und eine entsprechende Verbindung ausgewählt werden. +- Diese Einstellungen können im Default belassen werden. + Da evcc länger laufen sollte, als es der Akkubetrieb gewährleisten würde. + :::info + Da z.B. der SMA Home Manager über WLAN Probleme bereiten kann, sollte optional der Haken bei `Netzwerk` gesetzt und eine entsprechende Verbindung ausgewählt werden. + ::: ![Bedingungen](win10-srv/win10-srv-8.png) @@ -88,4 +120,5 @@ Diese Anweisungen wurden mit Windows 10 erstellt. - Du bist fertig! 🎉 -- Die Aufgabe kann nun manuell gestartet oder über einen Reboot getestet werden. Zur Kontrolle mit dem Browser von einem anderen System auf `http://localhost:7070` zugreifen. +Die Aufgabe kann nun manuell gestartet oder über einen Reboot getestet werden. +Zur Kontrolle mit dem Browser auf `http://[IP-Adresse]:7070` zugreifen. diff --git a/docs/reference/configuration/index.md b/docs/reference/configuration/index.md index 3e54714f4..8fd9ec319 100644 --- a/docs/reference/configuration/index.md +++ b/docs/reference/configuration/index.md @@ -2,19 +2,39 @@ sidebar_position: 1 --- -# evcc.yaml +# Konfiguration -evcc benötigt eine Konfigurationsdatei in der die Installation beschrieben wird. Ohne diese Datei kann evcc nicht genutzt werden. Die Datei selbst ist im [YAML](https://de.wikipedia.org/wiki/YAML) Format geschrieben. Dieses Format definiert eine Syntax wodurch eine strukturierte Datenstruktur in Textform erstellt werden kann. +evcc kann auf zwei Arten konfiguriert werden: -Zur Bearbeitung bzw. Erstellung der Konfigurationsdatei empfehlen wir einen Texteditor zu verwenden, welcher die YAML Synthax beherrscht und damit Fehler aufzeigen kann, z. B. [VS Code](https://code.visualstudio.com) mit der [YAML Erweiterung](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml). +**1. UI-Konfiguration (empfohlen)** -Die Konfigurationsdatei hat standardmäßig den Namen `evcc.yaml` und ist entweder im gleichen Verzeichnis wie das Programm selbst abzulegen, oder bei Linux-Systemen unter `/etc/evcc.yaml`. +Die Konfiguration erfolgt über die Weboberfläche unter **Konfiguration**. +Die Einstellungen werden automatisch in der Datenbank gespeichert. +Weitere Informationen findest du unter [Einrichtung](/docs/installation/configuration). -Wenn die Konfigurationsdatei nicht gefunden wird, kann diese über einen Parameter beim Aufruf evcc übergeben werden: z. B. `evcc -c /home/evcc.yaml` +**2. Dateibasierte Konfiguration** + +Die Konfiguration über die `evcc.yaml` Datei wird weiterhin unterstützt. +Dieser Bereich dokumentiert die YAML-basierte Konfiguration. + +:::info Parallele Nutzung +Beide Konfigurationsmethoden können parallel genutzt werden. +Geräte (Ladepunkte, Zähler, PV-Anlagen, Batterien, Fahrzeuge) werden aus beiden Quellen zusammengeführt. +Bei anderen Einstellungen hat die UI-Konfiguration Vorrang. +Details findest du in der [FAQ](/docs/faq#ui-migration). +::: + +## Dateibasierte Konfiguration (evcc.yaml) + +Die Konfigurationsdatei ist im YAML Format geschrieben und hat standardmäßig den Namen `evcc.yaml`. +Sie liegt entweder im gleichen Verzeichnis wie das Programm oder bei Linux-Systemen unter `/etc/evcc.yaml`. + +Abweichende Pfade können beim Start angegeben werden: `evcc -c /pfad/zur/evcc.yaml` ### Struktur -Die Konfigurationsdatei von evcc besteht aus mehreren Bereichen. Um von einem Bereich auf Elemente eines anderen Bereichs zu verweisen, haben einzelne Geräte einen `name` Parameter, den man frei mit einem Text vergeben kann. Der vergebene Text dient der Identifikation und Referenzierung. +Die Konfigurationsdatei besteht aus mehreren Bereichen. +Um zwischen Bereichen zu referenzieren, haben Geräte einen `name` Parameter zur Identifikation. Eine Beispieldatei mit vielen Parametern findet man hier: https://github.com/evcc-io/evcc/blob/master/evcc.dist.yaml @@ -54,7 +74,7 @@ graph TD; ### Wie funktioniert evcc? (Ein Blick ins Innere) -Wichtig für die Funktionalität ist ein Netzanschlusszähler (grid-meter). Dieser ermittelt die aktuelle Überschussleistung. +Wichtig für die Funktionalität ist ein Netzanschlusszähler (`grid` Zähler). Dieser ermittelt die aktuelle Überschussleistung. Die Messung der Erzeugungsleistung hat in diesem Fall keinen funktionalen Einfluss. Ein Betrieb ist aber auch ohne Netzanschlusszähler möglich. Mehr dazu findest du [hier](/docs/faq#einrichtung). diff --git a/docs/reference/configuration/sponsortoken.md b/docs/reference/configuration/sponsortoken.md index f3e046f65..024a8786d 100644 --- a/docs/reference/configuration/sponsortoken.md +++ b/docs/reference/configuration/sponsortoken.md @@ -6,6 +6,10 @@ sidebar_position: 16 `sponsortoken` definiert ein Token das auf [https://sponsor.evcc.io](https://sponsor.evcc.io) vergeben wird. +:::tip +Wir empfehlen die Eingabe des Sponsortokens über die Weboberfläche unter **Konfiguration**. +::: + **Beispiel**: ```yaml diff --git a/docs/sponsorship.mdx b/docs/sponsorship.mdx index 8518b77e6..48394e88f 100644 --- a/docs/sponsorship.mdx +++ b/docs/sponsorship.mdx @@ -86,11 +86,11 @@ Dazu aber später mehr._ #### Wo trage ich mein Token ein? -Das Sponsortoken wird in der `evcc.yaml` eingetragen. -Füge dafür eine neue Zeile mit `sponsortoken: ` ein. +Trage das Sponsortoken über die Weboberfläche unter **Konfiguration** → **Sponsoring** ein. +Nach dem Eintragen ist ein Neustart von evcc erforderlich. -Es ist auch möglich das Token über die UI auf der Konfigurationsseite zu setzen. -Beachte: Diese Eingabe wird in der `evcc.db` gespeichert und hat Vorrang gegenüber der `evcc.yaml`. +**Hinweis:** Falls bereits ein Token in der `evcc.yaml` vorhanden ist, ist die UI-Eingabe gesperrt. +Entferne den Eintrag aus der `evcc.yaml`, um das Token über die Weboberfläche zu verwalten. #### Kann ich mein Token in mehreren Installationen nutzen? @@ -118,10 +118,13 @@ Wir aktualisieren das Token hier regelmäßig. Sollte dein Token nicht funktionieren, kann das verschiedene Gründe haben: - **Monatliches Sponsoring ausgelaufen:** Prüfe deinen Sponsor-Status bei GitHub und auf [sponsor.evcc.io](https://sponsor.evcc.io). -- **Formatierungsfehler:** Prüfe, ob das Token korrekt in der `evcc.yaml` eingetragen ist. -- **Exerimentelle Config UI:** Hast du die experimentelle Sponsortoken-Funktion 🧪 in der Konfigurationsoberfläche verwendet? - Wenn ja, wird das Token in der `evcc.yaml` nicht mehr berücksichtigt und stattdessen deine UI-Eingabe (gespeichert in der `evcc.db`) verwendet. - Mit [`evcc migrate --reset`](/docs/reference/cli/evcc_migrate) oder dem Löschen der `evcc.db` kommst du wieder zum alten Verhalten. +- **Formatierungsfehler:** Prüfe, ob du das Token korrekt in die `evcc.yaml` eingetragen hast. +- **Doppelte Konfiguration:** Falls du das Token sowohl in der Weboberfläche als auch in der `evcc.yaml` eingetragen hast, wird nur das Token aus der `evcc.yaml` verwendet. + Entferne den Eintrag aus der Datei, wenn du das Token über die Weboberfläche verwalten möchtest. +- **Token abgelaufen:** Das Token selbst hat eine Ablaufzeit. + Ist diese überschritten, kannst du dir unter [sponsor.evcc.io](https://sponsor.evcc.io) ein neues ausstellen und das aktuelle ersetzen. + Du bekommst in der Weboberfläche rechtzeitig eine Warnung, wenn dies erforderlich ist. + Hinweis: Wir werden diesen Prozess in Zukunft automatisieren. Sollten die obigen Schritte nicht helfen, [melde dich bei uns](mailto:info@evcc.io) und wir prüfen das gerne. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx index fd6992658..64e7127e0 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx @@ -14,7 +14,15 @@ import DeviceFeatureFilter from "/src/components/DeviceFeatureFilter"; To control charging, evcc needs to be able to communicate with at least one Charger. -The configuration is formatted as follows: +## Setup + +**Recommended:** Set up your charger directly via the web interface under **Configuration** → **Charging & Heating**. +Setup is done via a guided wizard. +All devices listed here are selectable via the interface. +After entering all required data, you can test the connection and see which data evcc reads from the device. + +**Alternative:** You can also set up your charger via the configuration file. +On this page you'll find the YAML configurations for all chargers currently supported by evcc. ```yaml chargers: @@ -22,9 +30,9 @@ chargers: type: ... ``` -All of the Chargers listed on this page are supported by evcc. -Once you have adapted the code samples to suit your Charger(s) in `evcc.yaml`, you can test the connection using the `evcc charger` command, which returns the current status of all connected Chargers. -If you just want to test one Charger at a time, use `evcc charger --name my_charger`. +Once you have adapted the code sample for your charger and added it to `evcc.yaml`, you can test the connection using the `evcc charger` command. +This tests all configured chargers. +With the command `evcc charger --name my_charger` you can test selectively using the assigned name. ``` $ ./evcc charger diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/heating.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/heating.mdx index c7f3d1dbb..0fd9ef660 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/heating.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/heating.mdx @@ -19,7 +19,17 @@ For the devices listed here, a [sponsorship](/docs/sponsorship) will be required evcc supports different types of heating devices. Simple devices like heaters or fans can be switched on/off via [Smart Switches](./smartswitches). -On this page you will learn how to also **heat pumps** or **electric water heaters** can be regulated. +On this page you will learn how **heat pumps** or **electric water heaters** can be regulated. + +## Setup + +**Recommended:** Set up your heat pump or electric heater directly via the web interface under **Configuration** → **Charging & Heating**. +Setup is done via a guided wizard. +All devices listed here are selectable via the interface. +After entering all required data, you can test the connection and see which data evcc reads from the device. + +**Alternative:** You can also set up your heating devices via the configuration file. +On this page you'll find the YAML configurations for all devices currently supported by evcc. ## Heat pumps diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx index a697ade4c..006317eeb 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx @@ -11,16 +11,36 @@ import SponsorshipRequired from "/docs/_sponsorship_required.mdx"; # PV, Battery, Grid, Meter -The devices on this page can all be used as energy measuring points (`meter`) for various purposes: +Energy meters measure electricity flow at various points in your installation and form the basis for intelligent control by evcc. -- `grid`: Grid supply -- `pv`: Solar power -- `battery`: House battery -- `charge`: Charging power at the wallbox -- `aux`: Smart consumer with its own surplus regulation -- `ext`: Additional meter, e.g. for [load management](../features/loadmanagement) or data logging +## Setup -The configuration is formatted as follows: +**Recommended:** Set up your meters directly via the web interface under **Configuration**. +Setup is done via a guided wizard. +All devices listed here are selectable via the interface. +After entering all required data, you can test the connection and see which data evcc reads from the device. + +**Alternative:** You can also set up your meters via the configuration file. +On this page you'll find the YAML configurations for all devices currently supported by evcc. + +## Usage Areas + +The listed devices can be integrated in several places: + +- **Grid Meter** (`grid`): central grid connection (only one possible) +- **PV Production** (`pv`): energy producer +- **Battery** (`battery`): house battery +- **Charging & Heating**: + - **Consumer / Charger** (`charge`): additional meter for a charging point, e.g. for wallboxes without a meter +- **Additional Meters**: + - **Self-Regulating Consumer** (`aux`): consumer with its own surplus regulation + - **Regular Consumer** (`ext`): energy meter for purely statistical purposes or [load management](../features/loadmanagement) + +## Hybrid Inverters + +Hybrid inverters typically perform multiple measurement functions simultaneously. +They typically measure PV production, battery status and often also the grid connection. +Therefore, you must add the device at all relevant places (e.g. as grid meter, battery meter and PV meter). ```yaml # Definition of all devices @@ -49,10 +69,6 @@ site: - ... ``` -This page lists the configurations for all supported components that can be used as energy measuring points (`meter`). -Once you have adapted the code samples to suit your meters in `evcc.yaml`, you can test the connection using the `evcc meter` command, which returns the current status of all connected meters. -The command `evcc meter grid1` can be used to test a single meter by name. - ``` $ ./evcc meter diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/smartswitches.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/smartswitches.mdx index 2d7759bc2..bedb41bbb 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/smartswitches.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/smartswitches.mdx @@ -18,6 +18,16 @@ Here, evcc only controls the on/off state of the socket. If there is enough [surplus](/docs/features/solar-charging) or [cheap energy](/docs/features/dynamic-prices) available, the socket is switched automatically. Additionally, manual control via "Off" and "Fast" is possible. +## Setup + +**Recommended:** Set up your smart switches directly via the web interface under **Configuration** → **Charging & Heating**. +Setup is done via a guided wizard. +All devices listed here are selectable via the interface. +After entering all required data, you can test the connection and see which data evcc reads from the device. + +**Alternative:** You can also set up your switches via the configuration file. +On this page you'll find the YAML configurations for all devices currently supported by evcc. + ## Modes Depending on the application, there are two modes of operation. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx index cdd148593..27b46ce46 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx @@ -12,7 +12,15 @@ import DeviceConfig from "/src/components/DeviceConfig"; To limit vehicle charging to a given State of Charge (SoC), which most Chargers do not have the capability to read, evcc can directly communicate with the Vehicle, usually via its manufacturer. -The configuration is formatted as follows: +## Setup + +**Recommended:** Set up your vehicle directly via the web interface under **Configuration** → **Vehicles**. +Setup is done via a guided wizard. +All devices listed here are selectable via the interface. +After entering all required data, you can test the connection and see which data evcc reads from the device. + +**Alternative:** You can also set up your vehicle via the configuration file. +On this page you'll find the YAML configurations for all vehicles currently supported by evcc. ```yaml vehicles: @@ -20,9 +28,9 @@ vehicles: type: ... ``` -All of the Vehicles listed on this page are supported by evcc. -Once you have adapted the code samples to suit your Vehicle(s) in `evcc.yaml`, you can test the connection using the `evcc vehicle` command, which returns the current status of all connected vehicles. -If you just want to test one meter at a time, use `evcc vehicle --name my_swanky_ev`. +Once you have adapted the code sample for your vehicle and added it to `evcc.yaml`, you can test the connection using the `evcc vehicle` command. +This tests all configured vehicles. +With the command `evcc vehicle --name my_ev` you can test selectively using the assigned name. ``` $ ./evcc vehicle diff --git a/i18n/en/docusaurus-plugin-content-docs/current/faq.mdx b/i18n/en/docusaurus-plugin-content-docs/current/faq.mdx index cd3af5b77..8162a851b 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/faq.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/faq.mdx @@ -7,6 +7,54 @@ toc_max_heading_level: 2 ## Configuration +### Should I configure evcc via the web interface or with the configuration file? + +We recommend using the **web interface**. +After installing evcc, open it in your browser and configure your devices directly there. +Settings are automatically saved in the database. + +The **configuration file** (`evcc.yaml`) is the traditional method and remains supported. + +**Important**: Some newer features are only available through the web interface. +Both methods can also be used in parallel. + +More information can be found under [Configuration](./installation/configuration). + +### I have an evcc.yaml configuration. How do I migrate to the web interface? \{#ui-migration} + +You can use both configuration methods in parallel and migrate step by step. + +**Procedure:** + +1. Configure a new device directly via the web interface under **Configuration**. +2. Remove the corresponding entry from your `evcc.yaml`. +3. Repeat this for all devices until your `evcc.yaml` is empty. + +**Device merging:** + +Charging points, grid meters, solar systems, batteries, vehicles and other meters are merged from both sources. +On the configuration page, devices from `evcc.yaml` are visible but not editable. +You can use devices from both `evcc.yaml` and the UI simultaneously. + +**UI configuration takes precedence:** + +For other settings (MQTT, notifications, InfluxDB, tariffs, ...), values from the web interface take precedence over values from `evcc.yaml`. +We recommend using only one source to avoid confusion. + +**Note:** In some places (HEMS, sponsor token), UI configuration is locked if already configured via `evcc.yaml`. +Delete the entry from `evcc.yaml` to enable UI editing. + +**Conclusion:** + +A complete migration is not mandatory. +You can continue using `evcc.yaml` for certain configurations and add new features via the web interface. + +:::note +There is no automatic migration. +The previously available `evcc migrate` command was removed due to high complexity. +Please migrate manually. +::: + ### Can I use evcc without a grid meter? The grid meter is the core of evcc and should be included if possible. @@ -75,52 +123,40 @@ This ways evcc knows when there's enough surpuls to charge the vehicle. ## Debugging -### Finding syntax errors in evcc.yaml - -Yaml is very sensitive to syntax - and errors don't always catch the eye straight away. -Linters such as (https://onlineyamltools.com/validate-yaml) can be super useful, and are worth checking to find simple mistakes. - ### Something's not working. What now? -We have a [Community Support](https://github.com/evcc-io/evcc/discussions) forum, with developers and users standing by to help solve common issues. +First check the [Community Forum](https://github.com/evcc-io/evcc/discussions) to see if your problem has already been discussed. +Developers and users are standing by to help solve common issues. -When making a post, it would be super useful to give as much information as possible on the following: +The easiest way to get help is using the **Report a problem** function in the evcc web interface. +Click on the menu (top right) and select **Need Help?** → **Report a problem**. +This shows details about your configuration, database, logs and application state. +From there you can directly create a [GitHub Discussions](https://github.com/evcc-io/evcc/discussions) post or a [GitHub Issue](https://github.com/evcc-io/evcc/issues). -- As precise an explanation as possible as to what your problem is -- Which devices (vehicles, meters, chargers) are in use? -- Your full, sanitised `evcc.yaml` +When creating your own post, please provide detailed information: -
- - Helper command (*please make sure all usernames, passwords, and other secrets are removed!*). - +- Description of the problem with reproducible steps. +- Which devices (vehicles, meters, chargers) are in use. -`egrep -v '^#|^\s+#' evcc.yaml |grep . |sed -E 's/(password|user|token|url|host|broker|accessToken|refreshToken|vin).*/\1: *****/'` +A good problem description leads to faster and better help. -
- -- Alternatively, you can use `evcc dump --cfg >~/config.txt` to create an anonymized configuration file at `~/config.txt`. - -**⛑️ First Aid** +### Finding syntax errors in evcc.yaml -We've added a useful helper utility to evcc to help with the above. -By entering `evcc discuss` in your terminal, our helper wizard will help you create a new discussion topic in our "Erste Hilfe" (first aid) section. -This discussion will automatically include any relevant error messages, and the anonymized configuration file - you only need to supply a meaningful title and a description of your problem. +Yaml is very sensitive to syntax - and errors don't always catch the eye straight away. -This First Aid utility can only be use for the initial creation of a discussion thread. -If you need to supply further information to a topic already in progress, you'll need to do this manually. +Linters such as (https://onlineyamltools.com/validate-yaml) can be super useful, and are worth checking to find simple mistakes. ### How do I create a log file for error analysis? -In its standard configuration, evcc only issues log messages if an _error_ occurs (see also the [`log`](/docs/reference/configuration/log#log) configuration key). - -When evcc is started directly from the console, log messages are printed directly to the screen (`STDOUT`). +The easiest way is to view and download the **log in the WebUI**. +Click on "Logs" in the web menu (top right). +There you can also filter by different levels and areas. -You can test out different parts of your installation using `evcc charger`, `evcc meter`, and `evcc vehicle`. Note that the log level defined in your `evcc.yaml` is used with these commands, but you can override it if necessary: +The log includes the last 10k lines. -Example: `evcc -l debug meter` +**Advanced log options:** -If evcc is started as a Linux system service (as per [Linux Autostart](/docs/installation/linux#systemd)), you should be able to find your logs using the following commands: +If evcc is running as a Linux system service, you can access logs using the following commands: - Follow the log in real time - `sudo journalctl -fau evcc` @@ -128,20 +164,12 @@ If evcc is started as a Linux system service (as per [Linux Autostart](/docs/ins - `sudo journalctl -u evcc -q` - Save the above log to a file in the home directory - `sudo journalctl -u evcc -q > ~/evcc.log` -- You can also define a Start (`-s`) and End (`-e`) timestamp: +- You can also define a Start (`-S`) and End (`-U`) timestamp: - `sudo journalctl -u evcc -S "2023-03-21 07:00:00" -U "2023-03-21 08:00:00" -q > ~/evcc.log` -You might find more useful commands here: [wiki.archlinux.org/title/Systemd/Journal](https://wiki.archlinux.org/title/Systemd/Journal#Filtering_output) - -If you're using Docker, you should be able to use `docker logs`. See the [Docker documentation](https://docs.docker.com/config/containers/logging/) for more details. - -:::tip - -In addition to the console output, there is also the option to view and download the ongoing log in the WebUI. To do this, select the "Logs" menu item in the web menu (top right). There you can also filter by different levels and areas. +More useful commands here: [wiki.archlinux.org/title/Systemd/Journal](https://wiki.archlinux.org/title/Systemd/Journal#Filtering_output) -However, this log only includes the last 10k lines. - -::: +If you're using Docker, you can use `docker logs`. See the [Docker documentation](https://docs.docker.com/config/containers/logging/) for more details. ### More thoughts on device detection @@ -189,11 +217,10 @@ You can use a program such as `htop` to help you diagnose whether another instan If you do have a reason to use evcc at the terminal, make sure to stop the service (for example, with `systemctl stop evcc`) beforehand. -### The evcc UI isn't accessible, but I can access it when in Demo Mode. +### The evcc UI isn't accessible -It's not uncommon for errors to be overlooked in the configuration, saved, and then evcc restarted to have any changes take effect. When this happens, evcc will fail to launch, and the UI won't be accessible. - -To help diagnose the problem, run `evcc` directly from the terminal - this should hopefully give you a better idea of what's going on. +Check the log to find the cause of the error. +How to access the log is described in [Installation](/docs/installation) under your respective installation method. ### MQTT plugin shows `outdated` warning @@ -272,9 +299,7 @@ service evcc start ### How can I backup and restore my configuration? {#backup-restore} -In the evcc UI, go to **Settings** → **Enable Experimental** → **Backup & Restore**. - -You'll see the following options: +In the evcc web interface, go to **Configuration** → **Backup & Restore**. **Backup:** Downloads a copy of your database (evcc.db). @@ -297,7 +322,7 @@ You can delete individual areas of your database: :::warning Caution After resetting the configuration, you'll need to reconfigure all devices. -Your `evcc.yaml` file remains unchanged. +Your `evcc.yaml` (if present) remains unchanged. ::: Alternatively, you can delete individual caches via the command line: 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 f38fa66ec..7755d74c1 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx @@ -5,103 +5,68 @@ sidebar_position: 10 import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# Create evcc.yaml +# Configuration -This guide describes how to create a working `evcc.yaml` file. +After installing evcc, you can configure your devices and settings. +The recommended way is configuration through the web interface. +File-based configuration is also available for advanced users. -## With Assistant +## via Web Interface -Using the `evcc configure` command, you can create a configuration file through a terminal-based assistant. -You can configure your devices through an interactive question-and-answer dialog. - -### Prerequisites - -To use the assistant, evcc must be installed on your system. -You also need to be able to run the `evcc` command from the command line (terminal, shell, command prompt). -If evcc is running on a system where you don't have this access (e.g., Home Assistant, Docker), you unfortunately cannot use the assistant. - -:::note -`evcc configure` can also be started in a Docker container. -See the explanation in [Docker](./docker). +:::tip Recommended +The web interface is the easiest and fastest way to set up evcc. ::: -### Running the Assistant - -Start the configuration and follow the prompts in the terminal window: - -```sh -evcc configure -``` - -You should see output similar to the following: - -![evcc configure](./screenshots/configure.webp) - -After completing the configuration, an `evcc.yaml` file will be created in the current directory. - -:::note -With `--advanced` you can start the assistant in an advanced mode. -This will give you additional configuration options. -However, this is not necessary for your first configuration. - -```sh -evcc configure --advanced -``` - -::: - -Test if the configuration works: - -```sh -evcc -c evcc.yaml -``` - -Open a browser and enter the following URL: `http://localhost:7070`. -The evcc interface should now show your own devices. - -If everything works, you can move your `evcc.yaml` to the location required for your installation. +### Getting Started -### Troubleshooting +1. **Start evcc**: After [installation](../installation), start evcc according to the instructions for your system +2. **Open browser**: Go to `http://:7070` (e.g., `http://evcc.local:7070` or `http://192.168.1.50:7070`) +3. **Set administrator password**: On first start, you'll be prompted to set a password +4. **Setup**: Follow the instructions on the welcome page -If errors occur, you can get additional information using the following commands. +### Adding Devices -- Syntax check +In the configuration area, you can set up the following components: - ```sh - evcc -c evcc.yaml checkconfig - ``` +- **Charging & Heating** (required): Wallboxes and heat pumps – at least one device must be configured +- **Grid** (recommended): Grid connection meter and electricity tariffs – important for proper energy management +- **Solar & Battery** (optional): Solar systems and battery storage +- **Vehicles** (optional): Vehicle integrations for battery capacity and state of charge, enables smarter charging -- Meters (Grid, Solar, Battery) +### Integrations - ```sh - evcc -c evcc.yaml -l debug meter - ``` +Additionally, you can integrate various services and protocols: -- Vehicles +- **MQTT**: Data exchange with other systems on the network +- **Messaging**: Push notifications and email alerts +- **InfluxDB**: Data export for long-term analysis +- **EEBus**: Communication with other EEBus devices +- **OCPP Server**: Connection with OCPP-capable wallboxes +- **Circuits**: Circuit monitoring and control +- **Modbus Proxy**: Multiple access to Modbus devices +- **Sunny Home Manager**: Integration via SEMP protocol +- **HEMS**: External control and grid operator integration - ```sh - evcc -c evcc.yaml -l debug vehicle - ``` +### Backup & Restore {#backup} -- Wallboxes +The web interface offers integrated data backup functions: - ```sh - evcc -c evcc.yaml -l debug charger - ``` +- **Backup**: Download database for data backup +- **Restore**: Restore data from a backup file +- **Reset**: Delete configuration or charging history -Check the output of each command for plausibility. +## via Configuration File -You can also run `evcc configure` again and correct your entries. -Note that the assistant always creates a completely new configuration. -Targeted modification of an existing configuration is not possible. -Use manual configuration for this. +:::info Traditional Method +This method uses an `evcc.yaml` file and requires knowledge of command line and YAML files. Some new features are only configurable via the web interface. +::: -## Manual +### From Scratch -If the assistant is not available to you, you can create the `evcc.yaml` file manually. +You can also create the `evcc.yaml` file manually. Here you'll find a minimal template that you can use as a starting point. -### Creation +#### Creation Copy the content into a new `evcc.yaml` file. @@ -182,7 +147,7 @@ tariffs: You can start evcc with this file. Use the respective instructions for your system. -### Testing +#### Testing Restart evcc and open your browser at `http://:7070`. Check if the values are plausible. @@ -192,7 +157,7 @@ Often these are indentation or typing errors. The file is written in [YAML format](https://wikipedia.org/wiki/YAML). You can use the online tool [YAML Lint](https://www.yamllint.com/) to check if your file follows the correct format. -### Customizing +#### Customizing The file only contains demo devices (`demo-charger`, `demo-meter`, `demo-battery`, `offline`). These have fixed values. @@ -212,7 +177,7 @@ Make these changes step by step if possible. Restart evcc after each change and check the output in the browser. This way you'll quickly notice if you've made a mistake. -### Further Information +#### Further Information The [evcc.dist.yaml](https://github.com/evcc-io/evcc/blob/master/evcc.dist.yaml) in the main project contains a complete list of all possible configuration options. More detailed explanations of the options can be found under [Reference → evcc.yaml](../reference/configuration). @@ -222,4 +187,115 @@ This file contains JavaScript-based demo devices that simulate limited functiona 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. +See [CLI Reference](/docs/reference/cli/evcc) for more information. + +### With Assistant + +Using the `evcc configure` command, you can create a configuration file through a terminal-based assistant. +You can configure your devices through an interactive question-and-answer dialog. + +:::warning +The `evcc configure` assistant is deprecated and will be removed in an upcoming version. We recommend configuration through the web interface. +::: + +#### Prerequisites + +To use the assistant, evcc must be installed on your system. +You also need to be able to run the `evcc` command from the command line (terminal, shell, command prompt). + +#### Running the Assistant + +Start the configuration and follow the prompts in the terminal window: + +```sh +evcc configure +``` + +You should see output similar to the following: + +![evcc configure](./screenshots/configure.webp) + +After completing the configuration, an `evcc.yaml` file will be created in the current directory. + +:::note +With `--advanced` you can start the assistant in an advanced mode. +This will give you additional configuration options. +However, this is not necessary for your first configuration. + +```sh +evcc configure --advanced +``` + +::: + +### With Assistant via Docker + +You can also run the configuration assistant in a Docker container. +Handy if you don't want or can't run the evcc binary directly on your machine. + +#### Preparation + +Create an empty `evcc.yaml` file: + +```sh +touch evcc.yaml +``` + +#### Running the Assistant + +Run the configuration assistant directly in Docker: + +```sh +docker run -v $(pwd)/evcc.yaml:/app/evcc.yaml -it evcc/evcc:latest evcc configure +``` + +Follow the assistant's questions. +At the end, the configuration will be written to the created `evcc.yaml` file. + +## Testing + +Test if the configuration works: + +```sh +evcc -c evcc.yaml +``` + +Open a browser and enter the URL: `http://:7070` (e.g., `http://evcc.local:7070`). +The evcc interface should now show your own devices. + +If everything works, you can move your `evcc.yaml` to the location required for your installation. + +## Troubleshooting + +If errors occur, you can get additional information using the following commands. + +- Syntax check + + ```sh + evcc -c evcc.yaml checkconfig + ``` + +- Meters (Grid, Solar, Battery) + + ```sh + evcc -c evcc.yaml -l debug meter + ``` + +- Vehicles + + ```sh + evcc -c evcc.yaml -l debug vehicle + ``` + +- Wallboxes + + ```sh + evcc -c evcc.yaml -l debug charger + ``` + +Check the output of each command for plausibility. + +You can also run `evcc configure` again and correct your entries. +Note that the assistant always creates a completely new configuration. +Targeted modification of an existing configuration is not possible. +Use manual configuration for this. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx index cb081d908..68ce579aa 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx @@ -22,37 +22,24 @@ However, these are not covered here. ## Preparation -### Configuration File +### Configuration -You need an `evcc.yaml` configuration file for your components (meters, wallbox, vehicle, ...). -There are several ways to create this: +evcc can be configured in two ways: -1. **Assistant on another system:** Run `evcc configure` beforehand on a [Linux](./linux), [macOS](./macos) or [Windows](./windows) system. - Use the created `evcc.yaml` file for your Docker installation. +1. **Web interface** (recommended): Start the container without `evcc.yaml`. After starting, configure evcc directly in the browser. The configuration is automatically saved in the database. -2. **Manual:** Create the `evcc.yaml` manually. - You can find instructions under [Configuration](./configuration). - -3. **Assistant in Docker:** - Handy if you have Docker installed on a Linux system. - Create an empty `evcc.yaml` file and run the configuration assistant directly in Docker. - Follow the assistant's questions. - At the end, the configuration will be written to the created `evcc.yaml` file. - - ```sh - touch evcc.yaml - docker run -v $(pwd)/evcc.yaml:/app/evcc.yaml -it evcc/evcc:latest evcc configure - ``` +2. **Configuration file** (traditional method): Create an `evcc.yaml` file with your settings. Instructions can be found under [Configuration](./configuration). ### Volumes -The evcc Docker container needs two volumes: +The evcc Docker container needs at least one volume: -- `/etc/evcc.yaml` for the configuration file -- `/root/.evcc/` directory for the internal SQLite database. The database is automatically stored in this directory. +- `/root/.evcc/` directory for the internal SQLite database (required). The database is automatically stored in this directory. +- `/etc/evcc.yaml` for the configuration file (optional - only for file-based configuration) -Create these directories on your host system. -In this guide we use the paths `/home/user/.evcc/` and `/home/user/evcc.yaml` as examples. +Create the database directory on your host system. +In this guide we use the path `/home/user/.evcc/` as an example. +If you're using file-based configuration, also use `/home/user/evcc.yaml` ## Installation @@ -71,22 +58,22 @@ Here are the relevant details you need to enter: #### Volume Mounts {#volumes} -| Host Path | Container Path | Description | -| ---------------------- | ---------------- | ------------------------------- | -| `/home/user/evcc.yaml` | `/etc/evcc.yaml` | Configuration file | -| `/home/user/.evcc/` | `/root/.evcc` | Directory for internal database | +| Host Path | Container Path | Description | Required | +| ---------------------- | ---------------- | ------------------------------------------------------ | -------- | +| `/home/user/evcc.yaml` | `/etc/evcc.yaml` | Configuration file (only for file-based configuration) | no | +| `/home/user/.evcc/` | `/root/.evcc` | Directory for internal database | yes | #### Ports {#ports} -| Host Port | Container Port | Description | Optional | +| Host Port | Container Port | Description | Required | | --------- | -------------- | ---------------------- | -------- | -| 7070 | 7070/tcp | Web UI, API | | -| 8887 | 8887/tcp | OCPP Server | Yes | -| 9522 | 9522/udp | SMA Sunny Home Manager | Yes | -| 7090 | 7090/udp | KEBA Chargers | Yes | -| 5353 | 5353/udp | mDNS | Yes | -| 4712 | 4712/tcp | EEBus | Yes | -| 8899 | 8899/udp | Modbus UDP | Yes | +| 7070 | 7070/tcp | Web UI, API | Yes | +| 8887 | 8887/tcp | OCPP Server | No | +| 9522 | 9522/udp | SMA Sunny Home Manager | No | +| 7090 | 7090/udp | KEBA Chargers | No | +| 5353 | 5353/udp | mDNS | No | +| 4712 | 4712/tcp | EEBus | No | +| 8899 | 8899/udp | Modbus UDP | No | Open your system's Docker UI and create a new container with the above settings and start it. @@ -106,7 +93,7 @@ If after an update your charging sessions are no longer displayed, the `/root/.e ### via Docker CLI -Install and start the Docker container that matches your component configuration using one of the following commands. +Install and start the Docker container using one of the following commands. Whether you need `sudo` depends on your system. @@ -114,7 +101,7 @@ Whether you need `sudo` depends on your system. ```sh sudo docker run -d --name evcc \ --v /home/user/evcc.yaml:/etc/evcc.yaml \ +-v /home/user/evcc.yaml:/etc/evcc.yaml \ # optional -v /home/user/.evcc:/root/.evcc \ -p 7070:7070 \ -p 8887:8887 \ @@ -163,7 +150,7 @@ Simply create a configuration file named `compose.yml` in your active directory. Copy one of the following configurations matching your component setup into `compose.yml` and save it: - + ```yaml services: @@ -176,8 +163,8 @@ services: - 7070:7070/tcp - 8887:8887/tcp volumes: - - /home/user/evcc.yaml:/etc/evcc.yaml - /home/user/.evcc:/root/.evcc + - /home/user/evcc.yaml:/etc/evcc.yaml # optional restart: unless-stopped # optional: #user: : @@ -244,10 +231,18 @@ sudo docker-compose up -d After successfully creating and starting your container, you can access the evcc Web UI at `http://:7070`. `` is the IP address or hostname of the computer running the container. -You should see the evcc interface and be prompted to set an administration password. +**On first use:** + +- You will be prompted to set an administration password +- You can then configure your devices via the web interface (for UI configuration) +- Or see your configured devices directly (for file-based configuration) If you cannot establish a connection, check your container logs. -If you see the interface but an error message is displayed, check the configuration in the `evcc.yaml` file. +If you see the interface but an error message is displayed, check: + +- For file-based configuration: the settings in your `evcc.yaml` file +- For UI configuration: the device settings on the configuration page + You can find more details in [Configuration](./configuration) or in the [GitHub Discussions](https://github.com/evcc-io/evcc/discussions). ## Community Guides 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 9e3ff7b95..a6491e0a1 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 @@ -75,36 +75,55 @@ See [Home Assistant Documentation](https://www.home-assistant.io/installation/#a -## Configuration File +## Configuration -Go to Information menu in the "evcc" Addon and activate "show in sidebar" (evcc UI http://your-ha-instance-ip-address:7070) +evcc can be configured in two ways: -Go to Configuration menu and select your working directory (example): +### Web Interface (recommended) + +Go to the **Information** tab in the **evcc** addon and activate **Show in sidebar** (evcc UI http://your-ha-instance-ip-address:7070) + +Go to the **Configuration** tab and select your working directory (example): ![Image](screenshots/ha_configuration_ui.webp) ```sh -- config_file: /config/evcc.yaml - sqlite_file: /data/evcc.db ``` Leave the Network section unchanged. -Create an empty evcc configuration file `evcc.yaml` in your Addon root configuration folder (`/addon_configs/49686a9f_evcc`). +Start the addon. +Then open the evcc interface via the sidebar: + +- You'll be prompted to set an administrator password +- You can then configure your devices directly via the web interface +- Settings are automatically saved in the database + +### Configuration File (traditional) + +Alternatively, you can use an `evcc.yaml` configuration file. + +Go to the **Configuration** tab and add the configuration file to your working directory: + +```sh +- config_file: /config/evcc.yaml +- sqlite_file: /data/evcc.db +``` + +Create an evcc configuration file `evcc.yaml` in your addon root configuration folder (`/addon_configs/49686a9f_evcc`). If this folder does not exist, create it manually. -To create or edit the configuration file, you have many options, here are a few: +To create or edit the configuration file, you have several options: -- [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 +- [Visual Studio Code](https://github.com/hassio-addons/addon-vscode): 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`. +See [Configuration](./configuration) for details on creating the configuration 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. +See [CLI Reference](/docs/reference/cli/evcc) for more information. ## Updates diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/index.md b/i18n/en/docusaurus-plugin-content-docs/current/installation/index.md index d3066da65..2c9667676 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/index.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/index.md @@ -54,4 +54,4 @@ If you want to learn more about how wallboxes and EV charging work, first check /> -After installation: [Create evcc.yaml](./installation/configuration) +After installation: [Configure evcc](./installation/configuration) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/linux-image.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/linux-image.mdx index f0791b421..aba1fffcc 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/linux-image.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/linux-image.mdx @@ -5,14 +5,7 @@ sidebar_position: 3 # Raspberry Pi & Co. The easiest way to install evcc on a Raspberry Pi or similar single-board computers. -Pre-configured and ready to go! - -:::warning Experimental -With the evcc Linux images, you can set up evcc completely via the web UI. -Usually, you don't need an `evcc.yaml` or console commands. -However, the UI setup is still marked as experimental. -In case of problems or for debugging, console commands may still be required. -::: +Pre-configured and ready to set up via the web UI! ## Quick Start @@ -58,8 +51,9 @@ The evcc image can be found under - Alternatively via IP address, e.g., `https://192.168.1.123/` (determine IP in router) - Set administrator password (on first start) - Set up devices (wallbox, solar system, home battery, vehicles) - - activate "experimental" - - Note: At least one loadpoint must be created for evcc to run + - Note: At least one loadpoint must be created for evcc to run. + +More details on setup can be found in the [configuration guide](./configuration). ![evcc Welcome](screenshots/evcc-welcome.webp) @@ -118,6 +112,7 @@ Even 1 GB RAM is completely sufficient. **Supported Devices:** - Raspberry Pi 3, 4, and 5 - all models work equally well +- Raspberry Pi Zero 2 W - works well - NanoPi R3S - compact, affordable, and comes with case and integrated eMMC storage **Storage:** @@ -150,6 +145,9 @@ You can connect via SSH with the `admin` user (same credentials as [Cockpit](#co - Encrypted: https://evcc.local/ (recommended) - Unencrypted: http://evcc.local:7070/ (if certificate warning bothers you) +**OCPP Server:** +The OCPP server runs on `ws://evcc.local:8887/` for connection with OCPP-capable wallboxes. + More technical details can be found in the [GitHub Repository](https://github.com/evcc-io/images). ## Next Steps 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 93e79c24c..7592e8508 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/linux.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/linux.mdx @@ -17,7 +17,7 @@ For Raspberry Pi, we recommend the easier installation with [evcc Linux Image](. For other Linux distributions, see the [Docker](./docker) guide or [Manual Installation](#manual) section. ::: -## Installation +## First Installation - Open a terminal - Install required dependencies: @@ -72,13 +72,9 @@ 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`. The evcc application will ask you to set a password and start the configuration. - -- Stop the server: - - ```sh - sudo systemctl stop evcc - ``` +- Open the evcc web interface in your browser: [http://localhost:7070](http://localhost:7070) +- The evcc interface will prompt you to set an administrator password +- You can then configure your devices directly via the web interface :::note During installation, a user `evcc` is created, so ensure the logged-in user does not have the name `evcc`. @@ -92,50 +88,35 @@ The `plugdev` group is used to grant access to plug-in devices (like USB, serial ## Configuration -A **working** evcc configuration is required. -The configuration contains general settings and definitions for individual components (meters, wallboxes, vehicles, ...). - -### Create +evcc can be configured via the web interface or a configuration file. -We recommend using the configuration wizard: - -- Start the configuration wizard and answer the questions: - -```sh -sudo evcc configure -``` - -- Move the created configuration file to `/etc/evcc.yaml`: - -```sh -sudo mv evcc.yaml /etc -``` - -- Restart the evcc server: +:::tip Recommended +Configuration via the web interface is the easiest way to set up evcc. +::: -```sh -sudo systemctl restart evcc -``` +### Web Interface (recommended) -- Access the evcc interface at [http://localhost:7070](http://localhost:7070) +After first start, you can configure evcc directly in the browser at [http://localhost:7070](http://localhost:7070). +The settings are automatically saved in the database. -### Modify +### Configuration File (traditional) -If your configuration needs adjustments, you can either rerun the configuration wizard (see above) or manually edit the configuration file. +Alternatively, you can use an `evcc.yaml` configuration file. +See [Configuration](./configuration) for details on creating the configuration file. -- Edit the configuration file: +:::important +The configuration file must be placed at `/etc/evcc.yaml`. +::: -```sh -sudo nano /etc/evcc.yaml -``` +- Create the configuration file according to the [guide](./configuration) and save it at `/etc/evcc.yaml` - Restart the evcc server: -```sh -sudo systemctl restart evcc -``` + ```sh + sudo systemctl restart evcc + ``` -For more information and examples on configuring evcc, see [Configuration](./configuration). +- Access the evcc interface at [http://localhost:7070](http://localhost:7070) ## Upgrades @@ -156,7 +137,8 @@ To update to the latest version of evcc, follow this guide: ``` :::info -If the unstable repository (nightly versions) has been added, the update will always be updated to the latest available nightly version. If this is no longer desired, the unstable repository can be removed using `sudo rm /etc/apt/sources.list.d/evcc-unstable.list`. +If the unstable repository (nightly versions) has been added, updates will always install the latest available nightly version. +If this is no longer desired, the unstable repository can be removed using `sudo rm /etc/apt/sources.list.d/evcc-unstable.list`. ::: ## Downgrade @@ -220,9 +202,16 @@ Open a browser and enter the following URL: `http://127.0.0.1:7070`. Replace `127.0.0.1` with the IP address or hostname of the computer if the browser is not opened on the same computer. ::: -## Backup and Restore +## Backup and Restore {#backup} + +### Via Web Interface (recommended) + +The easiest method is to backup via the web interface. +See [Configuration → Backup & Restore](./configuration#backup) for details. + +### Manual Backup -To restore the "original state" after a reinstallation, it is sufficient to back up the configuration file `evcc.yaml` and the database file `evcc.db`. +To restore the "original state" after a reinstallation, it is sufficient to back up the configuration file `evcc.yaml` (if used) and the database file `evcc.db`. The storage location is specified in the log file at program start. Typically, the configuration is located under `/etc/evcc.yaml` and the database under `/var/lib/evcc/evcc.db`. @@ -234,6 +223,34 @@ Copy yaml: `sudo cp /etc/evcc.yaml /home/pi/evcc.yaml.bak` Copy db: `sudo cp /var/lib/evcc/evcc.db /home/pi/evcc.db.bak` +## Environment Variables & CLI Options {#environment} + +When installed via APT, evcc runs as a systemd service. +You can customize the behavior using an override file: + +```sh +sudo systemctl edit evcc +``` + +### Example + +```ini title="/etc/systemd/system/evcc.service.d/override.conf" +[Service] +Environment="EVCC_LOG=debug,tariff:trace" +ExecStart= +ExecStart=/usr/bin/evcc --custom-css /path/to/my.css +``` + +:::note +The first empty `ExecStart=` line is important to override the default command. +::: + +:::tip +All parameters from `evcc.yaml` can be set as environment variables: `EVCC_` + parameter name in uppercase. + +For a complete list of all CLI options, see the [CLI documentation](/docs/reference/cli/evcc). +::: + ## Manual Installation {#manual} In addition to the Debian/Ubuntu APT package, we also provide other binaries for Linux. @@ -256,13 +273,17 @@ In addition to the Debian/Ubuntu APT package, we also provide other binaries for ### Configuration -Create a working `evcc.yaml` configuration file following the [Configuration](./configuration) guide. -You can start it with this command: +You can configure evcc via the web interface or a configuration file. +See [Configuration](./configuration) for details. + +Start evcc with: ```sh -./evcc -c evcc.yaml +./evcc ``` +Then open your browser at [http://localhost:7070](http://localhost:7070) and follow the instructions. + ### Upgrade/Downgrade Follow the steps above and replace the evcc program file with the new or previous version. @@ -276,3 +297,52 @@ This ensures evcc starts when the computer boots and automatically restarts in c :::note This documentation assumes Linux supports `systemd`. ::: + +- Run the following command to create and open an editor with a new file for the service: + + ```sh + sudo nano /etc/systemd/system/evcc.service + ``` + +- Copy the following content into the file: + + ``` + [Unit] + Description=evcc + Requires=network-online.target + After=syslog.target network.target network-online.target + Wants=network-online.target + StartLimitIntervalSec=10 + StartLimitBurst=10 + + [Service] + ExecStart=/usr/local/bin/evcc + Restart=always + RestartSec=5 + + [Install] + WantedBy=multi-user.target + ``` + + Adjust the path of the `evcc` file in `ExecStart` if the file is located in a different directory. + This also assumes that the configuration file `evcc.yaml` can be found at `/etc/evcc.yaml`. + If this is not the case, add the text `-c /yourpath/evcc.yaml` at the end of `ExecStart`. + Replace `yourpath` with the appropriate directory. + +- Test the service: + + ```sh + sudo systemctl daemon-reload + sudo systemctl start evcc + sudo systemctl status evcc + ``` + + On success, the output should contain: `Active: active (running)`. + +- Configure the service to start automatically at system boot: + + ```sh + sudo systemctl enable evcc.service + ``` + +For more information, see the [System Service](#systemd) section above. 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 07157d8fe..555d5be06 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/macos.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/macos.md @@ -38,59 +38,21 @@ 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). The evcc application will ask you to set a password and start the configuration. -- Stop the evcc server: - - ```sh - brew services stop evcc - ``` +- Open the evcc interface in your browser: [http://localhost:7070](http://localhost:7070) +- The evcc application will ask you to set an administrator password +- You can then configure your devices directly via the web interface ## Configuration -Now you need a working `evcc.yaml` configuration file. -In addition to general settings, the configuration includes the definition of individual components (meter, wallbox, vehicle, ...). - -### Create - -We recommend using the configuration wizard: - -- Start the configuration wizard and answer the questions: - - ```sh - sudo evcc configure - ``` - -- Move the created configuration file to `/etc/evcc.yaml`: - - ```sh - sudo mv evcc.yaml /etc - ``` - -- Start the evcc server: - - ```sh - brew services start evcc - ``` - -- Access the evcc interface at [http://localhost:7070](http://localhost:7070) - -### Modify - -If your configuration needs adjustments, you can either rerun the configuration wizard (see above) or manually edit the configuration file. - -- Edit the configuration file: - - ```sh - sudo nano /etc/evcc.yaml - ``` +:::tip Recommended +Configure evcc directly in your browser. +::: -- Restart the evcc server: +After the first start, you can configure evcc at [http://localhost:7070](http://localhost:7070). +Settings are automatically saved in the database. - ```sh - brew services restart evcc - ``` - -For more information and examples on configuring evcc, see [Configuration](./configuration). +Alternatively, you can use an `evcc.yaml` configuration file at `/etc/evcc.yaml`. +Details can be found in [Configuration](./configuration). ## Upgrades @@ -142,8 +104,9 @@ Here you'll find instructions for manually installing evcc on macOS. ### Configuration -Create a working `evcc.yaml` configuration file following the instructions under [Configuration](./configuration). -You can start it with the following command: +After the first start, open [http://localhost:7070](http://localhost:7070) in your browser and configure evcc via the web interface. + +Alternatively, you can create an `evcc.yaml` configuration file (see [Configuration](./configuration)) and start evcc with it: ```sh ./evcc -c evcc.yaml diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/windows.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/windows.mdx index 13e46e4a8..f91953277 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/windows.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/windows.mdx @@ -20,7 +20,7 @@ However, evcc is typically used in a Linux environment (e.g., Raspberry Pi). - Extract the downloaded file (e.g., by double-clicking) - You'll now have a new folder containing the `evcc` program - Open Command Prompt and navigate to the folder containing the `evcc` program -- Start evcc with the following command: +- Test the installation with the following command: ```sh evcc -v ``` @@ -28,8 +28,28 @@ However, evcc is typically used in a Linux environment (e.g., Raspberry Pi). ## Configuration -Create a working `evcc.yaml` configuration file following the instructions under [Create evcc.yaml](./configuration). -You can start it with the following command: +evcc can be configured in two ways: + +### Web Interface (recommended) + +Start evcc without any additional parameters: + +```sh +./evcc +``` + +Then open your browser at [http://localhost:7070](http://localhost:7070): + +- You'll be prompted to set an administrator password +- You can then configure your devices directly via the web interface +- Settings are automatically saved in the database + +### Configuration File (traditional) + +Alternatively, you can use an `evcc.yaml` configuration file. +See [Configuration](./configuration) for details on creating the configuration file. + +Start evcc with: ```sh ./evcc -c evcc.yaml @@ -53,7 +73,8 @@ These instructions were created using Windows 10. ![Windows 10 Task Scheduler](win10-srv/win10-srv-1.png) - Once you've started Task Scheduler, you now need to choose whether to create the new service in your own folder, or in the general tasks folder. - In this example, we create the `evcc` folder. To do this, select "New Folder..." from the right hand pane. + In this example, we create the `evcc` folder. + To do this, select "New Folder..." from the right hand pane. ![Task Scheduling Library](win10-srv/win10-srv-2.png) @@ -61,7 +82,9 @@ These instructions were created using Windows 10. ![New Task window](win10-srv/win10-srv-3.png) -- Give the task a name (probably "evcc") and a short description. Since we need to run as a system service, open user management via "Change User or Group", and enter "SYSTEM" in the box. Once you click "Check Names", the word "SYSTEM" should be underscored - you can now click OK to close this dialog. +- Give the task a name (probably "evcc") and a short description. + Since we need to run as a system service, open user management via "Change User or Group", and enter "SYSTEM" in the box. + Once you click "Check Names", the word "SYSTEM" should be underscored - you can now click OK to close this dialog. ![Task Window](win10-srv/win10-srv-4.png) ![User Selection](win10-srv/win10-srv-5.png) @@ -71,7 +94,8 @@ These instructions were created using Windows 10. ![Trigger](win10-srv/win10-srv-6.png) - Open the "actions" menu, and again, select "New". -- Make sure "Start a Program" is selected, then find your `evcc.exe` executable using the Browse option. We advise also setting the path in the "Start In..." box, to make sure that the configuration file is easily found by evcc. +- Make sure "Start a Program" is selected, then find your `evcc.exe` executable using the Browse option. + We advise also setting the path in the "Start In..." box, to make sure that the configuration file is easily found by evcc. ![Actions](win10-srv/win10-srv-7.png) @@ -91,4 +115,5 @@ These instructions were created using Windows 10. - You're done! 🎉 -The task can now be started manually, or test with a reboot. To check it's working as expected, use a browser to navigate to the evcc interface `http://[ipaddress]:7070`. +The task can now be started manually, or test with a reboot. +To check it's working as expected, use a browser to navigate to the evcc interface `http://[ipaddress]:7070`. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/index.md b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/index.md index 80b943337..ed5a00f12 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/index.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/index.md @@ -2,30 +2,39 @@ sidebar_position: 1 --- -# evcc.yaml +# Configuration -evcc requires a configuration file to describe the system and cannot be used -without it. The file itself is written in -[YAML](https://en.wikipedia.org/wiki/YAML), which is a structured, -human-readable, plain text format. +evcc can be configured in two ways: -To create or edit the configuration file, we recommend using a text editor that -understands YAML and thus helps with the formatting and shows any errors, e.g. -instance, [VS Code](https://code.visualstudio.com) with the -[YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml). +**1. UI Configuration (recommended)** -The configuration file is called by default `evcc.yaml` and is either in the -same directory as evcc itself, or on POSIX (e.g. Linux) systems in -`/etc/evcc.yaml`. +Configuration is done via the web interface under **Configuration**. +Settings are saved automatically in the database. +For more information, see [Configuration](/docs/installation/configuration). -For non-standard paths, the filename can be passed as a command line argument, -e.g. `evcc -c /home/evcc.yaml` +**2. File-based Configuration** + +Configuration via the `evcc.yaml` file remains supported. +This section documents the YAML-based configuration. + +:::info Parallel Usage +Both configuration methods can be used in parallel. +Devices (loadpoints, meters, PV systems, batteries, vehicles) are merged from both sources. +For other settings, UI configuration takes priority. +Details can be found in the [FAQ](/docs/faq#ui-migration). +::: + +## File-based Configuration (evcc.yaml) + +The configuration file is written in YAML format and is called `evcc.yaml` by default. +It is located either in the same directory as evcc itself, or on POSIX (e.g. Linux) systems in `/etc/evcc.yaml`. + +Non-standard paths can be specified at startup: `evcc -c /path/to/evcc.yaml` ### Structure -evcc's configuration file contains multiple sections. In order to refer to -elements in a different section, each device has a `name` parameter, which is a -free text field and is used for identification. +The configuration file contains multiple sections. +To reference between sections, devices have a `name` parameter for identification. An example file with many parameters can be found here: https://github.com/evcc-io/evcc/blob/master/evcc.dist.yaml diff --git a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/sponsortoken.md b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/sponsortoken.md index 07e640f6e..e315c1da3 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/sponsortoken.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/sponsortoken.md @@ -6,6 +6,10 @@ sidebar_position: 16 `sponsortoken` defines a token that is provided on [https://sponsor.evcc.io](https://sponsor.evcc.io). +:::tip +We recommend entering the sponsor token via the web interface under **Configuration**. +::: + **For example**: ```yaml diff --git a/i18n/en/docusaurus-plugin-content-docs/current/sponsorship.mdx b/i18n/en/docusaurus-plugin-content-docs/current/sponsorship.mdx index fc3f5292e..e71fefb5e 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/sponsorship.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/sponsorship.mdx @@ -80,13 +80,13 @@ Your customers will then each need to create a sponsor token. Alternatively, we can also issue you several sponsor tokens at once and send you an invoice with the corresponding VAT. [Write us an email](mailto:info@evcc.io) with your requirements and we'll get back to you. -#### How do I enter my token? +#### Where do I enter my token? -The sponsor token is entered in the `evcc.yaml`. -Add a new line with `sponsortoken: `. +Enter the sponsor token via the web interface under **Configuration** → **Sponsorship**. +After entering the token, a restart of evcc is required. -It is also possible to set the token via the UI on the configuration page. -Note: This entry is stored in the `evcc.db` and takes precedence over the `evcc.yaml`. +**Note:** If a token is already present in `evcc.yaml`, the UI input is locked. +Remove the entry from `evcc.yaml` to manage the token via the web interface. #### Can I use my token on multiple installations? @@ -114,10 +114,13 @@ We update the test token regularly. There could be several reasons: - **Monthly sponsoring expired:** Check your sponsor status at GitHub and [sponsor.evcc.io](https://sponsor.evcc.io). -- **Formatting error:** Check if the token is correctly entered in the `evcc.yaml`. -- **Experimental Config UI:** You have activated the experimental sponsor token feature in Config UI. - In this case the token in your `evcc.yaml` is ignored and only the new database-entry is used. - With [`evcc migrate --reset`](/docs/reference/cli/evcc_migrate) or the deletion of the `evcc.db` you can get back to the old behavior. +- **Formatting error:** Check if you have correctly entered the token in `evcc.yaml`. +- **Duplicate configuration:** If you entered the token both in the web interface and in `evcc.yaml`, only the token from `evcc.yaml` is used. + Remove the entry from the file if you want to manage the token via the web interface. +- **Token expired:** The token itself has an expiration date. + If this has passed, you can issue a new one at [sponsor.evcc.io](https://sponsor.evcc.io) and replace the current one. + You will receive a warning in the web interface in good time when this is necessary. + Note: We will automate this process in the future. If the above does not help, [contact us](mailto:info@evcc.io) and we'll check it out.