diff --git a/docs/installation/configuration.mdx b/docs/installation/configuration.mdx new file mode 100644 index 000000000..e6c69e715 --- /dev/null +++ b/docs/installation/configuration.mdx @@ -0,0 +1,208 @@ +--- +sidebar_position: 10 +--- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Konfiguration + +:::note +Diese Konfigurations-Anleitung beschreibt beide möglichen Wege eine funktionierende Konfigurationsdatei zu erstellen, mit oder ohne Konfigurationsassistenten. +Wobei ersteres nur bei nicht Docker basierten Systemen möglich ist. +::: + + +## Konfiguration mit Assistenten + +Dieser Teil der Anleitung richtet sich an Benutzer, die evcc als als Linux/Mac oder Windows Installation nutzen. + +- Starte die Konfiguration und folge den Anweisungen im Terminal Fenster: + + ```sh + evcc configure + ``` + + Sofern alle Geräte korrekt konfiguriert sind, kannst du mit den nächsten Schritten fortfahren. + + :::note + Fortgeschrittene Anwender (z.B. mit evcc Erfahrung oder technischem Know-How) können auch alternativ folgenden Aufruf verwenden: + + ```sh + evcc configure --advanced + ``` + + Dieser Modus bietet weitere (technisch fortgeschrittene) Einstellmöglichkeiten. + ::: + +- Teste, ob die Konfiguration funktioniert + + ```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. + +- Wenn alles funktioniert, beende evcc durch drücken der Tastenkombination `CTRL-C`. + +- Verschiebe die erstellte Konfigurationsdatei in den Zielordner: + + ```sh + sudo mv evcc.yaml /etc + ``` + +- Starte den evcc-Server: + + ```sh title="Linux" + sudo systemctl start evcc + ``` + + ```sh title="MacOS" + brew services start evcc + ``` + + Andere mögliche Befehle sind ... restart evcc und ... stop evcc. + + + +- Gehe zurück zum Browser und lade die evcc Seite neu. Die Oberfläche sollte nun mit deinen konfigurierten Geräten zu sehen sein. + + + +## Konfiguration ohne Assistenten + +:::note +Dieser Teil der Anleitung richtet sich an Benutzer, die evcc als Home Assistant Addon oder als Docker Container verwenden und deshalb +den Konfigurationsassistenten nicht verwenden können. +Die Anleitung enthält aber eventuell nützliche Tipps, für Personen die ihre Konfiguration, nach der Verwendung des Konfigurationsassistenten noch anpassen müssen. +::: + +Es wird im folgenden davon ausgegangen dass du eine leere Konfigurationsdatei _evcc.yaml_ im korrekten Verzeichnis erstellt hast. +Die Anleitung findest du in der jeweiligen Installationsanleitung für Docker oder Home Assistant. + +```sh +- config_file Docker: `/etc/evcc.yaml` +- config_file Home Assistant: `/config/evcc.yaml` +``` + +Kopiere den Inhalt der folgenden minimalen Template Vorlage in deine soeben erstellte Datei _evcc.yaml_. +Die Vorlage erstellt eine Standardkonfiguration mit statischen Demo-Entitäten. + +```yaml title="evcc.yaml Mini Template" +## Configuration template with demo entities (meters, chargers) ## + +# log settings +log: info +levels: + site: debug + lp-1: debug + lp-2: debug + cache: error + db: error + +# meter definitions +# name can be freely chosen and is used as reference when assigning meters to site and loadpoints +# for documentation see https://docs.evcc.io/docs/devices/meters +meters: + # replace with your real grid meter + - name: my_grid + type: template + template: demo-meter + usage: grid + power: -1000 # 1 kW feed-in + # replace with your real pv system + - name: my_pv + type: template + template: demo-meter + usage: pv + power: 4000 # 4 kW production + # replace with your real battery + - name: my_battery + type: template + template: demo-battery + usage: battery + power: -1000 # 1 kW battery charging + soc: 50 # 50 % state of charge + +# replace with your real charger +# see https://docs.evcc.io/docs/devices/chargers +chargers: + - name: my_charger + type: template + template: demo-charger + status: C # charging + power: 2000 # 2 kW charging power + enabled: true # optional + +# replace with your real vehicle (optional) +# see https://docs.evcc.io/docs/devices/vehicles +vehicles: + - name: my_car + type: template + template: offline + title: blue e-Golf + capacity: 50 # in kWh + +# assign your devices to the site +site: + title: Home # display name for UI + meters: + grid: my_grid + pv: + - my_pv + battery: + - my_battery + +# define your loadpoints according your needs +# see https://docs.evcc.io/en/docs/reference/configuration/loadpoints +loadpoints: + - title: Garage # display name for UI + charger: my_charger # charger + vehicle: my_car # default vehicle + +# enter your real grid tariff and feed-in price +# see https://docs.evcc.io/docs/devices/tariffs +tariffs: + currency: EUR + grid: + type: fixed + price: 0.29 # EUR/kWh + feedin: + type: fixed + price: 0.10 # EUR/kWh +``` + + +Wenn du stattdessen sehen willst, wie evcc in einer dynamischen Demo läuft, +kopiere den Inhalt von https://github.com/evcc-io/evcc/blob/master/cmd/demo.yaml in deine _evcc.yaml_ Datei. + + +- Jetzt kannst du loslegen und das Addon oder den Docker Container starten. +- Überprüfe die Installation, indem du das WebUI öffnest - du solltest nun das evcc-Webinterface in einem statischen Demo-Modus sehen. +- Wenn dies ok ist, kannst du die Datei _evcc.yaml_ bearbeiten und dein eigenes Setup erstellen (nur mit der statischen Vorlage möglich). +- Kopiere dazu die nötigen Templates die du in der Dokumenation im Abschnitt [Geräte, z.b. Wallboxen](../devices/chargers) findest. + +:::tip +Wenn du mit der manuellen Konfiguration nicht zurechtkommst, solltest du ein eigenständiges evcc Windows- oder Linux-System installieren + und den Konfigurationsassistenten verwenden. + +Der Konfigurationsassistent ist in der Home Assistant-Umgebung nicht verfügbar. + +Es ist einfacher, dort `evcc configure` zu verwenden und dann die erzeugte _evcc.yaml_ auf das gewünschte System zu kopieren. + +**Fortgeschrittene Benutzer** (mit evcc-Erfahrung und etwas technischem Know-how) sollten den erweiterten Konfigurator verwenden: +::: + +Die minimale Template Vorlage enthält nur die nötigsten Abschnitte der Konfiguration. + +Falls du nicht aufgeführte Strukturen oder Erklärungen benötigst, lohnt sich ein Blick in die vollausgebaute Vorlage unter diesem +Link https://github.com/evcc-io/evcc/blob/master/evcc.dist.yaml. + +- Teste jedes neu hinzugefügte Gerät, um sicherzustellen, dass deine neue Konfiguration funktioniert. +- Sobald alle Geräte konfiguriert sind, kannst du mit der Einrichtung über die Benutzeroberfläche fortfahren. + +:::tip +Für Nutzer von Home Assistant + +Fahre mit der Installation der evcc-Integration für Home Assistant fort, wie in diesem Abschnitt [Integrationen](../integrations/home-assistant) beschrieben. +::: + diff --git a/docs/installation/docker.mdx b/docs/installation/docker.mdx index 2fbd48fea..46d5c8df0 100644 --- a/docs/installation/docker.mdx +++ b/docs/installation/docker.mdx @@ -30,7 +30,13 @@ Diese Dokumentation ist für Docker und Synology. Bei Verwendung anderer Systeme ## Konfiguration -1. Es wird eine **funktionierende** evcc Konfiguration benötigt. Führe dazu die Schritte auf einem der folgende Systeme durch: +1. Es wird eine **funktionierende** evcc Konfiguration benötigt. Es gibt dabei zwei Möglichkeiten: + Entweder du folgst der [Anleitung](./configuration#konfiguration-ohne-assistenten) zur Erstellung einer manuellen Konfiguration oder du benutzt den + Konfigurationsassistenten und folgst dieser [Anleitung](./configuration#konfiguration-mit-assistenten). + + Für den Weg mit dem Konfigurationsassistenten benötigst du eine zweite Installation von evcc. + + Führe dazu die Schritte auf einem der folgende Systeme durch: - [Debian, Ubuntu, Raspberry Pi](linux) - [macOS](macos) diff --git a/docs/installation/home-assistant.mdx b/docs/installation/home-assistant.mdx new file mode 100644 index 000000000..d975d6264 --- /dev/null +++ b/docs/installation/home-assistant.mdx @@ -0,0 +1,57 @@ +--- +sidebar_position: 7 +--- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Screenshot from "../../src/components/Screenshot"; + +# Home Assistant Addon + +:::note +Das evcc Home Assistant Addon ist eine Community Integration und wird "noch" nicht offiziell von den evcc Maintainern unterstützt. +Der Grund dafür ist, dass im Fehlerfall wichtige Daten nicht einfach bereit gestellt werden können (fehlende evcc cli). +::: + +Diese Anleitung richtet sich an Benutzer, die Home Assistant verwenden und evcc als Addon verwenden möchten. Es ist selbstverständlich auch möglich, +evcc außerhalb von Home Assistant zu betreiben und auch in Home Assistant zu integrieren. Der Betrieb von evcc als Addon ist natürlich +der einfachere Weg, hat aber vorderhand den Nachteil, dass man den Konfiguration Assistenten nicht nutzen kann. + +Anmerkung: Das Addon benötigt sehr wenig Ressourcen. + +## Installations Anleitung + +1. Klicke auf -> Add-on Store unter Einstellungen - Addons. +2. Klicke auf -> drei Punkte -> Repositories. +3. Kopiere https://github.com/evcc-io/hassio-addon Klicke -> Hinzufügen +4. Lade die Website neu (CTRL+R oder CTRL+F5 oder CTRL+Fn+F5) +5. Suche das Add-on „evcc“ und klicke es an. +6. Klick auf die Schaltfläche „INSTALLIEREN“. + +### Konfigurationsdatei + +Gehe im „evcc“ Addon in das Menü Information und aktiviere „in der Seitenleiste anzeigen“ (evcc UI http://your-ha-instance-ip-address:7070) + +Gehe zum Menü „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. + +Erstelle eine evcc-Konfigurationsdatei _evcc.yaml_ in deinem Home Assistant-Stammkonfigurationsordner (/homeassistant). + +## Konfiguration + +Folge nun dieser Anleitung um die evcc-Konfigurationsdatei mit einem Template Inhalt zu befüllen [Konfiguration (manuell)](./configuration#konfiguration-ohne-assistenten) + +## Installation der evcc-Integration + +Wenn du dann deine Konfiguration abgeschlossen hast, kannst mit der Installation der EVCC-Integration für Home Assistant fortfahren, wie in diesem Abschnitt [Integrationen](../integrations/home-assistant) beschrieben. + +## Upgrades + +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 1735c98dd..896286d14 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -10,3 +10,6 @@ Die Erstinstallation von evcc erfordert aktuell noch etwas Fachwissen. Du sollte - [macOS](./installation/macos) - [Docker, Synology](./installation/docker) - [Manuelle Installation (inkl. Windows)](./installation/manual) +- [Home Assistant addon](./installation/home-assistant) +- [Proxmox](./installation/proxmox) +- [Konfiguration (manuell)](./installation/configuration) \ No newline at end of file diff --git a/docs/installation/linux.mdx b/docs/installation/linux.mdx index 8c6100aec..8a2c99edf 100644 --- a/docs/installation/linux.mdx +++ b/docs/installation/linux.mdx @@ -74,52 +74,6 @@ Cloudsmith ist ein Service, welcher die Entwicklung von Software und Dienstleist sudo systemctl stop evcc ``` -- Starte die Konfiguration und folge den Anweisungen im Terminal Fenster: - - ```sh - evcc configure - ``` - - Sofern alle Geräte korrekt konfiguriert sind, kannst du mit den nächsten Schritten fortfahren. - - :::tip - Unter Homeassist ist `configure` nicht möglich. Hier bietet es sich an, evcc auf Windows/Mac zu installieren, dort `evcc configure` auszuführen und die so erstellte evcc.yaml zu kopieren. - ::: - - :::note - Fortgeschrittene Anwender (z.B. mit evcc Erfahrung oder technischem Know-How) können auch alternativ folgenden Aufruf verwenden: - - ```sh - evcc configure --advanced - ``` - - Dieser Modus bietet weitere (technisch fortgeschrittene) Einstellmöglichkeiten. - ::: - -- Teste, ob die Konfiguration funktioniert - - ```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. - -- Wenn alles funktioniert, beende evcc durch drücken der Tastenkombination `CTRL-C`. - -- Verschiebe die erstellte Konfigurationsdatei in den Zielordner: - - ```sh - sudo mv evcc.yaml /etc - ``` - -- Starte evcc neu: - - ```sh - sudo systemctl start evcc - ``` - -- Gehe zurück zum Browser und lade die evcc Seite neu. Die Oberfläche sollte nun mit deinen konfigurierten Geräten zu sehen sein. - ## Aktualisierung Um auf eine neue Version von evcc zu aktualisieren, führe folgende Schritte durch: @@ -142,6 +96,14 @@ Um auf eine neue Version von evcc zu aktualisieren, führe folgende Schritte dur Wenn das unstable Repository (Nightly Versionen) hinzugefügt wurde, wird beim Update immer auf die letzte verfügbare Nightly Version aktualisiert. Sollte das nicht mehr erwünscht sein, muss das unstable Repository mittels `sudo rm /etc/apt/sources.list.d/evcc-unstable.list` entfernt werden. ::: +## Konfiguration + +Es wird eine funktionierende evcc Konfiguration benötigt. + + + +Folge nun der [Anleitung](./configuration#konfiguration-mit-assistenten) zur Erstellung einer Konfiguration mit dem Konfigurationsassistenten. + ## Downgrade Mit folgendem Befehl kann man auf eine ältere Version von evcc wechseln: diff --git a/docs/installation/macos.md b/docs/installation/macos.md index 3c5f64c81..9a10f694f 100644 --- a/docs/installation/macos.md +++ b/docs/installation/macos.md @@ -43,47 +43,12 @@ Es wird mindestens macOS Version 10.12 (Sierra) benötigt, ältere Versionen von brew services stop evcc ``` -- Starte die Konfiguration und folge den Anweisungen im Terminal Fenster: +## Konfiguration - ```sh - evcc configure - ``` - - Sofern alle Geräte korrekt konfiguriert sind, kannst du mit den nächsten Schritten fortfahren. - - :::note - Fortgeschrittene Anwender (z.B. mit evcc Erfahrung oder technischem Know-How) können auch alternativ folgenden Aufruf verwenden: - - ```sh - evcc configure --advanced - ``` - - Dieser Modus bietet weitere (technisch fortgeschrittene) Einstellmöglichkeiten. - ::: - -- Teste ob die Konfiguration funktioniert: - - ```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. - -- Wenn alles funktioniert, beende evcc durch drücken der Tastenkombination `CTRL-C`. +Es wird eine funktionierende evcc Konfiguration benötigt. -- Verschiebe die erstellte Konfigurationsdatei in den Zielordner: - - ```sh - sudo mv evcc.yaml /etc - ``` - -- Starte evcc neu: - - ```sh - brew services start evcc - ``` +Folge nun der [Anleitung](./configuration#konfiguration-mit-assistenten) zur Erstellung einer Konfiguration mit dem Konfigurationsassistenten. -- Gehe zurück zum Browser und lade die evcc Seite neu. Die Oberfläche sollte nun mit deinen konfigurierten Geräten zu sehen sein. ## Aktualisierung diff --git a/docs/installation/manual.mdx b/docs/installation/manual.mdx index 7e5ac8dcc..d1d8b8ca2 100644 --- a/docs/installation/manual.mdx +++ b/docs/installation/manual.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 --- import Tabs from "@theme/Tabs"; @@ -38,21 +38,13 @@ Wähle die entsprechende Datei für dein System: - Entpacke die heruntergeladene Datei (z.B. per Doppelklick auf die Datei) - Es gibt nun einen neuen Ordner mit der dem Programm `evcc`. - Öffne ein Terminal/Eingeabeaufforderung und gehe in den Ordner mit dem Programm `evcc` -- Starte die Konfiguration und folge den Anweisungen im Terminal Fenster: - ```sh - evcc configure - ``` +## Konfiguration - :::note - Fortgeschrittene Anwender (z.B. mit evcc Erfahrung oder technischem Know-How) können auch alternativ folgenden Aufruf verwenden: +Es wird eine **funktionierende** evcc Konfiguration benötigt. - ```sh - evcc configure --advanced - ``` +Folge nun der [Anleitung](./configuration#konfiguration-mit-assistenten) zur Erstellung einer Konfiguration mit dem Konfigurationsassistenten. - Dieser Modus bietet weitere (technisch fortgeschrittene) Einstellmöglichkeiten. - ::: ## Aktualisierung/Downgrade diff --git a/docs/installation/proxmox.mdx b/docs/installation/proxmox.mdx new file mode 100644 index 000000000..517b7a5b7 --- /dev/null +++ b/docs/installation/proxmox.mdx @@ -0,0 +1,45 @@ +--- +sidebar_position: 8 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Screenshot from "../../src/components/Screenshot"; + +# Proxmox + +:::note +Proxmox ist eine Virtualisierungs-Platform, welche ein sehr einfaches evcc Hosting ermöglicht. +Wenn du vorhast evcc auf einem Linux Home Server, zu betreiben, kann Proxmox eine flexible Alternative darstellen, +die es ermöglicht neben evcc auch noch andere systeme zu installieren. Eine evcc Installation auf [Proxmox](https://www.proxmox.com/en/) verhält sich +danach genau so wie eine Installation auf einem dedizierten Linux server. + + +Die folgende Installation wurde mit Ubuntu 24.4 getestet. +::: + +## Installation + +1. Falls auf deinem System noch nicht vorhanden, lade ein aktuelles Ubuntu Template auf deinen Server. +2. Erstelle einen Debian basierten LX container, der nur mit minimalen Ressourcen konfiguriert wird. + (8G disk und 512MB RAM sind genügend Ressourcen) + + Siehe Screenshot: + + ![Screenshot Resources](screenshots/proxmox_ct_ressource.webp) + +Falls du lieber ein Script zur Installation verwendest, kopiere den Bashscript unter dem folgenden Link +[Proxmox VE Helper-Scripts](https://tteck.github.io/Proxmox/#evcc-lxc) in die Proxmox console. + +Anmerkung: +Dieser Weg erstellt ein Container mit 1 GB RAM und da evcc schon mitinstalliert wird, kannst du direkt mit dem +Konfigurationsassistenten starten. Es gibt auf dieser Seite auch noch andere nützliche Scripts, z.b. für Backups auf Fremdsysteme. + + +3. Installiere evcc wie in der Anleitung für Debian basierte Linux Systeme beschrieben [Debian, Ubuntu Installation](./linux). + +## Aktualisierung + +Aktualisierung über die Debian, Ubuntu Paketverwaltung. + +https://tteck.github.io/Proxmox/#evcc-lxc \ No newline at end of file diff --git a/docs/installation/screenshots/ha_configuration_ui.webp b/docs/installation/screenshots/ha_configuration_ui.webp new file mode 100644 index 000000000..e78198fe9 Binary files /dev/null and b/docs/installation/screenshots/ha_configuration_ui.webp differ diff --git a/docs/installation/screenshots/proxmox_ct_ressource.webp b/docs/installation/screenshots/proxmox_ct_ressource.webp new file mode 100644 index 000000000..f7c4dd821 Binary files /dev/null and b/docs/installation/screenshots/proxmox_ct_ressource.webp differ diff --git a/docs/integrations/home-assistant.md b/docs/integrations/home-assistant.md deleted file mode 100644 index 7db838a43..000000000 --- a/docs/integrations/home-assistant.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Home Assistant - -## Betrieb in Home Assistant - -Mit dem community-maintainten [evcc Home Assistant Add-on](https://github.com/evcc-io/hassio-addon) kannst du evcc in einer Home Assistant Umgebung betreiben. -Damit benötigst du keine separate Hardware oder Installationsumgebung. -evcc läuft direkt in Home Assistant. - -## Integration mit ha-evcc - -Mit der [ha-evcc](https://github.com/marq24/ha-evcc) von [marq24](https://github.com/marq24) kannst du evcc Daten und Funktionen einfach in Home Assistant integrieren. -Unabhängig davon, ob du evcc in Home Assistant betreibst oder nicht. - -## Manuelle Integration - -Über die bestehenden [MQTT](/docs/integrations/mqtt-api) und [REST](/docs/integrations/rest-api) Schnittstellen kannst du evcc auch manuell in Home Assistant integrieren. - -## Weitere Ressourcen - -- [smart home & more: evcc Basisinstallation und Konfiguration](https://youtu.be/aPq8k2MronY) -- [smart home & more: Schritt für Schritt - MQTT-Sensor mit Hilfe des MQTT-Explorer einrichten](https://youtu.be/0QQ3y8fgRVA) -- [smart home & more: Effizientes Energiedashboard für Home Assistant](https://youtu.be/V3p5-16U_oU) diff --git a/docs/integrations/home-assistant.mdx b/docs/integrations/home-assistant.mdx new file mode 100644 index 000000000..7fb9af5e9 --- /dev/null +++ b/docs/integrations/home-assistant.mdx @@ -0,0 +1,212 @@ +--- +fsidebar_position: 3 +--- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Home Assistant + +## Betrieb in Home Assistant + +Mit dem community-maintainten [evcc Home Assistant Add-on](https://github.com/evcc-io/hassio-addon) kannst du evcc in einer Home Assistant Umgebung betreiben. +Damit benötigst du keine separate Hardware oder Installationsumgebung. +evcc läuft direkt in Home Assistant. + +Eine detaillierte Installationsanleitung findest du hier +[Home Assistant Add-on Installation](../installation/home-assistant). + +## Integration mit ha-evcc + +Mit der [ha-evcc](https://github.com/marq24/ha-evcc) von [marq24](https://github.com/marq24) kannst du evcc Daten und Funktionen einfach in Home Assistant integrieren. +Unabhängig davon, ob du evcc in Home Assistant betreibst oder nicht. + +Die Integration unterstützt alle notwendigen von evcc in MQTT oder dem API bereitgestellten Entitäten, auch diese zur Anpassung der +evcc Einstellungen, Ladepunkte und der entsprechenden Fahrzeuge. + +## Sensordaten Integrieren + +Falls du Geräte, wie Chargers, Meters oder Fahrzeuge, in evcc integrieren möchtest die von Geräten stammen die evcc nicht +unterstützt (z.B. Zigbee Smartplugs) kannst du dies über [MQTT](/docs/integrations/mqtt-api) oder das +[REST API](/docs/integrations/rest-api) realisieren. Beide Wege erfordern für Einsteiger einen gewissen Lernaufwand um +sie erfolgreich nutzen zu können. Doch mit Hilfe der folgenden Kurzanleitungen mit verlinkten Tutorials ist die Aufgabe zu bewältigen. + +:::note +Dank der beiden evcc Schnittstellen können zusätzliche Ladepunkte für eine Vielzahl von verschiebbaren Lasten (Verbrauchern), +wie Heizgeräte, Waschmaschinen, Geschirrspüler oder Elektro-Zweiräder realisiert werden. +::: + +### Manuelle Integration von Sensordaten über MQTT + +MQTT ist ein einfaches Kommunikationsprotokoll, das für das Internet der Dinge (IoT) entwickelt wurde. +Der Weg über MQTT ist etwas einfacher als über das API, aber falls du noch nie mit MQTT gearbeitest hast, +gilt es ein paar Punkte zu beachten. + +Ein Endgerät (in diesem Fall Home Assistant) sendet eine Nachricht an einen sogenannten Broker. +In Home Assistant heisst der Broker Mosquitto und ist einfach als Addon installierbar. evcc kann dann die bereitgestellten +Daten vom Broker auslesen und weiterverarbeiten. + +Falls du den Mosquitto Broker in Home Assistant noch nicht installiert hast, +kannst du dieser [Anleitung](https://alkly.de/mqtt-mit-home-assistant-fuer-anfaenger) folgen. + +In Kurzform geht es darum, die nötigen Home Assistant Addons zu installieren und zu konfigurieren: + +1. Das Add-on “Mosquitto broker” installieren +2. Einen separaten Home Assistant Nutzer für MQTT einrichten (ohne Admin Rechte) +3. Das Add-on “MQTT Explorer” installieren (wird zur überprüfung der "topics" verwendet) +4. Die MQTT Integration installieren + +Nun wäre MQTT von Home Assistant eingerichtet und der nächste Schritt ist die Zugangsdaten zum Broker in evcc einzutragen +Dazu musste du folgende Konfiguration in der _evcc.yaml_ ändern oder anfügen. + +```yaml title="part of evcc.yaml" +# mqtt message broker +mqtt: +broker: your-HA-IP-Address:1883 +topic: evcc # root topic for publishing, set empty to disable +user: mosquitto # your username for the broker +password: yourpassword +``` + +Nach einem Restart des Addons müsste evcc mit dem Broker kommunizieren können und die von evcc bereitgestellten topics anzeigen. +Um das zu überprüfen, musst du das Addon “MQTT Explorer” starten und das WebUI öffnen. Mit den gleichen Zugangssdaten öffnet sich +dann der Explorer und zeigt in etwa folgendes Bild. + +![Image](screenshots/Screenshot_mosquitto_broker_evcc-topics.webp) + +Falls dies geklappt bist du nun bereit einen ersten MQTT Sensor in Home Assistant zu definieren. Für dies gibt es im Prinzip +verschiedene Wege, wir beschränken uns hier aber für den einfachsten über Automatisationen. +Wenn du den untenstehenden YAML Code kopierst und eine Automatisation daraus erstellst müsstest du den Sensor anschliessend +im “MQTT Explorer” angezeigt bekommen. +Selbstverständlich musst du die Entität sensor.shelly_em_channel_2_power mit einem vorhandenen Sensor von dir ersetzen. + +:::note +Die Namen der topics können frei gewählt werden, hier wurde der zugehörige Ladepunkt als Stammverzeichnis gewählt. + +In MQTT müssen die topics regelmässig neu publiziert werden, sonst erzeugt evcc einen Fehler "Sensordata outdated" +::: + +```yaml title="HA Automatisation" +alias: MQTT Heatpump Charger Power +description: sensor.shelly_em_channel_2_power -> actual Power Consumption +mode: single +triggers: + - entity_id: + - sensor.shelly_em_channel_2_power + trigger: state + - seconds: /15 + trigger: time_pattern +conditions: [] +actions: + - action: mqtt.publish + metadata: {} + data: + evaluate_payload: false + qos: 0 + retain: false + payload: "{{ states('sensor.shelly_em_channel_2_power') }}" + topic: evcc/loadpoints/2/charger/ChargePower +``` + +Im “MQTT Explorer” zeigt sich etwa folgendes Bild (ohne die 4 zusätzlichen Werte). + +![Image](screenshots/Screenshot_mosquitto_broker_evcc-charger-topics.webp) + +#### MQTT Templates für ein Heizungs Ladepunkt + +Um den Wert in evcc zu lesen muss man einen custom meter in _evcc.yaml_ definieren. + +```yaml title="Meter part of evcc.yaml" + - name: heatpump-pw + type: custom + power: # Power (W) + source: mqtt + topic: evcc/loadpoints/2/charger/ChargePower + timeout: 30s # don't accept values older than timeout + scale: 1 # floating point factor applied to result, e.g. for converting Wh to kWh +``` + +Im dem Beispiel eines Chargers müssen noch drei zusätzliche topics definiert werden. +Aber die Automatiserungen dazu sind im Prinzip gleich aufgebaut wie das Beispiel des ChargePower, der nicht hier sondern im Ladepunkt +verlinkt wird. + +Link zur [Charger Template Doku](/docs/devices/chargers#manuell) + +Hier der zusätzliche "Charger" Abschnitt für die _evcc.yaml_ Datei (icon: features: sind optional). + +```yaml title="Charger part of evcc.yaml" + - name: Heatpump + type: custom + status: # charger status A..F + source: mqtt + topic: evcc/loadpoints/2/charger/ChargerStatus + timeout: 10m + enabled: # charger enabled state (true/false or 0/1) + source: mqtt + topic: evcc/loadpoints/2/charger/ChargerEnabled + timeout: 10m + enable: # set charger ⇒ enable (true/false or 0/1) + source: mqtt + topic: evcc/loadpoints/2/charger/ChargerEnabled + payload: ${enable:%d} + timeout: 10m + maxcurrent: # set charger max current (A) + source: mqtt + topic: evcc/loadpoints/2/charger/AConfigured + timeout: 10m + icon: waterheater + features: + - integrateddevice + - heating +``` + +Nun kannst du noch den erfoderlichen Ladepunkt für die Wärmepumpe in _evcc.yaml_ Datei einfügen. + +```yaml title="Loadpoint part of evcc.yaml" + - title: Heatpump + charger: Heatpump + meter: heatpump-pw + mode: "off" + priority: 5 # relative priority for concurrent charging in PV mode with multiple loadpoints (higher values have higher priority) + disable: + threshold: 500 # maximum import power (W) + delay: 5m +``` + +Falls du alle Automatisationen für die vier erfoderlichen topics, plus den Ladepunkt erstellt hast müsste nach einem evcc +Neustart eine Wärmepumpe als Ladepunkt erscheinen. + + +:::note +Wärmepumpen sind in der Regel über einen Thermostat geregelt und sollten nicht über anderes System ein- aus geschaltet werden, +wie z.b. einen simplen Heizstab. Man kann aber über den Targt Current "sensor.evcc_heatpump_charge_current" des Ladepunktes +eine Umwandlung von Strom (A) in Prozent vornehmen und damit den Sollwert der Wärmepumpe beeinflussen. + +Doch diesen Ansatz zu erklären würde den Zweck dieser Kurzanleitung überstrapazieren. +::: + +#### Liste der MQTT Templates für Geräte + +Unter diesen Links findest du die nötigen Angaben zur Definition von zusätzlichen Geräten die über MQTT kommunizieren können. + +- Hausinstallationen [meters](/docs/devices/meters#manuell) +- Wallboxen [charger](/docs/devices/chargers#manuell) +- Fahrzeuge [vehicles](/docs/devices/vehicles#manuell) +- Tarrife [tariffs](/docs/devices/tariffs#eigenes-plugin) + +### Manuelle Integration Sensordaten über REST API + +Die zweite Möglichkeit um Sensor Daten einzulesen benötigt kein Extra Tool wie einen Broker, setzt aber gewisse Grundkenntnisse +über REST API's voraus. +Wie das über das REST Api geht steht detailliert in der folgenden Anleitung, (ebenso durch [marq24](https://github.com/marq24) bereitgestellt). + +[Anleitung, evcc mit Home Assistant Sensordaten](https://github.com/marq24/ha-evcc/blob/main/HA_AS_EVCC_SOURCE.md) + +## Weitere Ressourcen (Videos) + +Zu Beachten! + +Das erste Video unter diesen Links wiederspiegelt den Lösungsweg vor der Veröffentlichung der Home Assistant evcc Integration. + +- [smart home & more: evcc Basisinstallation und Konfiguration](https://youtu.be/aPq8k2MronY) +- [smart home & more: Schritt für Schritt - MQTT-Sensor mit Hilfe des MQTT-Explorer einrichten](https://youtu.be/0QQ3y8fgRVA) +- [smart home & more: Effizientes Energiedashboard für Home Assistant](https://youtu.be/V3p5-16U_oU) diff --git a/docs/integrations/screenshots/Screenshot_mosquitto_broker_evcc-charger-topics.webp b/docs/integrations/screenshots/Screenshot_mosquitto_broker_evcc-charger-topics.webp new file mode 100644 index 000000000..cc135395d Binary files /dev/null and b/docs/integrations/screenshots/Screenshot_mosquitto_broker_evcc-charger-topics.webp differ diff --git a/docs/integrations/screenshots/Screenshot_mosquitto_broker_evcc-topics.webp b/docs/integrations/screenshots/Screenshot_mosquitto_broker_evcc-topics.webp new file mode 100644 index 000000000..99a287883 Binary files /dev/null and b/docs/integrations/screenshots/Screenshot_mosquitto_broker_evcc-topics.webp differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx new file mode 100644 index 000000000..75b14c26f --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/configuration.mdx @@ -0,0 +1,201 @@ +--- +sidebar_position: 10 +--- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Configuration +:::note +This configuration guide describes both possible ways to create a working configuration file, with or without a configuration wizard. +The former is only possible for non-Docker-based systems. +::: + + +## Configuration with wizard + +This part of the guide is aimed at users who use evcc as a Linux/Mac or Windows installation. + +- You can now start the configuration wizard - simply follow the prompts in your terminal! + + ```sh + evcc configure + ``` + + Once all devices are configured, you can continue on. + + :::note + Advanced users (those with evcc experience & some technical know-how) might want to use the advanced configurator: + + ```sh + evcc configure --advanced + ``` + + This mode offers some further, more technically-involved options. + ::: + +- Test to make sure your new configuration works: + + ```sh + evcc -c evcc.yaml + ``` + + Open a browser and head to `http://localhost:7070`: the evcc interface should now show your own devices. + +- If everything's working, press `CTRL+C` to stop the server. + +- Move the generated configuration to its home: + + ```sh + sudo mv evcc.yaml /etc + ``` + +- Start evcc: + + ```sh title="Linux" + sudo systemctl start evcc + ``` + + ```sh title="MacOS" + brew services start evcc + ``` + + Other possible commands are ... restart evcc and ... stop evcc. + +- Go back to your browser and refresh to make sure everything's working as it should be! + + +## Configuration without wizard + +:::note +This part of the guide is aimed at users who use evcc as a Home Assistant addon or as a Docker container and therefore cannot use the configuration wizard. +However, the guide may contain useful tips for people who still need to adjust their configuration after using the configuration wizard. +::: + + +In the following instruction it is assumed that you have created an empty configuration file _evcc.yaml_ in the correct directory. +The instructions can be found in the respective installation instructions for Docker or Home Assistant. + +```sh +- config_file Docker: `/etc/evcc.yaml` +- config_file Home Assistant: `/config/evcc.yaml` +``` + +Copy the content of the following minimal template into the _evcc.yaml_ file you just created. +The template creates a standard configuration with static demo entities. + +```yaml title="evcc.yaml Mini Template" +## Configuration template with demo entities (meters, chargers) ## + +# log settings +log: info +levels: + site: debug + lp-1: debug + lp-2: debug + cache: error + db: error + +# meter definitions +# name can be freely chosen and is used as reference when assigning meters to site and loadpoints +# for documentation see https://docs.evcc.io/docs/devices/meters +meters: + # replace with your real grid meter + - name: my_grid + type: template + template: demo-meter + usage: grid + power: -1000 # 1 kW feed-in + # replace with your real pv system + - name: my_pv + type: template + template: demo-meter + usage: pv + power: 4000 # 4 kW production + # replace with your real battery + - name: my_battery + type: template + template: demo-battery + usage: battery + power: -1000 # 1 kW battery charging + soc: 50 # 50 % state of charge + +# replace with your real charger +# see https://docs.evcc.io/docs/devices/chargers +chargers: + - name: my_charger + type: template + template: demo-charger + status: C # charging + power: 2000 # 2 kW charging power + enabled: true # optional + +# replace with your real vehicle (optional) +# see https://docs.evcc.io/docs/devices/vehicles +vehicles: + - name: my_car + type: template + template: offline + title: blue e-Golf + capacity: 50 # in kWh + +# assign your devices to the site +site: + title: Home # display name for UI + meters: + grid: my_grid + pv: + - my_pv + battery: + - my_battery + +# define your loadpoints according your needs +# see https://docs.evcc.io/en/docs/reference/configuration/loadpoints +loadpoints: + - title: Garage # display name for UI + charger: my_charger # charger + vehicle: my_car # default vehicle + +# enter your real grid tariff and feed-in price +# see https://docs.evcc.io/docs/devices/tariffs +tariffs: + currency: EUR + grid: + type: fixed + price: 0.29 # EUR/kWh + feedin: + type: fixed + price: 0.10 # EUR/kWh +``` + +If you want to see how evcc runs in a dynamic demo instead, +copy the content of https://github.com/evcc-io/evcc/blob/master/cmd/demo.yaml into your _evcc.yaml_ file. + +- Now you can go ahead and start the addon or the Docker container. +- Check the installation by opening the WebUI - you should now see the evcc web interface in a static demo mode. +- If this is ok, you can edit the _evcc.yaml_ file and create your own setup (only possible with the static template). +- To do this, copy the necessary templates that you can find in the documentation in the section [Devices, e.g. wallboxes](../devices/chargers). + +:::tip +If you cannot manage the manual configuration, you should install a stand-alone evcc Windows or Linux system and use the configuration wizard. + +The configuration wizard is not available in the Home Assistant environment. + +It is easier to use `evcc configure` there and then copy the generated _evcc.yaml_ to the desired system. + +**Advanced users** (with evcc experience and some technical know-how) should use the advanced configurator: +::: + +The minimal template contains only the most necessary sections of the configuration. + +If you need structures or explanations that are not listed, it is worth taking a look at the fully developed template at this +link https://github.com/evcc-io/evcc/blob/master/evcc.dist.yaml. + + +- Test each newly added device to ensure that your new configuration works. +- Once all devices are configured, you can continue with the setup via the user interface. + +:::tip +For Home Assistant users + +Proceed with the installation of the evcc integration for Home Assistant as described in this section [Integrations](../integrations/home-assistant). +::: 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 290f75353..872e8a59e 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx @@ -33,7 +33,13 @@ At the moment, only the following CPU architectures are supported: ## Configuration -1. It's best to start with a known-working evcc setup using one of the other installation methods: +1. A **working** evcc configuration is required. There are two options: + Either you follow the [instructions](./configuration#configuration-without-wizard) to create a manual configuration or you use the + configuration wizard and follow these [instructions](./configuration#configuration-with-wizard). + + For the way with the configuration wizard you need a second installation of evcc. + + You can choose one of the following systems to create a second installation: - [Debian, Ubuntu, Raspberry Pi](linux) - [macOS](macos) 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 new file mode 100644 index 000000000..c28089776 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/home-assistant.mdx @@ -0,0 +1,56 @@ +--- +sidebar_position: 7 +--- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Screenshot from "../../../../../src/components/Screenshot"; + +# Home Assistant Addon + +:::note +The evcc Home Assistant addon is a community integration and is not ‘yet’ officially supported by the evcc maintainers. +The reason for this is that important data cannot simply be made available in the event of an error (missing evcc cli). +::: + +These instructions are aimed at users who use Home Assistant and want to use evcc as an add-on. It is of course also possible +to run evcc outside of Home Assistant and to integrate it into Home Assistant. Operating evcc as an add-on is of course +the easier way, but has the disadvantage that you cannot use the configuration assistant. + +Note: The addon requires very few resources. + +## Installation Guide + +1. Click -> Add-on Store under Settings - Addons. +2. Click -> three dots -> Repositories. +3. Copy https://github.com/evcc-io/hassio-addon Click -> Add +4. Reload the WebSite (CTRL+R or CTRL+F5 or CTRL+Fn+F5) +5. Find the "evcc" add-on and click it. +6. Click on the "INSTALL" button. + +### Configuration + +Go to Information menu in the "evcc" Addon and activate "show in side bar" (evcc UI http://your-ha-instance-ip-address:7070) + +Go to Configuration menu 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 evcc configuration file _evcc.yaml_in your Home Assistant root configuration folder (/homeassistant). + +## Configuration + +Now follow these instructions to fill the evcc configuration file with a template content [Configuration (manual)](./configuration#configuration-without-wizard) + +## Installation of the evcc Integration + +Proceed with installation process of the evcc Integration for Home Assistant as described in this section [Integrations](../integrations/home-assistant) + +## Upgrades + +The to the latest version of evcc, is included in the Home Assistant update process. 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 3228b5071..e2b798ac5 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/index.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/index.md @@ -11,4 +11,7 @@ Pick your platform of choice and we'll guide you through setting up! - [Linux (Debian, Ubuntu, Raspberry Pi OS)](./installation/linux) - [macOS](./installation/macos) - [Docker (incl. Synology)](./installation/docker) -- [Manual Installation (including Windows)](./installation/manual) +- [Manual Installation (incl. Windows)](./installation/manual) +- [Home Assistant addon](./installation/home-assistant) +- [Proxmox](./installation/proxmox) +- [Configuration (manual)](./installation/configuration) 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 c351be916..3c3c46290 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/linux.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/linux.mdx @@ -78,52 +78,12 @@ Cloudsmith provides services to support the development of free software and pla sudo systemctl stop evcc ``` -- You can now start the configuration wizard - simply follow the prompts in your terminal! +## Configuration - ```sh - evcc configure - ``` - - Once all devices are configured, you can continue on. - - :::tip - The Configuration wizard is not available under the Home Assistant environment. - You may find it easier to install evcc on another Windows or Linux system, use `evcc configure` there, and then copy the generated _evcc.yaml_ to the desired system. - ::: - - :::note - Advanced users (those with evcc experience & some technical know-how) might want to use the advanced configurator: - - ```sh - evcc configure --advanced - ``` - - This mode offers some further, more technically-involved options. - ::: +A **working** evcc configuration is required. -- Test to make sure your new configuration works: - - ```sh - evcc -c evcc.yaml - ``` - - Open a browser and head to `http://localhost:7070`: the evcc interface should now show your own devices. - -- If everything's working, press `CTRL+C` to stop the server. - -- Move the generated configuration to its home: - - ```sh - sudo mv evcc.yaml /etc - ``` - -- Start evcc: - - ```sh - sudo systemctl start evcc - ``` +Follow the [instructions](./configuration#configuration-with-wizard) to create a configuration file with the configuration wizard. -- Go back to your browser and refresh to make sure everything's working as it should be! ## Upgrades 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 9336563f1..ba7c4f960 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/macos.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/macos.md @@ -43,47 +43,11 @@ Versions of macOS older than 10.12 (Sierra) are not supported. brew services stop evcc ``` -- You can now start the configuration wizard - simply follow the prompts in your terminal! +## Configuration - ```sh - evcc configure - ``` - - Once all devices are configured, you can continue on. - - :::note - Advanced users (those with evcc experience & some technical know-how) might want to use the advanced configurator: - - ```sh - evcc configure --advanced - ``` - - This mode offers some further, more technically-involved options. - ::: - -- Test to make sure your new configuration works: - - ```sh - evcc -c evcc.yaml - ``` - - Open a browser and head to `http://localhost:7070`: the evcc interface should now show your own devices. - -- If everything's working, press `CTRL+C` to stop the server. - -- Move the generated configuration to its home: - - ```sh - sudo mv evcc.yaml /etc - ``` - -- Start the evcc server: - - ```sh - brew services start evcc - ``` +A **working** evcc configuration is required. -- Go back to your browser and refresh to make sure everything's working as it should be! +Follow the [instructions](./configuration#configuration-with-wizard) to create a configuration file with the configuration wizard. ## Upgrades diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/manual.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/manual.mdx index b3b1c171e..2cb20ee10 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/manual.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/manual.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 --- import Tabs from "@theme/Tabs"; @@ -36,23 +36,12 @@ Find the appropriate file for your system: - Extract the contents to a working directory - you'll now have a `evcc` directory to work from. - Open a terminal and change directory to `evcc`. -- You can now start the configuration wizard - simply follow the prompts in your terminal! -```sh -evcc configure -``` - -Once all devices are configured, you can continue on. - -:::note -Advanced users (those with evcc experience & some technical know-how) might want to use the advanced configurator: +## Configuration -```sh -evcc configure --advanced -``` +A **working** evcc configuration is required. -This mode offers some further, more technically-involved options. -::: +Follow the [instructions](./configuration#configuration-with-wizard) to create a configuration file with the configuration wizard. ## Upgrades / Downgrades diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/proxmox.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/proxmox.mdx new file mode 100644 index 000000000..2cb78962d --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/proxmox.mdx @@ -0,0 +1,42 @@ +--- +sidebar_position: 8 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Screenshot from "../../../../../src/components/Screenshot"; + +# Proxmox + +:::note +Proxmox is a virtualisation platform which enables a very simple evcc hosting. +If you plan to run evcc on a Linux Home server, Proxmox can be a flexible alternative, +which makes it possible to install other systems in addition to evcc. An evcc installation on [Proxmox](https://www.proxmox.com/en/) then behaves exactly + the same way as an installation on a dedicated Linux server. + +The following installation ha been tested with Ubuntu 24.4. +::: + +## Installation + +1. If not already present on your system, load a current Ubuntu template onto your server. +2. Create a Debian based LX container that is configured with minimal resources. + (8G of disk and 512MB of RAM are plenty of resources) + + See screenshot: + + ![Screenshot Resources](screenshots/proxmox_ct_ressource.webp) + +If you prefer to use a script for the installation, copy the bash script under the following link +[Proxmox VE Helper-Scripts](https://tteck.github.io/Proxmox/#evcc-lxc) into the Proxmox console. + +Remark: +This way creates a container with 1 GB RAM and since evcc is already installed, you can start directly + with the configuration wizard. There are also other useful scripts on this page, e.g. for backups to external systems. + +3. Install evcc as described in the instructions for Debian-based Linux systems [Debian, Ubuntu](./linux). + +## Update + +Update via the Debian, Ubuntu package management. + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/screenshots/ha_configuration_ui.webp b/i18n/en/docusaurus-plugin-content-docs/current/installation/screenshots/ha_configuration_ui.webp new file mode 100644 index 000000000..e78198fe9 Binary files /dev/null and b/i18n/en/docusaurus-plugin-content-docs/current/installation/screenshots/ha_configuration_ui.webp differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/screenshots/proxmox_ct_ressource.webp b/i18n/en/docusaurus-plugin-content-docs/current/installation/screenshots/proxmox_ct_ressource.webp new file mode 100644 index 000000000..f7c4dd821 Binary files /dev/null and b/i18n/en/docusaurus-plugin-content-docs/current/installation/screenshots/proxmox_ct_ressource.webp differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/integrations/home-assistant.mdx b/i18n/en/docusaurus-plugin-content-docs/current/integrations/home-assistant.mdx new file mode 100644 index 000000000..78df4e243 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/integrations/home-assistant.mdx @@ -0,0 +1,214 @@ +--- +fsidebar_position: 3 +--- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Home Assistant + +## Operation in Home Assistant + +With the community-maintained [evcc Home Assistant Add-on](https://github.com/evcc-io/hassio-addon) you can operate evcc in a Home Assistant environment. +This means you do not need any separate hardware or installation environment. +evcc runs directly in Home Assistant. + +You can find detailed installation instructions here +[Home Assistant Add-on Installation](../installation/home-assistant). + +## Integration with ha-evcc + +With the [ha-evcc](https://github.com/marq24/ha-evcc) from [marq24](https://github.com/marq24) you can easily integrate evcc data and functions into Home Assistant. +Regardless of whether you run evcc in Home Assistant or not. + +The integration supports all necessary entities provided by evcc in MQTT or the API, including those for customising the +evcc settings, loadpoints and the corresponding vehicles. + +## Integrate sensor data + +If you want to integrate devices such as chargers, meters or vehicles into evcc that originate from devices that evcc does not +support (e.g. Zigbee smart plugs), you can do this via [MQTT](/docs/integrations/mqtt-api) or the +[REST API](/docs/integrations/rest-api). Both methods require a certain amount of learning for beginners to +be able to use them successfully. However, with the help of the following short instructions with linked tutorials, the task can be mastered. + +:::note +Thanks to the two evcc interfaces, additional loadpoints can be realised for a variety of deferrable loads (consumers), +such as heaters, washing machines, dishwashers or electric two-wheelers. +::: + +### Manual integration of sensor data via MQTT + +MQTT is a simple communication protocol that was developed for the Internet of Things (IoT). +The way via MQTT is a little easier than via the API, but if you have never worked with MQTT before, there are a few points to consider. + +An end device (in this case Home Assistant) sends a message to a so-called broker. +In Home Assistant, the broker is called Mosquitto and can be easily installed as an add-on. evcc can then read the data + provided by the broker and process it. + +If you have not yet installed the Mosquitto Broker in Home Assistant, +you can follow these [instructions](https://haprofs.com/setting-up-mqtt-mosquitto-broker-home-assistant/). + +In short, it is about installing and configuring the necessary Home Assistant add-ons: + +1. Install the ‘Mosquitto broker’ add-on +2. Set up a separate Home Assistant user for MQTT (without admin rights) +3. Install the ‘MQTT Explorer’ add-on (used to check the ‘topics’) +4. Install the MQTT integration + +MQTT would now be set up in Home Assistant and the next step is to enter the access data for the broker in evcc. +To do this, you must enter the following configuration into the _evcc.yaml_. + +```yaml title="part of evcc.yaml" +# mqtt message broker +mqtt: +broker: your-HA-IP-Address:1883 +topic: evcc # root topic for publishing, set empty to disable +user: mosquitto # your username for the broker +password: yourpassword +``` + +After restarting the addon, evcc should be able to communicate with the broker and display the topics provided by evcc. +To check this, you need to start the addon ‘MQTT Explorer’ and open the WebUI. With the same access data +the explorer opens and shows something like the following picture. + +![Image](screenshots/Screenshot_mosquitto_broker_evcc-topics.webp) + +If this works, you are now ready to define a first MQTT sensor in Home Assistant. There are in principle +different ways to do this, but we will limit ourselves here to the simplest one via automations. +If you copy the YAML code below and create an automation from it, you should then have the sensor +be displayed in the ‘MQTT Explorer’. +Of course you have to replace the entity sensor.shelly_em_channel_2_power with an existing sensor of yours. + +:::note +The names of the topics can be freely chosen, here the corresponding loadpoint was selected as the root directory. + +In MQTT, the topics must be republished regularly, otherwise evcc will generate a ‘sensor data outdated’ error. +::: + +```yaml title="HA Automatisation" +alias: MQTT Heatpump Charger Power +description: sensor.shelly_em_channel_2_power -> actual Power Consumption +mode: single +triggers: + - entity_id: + - sensor.shelly_em_channel_2_power + trigger: state + - seconds: /15 + trigger: time_pattern +conditions: [] +actions: + - action: mqtt.publish + metadata: {} + data: + evaluate_payload: false + qos: 0 + retain: false + payload: "{{ states('sensor.shelly_em_channel_2_power') }}" + topic: evcc/loadpoints/2/charger/ChargePower +``` + +The ‘MQTT Explorer’ shows the following picture (without the 4 additional values). + +![Image](screenshots/Screenshot_mosquitto_broker_evcc-charger-topics.webp) + + +#### MQTT templates for a heating loadpoint + +To read the value in evcc you have to define a custom meter in _evcc.yaml_. + +```yaml title="Meter part of evcc.yaml" + - name: heatpump-pw + type: custom + power: # Power (W) + source: mqtt + topic: evcc/loadpoints/2/charger/ChargePower + timeout: 30s # don't accept values older than timeout + scale: 1 # floating point factor applied to result, e.g. for converting Wh to kWh +``` + +In the example of a charger, three additional topics must be defined. +But the automations for this are basically structured in the same way as the example of the ChargePower, +which is not linked here, but in the loadpoint. + +Link to [Custom Template Docs](../devices/chargers#custom) + +Here is the additional charger section for the _evcc.yaml_ file (icon: features: are optional). + +```yaml title="Charger part of evcc.yaml" + - name: Heatpump + type: custom + status: # charger status A..F + source: mqtt + topic: evcc/loadpoints/2/charger/ChargerStatus + timeout: 10m + enabled: # charger enabled state (true/false or 0/1) + source: mqtt + topic: evcc/loadpoints/2/charger/ChargerEnabled + timeout: 10m + enable: # set charger ⇒ enable (true/false or 0/1) + source: mqtt + topic: evcc/loadpoints/2/charger/ChargerEnabled + payload: ${enable:%d} + timeout: 10m + maxcurrent: # set charger max current (A) + source: mqtt + topic: evcc/loadpoints/2/charger/AConfigured + timeout: 10m + icon: waterheater + features: + - integrateddevice + - heating +``` + +Now you can add the required loadpoint for the heat pump to the _evcc.yaml_ file. + +```yaml title="Loadpoint part of evcc.yaml" + - title: Heatpump + charger: Heatpump + meter: heatpump-pw + mode: ‘off’ + priority: 5 # relative priority for concurrent charging in PV mode with multiple loadpoints (higher values have higher priority) + disable: + threshold: 500 # maximum import power (W) + delay: 5m +``` + +If you have created all automations for the four required topics, plus the load point, a heat pump should be available as a charge point after an evcc +restart, a heat pump should appear as a loadpoint. + + +:::note +Heat pumps are usually controlled via a thermostat and should not be switched on and off via other systems, +such as a simple heating element. However, you can use the target current ‘sensor.evcc_heatpump_charge_current’ of the loadpoint +to convert the current (A) into a percentage and thus influence the setpoint of the heat pump. + +However, to explain this approach would overstretch the purpose of this quick guide. +::: + +#### List of MQTT templates for devices + +Under these links you will find the necessary information for defining additional devices that can communicate via MQTT. + +- Meters/Site [meters](../devices/meters#custom) +- Chargers [chargers](../devices/chargers#custom) +- Vehicles [vehicles](../devices/vehicles#custom) +- Tariffs [tariffs](../devices/tariffs#custom-plugin) + +### Manual integration of sensor data via REST API + +The second option for reading in sensor data does not require an extra tool such as a broker, but does require some basic +knowledge about REST APIs. +The following instructions (also provided by [marq24](https://github.com/marq24)) explain in detail how to do this via the REST API. + +[Instructions, evcc with Home Assistant sensor data](https://github.com/marq24/ha-evcc/blob/main/HA_AS_EVCC_SOURCE.md) + +## Further resources (videos) + +Please note! + +The first video under these links reflects the solution before the release of the Home Assistant evcc integration. + +The videos are in German. + +- [smart home & more: evcc Basisinstallation und Konfiguration](https://youtu.be/aPq8k2MronY) +- [smart home & more: Schritt für Schritt - MQTT-Sensor mit Hilfe des MQTT-Explorer einrichten](https://youtu.be/0QQ3y8fgRVA) +- [smart home & more: Effizientes Energiedashboard für Home Assistant](https://youtu.be/V3p5-16U_oU) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/integrations/screenshots/Screenshot_mosquitto_broker_evcc-charger-topics.webp b/i18n/en/docusaurus-plugin-content-docs/current/integrations/screenshots/Screenshot_mosquitto_broker_evcc-charger-topics.webp new file mode 100644 index 000000000..cc135395d Binary files /dev/null and b/i18n/en/docusaurus-plugin-content-docs/current/integrations/screenshots/Screenshot_mosquitto_broker_evcc-charger-topics.webp differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/integrations/screenshots/Screenshot_mosquitto_broker_evcc-topics.webp b/i18n/en/docusaurus-plugin-content-docs/current/integrations/screenshots/Screenshot_mosquitto_broker_evcc-topics.webp new file mode 100644 index 000000000..99a287883 Binary files /dev/null and b/i18n/en/docusaurus-plugin-content-docs/current/integrations/screenshots/Screenshot_mosquitto_broker_evcc-topics.webp differ