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

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
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
180 changes: 180 additions & 0 deletions docs/installation/configuration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
---
sidebar_position: 10
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

# Konfiguration

:::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.
:::
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
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
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
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
lucode marked this conversation as resolved.
Show resolved Hide resolved
## Configuration template with demo entities (meters, chargers) ##
network:
# schema is the HTTP schema
# setting to `https` does not enable https, it only changes the way URLs are generated
schema: http
# host is the hostname or IP address
# if the host name contains a `.local` suffix, the name will be announced on MDNS
# docker: MDNS announcements don't work. host must be set to the docker host's name.
host: evcc.local
# port is the listening port for UI and api
# evcc will listen on all available interfaces
port: 7070

interval: 30s # control cycle interval. Interval <30s can lead to unexpected behavior, see https://docs.evcc.io/docs/reference/configuration/interval

# database configuration for persisting charge sessions and settings
# database:
# type: sqlite
# dsn: <path-to-db-file>

# sponsor token enables optional features (request at https://sponsor.evcc.io)
# sponsortoken:

# telemetry enables aggregated statistics
#
# Telemetry allows collecting usage data (grid and green energy, charge power).
# It can be enabled in the configuration section of the UI.


# log settings
log: info
levels:
site: debug
lp-1: debug
lp-2: debug
cache: error
db: error

# modbus proxy for allowing external programs to reuse the evcc modbus connection
# each entry will start a proxy instance at the given port speaking Modbus TCP and
# relaying to the given modbus downstream device (either TCP or RTU, RS485 or TCP)
modbusproxy:
# - port: 5200
# uri: solar-edge:502
# # rtu: true
# # readonly: true # use `deny` to raise modbus errors
Comment on lines +27 to +72
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Configuration template with demo entities (meters, chargers) ##
network:
# schema is the HTTP schema
# setting to `https` does not enable https, it only changes the way URLs are generated
schema: http
# host is the hostname or IP address
# if the host name contains a `.local` suffix, the name will be announced on MDNS
# docker: MDNS announcements don't work. host must be set to the docker host's name.
host: evcc.local
# port is the listening port for UI and api
# evcc will listen on all available interfaces
port: 7070
interval: 30s # control cycle interval. Interval <30s can lead to unexpected behavior, see https://docs.evcc.io/docs/reference/configuration/interval
# database configuration for persisting charge sessions and settings
# database:
# type: sqlite
# dsn: <path-to-db-file>
# sponsor token enables optional features (request at https://sponsor.evcc.io)
# sponsortoken:
# telemetry enables aggregated statistics
#
# Telemetry allows collecting usage data (grid and green energy, charge power).
# It can be enabled in the configuration section of the UI.
# log settings
log: info
levels:
site: debug
lp-1: debug
lp-2: debug
cache: error
db: error
# modbus proxy for allowing external programs to reuse the evcc modbus connection
# each entry will start a proxy instance at the given port speaking Modbus TCP and
# relaying to the given modbus downstream device (either TCP or RTU, RS485 or TCP)
modbusproxy:
# - port: 5200
# uri: solar-edge:502
# # rtu: true
# # readonly: true # use `deny` to raise modbus errors

Ich würd die Optionen bis hier hin alle rausnehmen. Das ist wieder viel kopierter Text, denn wir mühselig in-sync halten müssen. Hier gehts ja nicht um nen Referenz sondern um ne Mini-Config. Gleiches betrifft natürlich die englische Übersetzung.

Copy link
Author

Choose a reason for hiding this comment

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

Im Prinzip was es schon als Mini Template gedacht, um mit etwas beginnen zu können was ohne Fehlermeldung läuft. Wenn es nur eine Demo ist mit was soll ein Benutzer dann anfangen seine Konf zu erstellen? Ich würde immerhin die Network und Log settings drin lassen.


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

7 changes: 6 additions & 1 deletion docs/installation/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,12 @@ 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](../installation/configuration) zur Erstellung einer manuellen Konfiguration oder du benutzt den Konfigurations Assistenten.
lucode marked this conversation as resolved.
Show resolved Hide resolved

Für den Weg mit dem Konfigurations Assistenten 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)](../installation/configuration)

## 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
2 changes: 1 addition & 1 deletion docs/installation/manual.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
---

import Tabs from "@theme/Tabs";
Expand Down
36 changes: 36 additions & 0 deletions docs/installation/proxmox.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
sidebar_position: 8
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Screenshot from "../../src/components/Screenshot";

# Proxmox
lucode marked this conversation as resolved.
Show resolved Hide resolved

:::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.
:::
lucode marked this conversation as resolved.
Show resolved Hide resolved

## 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)

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.

Binary file not shown.
Binary file not shown.
26 changes: 0 additions & 26 deletions docs/integrations/home-assistant.md

This file was deleted.

Loading