Add content

README.md

@@ -1 +1,3 @@
 # Docs
+
+Bitte gehen Sie weiter, hier gibt es (noch) nichts zu sehen.

_config.yml

@@ -1,8 +1,29 @@
-title: Just the Docs Template
-description: A starter template for a Jeykll site using the Just the Docs theme!
+title: Dokumentation
+description: Dokumentation für SOLECTRUS
 theme: just-the-docs
 
-url: https://just-the-docs.github.io
+url: https://docs.solectrus.de
 
 aux_links:
-  Template Repository: https://github.com/just-the-docs/just-the-docs-template
+  SOLECTRUS: https:/solectrus.de
+
+gh_edit_link: true # show or hide edit this page link
+gh_edit_link_text: 'Diese Seite auf GitHub bearbeiten.'
+gh_edit_repository: 'https://github.com/solectrus/docs' # the github URL for your repo
+gh_edit_branch: "main" # the branch that your docs is served from
+# gh_edit_source: docs # the source that your files originate from
+gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+callouts:
+  warning:
+    title: Warnung
+    color: red
+
+  note:
+    title: Hinweis
+    color: green
+
+mermaid:
+  # Version of mermaid library
+  # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
+  version: "11.2.1"

_includes/nav_footer_custom.html

@@ -0,0 +1,3 @@
+<footer class="site-footer">
+    Diese Dokumentation ist <a href="https://github.com/solectrus/docs">Open-Source</a>, Mitwirkung ist erwünscht.
+</footer>

_includes/search_placeholder_custom.html

@@ -0,0 +1 @@
+Suchen

_includes/toc_heading_custom.html

@@ -0,0 +1 @@
+<h2 class="text-delta">Inhalt</h2>

benutzung/administrator.md

@@ -0,0 +1,31 @@
+---
+title: Administrator-Zugang
+layout: page
+parent: Benutzung
+---
+
+Der Administrator-Zugang gewährleistet, dass nur autorisierte Benutzer bestimmte kritische Funktionen von SOLECTRUS ausführen können. Zu den gegenwärtig geschützten Funktionen gehören:
+
+- Festlegung der Strompreise, der Einspeisevergütung und weiterer Optionen
+- Durchführung der Registrierung
+
+Ohne vorherigen Admin-Login hat ein Benutzer nur Lesezugriff und kann dementsprechend keine Einstellungen ändern.
+
+<img src="/assets/images/login.png" alt="Login" class="mx-auto w-full max-w-2xl rounded-full border-8 border-indigo-300" />
+
+Übrigens: Wie du hier sehen kannst, ist es wirklich nur ein Passwort. Aus Gründen der Einfachheit gibt es keinen Benutzernamen oder E-Mail-Adresse.
+
+Diese Funktion ist besonders nützlich, wenn deine Installation von SOLECTRUS von mehreren Benutzern genutzt wird, insbesondere wenn sie über das Internet zugänglich ist. Als Administrator kannst du sicherstellen, dass niemand außer dir die Einstellungen ändert.
+
+### Festlegen und Ändern des Passwortes
+
+Das Passwort für den Administrator-Zugang wird während der Installation von SOLECTRUS festgelegt und befindet sich in der `.env`-Datei:
+
+```bash
+# ...
+#
+# Password to login as administrator, required to manage settings like historical prices
+ADMIN_PASSWORD=my-secret-login-password
+```
+
+Möchtest du das Passwort ändern, ist dies ausschließlich über die Bearbeitung der `.env`-Datei möglich. Nachdem du es dort geändert hast, muss SOLECTRUS neu gestartet werden, damit die Änderung wirksam wird.

benutzung/ersparnis-berechnung.md

@@ -0,0 +1,74 @@
+---
+title: Ersparnis-Berechnung
+layout: page
+parent: Benutzung
+---
+
+# Berechnung der Ersparnis durch die Photovoltaikanlage
+
+## Die zwei Komponenten der Ersparnis
+
+Die Einsparung, die durch den Betrieb der PV-Anlage erzielt wird, besteht grundsätzlich aus zwei Komponenten:
+
+1. Einsparung durch Reduzierung des aus dem Netz bezogenen Stroms
+2. Einsparung durch Erhalt einer Einspeisevergütung für den ins Netz abgegebenen Strom
+
+SOLECTRUS berechnet die Ersparnis aus einer Gegenüberstellung zweier Szenarien: Die aktuelle Situation (d.h. **mit** PV-Anlage) wird mit einem theoretischen Szenario verglichen, bei dem man **keine** PV-Anlage hat, aber den exakt gleichen Stromverbrauch verursacht. SOLECTRUS macht also einen Vorher-Nachher-Vergleich und bildet die Differenz. Das sieht dann so aus (im Beispiel für das Jahr 2022):
+
+<img
+  src="/assets/images/ersparnis.png"
+  alt="Einsparung durch PV-Anlage"
+  class="mx-auto w-full max-w-2xl rounded-full border-8 border-indigo-300"
+/>
+
+## Berechnung der Ersparnis
+
+Die Berechnung erfolgt in drei Schritten:
+
+1. **Mit PV-Anlage**: Es werden zunächst die Kosten berechnet, die durch den Bezug von Strom tatsächlich entstehen (siehe auch die Erläuterungen zur [Kosten-Berechnung](/faq/kosten-berechnung/)). Der Betrag ist immer negativ, hier im Beispiel sind es `-386 €`. Außerdem erhält man eine Einspeisevergütung für den Überschuss (hier `624 €`, positiv). Zusammen ergibt das den "Solarpreis" als Summe, wobei die Vorzeichen zu beachten sind (hier: `-386 € + 624 € = 238 €`). Der Solarpreis ist meist positiv, kann aber je nach gewähltem Zeitraum auch negativ sein, z.B. im Winter, wenn der Strombezug mehr kostet als die Einspeisevergütung einbringt.
+
+2. **Ohne PV-Anlage**: Der Strom für den gesamten Verbrauch muss gekauft werden und es gibt natürlich keine Einspeisevergütung. Gerechnet wird `(Hausverbrauch + Wallbox) * Strompreis`. In Beispiel ergibt sich ein "Vergleichspreis" (immer negativ) mit den theoretischen Strombezugskosten von `1.857 €`. Berücksichtigt werden bei der Berechnung die sich im Zeitverlauf ändernden Strompreise.
+
+3. **Vergleich**: Die mit der PV-Anlage erzielte Ersparnis ist nun die Differenz zwischen Solarpreis und Vergleichspreis. Weil der Solarpreis sowohl positiv (Sommer) als auch negativ (Winter) sein kann, sind die Vorzeichen wichtig. Im Beispiel wird gerechnet: \
+   `238 € - (- 1.857 €) = 2.095 €`. Das bedeutet: Dadurch, dass du eine PV-Anlage hast, hast du im gewählten Zeitraum 2095 € mehr im Geldbeutel, als wenn du keine PV-Anlage hättest.
+
+Zusammengefasst lässt sich die Formel wie folgt darstellen:
+
+```
+Ersparnis (€) = (Hausverbrauch + Wallbox - Strombezug) * Strompreis +
+                Einspeisung * Einspeisevergütung
+```
+
+Da sich der Strompreis im Zeitverlauf ändern kann, wird diese Berechnung für jeden Teilzeitraum einzeln durchgeführt und das Ganze dann aufsummiert.
+
+:::caution
+
+Diese Berechnungsformel unterscheidet sich von der SENEC-App, die in der aktuellen Version v4.3.2 aus mir nicht verständlichen Gründen die **Speicherentladung** (anstatt des **Strombezugs**) mit einbezieht und folgende Formel verwendet:
+
+```
+Ersparnis (€) = (Hausverbrauch + Wallbox + Speicherentladung) * Strompreis +
+                Einspeisung * Einspeisevergütung
+```
+
+Dies ist aus meiner Sicht **falsch** und ergibt eine zu hohe Ersparnis.
+
+:::
+
+## Anteil des Speichers an der Ersparnis
+
+Zum Schluss errechnet SOLECTRUS, welchen Anteil der Stromspeicher (Akku) an der Ersparnis hat:
+
+```
+Ersparnis durch Akku (€) =
+    Akkuentnahme (kWh) * Strompreis (€/kWh)
+  - Akkubeladung (kWh) * Einspeisevergütung (€/kWh)
+```
+
+Die Idee ist hier, dass man einerseits den aus dem Akku entnommenen Strom nicht kaufen muss, also den Strompreis einspart. Andererseits verliert man aber auch die Einspeisevergütung für die Strommenge, mit der man den Akku auflädt. Die Akku-Ersparnis ist also der Betrag, der gespart wird, weil man einen Akku hat - gegenüber der Situation, eine PV-Anlage ohne Akku zu betreiben. Anders ausgedrückt: Mit diesem Betrag amortisiert sich die Investition in den Akku.\
+Der Betrag wird schließlich noch prozentual ins Verhältnis zur vorher ausgerechneten Gesamtersparnis gesetzt.
+
+## Zugrunde liegende Annahmen
+
+Zu beachten ist, dass diese Berechnung die Anfangsinvestitionen in die PV-Anlage nicht berücksichtigt und auch Wartungskosten, Versicherungsprämien etc. nicht mit einfließen.
+
+Ebenfalls unberücksichtigt bleibt, dass der Speicher einen nicht unerheblichen Eigenverbrauch hat und somit der Hausverbrauch höher ist, als wenn man keine PV-Anlage bzw. keinen Stromspeicher hätte.

benutzung/index.md

@@ -0,0 +1,7 @@
+---
+title: Benutzung
+layout: page
+nav_order: 4
+---
+
+todo

benutzung/kosten-berechnung.md

@@ -0,0 +1,73 @@
+---
+title: Kosten-Berechnung
+layout: page
+parent: Benutzung
+---
+
+# Berechnung der entstandenen Stromkosten
+
+SOLECTRUS berechnet Kosten, die für den Verbrauch von Strom anfallen, wobei zwischen Netzbezug und Eigenverbrauch unterschieden wird. Diese werden für den ausgewählten Zeitraum dargestellt, hier ein Beispiel:
+
+<img
+  src="/assets/images/kosten.png"
+  alt="Kostenberechnung"
+  class="mx-auto w-full max-w-lg rounded-full border-8 border-indigo-300"
+/>
+
+Teil der Kosten ist die entgangene Einspeisevergütung, die beim Eigenverbrauch entsteht, wenn der erzeugte Strom nicht ins Netz eingespeist wird. Dieser Teil der Berechnung ist optional und kann auch deaktiviert werden.
+
+:::note
+
+Die hier beschriebene Berechnung gilt ab Version `0.16.0`. Frühere Versionen haben die Kosten anders dargestellt.
+
+:::
+
+Berechnungsgrundlage sind die eingestellten Strompreise, die sich regelmäßig ändern können. Auch hierzu ein Beispiel:
+
+<img
+  src="/assets/images/strompreise.png"
+  alt="Strompreise"
+  class="mx-auto w-full max-w-2xl rounded-full border-8 border-indigo-300"
+/>
+
+Die Berechnung erfolgt in drei Schritten:
+
+1. Ermittlung der Strompreise, die für den ausgewählten Zeitraum gelten - hier also für ein Jahr. Hat sich der Preis im gewählten Zeitraum geändert, wird das berücksichtigt, indem der Zeitraum in einzelne Abschnitte aufgeteilt wird. Hier im Beispiel ist das der Fall: Der Strompreis bewegte sich zwischen `0,2545 €/kWh` und `0,3244 €/kWh`. Insgesamt hat sich der Preis zweimal geändert, es gab also drei verschiedene Preise. Somit sind drei Zeitabschnitte zu bilden.
+
+2. Für jeden Zeitabschnitt wird der Stromverbrauch in kWh aus den Messwerten ermittelt. Im Beispiel sind es aufsummiert `1.335 kWh`. Die Einzelverbräuche der Zeitabschnitte werden aus Gründen der Einfachheit nicht dargestellt. Gleiches gilt für den Eigenverbrauch, im Beispiel sind es `4.926 kWh`.
+
+3. Die Netzbezugskosten ergeben sich für jeden Zeitabschnitt durch Multiplikation von Stromverbrauch und Strompreis. Zum Schluss wird alles aufaddiert. Im Beispiel resultieren daraus `386 €`. Hinzu kommt die entgangene Einspeisevergütung, im Beispiel `418 €`. Die Gesamtkosten betragen also `804 €`. Diese Kosten sind entstanden, um die benötigten Verbraucher mit Strom zu versorgen.
+
+<h2>Power-Splitter</h2>
+
+Mit dem [Power-Splitter](/features/#power-splitter) gibt es ein mächtiges Werkzeug, um die tatsächlichen Kosten der großen Verbraucher Haus, Wärmepumpe und E-Auto **separat** zu berechnen.
+
+Beim Verbrauch entsteht üblicherweise ein Mix aus Eigenverbrauch (grüner Strom) und Netzbezug. Diese Aufteilung wird vom Power-Splitter für jeden der großen Verbraucher ermittelt und aufsummiert.
+
+:::note
+
+Die Berechnung erfolgt &dash; grob skizziert &dash; in etwa so:
+
+Im Minutentakt wird der insgesamt bezogene Netzstrom (in Watt) ermittelt. Dieser wird anteilig auf die im gleichen Zeitabschnitt aktiven Verbraucher verteilt. Dabei wird das E-Auto erstrangig behandelt, da man dieses meist bewusst lädt. Der verbliebene Rest (sofern vorhanden) wird dann anteilig auf Haus und Wärmepumpe verteilt.
+
+Insgesamt ist damit für jede Minute bekannt, welcher Verbraucher welchen Anteil am Netzbezug hat.
+
+:::
+
+Aus dem Anteil werden dann die echten Stromkosten dieser Verbraucher ermittelt, die sich aus Netzbezug und entgangener Einspeisevergütung (optional) zusammensetzen. Hier ein Beispiel für das E-Auto in einem Jahr:
+
+<img
+  src="/assets/images/power-splitter-car.png"
+  alt="Power-Splitter"
+  class="mx-auto w-full max-w-xs rounded-full border-8 border-indigo-300"
+/>
+
+In diesem Beispiel hat das E-Auto etwa 2 MWh im Jahr über die Wallbox bezogen. 69% davon war grüner Strom, wurde also selbst über die PV-Anlage erzeugt. Der kleinere rote Teil des Balkens zeigt den Netzbezug an.
+
+Die Summe aus Netzbezug und entgangener Einspeisevergütung beträgt `314 €`, wobei die jeweils gültigen Strompreise berücksichtigt werden. So kennt man jetzt die Stromkosten für ein Jahr Autofahren.
+
+:::caution
+
+Zu beachten ist bei diesem Beispiel, dass externe Ladungen (z.B. an öffentlichen Ladesäulen) hier nicht berücksichtigt werden, da es dafür keine Messwerte gibt. Zukünftige Versionen werden diese Lücke schließen, indem externe Beladungen manuell erfasst werden können.
+
+:::

benutzung/smartphone.md

@@ -0,0 +1,25 @@
+---
+title: Smartphone
+layout: page
+parent: Benutzung
+---
+
+# Gibt es eine App für das Smartphone?
+
+Eine native App für Android und iOS gibt es derzeitig nicht. SOLECTRUS ist jedoch eine sogenannte PWA (Progressive Web App). Das bedeutet, dass es sich um eine normale Webanwendung handelt, die aber so aussieht und sich so verhält, als wäre sie eine native App. Das hat den Vorteil, dass SOLECTRUS auf allen Geräten funktioniert, die einen Browser unterstützen. Die Verwendung auf iPhone, iPad oder Android Geräten ist also kein Problem. Es gibt auch Berichte von Nutzern, die [SOLECTRUS auf einem (smarten) Kühlschrank verwenden](https://github.com/solectrus/solectrus/issues/2511#issuecomment-2052028943) - alles, was einen modernen Browser hat, kann SOLECTRUS anzeigen.
+
+Die Verwendung von SOLECTRUS als App auf einem Smartphone oder Tablet funktioniert folgendermaßen:
+
+## Auf iOS oder iPadOS
+
+1. Öffne SOLECTRUS im Browser auf dem iPhone oder iPad
+2. Klicke auf das Symbol mit dem Quadrat und dem Pfeil nach oben
+3. Wähle "Zum Home-Bildschirm" und bestätige den Namen
+4. Fertig!
+
+## Auf Android
+
+1. Öffnet SOLECTRUS im Browser auf dem Smartphone oder Tablet
+2. Tippe auf die drei Punkte rechts oben
+3. Wähle "Zum Startbildschirm hinzufügen" und bestätige den Namen
+4. Fertig!

index.md

@@ -1,35 +1,17 @@
 ---
 title: Home
 layout: home
+nav_order: 1
 ---
 
-This is a _bare-minimum_ template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
+# Willkommen!
 
-If [Jekyll] is installed on your computer, you can also build and preview the created site _locally_. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
+Willkommen auf der Dokumentations-Website von **SOLECTRUS**. Hier findest du alles, was man zum Installieren, Konfigurieren und Aktualisieren von SOLECTRUS wissen muss.
 
-More specifically, the created site:
+SOLECTRUS ist ein Dashboard für die Überwachung von Solaranlagen. Es bietet eine einfache und intuitive Benutzeroberfläche, um die Leistung und den Status deiner Solaranlage zu überwachen.
 
-- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
-- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
+Die Installation erfolgt üblicherweise auf einem kleinen Gerät wie einem Raspberry Pi unter Linux und Docker. Es hilft, wenn du zu beiden Themen bereits ein wenig Erfahrung hast.
 
-Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
+Für Neueinsteiger ist der Konfigurator eine gute Wahl. Er führt dich Schritt für Schritt durch die Installation und Konfiguration von SOLECTRUS.
 
-[Browse our documentation][Just the Docs] to learn more about how to use this theme.
-
-To get started with creating a site, simply:
-
-1. click "[use this template]" to create a GitHub repository
-2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
-
-If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
-
----
-
-[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
-
-[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
-[GitHub Pages]: https://docs.github.com/en/pages
-[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
-[Jekyll]: https://jekyllrb.com
-[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
-[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
+Wenn du eine bestehende Installation verändern oder erweitern möchtest, findest du hier in der Dokumentation alle Informationen, die du benötigst. Insbesondere wird jede einzelne Komponente von SOLECTRUS beschrieben.

installation/configurator.md

@@ -0,0 +1,8 @@
+---
+title: Konfigurator
+layout: page
+parent: Installation
+nav_order: 2
+---
+
+todo