Skip to content

Commit 08eced5

Browse files
committed
Merge branch 'main' of github.com:evcc-io/docs
2 parents 140346b + d836819 commit 08eced5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+513
-107
lines changed

docs/devices/plugins.mdx

Lines changed: 115 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -155,25 +155,63 @@ Neben den Attributen, die Plugins zur lesenden Auswertung bereitstellen, werden
155155
| limitsoc | int | nein | `battery` | Setze Ladeziel für Batterie in %. Das Ladeziel wird aus den konfigurierten `MinSoc`, `MaxSoc` und dem aktuellen Ladestand (Attribut `soc`) berechnet. |
156156
| batterymode | int | nein | `battery` | Setze Lademodus direkt (1: normal, 2: hold, 3: charge) |
157157

158-
### Charger
158+
### Charger {#charger}
159159

160160
Wallboxen und Ladegeräte haben folgende Attribute die ausgelesen werden können:
161161

162-
| Attribut | Typ | Erfordert | Beschreibung |
163-
| --------- | ------------------- | --------- | ----------------------------------- |
164-
| status | string | ja | Status (A..F) |
165-
| enabled | bool | ja | Ist Ladung freigegeben? |
166-
| power | float | nein | Ladeleistung in W |
167-
| energy | float | nein | Zählerstand in kWh |
168-
| identify | string | nein | Aktuelle RFID-Kennung |
169-
| soc | int | nein | Ladestand in % |
170-
| phases | int | nein | Anzahl der physischen Phasen (1..3) |
171-
| powers | [float,float,float] | nein | Phasenleistungen in W |
172-
| currents | [float,float,float] | nein | Phasenströme in A |
173-
| voltages | [float,float,float] | nein | Phasenspannungen in V |
174-
| temp | float | nein | Aktuelle Temperatur in °C (Heizung) |
175-
| templimit | int | nein | Temperaturlimit in °C (Heizung) |
176-
| getmode | int | nein | SG-Ready Modus (Wärmepumpe) |
162+
| Attribut | Typ | Erfordert | Beschreibung |
163+
| ----------- | ------------------- | --------- | ------------------------------------ |
164+
| status | string | ja | Status (A..F) |
165+
| enabled | bool | ja | Ist Ladung freigegeben? |
166+
| power | float | nein | Ladeleistung in W |
167+
| energy | float | nein | Zählerstand in kWh |
168+
| identify | string | nein | Aktuelle RFID-Kennung |
169+
| soc | int | nein | Ladestand in % |
170+
| phases | int | nein | Anzahl der physischen Phasen (1..3) |
171+
| powers | [float,float,float] | nein | Phasenleistungen in W |
172+
| currents | [float,float,float] | nein | Phasenströme in A |
173+
| voltages | [float,float,float] | nein | Phasenspannungen in V |
174+
| temp | float | nein | Aktuelle Temperatur in °C (Heizung) |
175+
| templimit | int | nein | Temperaturlimit in °C (Heizung) |
176+
| getmode | int | nein | SG-Ready Modus (Wärmepumpe) |
177+
| getmaxpower | float | nein | Maximale Heizleistung in W (Heizung) |
178+
179+
#### Allgemeine Konfigurationsoptionen {#charger-config}
180+
181+
Zusätzlich zu den Plugin-Attributen können folgende Konfigurationsoptionen direkt am Charger gesetzt werden:
182+
183+
| Attribut | Typ | Erfordert | Beschreibung |
184+
| ------------ | -------- | --------- | --------------------------------------------------------------- |
185+
| icon | string | nein | Icon für die Darstellung in der Benutzeroberfläche |
186+
| features | []string | nein | Feature-Flags für spezielle Charger-Eigenschaften (siehe unten) |
187+
| standbypower | int | nein | Standby-Leistung in W (für `switchsocket` Typ) |
188+
189+
##### Feature-Flags {#charger-features}
190+
191+
Über das `features` Array können spezielle Eigenschaften des Chargers aktiviert werden:
192+
193+
| Feature | Beschreibung |
194+
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
195+
| heating | Behandelt das Gerät als Heizung (z. B. Wärmepumpe, Heizstab). Beeinflusst die Darstellung in der Benutzeroberfläche. |
196+
| integrateddevice | Gerät ohne Ladesitzungen und ohne angeschlossenes Fahrzeug (z. B. Smartes Schalter, fest installierte Verbraucher). |
197+
| coarsecurrent | Ladestrom kann nur in 1 A Schritten eingestellt werden (wird in der Regelung berücksichtigt). |
198+
| welcomecharge | Aktiviert Welcome Charge Funktion. Ladegerät liefert beim Anschließen kurz Strom, damit das Fahrzeug erkennt, dass der Charger funktioniert. |
199+
200+
**Beispiel mit Features**:
201+
202+
```yaml
203+
chargers:
204+
- name: heizstab
205+
type: custom
206+
features:
207+
- heating
208+
- integrateddevice
209+
icon: heater
210+
status:
211+
source: mqtt
212+
topic: heater/status
213+
# ... weitere Attribute
214+
```
177215

178216
**Beispiel**
179217

@@ -204,6 +242,7 @@ Neben den read-only Werten können über Plugins auch Aktionen getriggert oder K
204242
| phases1p3p | int | nein | Phasenumschaltung durchführen (erfordert `tos: true`) |
205243
| wakeup | bool | nein | Wecke Fahrzeug auf |
206244
| setmode | int | nein | Ändere SG-Ready Modus (1: reduced, 2: normal, 3: boost) |
245+
| setmaxpower | int | nein | Setze maximale Heizleistung in W (Heizung) |
207246

208247
**Beispiel**
209248

@@ -220,7 +259,7 @@ chargers:
220259
payload: ON
221260
```
222261

223-
### Vehicle
262+
### Vehicle {#vehicle}
224263

225264
Fahrzeugparameter können ebenfalls über Plugins ausgelesen werden.
226265

@@ -235,14 +274,26 @@ Fahrzeugparameter können ebenfalls über Plugins ausgelesen werden.
235274
| getmaxcurrent | float | nein | Maximaler Ladestrom in A |
236275
| finishtime | string | nein | Geplantes Ladeende (RFC3339) |
237276

277+
#### Allgemeine Konfigurationsoptionen {#vehicle-config}
278+
279+
Folgende Konfigurationsoptionen können direkt am Fahrzeug gesetzt werden:
280+
281+
| Attribut | Typ | Erfordert | Beschreibung |
282+
| -------- | ------ | --------- | --------------------------------------------------- |
283+
| title | string | nein | Anzeigename des Fahrzeugs in der Benutzeroberfläche |
284+
| icon | string | nein | Icon für die Darstellung in der Benutzeroberfläche |
285+
| capacity | float | nein | Batteriekapazität in kWh |
286+
238287
**Beispiel**
239288

240289
Im folgenden Beispiel wird die aktuelle Reichweite des Fahrzeugs aus MQTT Nachrichten gelesen:
241290

242291
```yaml
243292
vehicles:
244-
- name: Mazda
293+
- name: mazda
245294
type: custom
295+
title: Grüner Mazda
296+
capacity: 50
246297
range:
247298
source: mqtt
248299
topic: mazda2mqtt/c53/chargeInfo/drivingRangeKm
@@ -353,6 +404,51 @@ Der volle Funktionsumfang ist in der [offiziellen jq Dokumentation](https://jqla
353404
Methoden der Authentifizierung sind `basic`, `bearer` und `digest`.
354405
Die Namen der jeweiligen Parameter finden sich [hier](https://github.com/evcc-io/evcc/blob/master/plugin/http_auth.go#L23).
355406

407+
#### Authentifizierung {#http-auth}
408+
409+
Für HTTP-Anfragen stehen verschiedene Authentifizierungsmethoden zur Verfügung:
410+
411+
**Basic Authentication**:
412+
413+
```yaml
414+
auth:
415+
type: basic
416+
user: <benutzername>
417+
password: <passwort>
418+
```
419+
420+
**Bearer Token** (z. B. für JWT):
421+
422+
```yaml
423+
auth:
424+
type: bearer
425+
token: <token>
426+
```
427+
428+
**Digest Authentication**:
429+
430+
```yaml
431+
auth:
432+
type: digest
433+
user: <benutzername>
434+
password: <passwort>
435+
```
436+
437+
**Benutzerdefinierte Authentifizierung**:
438+
439+
Für komplexere Authentifizierungsszenarien können benutzerdefinierte Authentifizierungs-Plugins entwickelt werden.
440+
Diese werden über den Parameter `source` eingebunden:
441+
442+
```yaml
443+
auth:
444+
source: <plugin-name>
445+
user: <benutzername>
446+
password: <passwort>
447+
# weitere plugin-spezifische Parameter
448+
```
449+
450+
Dies ermöglicht die Integration von Geräten mit speziellen Authentifizierungsanforderungen, ohne den gesamten HTTP-Plugin-Code anpassen zu müssen.
451+
356452
:::important Wichtig
357453
XML-Dokumente werden intern automatisch in JSON-Form überführt, welche dann mit jq wie eine native JSON-Antwort weiter gefiltert werden können.
358454
Attribute bekommen das prefix `attr`.
@@ -378,8 +474,7 @@ insecure: false # set to true to trust self-signed certificates
378474
jq: .data.tuples[0][1] # parse response json
379475
scale: 0.001 # factor applied to result, e.g. for kW to W conversion
380476
cache: 60s # response cache duration
381-
timeout: 10s # timeout in golang duration format,
382-
# see https://golang.org/pkg/time/#ParseDuration
477+
timeout: 10s # timeout in golang duration format, see https://golang.org/pkg/time/#ParseDuration
383478
```
384479

385480
```yaml

docs/faq.mdx

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,44 @@ EVCC_DATABASE_DSN=/var/lib/evcc/evcc.db evcc password reset
259259
service evcc start
260260
```
261261

262+
### Wie kann ich meine Konfiguration sichern und wiederherstellen? {#backup-restore}
263+
264+
In der evcc UI findest du unter **Einstellungen** → **Experimentell aktivieren** → **Sichern & Wiederherstellen** folgende Optionen:
265+
266+
**Sichern:**
267+
Lädt eine Kopie deiner Datenbank (evcc.db) herunter.
268+
Diese enthält alle konfigurierten Geräte, Dienste, Pläne, Ladevorgänge, usw.
269+
270+
**Wiederherstellen:**
271+
Stellt eine zuvor heruntergeladene Datenbank wieder her.
272+
Vor dem Überschreiben wird automatisch eine lokale Sicherung (`evcc.db.bak`) angelegt.
273+
274+
:::warning Achtung
275+
Alle Aktionen sind passwortgeschützt.
276+
Beim Wiederherstellen werden die aktuellen Daten komplett überschrieben.
277+
:::
278+
279+
**Zurücksetzen:**
280+
Du kannst einzelne Bereiche deiner Datenbank löschen:
281+
282+
- **Ladevorgänge:** Löscht den Verlauf deiner Ladevorgänge.
283+
- **Konfiguration & Einstellungen:** Löscht alle konfigurierten Geräte, Dienste, Pläne, Caches, usw.
284+
285+
:::warning Achtung
286+
Nach dem Zurücksetzen der Konfiguration musst du alle Geräte neu konfigurieren.
287+
Deine `evcc.yaml` bleibt dabei unverändert.
288+
:::
289+
290+
Alternativ kannst du einzelne Caches über die Kommandozeile löschen:
291+
292+
```bash
293+
# Alle Caches ansehen
294+
evcc cache get
295+
296+
# Alle Caches löschen
297+
evcc cache clear
298+
```
299+
262300
## PV Vorhersage {#pv-vorhersage}
263301

264302
Du kannst in evcc verschiedene [PV-Vorhersagen](/docs/tariffs#pv-vorhersage) nutzen, um die geschätzte Restproduktion für den aktuellen Tag und die nächsten Tage zu sehen.

docs/features/loadmanagement.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,16 @@ Für die Umsetzung von Regelanweisungen durch den Netzbetreiber kann der HEMS-Me
140140
Weitere Informationen findest du unter [§ 14a EnWG & SteuVE](./14a-enwg-steuve).
141141
:::
142142

143+
## Phasenumschaltung
144+
145+
Hast du eine Wallbox mit automatischer Phasenumschaltung (1P/3P), nutzt evcc diese, um die Grenzwerte einzuhalten.
146+
Reicht die verfügbare Leistung nicht für 3-phasiges Laden, schaltet evcc automatisch auf 1-phasig um.
147+
148+
Dies gilt auch für Schnellladen und planbasiertes Laden.
149+
Wenn z. B. durch Lastmanagement nur noch 3,5 kW verfügbar sind, wird auf 1-phasiges Laden (ab 1,4 kW) umgeschaltet, statt die Ladung zu pausieren.
150+
151+
**Voraussetzung:** Die Wallbox muss Phasenumschaltung unterstützen.
152+
143153
## Einschränkungen
144154

145155
:::info
@@ -149,4 +159,3 @@ Private Nutzung mit kleineren Installationen wird kostenlos bleiben.
149159

150160
- Die aktuellen Werte und Grenzen der einzelnen Schaltkreise werden auf der Konfigurationsseite im UI angezeigt. Die Visualisierung am Ladepunkt ist in Planung.
151161
- `priority` Einstellungen am Ladepunkt werden noch nicht berücksichtigt.
152-
- Lastmanagement wird nicht durch die Ladeplanung berücksichtigt.

docs/features/sessions.mdx

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,17 @@ Wurde ein Fahrzeug nicht korrekt erkannt, kannst du in dieser Ansicht auch die F
8787
caption="Detailansicht eines Ladevorgangs"
8888
/>
8989

90-
## Schaltbare Steckdosen
90+
## Schaltbare Steckdosen und Wärmeerzeugung
9191

92-
Im Gegensatz zu Wallboxen gibt es bei schaltbaren Steckdosen (z. B. Schuko-Ladegerät, E-Bike, ...) oder fest verkabelten Anlagen (z. B. Wärmepumpe, Heizstab, ...) keine Möglichkeit, den Ladevorgang zu erkennen.
93-
Diese Verbraucher tauchen aktuell trotzdem in der Liste der Ladevorgänge mit langen Zeiträumen auf.
94-
Wird evcc neu gestartet, wird ein neuer Ladevorgang protokolliert.
95-
Dies kann auch über aktives Stoppen und Starten am Ladepunkt (Modus: aus) manuell erfolgen.
92+
Im Gegensatz zu Wallboxen gibt es bei schaltbaren Steckdosen (z. B. Schuko-Ladegerät, E-Bike, ...) oder Wärmeerzeugern (z. B. Wärmepumpe, Heizstab, ...) keine Möglichkeit, den Ladevorgang zu erkennen.
93+
94+
### Heizungsanlagen
95+
96+
Für Heizungsanlagen (Wärmepumpen, Heizstäbe, etc.) werden Ladevorgänge täglich um Mitternacht automatisch zurückgesetzt.
97+
Dadurch werden die Messwerte für jeden Tag neu erfasst und die Liste der Ladevorgänge bleibt übersichtlich.
9698

97-
Die momentane Lösung ist für diese Fälle nicht optimal.
98-
In einem zukünftigen Release werden wir die Auswertung für Schaltsteckdosen und fest verkabelte Anlagen verbessern.
99+
### Schaltbare Steckdosen
100+
101+
Für schaltbare Steckdosen werden Ladevorgänge mit langen Zeiträumen protokolliert.
102+
Wird evcc neu gestartet, wird ein neuer Ladevorgang begonnen.
103+
Dies kann auch über aktives Stoppen und Starten am Ladepunkt (Modus: aus) manuell erfolgen.

docs/reference/cli/evcc.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@ evcc [flags]
2222
--metrics Expose metrics
2323
--profile Expose pprof profiles
2424
--template string Add custom template file (debug only)
25-
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
25+
--template-type string Custom template type (charger, meter, tariff, vehicle) (debug only)
2626
```
2727

2828
## See also
2929

30+
* [evcc cache](evcc_cache.md) - Manage cache entries
3031
* [evcc charger](evcc_charger.md) - Query configured chargers
3132
* [evcc checkconfig](evcc_checkconfig.md) - Check config file for errors
3233
* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell

docs/reference/cli/evcc_cache.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# evcc cache
2+
3+
Manage cache entries
4+
5+
## Options inherited from parent commands
6+
7+
```
8+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
9+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
10+
--database string Database location (default "~/.evcc/evcc.db")
11+
--demo Enter demo mode. Disables auth, config ui and restart
12+
-h, --help Help
13+
--ignore-db Run command ignoring service database
14+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
15+
--log-headers Log headers
16+
--template string Add custom template file (debug only)
17+
--template-type string Custom template type (charger, meter, tariff, vehicle) (debug only)
18+
```
19+
20+
## See also
21+
22+
* [evcc](evcc.md) - evcc - open source solar charging
23+
* [evcc cache clear](evcc_cache_clear.md) - Clear all cache entries
24+
* [evcc cache get](evcc_cache_get.md) - Get cache entries
25+
26+
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# evcc cache clear
2+
3+
Clear all cache entries
4+
5+
```
6+
evcc cache clear [flags]
7+
```
8+
9+
## Options
10+
11+
```
12+
-f, --force Force (no confirmation)
13+
```
14+
15+
## Options inherited from parent commands
16+
17+
```
18+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
19+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
20+
--database string Database location (default "~/.evcc/evcc.db")
21+
--demo Enter demo mode. Disables auth, config ui and restart
22+
-h, --help Help
23+
--ignore-db Run command ignoring service database
24+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
25+
--log-headers Log headers
26+
--template string Add custom template file (debug only)
27+
--template-type string Custom template type (charger, meter, tariff, vehicle) (debug only)
28+
```
29+
30+
## See also
31+
32+
* [evcc cache](evcc_cache.md) - Manage cache entries
33+
34+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# evcc cache get
2+
3+
Get cache entries
4+
5+
```
6+
evcc cache get [flags]
7+
```
8+
9+
## Options inherited from parent commands
10+
11+
```
12+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
13+
--custom-css string Additional user-defined CSS file for custom styling. No compatibility guarantees.
14+
--database string Database location (default "~/.evcc/evcc.db")
15+
--demo Enter demo mode. Disables auth, config ui and restart
16+
-h, --help Help
17+
--ignore-db Run command ignoring service database
18+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
19+
--log-headers Log headers
20+
--template string Add custom template file (debug only)
21+
--template-type string Custom template type (charger, meter, tariff, vehicle) (debug only)
22+
```
23+
24+
## See also
25+
26+
* [evcc cache](evcc_cache.md) - Manage cache entries
27+
28+

0 commit comments

Comments
 (0)