Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add, Installation, Home Assistant and Proxmox DE/EN / Integration HA update #627

Closed
wants to merge 27 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
db85053
Add, Home Assistant and Proxmox Installation
lucode Sep 17, 2024
7fb1d1f
Add section in Home Integration over REST API
lucode Sep 22, 2024
587b5c2
Add, Installation Home Assistant and Proxmox EN
lucode Sep 22, 2024
31ecebf
Merge branch 'evcc-io:main' into main
lucode Sep 22, 2024
ecd8671
Update, Installation Home Assistant
lucode Oct 5, 2024
52d859b
Merge remote-tracking branch 'origin/main'
lucode Oct 5, 2024
14f3943
Update, Installation Home Assistant
lucode Oct 5, 2024
a68cd09
Update docs/installation/configuration.mdx
lucode Oct 15, 2024
876cbe6
Update docs/installation/configuration / Minor format corr
lucode Oct 15, 2024
4ffd9fe
Update docs/installation/configuration Format
lucode Oct 15, 2024
d7f3f97
Update docs/installation/configuration Format
lucode Oct 15, 2024
1cb812c
Update Integrations home-assistant minor
lucode Oct 15, 2024
99d0e58
Update, Installation Docker
lucode Oct 15, 2024
13cf001
Update, Installation Order of Doc, minor corrections
lucode Oct 15, 2024
3c41825
Update, Installation Configuration DE, smaller evcc.yam template
lucode Oct 15, 2024
7ba0711
Update, Installation EN VERSION
lucode Oct 15, 2024
40b41ac
Update, Installation EN VERSION delete conf file
lucode Oct 15, 2024
9c298b9
Update, Integration of HA MQTT docs,
lucode Oct 17, 2024
31d7dd7
Update docs/installation/configuration evcc.yaml format
lucode Oct 21, 2024
084a733
Update docs/installation/docker simpler link
lucode Oct 21, 2024
2f684fd
Format, Integration of HA MQTT docs,
lucode Oct 22, 2024
7bef839
add, Install/Proxmox adding section link to script for container crea…
lucode Oct 22, 2024
883e626
Update, Installaation changing configuration to serve for configurati…
lucode Oct 22, 2024
2f0c462
Update docs/installation/home-assistant format
lucode Oct 25, 2024
8833f6c
Update docs/installation/home-assistant format
lucode Oct 25, 2024
8987ab8
Update docs/installation/linux format
lucode Oct 25, 2024
0538e04
Update, Installation files,
lucode Oct 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 208 additions & 0 deletions docs/installation/configuration.mdx
Original file line number Diff line number Diff line change
@@ -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
```
Copy link
Member

Choose a reason for hiding this comment

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

Das ist Linux spezifisch. Ich würd das hier kürzer halten. Das Testen der Datei gehört hier mMn noch rein. Auch wo der Assistent die Datei hinlegt. Aber der rest ist dann wieder Thema der jeweiligen spezifischen Anleitung.

Copy link
Member

Choose a reason for hiding this comment

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

So hab ich das nicht gemeint. Mit dem Kommentar ging es mir darum, dass wir auf dieser generischen "Konfigurations-Seite" nur das Thema behandeln wie man eine evcc.yaml erstellen kann. Wie man die in Anwendung bringt (richtiger Speicherort, Dienst neu starten) ist abhängig von der Installationsart (Linux, Mac, Docker, Windows, ...). Das würde ich hier komplett raushalten.


```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.
:::
Copy link
Member

Choose a reason for hiding this comment

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

Aktuell benutzen wir die Infobox auch an anderen Stellen in der Doku zu inflationär. Dieser Text hier kann eine ganz normale Einleitung sein. Ich würde auch Docker und Home Assistant hier gar nicht explizit erwähnen, sondern eher beschrieben, dass das hier die Seite ist, die erklärt, wie ich an eine funktionierende evcc.yaml komme.

Ich würd die auch in zwei Abschnitte/Unterüberschriften aufteilen: 1. Über Kommandozeilenassistent (evcc configure), 2. evcc.yaml manuell bearbeiten (bestehender Inhalt).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry habe das erst nach dem untenstehenden Kommentar gesehen. Bist du sicher dass es eine gute Idee ist alle Fälle in der gleichen Doku zu präsentieren. Ich denke es ist einiges übersichtlicher es getrennt zu halten.
Auch weil ja die Docker Installationen nicht offiziell supportet werden.

Copy link
Member

Choose a reason for hiding this comment

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

Die Herrausforderung, dass man händisch Änderungen an der evcc.yaml machen muss oder aus Gründen configure nicht verwenden kann gibt es ja in allen Installationsarten. Natürlich sind die nicht immer gleich "wichtig". Aber unter Installation > Configuration würde ich ja nicht erwarten, dass spezieller Content für Home Assistant kommt. Daher würde ich schon sagen, dass wir das hier allgemein halten sollten und ggf. an den relevanten Stellen Zusatzhinweise für bestimmte Umgebungsanforderungen einfügen können.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Daher würde ich schon sagen, dass wir das hier allgemein halten sollten und ggf. an den relevanten Stellen Zusatzhinweise für bestimmte Umgebungsanforderungen einfügen können.

Kann ich so machen, aber ist noch einmal ein ziemlicher Umbau, müssen ja auch alle links auf die Linux Install./ Konf neu gemacht werden.


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`
```
Copy link
Member

Choose a reason for hiding this comment

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

Auch hier zu speziell. Das gilt ja auch für Windows, Linux und andere Installationen. Würde ich einfach weglassen.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Bist du sicher? eigentlich richtet sich die Konfigurations Anleitung explizit an Nutzer von Docker basierten Inst.

:

::note Diese Anleitung richtet sich an Benutzer, die evcc als Home Assistant Addon oder als Docker Container verwenden und deshalb den Konfigurationsassistent 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. ::

Ansonsten wird es zu kompliziert. Und ich denke der Hinweis wo die Datei zu finden ist schon hilfreich.


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.
:::

8 changes: 7 additions & 1 deletion docs/installation/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
57 changes: 57 additions & 0 deletions docs/installation/home-assistant.mdx
Original file line number Diff line number Diff line change
@@ -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).
:::
lucode marked this conversation as resolved.
Show resolved Hide resolved

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.
3 changes: 3 additions & 0 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
lucode marked this conversation as resolved.
Show resolved Hide resolved
54 changes: 8 additions & 46 deletions docs/installation/linux.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

Aktualisieren sollte nach Konfiguration bleiben.


Um auf eine neue Version von evcc zu aktualisieren, führe folgende Schritte durch:
Expand All @@ -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:
Expand Down
Loading