Merge pull request #1903 from benderl/wiki-device-component

Wiki device component

docs/Anzeige-Steuerung.md

@@ -1,7 +1,9 @@
 Die Kontrolle der openWB geschieht über einen Webbrowser. Aufruf geschieht über Eingabe der IP-Adresse der openWB.
 
 ## Startseite
+
 Die hier angezeigten Leistungen werden direkt aus den Leistungsdaten, welche vom Zähler übertragen werden, übernommen.
 
 ## Auswertungen - Diagramme
-In der Auswertung (und für's Langzeit-Logging) werden 5min-Intervalle der Zählerstände (kWh-Differenz/5min = kW) verwendet.
+
+In der Auswertung (und für's Langzeit-Logging) werden 5min-Intervalle der Zählerstände (kWh-Differenz/5min = kW) verwendet.

docs/Cloud-Sicherung.md

@@ -1,10 +1,10 @@
 _Einstellungen -> System -> System -> Sicherung/Wiederherstellung_
 
-In den Sicherungseinstellungen kann ein Cloud-Dienst für automatische Sicherungen hinterlegt werden. 
-Die Konfiguration des Cloud-Dienstes wird in diesem Wiki-Beitrag beschrieben. 
+In den Sicherungseinstellungen kann ein Cloud-Dienst für automatische Sicherungen hinterlegt werden.
+Die Konfiguration des Cloud-Dienstes wird in diesem Wiki-Beitrag beschrieben.
 
-Automatische Sicherungen werden nur ausgeführt, wenn die openWB als *primary* konfiguriert (oder die einzige) ist.
-Auf als *secondary* konfigurierten openWBs werden nur manuelle Sicherungen und Sicherungen vor einem Update (falls aktiviert)  ausgeführt, da hier keine Arbeitsdaten (Log-Dateien) zu sichern sind.
+Automatische Sicherungen werden nur ausgeführt, wenn die openWB als **primary** konfiguriert (oder die einzige) ist.
+Auf als **secondary** konfigurierten openWBs werden nur manuelle Sicherungen und Sicherungen vor einem Update (falls aktiviert)  ausgeführt, da hier keine Arbeitsdaten (Log-Dateien) zu sichern sind.
 
 Folgende Anbieter werden unterstützt:
 

docs/Einstellungs-Seite erstellen.md

@@ -5,20 +5,28 @@ Die Installation des GUI-Repositories ist in eben diesem beschrieben: [openwb-ui
 Die Auswahllisten werden dynamisch erzeugt. Damit euer Element darin enthalten ist, muss im entsprechenden Ordner im Core-Repo eine config.py-Datei wie in den Samples beschrieben enthalten sein. Wenn keine Einstellungsseiten in vue hinterlegt sind, sind die Einstellungen als json-Objekt editierbar. Dies ist für einen PR im Core-Repo ausreichend. Wie Ihr auch einen PR im GUI-Repo für die Einstellungen erstellen könnt, erklären wir Euch hier am Beispiel eines Fahrzeugs:
 
 ### Einstellungen erzeugen
+
 Im Ordner src/components des GUI-Repos legt Ihr im Ordner `vehicles` einen neuen Ordner `sample` an. Dort hinein kopiert Ihr die Vorlage aus dem Ordner [samples_gui](https://github.com/openWB/core/tree/master/docs/samples/samples_gui) und ersetzt sample durch den Namen eures neuen Fahrzeugs. Bitte auf die Groß- und Kleinschreibung achten.
 
 Nun müssen noch Frames für einzelnen Einstellungen ergänzt werden. Dafür könnt Ihr euch entweder an den bereits existierenden Modulen orientieren oder die Beispiele nutzen, die Ihr euch im GUI unter Einstellungen -> Beispiele anschauen könnt. Die Frames findet Ihr [hier](https://github.com/openWB/openwb-ui-settings/blob/main/src/views/TestingStore.vue).
 
-`:model-value="$store.state.examples.text3"`  
-`@update:model-value="updateState('text3', $event)"`  
-Diese beiden Zeilen gibt es in jedem Frame. Die erste Zeile gibt den Wert an, der vom Broker gelesen werden soll. Die zweite den Wert, der aktualisiert werden soll. 
-Für die Einstellungen müssen die Zeilen immer so aussehen:  
-`:model-value="configuration.sample"`  
-`@update:model-value="updateConfiguration($event, 'configuration.sample')`
+```javascript
+:model-value="$store.state.examples.text3"
+@update:model-value="updateState('text3', $event)"
+```
+
+Diese beiden Zeilen gibt es in jedem Frame. Die erste Zeile gibt den Wert an, der vom Broker gelesen werden soll. Die zweite den Wert, der aktualisiert werden soll.
+Für die Einstellungen müssen die Zeilen immer so aussehen:
+
+```javascript
+:model-value="configuration.sample"
+@update:model-value="updateConfiguration($event, 'configuration.sample')
+```
 
 Dann werden die Einstellungen automatisch dem richtigen Topic im Broker zugeordnet. Wichtig ist, dass sample immer genau so heißt, wie die Einstellung in der config.py. Nach dem Tag `<template #help>` könnt Ihr einen Hilfetext eingeben, der angezeigt wird, wenn man auf das Fragezeichen klickt.
 
 ### Pull Request stellen
+
 Die kompilierten vue-Dateien im Core-Repo können nicht gemergt werden. Deshalb dürfen im PR des Core-Repos keine kompilierten vue-Dateien enthalten sein. Für die Einstellungs-Seiten bitte einen PR im openwb-ui-settings-Repo stellen. Nach dem Mergen kompilieren wir die vue-Dateien neu und aktualisieren diese im Core-Repo.
 
-_Bei Fragen programmiert Ihr die Einstellungs-Seite vorerst, wie Ihr es versteht, und erstellt einen (Draft-)PR. Wir unterstützen Euch gerne per Review._
+_Bei Fragen programmiert Ihr die Einstellungs-Seite vorerst, wie Ihr es versteht, und erstellt einen (Draft-)PR. Wir unterstützen Euch gerne per Review._

docs/Fehlersuche.md

@@ -1,19 +1,22 @@
 # Fehlersuche
+
 Es kann immer mal passieren, dass etwas nicht wie gedacht funktioniert. Das kann an einem Fehler im Programmcode, an einem Hardwaredefekt oder an einer fehlerhaften oder nicht zu den Gegebenheiten passenden Konfiguration liegen.
 
-Wenn nun eine Funktion nicht wie erwartet ausgeführt wird oder plötzlich ein Fehler auftritt, ist die erste Frage: 
+Wenn nun eine Funktion nicht wie erwartet ausgeführt wird oder plötzlich ein Fehler auftritt, ist die erste Frage:
 > Habe ich vor Kurzem etwas verändert?
 
 Dies betrifft ebenso Änderungen der Einstellungen im Fahrzeug, Wechselrichter (Softwareupdate?)  oder der Hauselektrik. Unter Umständen kann das Problem so schon gelöst werden.
 
-
 ## Wo bekomme ich Hilfe?
+
 ### Hardwaresupport
-Mit Problemen bei Inbetriebnahme / Anschluss oder Hardwareproblemen mit openWB-Hardware bitte direkt über die Support-Funktion unter System -> Support an openWB wenden (Notfalls auch per Mail an support@openwb.de).
+
+Mit Problemen bei Inbetriebnahme / Anschluss oder Hardwareproblemen mit openWB-Hardware bitte direkt über die Support-Funktion unter System -> Support an openWB wenden (Notfalls auch per Mail an <support@openwb.de>).
 Im Forum kann durchaus mal etwas untergehen. Das führt zu Frust und soll nicht sein.
 
 ### Forum
-Im [Forum](https://forum.openwb.de/index.php) findet man folgende Hilfestellung für Hilfesuchende. Die hier erbetene Herangehensweise dient dazu, den Fehler mit dem für alle niedrigsten Aufwand zu beheben. 
+
+Im [Forum](https://forum.openwb.de/index.php) findet man folgende Hilfestellung für Hilfesuchende. Die hier erbetene Herangehensweise dient dazu, den Fehler mit dem für alle niedrigsten Aufwand zu beheben.
 
 > Bitte keine Mehrfach-Meldung per Mail, Support-Ticket und Forum.
 Das spart auf unserer Seite Supportzeit und bringt erfahrungsgemäß keine Beschleunigung des Vorgangs.
@@ -31,7 +34,8 @@ Formuliert Eure Frage freundlich, beschreibt was ihr tun wolltet und was anstell
 Da es schon Wechselwirkungen mit anderen Smarthome-Systemen gegeben hat, erwähnt ggf. weitere im Heimnetzwerk laufende SmartHome-Systeme.
 
 ### Log-Erstellung
-In der Standard-Einstellung des Logs werden nur Warnungen & Fehler erfasst.  Außerdem wird bei einem Neustart der openWB der Fehlerlog gelöscht. 
+
+In der Standard-Einstellung des Logs werden nur Warnungen & Fehler erfasst.  Außerdem wird bei einem Neustart der openWB der Fehlerlog gelöscht.
 
 Um aussagekräftige Logs zu erzeugen, müssen Log-Dateien im Debug-Modus erstellt werden. Hierzu ist folgende Schaltfläche zu aktivieren:
 
@@ -40,4 +44,4 @@ Um aussagekräftige Logs zu erzeugen, müssen Log-Dateien im Debug-Modus erstell
 Aufgrund des detaillierten Loggings, ist die Dauer der Aufnahme ca. auf die letzten zwei Stunden begrenzt.  Beachtet also, dass ihr sich der Fehler innerhalb des aufgezeichneten Abschnitts befindet.
 Dann ist in den meisten Fällen das Main.log, aufzuklappen und mit der grünen Schaltfläche zu aktualisieren. Der entsprechende Auszug kann nun in eine Textdatei oder direkt in die Nachricht im Forum kopiert werden.
 
-![Main-Log](pictures/Fehlersuche_Main-Log.jpg)
+![Main-Log](pictures/Fehlersuche_Main-Log.jpg)

docs/Grundkonzept.md

@@ -1,23 +1,24 @@
 Hier werden die Grundeinstellungen für Anfänger mit einer einfachen Konstellation, welche im privaten Umfeld häufig vorkommt, erklärt.
-Üblicherweise sind da ein oder zwei Autos und ein oder zwei Wallboxen, die bei der software2 nur noch openWBs sein dürfen. Hat man nur ein Auto und eine openWB ist es ganz simpel. Mit zwei Autos muss man sich - wenn man weiterreichende Features nutzen - oder nur ganz einfach die geladenen kWh loggen möchte - damit auseinander setzen, wie man der openWB mitteilt, welches Auto nun angeschlossen ist: 
+Üblicherweise sind da ein oder zwei Autos und ein oder zwei Wallboxen, die bei der software2 nur noch openWBs sein dürfen. Hat man nur ein Auto und eine openWB ist es ganz simpel. Mit zwei Autos muss man sich - wenn man weiterreichende Features nutzen - oder nur ganz einfach die geladenen kWh loggen möchte - damit auseinander setzen, wie man der openWB mitteilt, welches Auto nun angeschlossen ist:
+
 - man wählt das zu ladende Auto auf dem Handy oder auf dem Display der openWB aus
 - man macht das bei mit RFID-Leser ausgestatteten openWBs per RFID-Karte
 - man kauft für jedes Auto eine eigene openWB; das hat den Vorteil, dass die Autos immer eingesteckt bleiben können und so der gesamte PV-Überschuss garantiert in den Autos landet.
 - man gibt ein bisschen mehr Geld aus, kauft eine openWB pro und hat auch die richtigen Autos dafür, dass die Wallbox selbst das Auto erkennt. Da geht das automatisch und das ist neu in der software2; alternativ kann auch ein optionaler RFID-Leser an die Pro angeschlossen werden und zur Identifizierung des Fahrzeugs verwendet werden
 
 ## Konfiguration
 
-Die Konfiguration der Wallbox-Funktionalität verteilt sich auf zwei oder drei Menüpunkte im Konfigurations-Menü: Ladepunkte (ggf. Lastmanagement) und Fahrzeuge 
+Die Konfiguration der Wallbox-Funktionalität verteilt sich auf zwei oder drei Menüpunkte im Konfigurations-Menü: Ladepunkte (ggf. Lastmanagement) und Fahrzeuge
 
 ### Ladepunkte - die Infrastruktur
 
 Hier werden die vorhandenen Wallboxen als Ladepunkt angelegt und ihnen gemeinsame Eigenschaften in Form von Ladepunkt-Profilen zugewiesen. Im privaten Bereich ist es ja üblicherweise so, dass mit maximal 11kW geladen wird und die Ladepunkte entweder vor unbefugtem Zugriff geschützt werden wollen oder nicht. Das versteckt sich im Ladepunkt-Profil, weshalb wir uns um eigene Ladepunkt-Profile gar nicht kümmern müssen. Wir nehmen das Standard Ladepunkt-Profil für alle unsere openWBs und passen das nach unseren Wünschen an.
 
 Sind mehrere Ladepunkte an einer Unterverteilung angeschlossen, deren Zuleitung weniger verträgt, als die Ladepunkte abgeben können, muss man sich noch über das Loadsharing Gedanken machen. Zum Beispiel ist eine Unterverteilung an der zwei 22kW openWBs angeschlossen sind, in den seltensten Fällen mit den dafür notwendigen 63A abgesichert; häufig z.B. nur 35A. Hier fügt man noch eine Komponente "virtuellen Zähler" ein, setzt den im [Lastmanagement](https://github.com/openWB/core/wiki/Lastmanagement-und-kaskadierte-Zähler) in der Struktur über die beiden Ladepunkte und trägt dort die 24kW / 35A ein. Die maximal zulässige Leistung am EVU-Punkt trägt man dementsprechend in diesem [Zähler](https://github.com/openWB/core/wiki/Zaehler) ein.
- 
+
 ### Fahrzeuge - warum wir das hier alles machen
 
-Bei den Fahrzeugen zerteilt sich die Konfiguration in die technischen Eigenschaften und die ladungstechnischen Aspekte - das sind die beiden Profile für Fahrzeug und Ladung. Die beiden zusammengefasst ergibt das Fahrzeug. 
+Bei den Fahrzeugen zerteilt sich die Konfiguration in die technischen Eigenschaften und die ladungstechnischen Aspekte - das sind die beiden Profile für Fahrzeug und Ladung. Die beiden zusammengefasst ergibt das Fahrzeug.
 
 #### Fahrzeug-Profile
 

docs/Hausverbrauchs-Zähler.md

@@ -1,17 +1,17 @@
-Es gibt zwei mögliche Einbaupositionen für Zähler: EVU-Punkt und Hausverbrauchs-Zweig.  
-Ist der Zähler am EVU-Punkt installiert, misst er am EVU-Punkt (EVU=Elektrizitätsversorgungsunternehmen) Bezug und Einspeisung ins öffentliche Netz. Der Hausverbrauch wird dann aus den Werten der Ladepunkte, Wechselrichter und Speicher berechnet.  
-Ist der Zähler im Hausverbrauchs-Zweig installiert, misst er die Leistung der Ladepunkte und den Hausverbrauch. Bezug und Einspeisung ins öffentliche Netz werden dann aus den Werten des Zählers, Wechselrichter und Speicher berechnet. Dazu gibt es in openWB einen virtuellen Zähler. Dieser addiert die Werte aller in der Struktur dahinter angeordneten Komponenten. 
+Es gibt zwei mögliche Einbaupositionen für Zähler: EVU-Punkt und Hausverbrauchs-Zweig.
+Ist der Zähler am EVU-Punkt installiert, misst er am EVU-Punkt (EVU=Elektrizitätsversorgungsunternehmen) Bezug und Einspeisung ins öffentliche Netz. Der Hausverbrauch wird dann aus den Werten der Ladepunkte, Wechselrichter und Speicher berechnet.
+Ist der Zähler im Hausverbrauchs-Zweig installiert, misst er die Leistung der Ladepunkte und den Hausverbrauch. Bezug und Einspeisung ins öffentliche Netz werden dann aus den Werten des Zählers, Wechselrichter und Speicher berechnet. Dazu gibt es in openWB einen virtuellen Zähler. Dieser addiert die Werte aller in der Struktur dahinter angeordneten Komponenten.
 
 Zunächst ein Virtuelles Gerät mit einem virtuellen Zähler anlegen. Die Komponenten müssen in der Hierarchie wie in den Abbildungen unten angeordnet werden. In den Einstellungen für das Lastmanagement beim Punkt `Hausverbrauch` den Hausverbrauchs-Zähler auswählen. Der Hausverbrauch ist die Leistung des ausgewählten Zählers abzüglich der Ladeleistung.
 
 Misst der Zähler den Hausverbrauch, ergibt sich folgende Anordnung:
 
-<img src="Hausverbrauchs-Zaehler.png" width="500">
+![Hausverbrauchs-Zähler](Hausverbrauchs-Zaehler.png)
 
 Misst der Zähler den Hausverbrauchs und ist ein Hybrid-Wechselrichter vorhanden, ergibt sich folgende Struktur:
 
-<img src="Hausverbrauchs-Zaehler_Hybrid.png" width="500">
+![Hausverbrauchs-Zähler Hybrid](Hausverbrauchs-Zaehler_Hybrid.png)
 
 Ist der Zähler wie üblich am EVU-Punkt installiert und misst den gesamten Verbrauch/Einspeisung, muss die Struktur wie folgt aussehen:
 
-<img src="standard.png" width="500">
+![Standard Zähler](standard.png)

docs/Huawei-Smartlogger.md

@@ -1,17 +1,15 @@
 Im Smartlogger3000a müssen folgende Einstellungen festgelegt werden:
 
-1. Zunächst unter Einstell.-> Bef.-Param. -> Modbus TCP
-   Folgende Einstellungen festlegen:
-     Leitungseinstellungen: Akt.(Unbegrenzt)
-     Addressmodus: Logische Addresse
-     Logger-Addresse: z.B.4 (Muss eine freie ModBus ID sein, logische Addresse 2tes Bild.)
-     Schnelle Planung: Aktivieren
-    ![Huawei Smartlogger ModBusTCP](HuaweiSmartloggerModBusTCP.PNG)
-2.  Unter Wartung->Geräte-Mgmt.-> Geräte Liste
-    kann man jetzt die logische Adresse der einzelnen Geräte ablesen. Diese wird dann in der openWB in der Einstellung ModbusID eingetragen.
+1. Zunächst unter Einstell.-> Bef.-Param. -> Modbus TCP Folgende Einstellungen festlegen:
+    - Leitungseinstellungen: Akt.(Unbegrenzt)
+    - Addressmodus: Logische Addresse
+    - Logger-Addresse: z.B.4 (Muss eine freie ModBus ID sein, logische Addresse 2tes Bild.)
+    - Schnelle Planung: Aktivieren
+![Huawei Smartlogger ModBusTCP](HuaweiSmartloggerModBusTCP.PNG)
+2. Unter Wartung->Geräte-Mgmt.-> Geräte Liste kann man jetzt die logische Adresse der einzelnen Geräte ablesen. Diese wird dann in der openWB in der Einstellung ModbusID eingetragen.
     ![HuaweiSmartloggerLogischeAdressen](HuaweiSmartloggerLogischeAdressen.PNG)
-4. in den Einstellungen der openWB das Modul Huawei Smartlogger auswählen.
-5. Jetzt muss man die IP des Smartloggers und den Port 502 eintragen, außer dieser wurde geändert.
-6. Jetzt die passenden Komponenten hinzufügen und die jeweilige ModbusID eintragen.
-7. Zum Schluss auf Speichern drücken und unter dem Lastmanagement die passende Anordnung wählen.
-  ![Huawei Smartlogger Komponenten](HuaweiSmartloggerKomponenten.PNG)
+3. in den Einstellungen der openWB das Modul Huawei Smartlogger auswählen.
+4. Jetzt muss man die IP des Smartloggers und den Port 502 eintragen, außer dieser wurde geändert.
+5. Jetzt die passenden Komponenten hinzufügen und die jeweilige ModbusID eintragen.
+6. Zum Schluss auf Speichern drücken und unter dem Lastmanagement die passende Anordnung wählen.
+    ![Huawei Smartlogger Komponenten](HuaweiSmartloggerKomponenten.PNG)

docs/Hybrid System aus Wechselrichter und Speicher.md

@@ -1,4 +1,4 @@
-Bei Hybrid-Systemen ist ein DC- Speicher an den Wechselrichter angeschlossen. Bei den meisten Herstellern wird dann die Wechselrichter-Leistung anstelle der PV-Leistung ausgegeben. Auch die Zählerstände werden miteinander verrechnet. 
+Bei Hybrid-Systemen ist ein DC- Speicher an den Wechselrichter angeschlossen. Bei den meisten Herstellern wird dann die Wechselrichter-Leistung anstelle der PV-Leistung ausgegeben. Auch die Zählerstände werden miteinander verrechnet.
 
 Wechselrichter-Leistung: Summe aus PV- und Speicher-Leistung, die der Wechselrichter ins Hausnetz abgibt.
 PV-Leistung: Auf dem Dach erzeugte Leistung.
@@ -10,7 +10,7 @@ Die Struktur muss wie in der ersten Abbildung angeordnet werden, wenn die PV-Lei
 
 Hybrid-System, wenn die Wechselrichter-Leistung ausgegeben wird:
 
-<img src="hybrid.png" width="500">
+![Hybrid-System](hybrid.png)
 
 Hybrid-System, wenn die PV-Leistung ausgegeben wird:
-<img src="standard.png" width="500">
+![Hybrid-System](standard.png)

docs/Ladeprofile.md

@@ -1,5 +1,5 @@
 _Einstellungen -> Konfiguration -> Fahrzeuge -> Lade-Profile_
 
 Unter den Lade-Profilen werden die Einstellungen für das Ladeprofil verwaltet. Die Einstellungen auf der Hauptseite werden aus diesem Profil geladen und dorthin geschrieben. Ist nur ein Fahrzeug vorhanden, so wird in den meisten Fällen nur das Standard-Ladeprofil benötigt. Ausgenommen hiervon ist, wenn per RFID-Tag Ladevorgaben ausgewählt werden.
- 
-In den fahrzeugspezifischen Einstellungen wird ein Ladeprofil einem Fahrzeug zugeordnet. Werden zwei Fahrzeuge geladen, empfiehlt es sich dazu ein zweites Ladeprofil anzulegen.
+
+In den fahrzeugspezifischen Einstellungen wird ein Ladeprofil einem Fahrzeug zugeordnet. Werden zwei Fahrzeuge geladen, empfiehlt es sich dazu ein zweites Ladeprofil anzulegen.