fix: allow backticks in template texts

evcc-io · Dec 1, 2024 · 39745de · 39745de
1 parent 3de27d3
commit 39745de
Show file tree

Hide file tree

Showing 6 changed files with 289 additions and 54 deletions.
diff --git a/docs/devices/meters.mdx b/docs/devices/meters.mdx
@@ -4734,7 +4734,7 @@ Siehe https://forum.huawei.com/enterprise/en/modbus-tcp-guide/thread/66725067715
 
 <DeviceFeatures features="battery-control" />
 
-Nur ein System kann und darf auf den Wechselrichter zugreifen! Für die aktive Batteriesteuerung muss die externe Batteriesteuerung über Modbus mit dem Handwerkerzugang aktiviert sein. Netzladen ist nicht verfügbar.
+Nur ein System kann und darf auf den Wechselrichter zugreifen! Für die aktive Batteriesteuerung muss die externe Batteriesteuerung über Modbus mit dem Handwerkerzugang aktiviert sein. Diese Vorlage ist für Wechselrichter mit der HW Version 0100. Netzladen steht nicht zur verfügung.
 
 <Tabs>
 <TabItem value="pv" label="PV" default>
@@ -4809,15 +4809,15 @@ Nur ein System kann und darf auf den Wechselrichter zugreifen! Für die aktive B
 
 <DeviceFeatures features="battery-control" />
 
-Nur ein System kann und darf auf den Wechselrichter zugreifen! Für die aktive Batteriesteuerung muss die externe Batteriesteuerung über Modbus mit dem Handwerkerzugang aktiviert sein. Das Netzladen steht mit dieser Vorlage zur Verfügung, ist aktuell jedoch inkompatibel mit Gen.1 Wechselrichtern (z.B. HW-Version 0100).
+Nur ein System kann und darf auf den Wechselrichter zugreifen! Für die aktive Batteriesteuerung muss die externe Batteriesteuerung über Modbus mit dem Handwerkerzugang aktiviert sein. Das Netzladen steht mit dieser Vorlage zur Verfügung, ist aktuell jedoch inkompatibel mit Wechselrichtern der HW-Version 0100).
 
 <Tabs>
 <TabItem value="pv" label="PV" default>
 
 <DeviceConfig code={`meters:
     - name: my_pv
       type: template
-      template: kostal-plenticore-gen2
+      template: kostal-plenticore-hw0200
       usage: pv
       
       # Modbus TCP
@@ -4827,7 +4827,7 @@ Nur ein System kann und darf auf den Wechselrichter zugreifen! Für die aktive B
       port: 1502 # Port`} advanced={`meters:
     - name: my_pv
       type: template
-      template: kostal-plenticore-gen2
+      template: kostal-plenticore-hw0200
       usage: pv
       
       # Modbus TCP
@@ -4847,7 +4847,7 @@ Nur ein System kann und darf auf den Wechselrichter zugreifen! Für die aktive B
 <DeviceConfig code={`meters:
     - name: my_battery
       type: template
-      template: kostal-plenticore-gen2
+      template: kostal-plenticore-hw0200
       usage: battery
       
       # Modbus TCP
@@ -4857,7 +4857,7 @@ Nur ein System kann und darf auf den Wechselrichter zugreifen! Für die aktive B
       port: 1502 # Port`} advanced={`meters:
     - name: my_battery
       type: template
-      template: kostal-plenticore-gen2
+      template: kostal-plenticore-hw0200
       usage: battery
       
       # Modbus TCP
@@ -4918,7 +4918,79 @@ Der Zähler muss in Sensorposition 2 (Netzanschluss) installiert sein. Sensorpos
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## LG ESS Home 8/10
+## LG
+
+### ESS Home 15
+
+<DeviceFeatures features="" />
+
+<Tabs>
+<TabItem value="grid" label="Netz" default>
+
+<DeviceConfig code={`meters:
+    - name: my_grid
+      type: template
+      template: lg-ess-home-15
+      usage: grid
+      host: 192.0.2.2 # IP-Adresse oder Hostname
+      password: # Benutzerpasswort, siehe https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alternativ kann die Registriernummer für Administratorlogin verwendet werden. (optional)`} advanced={`meters:
+    - name: my_grid
+      type: template
+      template: lg-ess-home-15
+      usage: grid
+      host: 192.0.2.2 # IP-Adresse oder Hostname
+      password: # Benutzerpasswort, siehe https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alternativ kann die Registriernummer für Administratorlogin verwendet werden. (optional)
+      registration: DE200... # Registriernummer des LG ESS HOME Wechselrichters. (optional)`} />
+
+
+
+</TabItem>
+<TabItem value="pv" label="PV">
+
+<DeviceConfig code={`meters:
+    - name: my_pv
+      type: template
+      template: lg-ess-home-15
+      usage: pv
+      host: 192.0.2.2 # IP-Adresse oder Hostname
+      password: # Benutzerpasswort, siehe https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alternativ kann die Registriernummer für Administratorlogin verwendet werden. (optional)`} advanced={`meters:
+    - name: my_pv
+      type: template
+      template: lg-ess-home-15
+      usage: pv
+      host: 192.0.2.2 # IP-Adresse oder Hostname
+      password: # Benutzerpasswort, siehe https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alternativ kann die Registriernummer für Administratorlogin verwendet werden. (optional)
+      registration: DE200... # Registriernummer des LG ESS HOME Wechselrichters. (optional)`} />
+
+
+
+</TabItem>
+<TabItem value="battery" label="Batterie">
+
+<DeviceConfig code={`meters:
+    - name: my_battery
+      type: template
+      template: lg-ess-home-15
+      usage: battery
+      host: 192.0.2.2 # IP-Adresse oder Hostname
+      password: # Benutzerpasswort, siehe https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alternativ kann die Registriernummer für Administratorlogin verwendet werden. (optional)`} advanced={`meters:
+    - name: my_battery
+      type: template
+      template: lg-ess-home-15
+      usage: battery
+      host: 192.0.2.2 # IP-Adresse oder Hostname
+      password: # Benutzerpasswort, siehe https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alternativ kann die Registriernummer für Administratorlogin verwendet werden. (optional)
+      registration: DE200... # Registriernummer des LG ESS HOME Wechselrichters. (optional)
+      capacity: 50 # Akkukapazität in kWh (optional)`} />
+
+
+
+</TabItem>
+</Tabs>
+
+<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
+
+### ESS Home 8/10
 
 <DeviceFeatures features="" />
 
@@ -6740,8 +6812,7 @@ In der Weboberfläche des SMA Data Manager muss im Bereich "Externe Kommunikatio
       id: 3
       host: 192.0.2.2 # Hostname
       port: 502 # Port
-      maxacpower: 0 # Maximale AC Leistung des Hybrid-Wechselrichters (optional)
-      watchdog: 30s # optional`} />
+      maxacpower: 0 # Maximale AC Leistung des Hybrid-Wechselrichters (optional)`} />
 
 
 
@@ -6770,8 +6841,8 @@ In der Weboberfläche des SMA Data Manager muss im Bereich "Externe Kommunikatio
       host: 192.0.2.2 # Hostname
       port: 502 # Port
       capacity: 50 # Akkukapazität in kWh (optional)
-      watchdog: 30s # optional
-      chargepower: 100000 # Ladeleistung für Netzladen in W (optional)`} />
+      watchdog: 60s # optional
+      chargepower: 4200 # Maximale Ladeleistung für erzwungenes Laden des Speichers in Watt (optional)`} />
 
 
 
@@ -6806,7 +6877,8 @@ In der Weboberfläche des SMA Data Manager muss im Bereich "Externe Kommunikatio
       host: 192.0.2.2 # Hostname
       port: 502 # Port
       capacity: 50 # Akkukapazität in kWh (optional)
-      watchdog: 60s # optional`} />
+      watchdog: 60s # optional
+      chargepower: 4200 # Maximale Ladeleistung für erzwungenes Laden des Speichers in Watt (optional)`} />
 
 
 
@@ -6838,7 +6910,8 @@ In der Weboberfläche des SMA Data Manager muss im Bereich "Externe Kommunikatio
       host: 192.0.2.2 # Hostname
       port: 502 # Port
       capacity: 50 # Akkukapazität in kWh (optional)
-      watchdog: 60s # optional`} />
+      watchdog: 60s # optional
+      chargepower: 4200 # Maximale Ladeleistung für erzwungenes Laden des Speichers in Watt (optional)`} />
 
 
 
@@ -6891,7 +6964,8 @@ In der Weboberfläche des SMA Data Manager muss im Bereich "Externe Kommunikatio
       host: 192.0.2.2 # Hostname
       port: 502 # Port
       capacity: 50 # Akkukapazität in kWh (optional)
-      watchdog: 60s # optional`} />
+      watchdog: 60s # optional
+      chargepower: 4200 # Maximale Ladeleistung für erzwungenes Laden des Speichers in Watt (optional)`} />
 
 
 
@@ -8517,8 +8591,8 @@ Der Solax Hybrid-Wechselrichter muss in der SolaxCloud angemeldet sein.
       type: template
       template: solax-hybrid-cloud
       usage: grid
-      tokenid: # Auf https://www.solaxcloud.com/#/api den Wert von "ObtaintokenID" hier eintragen.
-      serial: # Auf https://www.solaxcloud.com/#/inverter die Registriernummer hier eintragen.`}  />
+      tokenid: # https://www.solaxcloud.com/ -> Support -> Drittanbieter-Ökosystem (alte Website) oder Dienst -> API (neue Website), den Wert von \`tokenID\` hier in Anführungszeichen eintragen (Beispiel: '20241028488283838')
+      serial: # https://www.solaxcloud.com/ -> Gerät -> Wechselrichter (neue Website) oder Support (alte Website), Wert von Registrierungsnummer hier eintragen`}  />
 
 
 
@@ -8530,8 +8604,8 @@ Der Solax Hybrid-Wechselrichter muss in der SolaxCloud angemeldet sein.
       type: template
       template: solax-hybrid-cloud
       usage: pv
-      tokenid: # Auf https://www.solaxcloud.com/#/api den Wert von "ObtaintokenID" hier eintragen.
-      serial: # Auf https://www.solaxcloud.com/#/inverter die Registriernummer hier eintragen.`}  />
+      tokenid: # https://www.solaxcloud.com/ -> Support -> Drittanbieter-Ökosystem (alte Website) oder Dienst -> API (neue Website), den Wert von \`tokenID\` hier in Anführungszeichen eintragen (Beispiel: '20241028488283838')
+      serial: # https://www.solaxcloud.com/ -> Gerät -> Wechselrichter (neue Website) oder Support (alte Website), Wert von Registrierungsnummer hier eintragen`}  />
 
 
 
@@ -8543,14 +8617,14 @@ Der Solax Hybrid-Wechselrichter muss in der SolaxCloud angemeldet sein.
       type: template
       template: solax-hybrid-cloud
       usage: battery
-      tokenid: # Auf https://www.solaxcloud.com/#/api den Wert von "ObtaintokenID" hier eintragen.
-      serial: # Auf https://www.solaxcloud.com/#/inverter die Registriernummer hier eintragen.`} advanced={`meters:
+      tokenid: # https://www.solaxcloud.com/ -> Support -> Drittanbieter-Ökosystem (alte Website) oder Dienst -> API (neue Website), den Wert von \`tokenID\` hier in Anführungszeichen eintragen (Beispiel: '20241028488283838')
+      serial: # https://www.solaxcloud.com/ -> Gerät -> Wechselrichter (neue Website) oder Support (alte Website), Wert von Registrierungsnummer hier eintragen`} advanced={`meters:
     - name: my_battery
       type: template
       template: solax-hybrid-cloud
       usage: battery
-      tokenid: # Auf https://www.solaxcloud.com/#/api den Wert von "ObtaintokenID" hier eintragen.
-      serial: # Auf https://www.solaxcloud.com/#/inverter die Registriernummer hier eintragen.
+      tokenid: # https://www.solaxcloud.com/ -> Support -> Drittanbieter-Ökosystem (alte Website) oder Dienst -> API (neue Website), den Wert von \`tokenID\` hier in Anführungszeichen eintragen (Beispiel: '20241028488283838')
+      serial: # https://www.solaxcloud.com/ -> Gerät -> Wechselrichter (neue Website) oder Support (alte Website), Wert von Registrierungsnummer hier eintragen
       capacity: 50 # Akkukapazität in kWh (optional)`} />
 
 
@@ -8573,8 +8647,8 @@ Der Solax PV-Wechselrichter muss in der SolaxCloud angemeldet sein.
       type: template
       template: solax-inverter-cloud
       usage: pv
-      tokenid: # ObtaintokenID von https://www.solaxcloud.com/#/api verwenden.
-      serial: # Registriernummer von https://www.solaxcloud.com/#/inverter verwenden.`}  />
+      tokenid: # https://www.solaxcloud.com/ -> Support -> Drittanbieter-Ökosystem (alte Website) oder Dienst -> API (neue Website), den Wert von \`tokenID\` hier in Anführungszeichen eintragen (Beispiel: '20241028488283838')
+      serial: # https://www.solaxcloud.com/ -> Gerät -> Wechselrichter (neue Website) oder Support (alte Website), Wert von Registrierungsnummer hier eintragen`}  />
 
 
 

diff --git a/docs/devices/tariffs.mdx b/docs/devices/tariffs.mdx
@@ -378,7 +378,7 @@ Den API-Key bekommst du im Octopus Portal https://octopus.energy/dashboard/new/a
 
 ### Ostrom 
 
-Erzeuge einen 'Production Client' in dem Tibber-Entwicklerportal: https://developer.ostrom-api.io/
+Erzeuge einen 'Production Client' im Ostrom-Entwicklerportal: https://developer.ostrom-api.io/
 
 <DeviceConfig code={`tariffs:
     grid:

diff --git a/docs/devices/vehicles.mdx b/docs/devices/vehicles.mdx
@@ -107,6 +107,8 @@ Die Qualität und Verfügbarkeit der Fahrzeugschnittstellen variiert von Herstel
 
 ## BMW 
 
+Benötigt `hcaptcha` Token. Dieses muss einmalig unter https://bimmer-connected.readthedocs.io/en/latest/captcha/rest_of_world.html generiert werden. Das Token ist nur für kurze Zeit gültig. Bitte möglichst schnell nach Generierung in die Konfiguration kopieren und evcc starten.
+
 <DeviceConfig code={`vehicles:
     - name: my_car
       type: template
@@ -115,7 +117,8 @@ Die Qualität und Verfügbarkeit der Fahrzeugschnittstellen variiert von Herstel
       user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.)
       password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen)
       vin: WBMW... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional)
-      capacity: 50 # Akkukapazität in kWh (optional)`} advanced={`vehicles:
+      capacity: 50 # Akkukapazität in kWh (optional)
+      hcaptcha:`} advanced={`vehicles:
     - name: my_car
       type: template
       template: bmw
@@ -124,6 +127,7 @@ Die Qualität und Verfügbarkeit der Fahrzeugschnittstellen variiert von Herstel
       password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen)
       vin: WBMW... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional)
       capacity: 50 # Akkukapazität in kWh (optional)
+      hcaptcha:
       icon: car # Icon in der Benutzeroberfläche (optional)
       phases: 3 # Die maximale Anzahl der Phasen welche genutzt werden können (optional)
       cache: 15m # Zeitintervall nach dem Daten erneut vom Fahrzeug abgefragt werden (optional)
@@ -491,6 +495,8 @@ Benötigt `access` und `refresh` Tokens. Diese können über den Befehl `evcc to
 
 ## Mini 
 
+Benötigt `hcaptcha` Token. Dieses muss einmalig unter https://bimmer-connected.readthedocs.io/en/latest/captcha/rest_of_world.html generiert werden. Das Token ist nur für kurze Zeit gültig. Bitte möglichst schnell nach Generierung in die Konfiguration kopieren und evcc starten.
+
 <DeviceConfig code={`vehicles:
     - name: my_car
       type: template
@@ -499,7 +505,8 @@ Benötigt `access` und `refresh` Tokens. Diese können über den Befehl `evcc to
       user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.)
       password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen)
       vin: WBMW... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional)
-      capacity: 50 # Akkukapazität in kWh (optional)`} advanced={`vehicles:
+      capacity: 50 # Akkukapazität in kWh (optional)
+      hcaptcha:`} advanced={`vehicles:
     - name: my_car
       type: template
       template: mini
@@ -508,6 +515,7 @@ Benötigt `access` und `refresh` Tokens. Diese können über den Befehl `evcc to
       password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen)
       vin: WBMW... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional)
       capacity: 50 # Akkukapazität in kWh (optional)
+      hcaptcha:
       icon: car # Icon in der Benutzeroberfläche (optional)
       phases: 3 # Die maximale Anzahl der Phasen welche genutzt werden können (optional)
       cache: 15m # Zeitintervall nach dem Daten erneut vom Fahrzeug abgefragt werden (optional)
@@ -1195,6 +1203,40 @@ vehicles:
 
 
 
+<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/vehicle  -->
+
+### ioBroker.bmw
+
+ioBroker BMW Adapter. Benötigt ioBroker.bmw und ioBroker.simple-api
+
+<DeviceConfig code={`vehicles:
+    - name: my_car
+      type: template
+      template: ioBroker.bmw
+      title: # Wird in der Benutzeroberfläche angezeigt (optional)
+      capacity: 50 # Akkukapazität in kWh (optional)
+      vin: WBMW... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional)
+      uri: # HTTP(S) Adresse (optional)`} advanced={`vehicles:
+    - name: my_car
+      type: template
+      template: ioBroker.bmw
+      title: # Wird in der Benutzeroberfläche angezeigt (optional)
+      capacity: 50 # Akkukapazität in kWh (optional)
+      vin: WBMW... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional)
+      uri: # HTTP(S) Adresse (optional)
+      icon: car # Icon in der Benutzeroberfläche (optional)
+      phases: 3 # Die maximale Anzahl der Phasen welche genutzt werden können (optional)
+      mode: # Möglich sind Off, Now, MinPV und PV, oder leer wenn keiner definiert werden soll (optional)
+      minCurrent: 6 # Definiert die minimale Stromstärke pro angeschlossener Phase mit welcher das Fahrzeug geladen werden soll (optional)
+      maxCurrent: 16 # Definiert die maximale Stromstärke pro angeschlossener Phase mit welcher das Fahrzeug geladen werden soll (optional)
+      identifiers: # Kann meist erst später eingetragen werden, siehe: https://docs.evcc.io/docs/features/vehicle (optional)
+      priority: # Priorität des Ladepunktes oder Fahrzeugs in Relation zu anderen Ladepunkten oder Fahrzeugen für die Zuweisung von PV-Energie (optional)
+      id: 0 # Instanz-ID (optional)
+      coarsecurrent: # 1A Ladestromvorgabe (optional)
+      welcomecharge: # Wallbox gibt kurzzeitige Ladefreigabe bei Fahrzeugverbindung. Das ermöglicht es Fahrzeugen, die eine Stromversorgung beim Anschließen benötigen, einen Fehlerzustand zu vermeiden. (optional)`} />
+
+
+
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/vehicle  -->
 
 ### ISO15118