Skip to content

Commit

Permalink
docosaurus upgrade, gh actions upgrade, fixed anchors (#552)
Browse files Browse the repository at this point in the history
  • Loading branch information
naltatis authored Apr 3, 2024
1 parent c905fa4 commit 5b50de1
Show file tree
Hide file tree
Showing 194 changed files with 4,510 additions and 9,347 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Build

on: [pull_request]

jobs:
checks:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Prepare
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install
run: npm ci
- name: Build
run: npm run build
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: documentation
name: Build and Deploy

on:
push:
Expand All @@ -9,11 +9,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Prepare
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 18
node-version: 20
cache: "npm"
- name: Install
run: npm ci
- name: Build
Expand Down
22 changes: 0 additions & 22 deletions .github/workflows/verify.yml

This file was deleted.

4 changes: 2 additions & 2 deletions blog/2021-12-12/version-0-73.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Heute gibt es ein kleines Update hauptsächlich mit einigen Fehlerkorrekturen un

Das Kommando zur geführten Erstellung einer Konfigurationsdatei und die darunterliegenden Templates hat folgende Verbesserungen erhalten:

- Bei einem Ladepunkt kann nun eingestellt werden, ob beim Abstecken des Ladekabels die Lade-Standardeinstellungen wieder hergestellt werden sollen. Mehr dazu in unserer Dokumentation unter [`resetOnDisconnect`](/docs/reference/configuration/loadpoints#resetondisconnect)
- Es können nun Fahrzeugspezifische Lade-Standardwerte eingerichtet werden. Interaktiv sind diese mit `evcc configure --advanced` verfügbar. Mehr dazu in der Dokumentation unter [`onIdentify`](/docs/reference/configuration/vehicles#onidentify)
- Bei einem Ladepunkt kann nun eingestellt werden, ob beim Abstecken des Ladekabels die Lade-Standardeinstellungen wieder hergestellt werden sollen. Mehr dazu in unserer Dokumentation unter `resetOnDisconnect`
- Es können nun Fahrzeugspezifische Lade-Standardwerte eingerichtet werden. Interaktiv sind diese mit `evcc configure --advanced` verfügbar. Mehr dazu in der Dokumentation unter `onIdentify`
- Geräte mit Modbus erzeugen nun korrekte Konfigurationen
- Verbesserter Umgang wenn eine `evcc.yaml` Datei bereits im aktuellen Ordner existiert aber andere Zugriffsrechte hat.

Expand Down
12 changes: 6 additions & 6 deletions blog/2023-10-05/feature-highlights-10-2023.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Seit einigen Releases ist der Algorithmus keine Blackbox, da wir das Planungserg
Zur Funktionsweise des Algorithmus:

1. Überschüssige Sonnenenergie wird priorisiert
2. Zeiten mit günstigem Netzstrom (wenn [dynamischer Stromtarif](/docs/reference/configuration/tariffs/#type-awattar) existiert)
3. Zeiten mit sauberem Netzstrom (wenn [CO₂-Schnittstelle](/docs/reference/configuration/tariffs/#co2) konfiguriert ist)
2. Zeiten mit günstigem Netzstrom (wenn [dynamischer Stromtarif](/docs/reference/configuration/tariffs#type-awattar) existiert)
3. Zeiten mit sauberem Netzstrom (wenn [CO₂-Schnittstelle](/docs/reference/configuration/tariffs#co2) konfiguriert ist)
4. Zeitfenster kurz vor Abfahrt

**Ausblick:** Aktuell experimentieren wir mit PV-Prognosedaten von [Solcast](https://solcast.com/).
Expand Down Expand Up @@ -73,12 +73,12 @@ Bei Awattar, Nordpool Estonia und Energinet kann man diese nun ergänzen.
## Batterieeinstellungen

Ein großer Vorteil den evcc gegenüber anderen Überschussladeregelungen hat, ist die Berücksichtigung des Hausakkus.
Über den Konfigurationswert [`prioritySoc`](/docs/reference/configuration/site/#prioritysoc) kann geregelt werden, ob überschüssige Sonnenenergie **zuerst in den Hausakku oder das Fahrzeug** geladen werden soll.
Über den Konfigurationswert [`prioritySoc`](/docs/reference/configuration/site#prioritysoc) kann geregelt werden, ob überschüssige Sonnenenergie **zuerst in den Hausakku oder das Fahrzeug** geladen werden soll.

Generell versucht evcc im PV-Modus das Umlanden von Hausakku in Fahrzeugakku zu verhindern, um unnötige Wechselverluste zu vermeiden.
Mit dem Wert [`bufferSoc`](/docs/reference/configuration/site/#buffersoc) kannst du jedoch bewusst **einen Anteil des Hausakkus zur Ladeunterstützung** freigeben.
Mit dem Wert [`bufferSoc`](/docs/reference/configuration/site#buffersoc) kannst du jedoch bewusst **einen Anteil des Hausakkus zur Ladeunterstützung** freigeben.

Zudem kannst du festlegen, dass der Ladevorgang **automatisch startet**, sobald der Akku einen bestimmten Ladestand überschritten wurde ([`bufferStartSoc`](/docs/reference/configuration/site/#bufferstartsoc)).
Zudem kannst du festlegen, dass der Ladevorgang **automatisch startet**, sobald der Akku einen bestimmten Ladestand überschritten wurde ([`bufferStartSoc`](/docs/reference/configuration/site#bufferstartsoc)).
Die Autoladung startet dann, auch wenn die Sonne nicht scheint.

<Video src={batterysettingsVideo} poster={batterysettingsPoster} />
Expand Down Expand Up @@ -115,7 +115,7 @@ Wer hier noch mehr Flexibilität braucht, kann natürlich auch auf den CSV-Expor

## Priorisierung von Ladepunkten und Fahrzeugen

Hast du mehrere Ladepunkte kannst du mit der [`priority`](/docs/reference/configuration/loadpoints/#priority) Einstellung festlegen, welcher bevorzugt werden soll.
Hast du mehrere Ladepunkte kannst du mit der [`priority`](/docs/reference/configuration/loadpoints#priority) Einstellung festlegen, welcher bevorzugt werden soll.
Die Priorisierung kannst du auch vom erkannten Fahrzeug abhängig machen oder per API steuern.
Eine Konfiguration über die UI gibt es aktuell noch nicht.

Expand Down
3 changes: 2 additions & 1 deletion docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,8 @@ evcc erkannt dieses Fehlverhalten aber und stoppt die Ladung nach kurzer Zeit.

### PV-Erzeugung im Winter nutzen

In den Wintermonaten ist die PV Erzeugung meisst unterhalb oder im Bereich der [Mindestleistung](#ich-habe-pv-überschuß-aber-das-auto-lädt-nicht). Um dennoch möglichst viel eigenen Strom ins Fahrzeug zu laden, kann man folgende "Tricks" anwenden:
In den Wintermonaten ist die PV Erzeugung meist unterhalb oder im Bereich der [Mindestleistung](/docs/features/solar-charging#wann-startet-die-ladung).
Um dennoch möglichst viel eigenen Strom ins Fahrzeug zu laden, kann man folgende "Tricks" anwenden:

#### mittels `residualpower`

Expand Down
2 changes: 1 addition & 1 deletion docs/features/co2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ tariffs:
```
In diesem Beispiel verwenden wir die Daten von [GrünstromIndex](https://www.gruenstromindex.de/).
Unter [tariffs](../reference/configuration/tariffs/#co2) findest du eine Liste aller unterstützten Datenquellen.
Unter [tariffs](../reference/configuration/tariffs#co2) findest du eine Liste aller unterstützten Datenquellen.
## Sauberes Netzladen
Expand Down
2 changes: 1 addition & 1 deletion docs/features/limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Wählst du beispielsweise ein Limit von 30 kWh aus, stoppt die Ladung, sobald di
/>

Standardmäßig kannst du einen Wert in 5 kWh Schritten bis 100 kWh auswählen.
Hast du die Akkukapazität deines Fahrzeugs in den [Fahrzeugeinstellungen](../reference/configuration/vehicles/#capacity) hinterlegt, werden die Schritte entsprechend angepasst.
Hast du die Akkukapazität deines Fahrzeugs in den [Fahrzeugeinstellungen](../reference/configuration/vehicles#capacity) hinterlegt, werden die Schritte entsprechend angepasst.
Zusätzlich siehst du, wie vielen Akku-Prozenten die ausgewählte Energiemenge entspricht.

Das eingestellte Energielimit gilt nur für den aktuellen Ladevorgang und wird beim Abstecken wieder entfernt.
Expand Down
2 changes: 1 addition & 1 deletion docs/features/vehicle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Abhängig vom Hersteller sind auch weitere Informationen wie Ladestatus, Fahrzeu
:::note Hinweis
Um den Fahrzeugakku zu schonen, aktualisiert evcc den Ladestand nur, wenn ein Fahrzeug am Ladepunkt angeschlossen ist.
Je nach Hersteller kann ein API-Zugriff zum Aufwecken des Fahrzeugs führen und den Standby-Verbrauch signifikant erhöhen.
Dieses Verhalten kannst du über den [`poll` Parameter](../reference/configuration/loadpoints/#poll) am Ladepunkt verändern.
Dieses Verhalten kannst du über den [`poll` Parameter](../reference/configuration/loadpoints#poll) am Ladepunkt verändern.
:::

## Mehrere Fahrzeuge
Expand Down
32 changes: 16 additions & 16 deletions docs/reference/configuration/messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,16 @@ Bei Nutzung der Variablen ist auf die korrekte Schreibweise (groß/klein) zu ach

**Nützliche Auswahl zur Nutzung in evcc Benachrichtungen**:

| msg Variable | Beschreibung |
| ------------------------ | -------------------------------------------------------------------------------------- |
| `${chargedEnergy:%.1fk}` | Geladene Energiemenge in kWh |
| `${chargeDuration}` | Dauer der Ladezeit |
| `${connectedDuration}` | Dauer der Wallbox Verbindung |
| `${loadpoint}` | Nummer des [`loadpoints`](loadpoints) (Ladepunkt) 1,2... |
| `${mode}` | Aktiver Lademodus (vgl. [`mode`](loadpoints/#mode) des [`loadpoints`](loadpoints)) |
| `${pvPower:%.1fk}` | Aktuell gemessene PV Leistung in kW |
| `${title}` | Ladepunkt: Text des [`loadpoints`](loadpoints) [`title`](loadpoints/#title) Parameters |
| `${vehicleTitle}` | Fahrzeug: Text des [`vehicles`](vehicles) [`title`](vehicles/#title) Parameters |
| msg Variable | Beschreibung |
| ------------------------ | ------------------------------------------------------------------------------------- |
| `${chargedEnergy:%.1fk}` | Geladene Energiemenge in kWh |
| `${chargeDuration}` | Dauer der Ladezeit |
| `${connectedDuration}` | Dauer der Wallbox Verbindung |
| `${loadpoint}` | Nummer des [`loadpoints`](loadpoints) (Ladepunkt) 1,2... |
| `${mode}` | Aktiver Lademodus (vgl. [`mode`](loadpoints#mode) des [`loadpoints`](loadpoints)) |
| `${pvPower:%.1fk}` | Aktuell gemessene PV Leistung in kW |
| `${title}` | Ladepunkt: Text des [`loadpoints`](loadpoints) [`title`](loadpoints#title) Parameters |
| `${vehicleTitle}` | Fahrzeug: Text des [`vehicles`](vehicles) [`title`](vehicles#title) Parameters |

**Beispiel**:

Expand Down Expand Up @@ -141,15 +141,15 @@ Die von evcc bereitgestellten Variablen (siehe auch /api/state) müssen als rege
- Site
- Konfiguration
- [`siteTitle`](site) - Hauptüberschrift der evcc App (_string_)
- [`prioritySoc`](site/#prioritysoc) - Mindest-Füllstand der Powerwall in Prozent, vor [PV mode](loadpoints/#mode) Freigabe (_integer_)
- [`prioritySoc`](site#prioritysoc) - Mindest-Füllstand der Powerwall in Prozent, vor [PV mode](loadpoints#mode) Freigabe (_integer_)
- Information
- `batteryConfigured` - Indikator, Hausbatterie/Powerwall-Meter konfiguriert (_bool_)
- `gridConfigured` - Indikator, Smart/Grid-Meter konfiguriert (_bool_)
- `pvConfigured` - Indikator, Solaranlagen/Photovoltaik-Meter konfiguriert (_bool_)
- Infos zum Stromtarif
- [`currency`](tariffs) - Tarif-Währung (_string_)
- [`tariffFeedIn`](tariffs/#feedin) - PV-Einspeisevergütung pro kWh in der Tarif-Währung (float)
- [`tariffGrid`](tariffs/#grid) - Netz-Abnahmepreis pro kWh in der Tarif-Währung (float)
- [`tariffFeedIn`](tariffs#feedin) - PV-Einspeisevergütung pro kWh in der Tarif-Währung (float)
- [`tariffGrid`](tariffs#grid) - Netz-Abnahmepreis pro kWh in der Tarif-Währung (float)
- Meter Infos
- `batteryPower` - Aktuelle Hausbatterie/Powerwall-Leistung in Watt (_float_)
- `batterySoc` - Aktueller Füllstand der Hausbatterie/Powerwall in Prozent (_integer_)
Expand All @@ -162,7 +162,7 @@ Die von evcc bereitgestellten Variablen (siehe auch /api/state) müssen als rege
- [`maxCurrent`](loadpoints#maxcurrent) - Maximale Lade-Stromstärke in Ampere (_float_)
- [`minCurrent`](loadpoints#mincurrent) - Minimale Lade-Stromstärke in Ampere (_float_)
- [`mode`](loadpoints#mode) - Initialer Modus des Ladepunktes nach evcc-Start `off`/`now`/`min`/`pv` (_string_)
- [`phases`](loadpoints/#phases) - Initial aktive Anzahl Stromphasen des Ladepunktes nach evcc-Start (_integer_)
- [`phases`](loadpoints#phases) - Initial aktive Anzahl Stromphasen des Ladepunktes nach evcc-Start (_integer_)
- [`title`](loadpoints#title) - Bezeichnung des Ladepunktes in der evcc App (_string_)
- Information
- `activePhases`- Aktuell aktive Anzahl Stromphasen des Ladepunktes (_integer_)
Expand All @@ -181,8 +181,8 @@ Die von evcc bereitgestellten Variablen (siehe auch /api/state) müssen als rege
- `pvRemaining` - Notwendige PV-Restladezeit bei aktivierter Timer Steuerung in Nanosekunden (_integer_)
- Fahrzeuge (vehicles)
- Konfiguration
- [`vehicleCapacity`](vehicles/#capacity)- Kapazität der Fahrzeugbatterie in Wh (_float_)
- [`vehicleTitle`](vehicles/#title) - Bezeichnung des Fahrzeugs in der evcc App (_string_)
- [`vehicleCapacity`](vehicles#capacity)- Kapazität der Fahrzeugbatterie in Wh (_float_)
- [`vehicleTitle`](vehicles#title) - Bezeichnung des Fahrzeugs in der evcc App (_string_)
- Information
- `climater` - Status der Fahrzeug-Klimatisierung `on`/`off`/`heating`/`cooling` (_string_)
- `connected` - Indikator, Fahrzeug am Ladepunkt angeschlossen (_bool_)
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/configuration/mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 14

Stellt die Konnektivität mit einem MQTT-Broker her.
Bei bestehender Verbindung pusht evcc automatisch alle internen Werte via MQTT-Broker auf das angegebene Topic und empfängt dort auch Änderungen.
Siehe dazu auch die Dokumentation zur [`MQTT API`](/docs/reference/api/#mqtt-api).
Siehe dazu auch die Dokumentation zur [`MQTT API`](/docs/reference/api#mqtt-api).

---

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/configuration/vehicles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Standardwerte die bei Erkennung des Fahrzeuges angewendet werden sollen:
- [`mode`](loadpoints#mode)
- [`minCurrent`](loadpoints#mincurrent)
- [`maxCurrent`](loadpoints#maxcurrent)
- [`priority`](https://docs.evcc.io/docs/reference/configuration/loadpoints/#priority)
- [`priority`](https://docs.evcc.io/docs/reference/configuration/loadpoints#priority)

:::

Expand Down
1 change: 1 addition & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { themes as prismThemes } from "prism-react-renderer";
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
onBrokenAnchors: "throw",
favicon: "img/favicon.ico",
organizationName: "evcc-io", // Usually your GitHub org/user name.
projectName: "docs", // Usually your repo name.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Since a few releases the algorithm is no longer a black box, as we visualize the
How does the algorithm work?

5. Surplus solar energy is prioritized
6. Times with cheap grid electricity (if [dynamic electricity tariff](/docs/reference/configuration/tariffs/#type-awattar) exists)
7. Times with clean grid electricity (if [CO₂ interface](/docs/reference/configuration/tariffs/#co2) is configured)
6. Times with cheap grid electricity (if [dynamic electricity tariff](/docs/reference/configuration/tariffs#type-awattar) exists)
7. Times with clean grid electricity (if [CO₂ interface](/docs/reference/configuration/tariffs#co2) is configured)
8. Time windows shortly before departure

**Outlook:** We are currently experimenting with PV forecast data from [Solcast](https://solcast.com/).
Expand Down Expand Up @@ -73,12 +73,12 @@ By the way: If you have a dynamic electricity tariff that is not yet supported,
## Battery settings

A huge advantage that evcc has over other surplus charging solutions is the integration with the home battery.
The configuration value [`prioritySoc`](/docs/reference/configuration/site/#prioritysoc) can be used to control whether surplus solar energy should be **charged into the home battery or the vehicle** first.
The configuration value [`prioritySoc`](/docs/reference/configuration/site#prioritysoc) can be used to control whether surplus solar energy should be **charged into the home battery or the vehicle** first.

In general, evcc tries to prevent the home battery from being unloaded into the vehicle battery in PV mode in order to avoid unnecessary conversion losses.
However, with the value [`bufferSoc`](/docs/reference/configuration/site/#buffersoc) you can consciously **dedicate a portion of the home battery to support charging**.
However, with the value [`bufferSoc`](/docs/reference/configuration/site#buffersoc) you can consciously **dedicate a portion of the home battery to support charging**.

You can also set the charging process to start automatically as soon as the battery has reached a certain state of charge ([`bufferStartSoc`](/docs/reference/configuration/site/#bufferstartsoc)).
You can also set the charging process to start automatically as soon as the battery has reached a certain state of charge ([`bufferStartSoc`](/docs/reference/configuration/site#bufferstartsoc)).
The automatic charging starts even if the sun is not shining.

<Video src={batterysettingsVideo} poster={batterysettingsPoster} />
Expand Down Expand Up @@ -115,7 +115,7 @@ If you need even more flexibility here, you can of course also use the CSV expor

## Prioritization of charging points and vehicles

If you have multiple charging points, you can use the [`priority`](/docs/reference/configuration/loadpoints/#priority) setting to specify which one should be preferred.
If you have multiple charging points, you can use the [`priority`](/docs/reference/configuration/loadpoints#priority) setting to specify which one should be preferred.
You can also make the prioritization dependent on the detected vehicle or control it via API.
There is currently no configuration via the UI.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ If your inverter supports this feature, a corresponding option will appear in th

When this option is active, the house battery is put into a lock mode during fast charging.
In this time it is neither discharged nor charged.
This lock is also active during [scheduled charging](/blog/2023/10/05/feature-highlights-10-2023#visualisierung-ladeplanung) and [smart grid charging](/blog/2023/10/05/feature-highlights-10-2023#smartes-netzladen).
This lock is also active during [scheduled charging](/blog/2023/10/05/feature-highlights-10-2023#charging-planner-visualization) and [smart grid charging](/blog/2023/10/05/feature-highlights-10-2023#smart-grid-charging).

### Next step: Charging the battery with cheap grid power

Expand Down
2 changes: 1 addition & 1 deletion i18n/en/docusaurus-plugin-content-docs/current/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Some chargers start charging as soon as the car is plugged in, or when an RFID c

### Solar Production in Winter

In the Winter months, solar production is often regularly below the configured minimum.
In the winter months, solar production is often regularly below the configured minimum.
In order to get as much energy into the Vehicle as possible, you can try some of the following tips and tricks:

#### Using `residualpower`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ tariffs:
zip: 12349 # ZIP code
```
In this example, we'll use data from GrünstromIndex. See tariffs for a list of all [supported data sources](../reference/configuration/tariffs/#co2).
In this example, we'll use data from GrünstromIndex. See tariffs for a list of all [supported data sources](../reference/configuration/tariffs#co2).
## Clean web charging
Expand Down
Loading

0 comments on commit 5b50de1

Please sign in to comment.