From 4f9d3574b997b0da4cb9f1ea0a1e91579718d3c6 Mon Sep 17 00:00:00 2001
From: heatpumper <125735459+heatpumper@users.noreply.github.com>
Date: Thu, 24 Oct 2024 23:42:32 +0200
Subject: [PATCH] Add Batterie Boost to documentation (#643)
---
docs/features/battery.mdx | 21 ++++++++++++++++++
...ark-1x.webp => battery-boost-dark-1x.webp} | Bin
...ark-2x.webp => battery-boost-dark-2x.webp} | Bin
...ht-1x.webp => battery-boost-light-1x.webp} | Bin
...ht-2x.webp => battery-boost-light-2x.webp} | Bin
docs/integrations/mqtt-api.md | 1 +
docs/integrations/rest-api.md | 1 +
.../current/features/battery.mdx | 20 +++++++++++++++++
...ark-1x.webp => battery-boost-dark-1x.webp} | Bin
...ark-2x.webp => battery-boost-dark-2x.webp} | Bin
...ht-1x.webp => battery-boost-light-1x.webp} | Bin
...ht-2x.webp => battery-boost-light-2x.webp} | Bin
.../recipes/batterie-boost.spec.js | 2 +-
13 files changed, 44 insertions(+), 1 deletion(-)
rename docs/features/screenshots/{batterie-boost-dark-1x.webp => battery-boost-dark-1x.webp} (100%)
rename docs/features/screenshots/{batterie-boost-dark-2x.webp => battery-boost-dark-2x.webp} (100%)
rename docs/features/screenshots/{batterie-boost-light-1x.webp => battery-boost-light-1x.webp} (100%)
rename docs/features/screenshots/{batterie-boost-light-2x.webp => battery-boost-light-2x.webp} (100%)
rename i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/{batterie-boost-dark-1x.webp => battery-boost-dark-1x.webp} (100%)
rename i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/{batterie-boost-dark-2x.webp => battery-boost-dark-2x.webp} (100%)
rename i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/{batterie-boost-light-1x.webp => battery-boost-light-1x.webp} (100%)
rename i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/{batterie-boost-light-2x.webp => battery-boost-light-2x.webp} (100%)
diff --git a/docs/features/battery.mdx b/docs/features/battery.mdx
index ba6cdb10a..44f732096 100644
--- a/docs/features/battery.mdx
+++ b/docs/features/battery.mdx
@@ -79,6 +79,27 @@ Wie auch im vorherigen Beispiel endet die Ladung, wenn der Ladestand des Hausspe
caption="Automatischer Start"
/>
+## Batterie Boost
+
+:::warning Experimentell
+Batterie Boost befindet sich gerade noch in der Erprobungsphase.
+:::
+
+Durch den Batterie Boost wird der PV-Modus maximal durch die Hausbatterie unterstützt.
+Zusätzlich zu der Leistung aus der PV-Anlage wird die maximal mögliche Leistung aus der Batterie gezogen.
+Das Boostverhalten endet, wenn das Auto abgesteckt wird oder der Modus umgeschaltet wird.
+
+Der Batterie Boost kann in den Einstellungen des Ladepunktes aktiviert werden:
+
+
+
+Beispiel:
+Dies ist nützlich, wenn das Fahrzeug in Kürze die Ladestation verlassen wird, in den kommenden Stunden aber viel Sonnenüberschuss verfügbar sein wird.
+So kann kurz vor der Abfahrt noch Energie aus der Hausbatterie ins Fahrzeug geladen werden und die Hausbatterie lädt sich danach wieder auf.
+
## Mehrere Batterien
Natürlich kannst du in evcc auch mehrere Batterien konfigurieren.
diff --git a/docs/features/screenshots/batterie-boost-dark-1x.webp b/docs/features/screenshots/battery-boost-dark-1x.webp
similarity index 100%
rename from docs/features/screenshots/batterie-boost-dark-1x.webp
rename to docs/features/screenshots/battery-boost-dark-1x.webp
diff --git a/docs/features/screenshots/batterie-boost-dark-2x.webp b/docs/features/screenshots/battery-boost-dark-2x.webp
similarity index 100%
rename from docs/features/screenshots/batterie-boost-dark-2x.webp
rename to docs/features/screenshots/battery-boost-dark-2x.webp
diff --git a/docs/features/screenshots/batterie-boost-light-1x.webp b/docs/features/screenshots/battery-boost-light-1x.webp
similarity index 100%
rename from docs/features/screenshots/batterie-boost-light-1x.webp
rename to docs/features/screenshots/battery-boost-light-1x.webp
diff --git a/docs/features/screenshots/batterie-boost-light-2x.webp b/docs/features/screenshots/battery-boost-light-2x.webp
similarity index 100%
rename from docs/features/screenshots/batterie-boost-light-2x.webp
rename to docs/features/screenshots/battery-boost-light-2x.webp
diff --git a/docs/integrations/mqtt-api.md b/docs/integrations/mqtt-api.md
index 5d42f17b6..4f46672b7 100644
--- a/docs/integrations/mqtt-api.md
+++ b/docs/integrations/mqtt-api.md
@@ -44,6 +44,7 @@ Alle API IDs (z.B. die Loadpoint ID) beginnen bei `1`.
- `evcc/loadpoints//maxCurrent`: current maxCurrent value (writable)
- `evcc/loadpoints//enableThreshold`: threshold value (writable)
- `evcc/loadpoints//disableThreshold`: threshold value (writable)
+- `evcc/loadpoints//batteryboost`: battery boost enabled (writeable: [1/0])
:::note
Um schreibbare Einstellungen durchzuführen, muss ein `/set` am Ende des Topics hinzugefügt werden an welches der neue Wert gesendet wird.
diff --git a/docs/integrations/rest-api.md b/docs/integrations/rest-api.md
index 43caddebc..d0b8a0acd 100644
--- a/docs/integrations/rest-api.md
+++ b/docs/integrations/rest-api.md
@@ -50,6 +50,7 @@ Alle API IDs (z.B. die Loadpoint ID) beginnen bei `1`.
- `POST /api/loadpoints//vehicle/`: set currently selected vehicle
- `DELETE /api/loadpoints//vehicle`: remove vehicle
- `PATCH /api/loadpoints//vehicle`: start vehicle detection
+- `POST /api/loadpoints//batteryboost/`: enable/disable battery boost (1/0)
:::note
Beispiel: `curl -X POST http://evcc:7070/api/loadpoints/1/mode/pv` um den Lademodus des 1. Ladepunkts auf `pv` zu stellen.
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/features/battery.mdx b/i18n/en/docusaurus-plugin-content-docs/current/features/battery.mdx
index b421f47b2..c2dd2174a 100644
--- a/i18n/en/docusaurus-plugin-content-docs/current/features/battery.mdx
+++ b/i18n/en/docusaurus-plugin-content-docs/current/features/battery.mdx
@@ -78,6 +78,26 @@ As in the previous example, the charging ends when the charge level of the home
caption="Automatic Start"
/>
+## Battery Boost
+
+:::warning Experimental
+Battery Boost is still in the validation phase.
+:::
+
+The battery boost supports the solar mode with power from the home storage.
+In addition to the power available from the photovoltaic system the maximum available power from the home storage is used.
+The boosting behavior ends when the car is unplugged or the mode is changed.
+The battery boost can be activated in the options of the charging point.
+
+
+
+Example:
+This is useful if the car leaves the charging station in near future and there will be an excess of solar power in the upcoming hours.
+In doing so the energy in the car is maximised, while the home storage will recharge while the car is away.
+
## Multiple batteries
Of course, you can also configure multiple batteries in evcc.
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/batterie-boost-dark-1x.webp b/i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/battery-boost-dark-1x.webp
similarity index 100%
rename from i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/batterie-boost-dark-1x.webp
rename to i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/battery-boost-dark-1x.webp
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/batterie-boost-dark-2x.webp b/i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/battery-boost-dark-2x.webp
similarity index 100%
rename from i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/batterie-boost-dark-2x.webp
rename to i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/battery-boost-dark-2x.webp
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/batterie-boost-light-1x.webp b/i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/battery-boost-light-1x.webp
similarity index 100%
rename from i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/batterie-boost-light-1x.webp
rename to i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/battery-boost-light-1x.webp
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/batterie-boost-light-2x.webp b/i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/battery-boost-light-2x.webp
similarity index 100%
rename from i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/batterie-boost-light-2x.webp
rename to i18n/en/docusaurus-plugin-content-docs/current/features/screenshots/battery-boost-light-2x.webp
diff --git a/screenshot-generator/recipes/batterie-boost.spec.js b/screenshot-generator/recipes/batterie-boost.spec.js
index d33780033..7ddd2c50d 100644
--- a/screenshot-generator/recipes/batterie-boost.spec.js
+++ b/screenshot-generator/recipes/batterie-boost.spec.js
@@ -29,7 +29,7 @@ loop((screenshot) => {
await screenshot(
page,
- `${BASE_PATH}/batterie-boost`,
+ `${BASE_PATH}/battery-boost`,
"#loadpointSettingsModal_1 .modal-content",
{
all: 20,