Generate docs from templates

evcc-io · Nov 16, 2024 · 52d169f · 52d169f
1 parent 066a4ac
commit 52d169f
Show file tree

Hide file tree

Showing 4 changed files with 240 additions and 20 deletions.
diff --git a/docs/devices/meters.mdx b/docs/devices/meters.mdx
@@ -5256,6 +5256,65 @@ Die Werte werden ca. alle 15 Sekunden aktualisiert, deshalb sollte das evcc `int
 
 
 
+</TabItem>
+</Tabs>
+
+<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
+
+## QCells Hybrid-Wechselrichter (Cloud)
+
+<DeviceFeatures features="" />
+
+Der QCells Hybrid-Wechselrichter muss in der QCellsCloud angemeldet sein.
+
+**Achtung**: Die Werte können nur alle 150s abgerufen werden und dann auch 5 Minuten alt sein. Die Laderegelung nach PV kann hiermit nicht optimal gesteuert werden! Nur als Notfalloption nutzen wenn kein lokaler Zugriff möglich ist.
+
+<Tabs>
+<TabItem value="grid" label="Netz" default>
+
+<DeviceConfig code={`meters:
+    - name: my_grid
+      type: template
+      template: qcells-hybrid-cloud
+      usage: grid
+      tokenid: # Von https://qhome-ess-g3.q-cells.eu/#/api/ den Wert von "ObtaintokenID" hier eintragen.
+      serial: # Von https://qhome-ess-g3.q-cells.eu/blue/#/inverter die Registriernummer hier eintragen.`}  />
+
+
+
+</TabItem>
+<TabItem value="pv" label="PV">
+
+<DeviceConfig code={`meters:
+    - name: my_pv
+      type: template
+      template: qcells-hybrid-cloud
+      usage: pv
+      tokenid: # Von https://qhome-ess-g3.q-cells.eu/#/api/ den Wert von "ObtaintokenID" hier eintragen.
+      serial: # Von https://qhome-ess-g3.q-cells.eu/blue/#/inverter die Registriernummer hier eintragen.`}  />
+
+
+
+</TabItem>
+<TabItem value="battery" label="Batterie">
+
+<DeviceConfig code={`meters:
+    - name: my_battery
+      type: template
+      template: qcells-hybrid-cloud
+      usage: battery
+      tokenid: # Von https://qhome-ess-g3.q-cells.eu/#/api/ den Wert von "ObtaintokenID" hier eintragen.
+      serial: # Von https://qhome-ess-g3.q-cells.eu/blue/#/inverter die Registriernummer hier eintragen.`} advanced={`meters:
+    - name: my_battery
+      type: template
+      template: qcells-hybrid-cloud
+      usage: battery
+      tokenid: # Von https://qhome-ess-g3.q-cells.eu/#/api/ den Wert von "ObtaintokenID" hier eintragen.
+      serial: # Von https://qhome-ess-g3.q-cells.eu/blue/#/inverter die Registriernummer hier eintragen.
+      capacity: 50 # Akkukapazität in kWh (optional)`} />
+
+
+
 </TabItem>
 </Tabs>
 
@@ -6380,7 +6439,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`} />
+      watchdog: 30s # optional
+      chargepower: 100000 # Ladeleistung für Netzladen in W (optional)`} />
 
 
 
@@ -10548,7 +10608,7 @@ Zur Erfassung der PV-Produktion wird ein extern angebundenener S0-Erzeugungszäh
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## Zendure Hyper V
+## Zendure Hyper 2000
 
 <DeviceFeatures features="skiptest" />
 
@@ -10560,8 +10620,9 @@ Zur Erfassung der PV-Produktion wird ein extern angebundenener S0-Erzeugungszäh
       type: template
       template: zendure
       usage: pv
-      account: # optional
-      serial: # optional
+      account: [email protected]
+      serial: VU5D99F74021B04 # Zu finden in der Zendure App in den Einstellungen des Geräts
+      region: EU # optional
       timeout: 10s # optional`}  />
 
 
@@ -10574,15 +10635,17 @@ Zur Erfassung der PV-Produktion wird ein extern angebundenener S0-Erzeugungszäh
       type: template
       template: zendure
       usage: battery
-      account: # optional
-      serial: # optional
+      account: [email protected]
+      serial: VU5D99F74021B04 # Zu finden in der Zendure App in den Einstellungen des Geräts
+      region: EU # optional
       timeout: 10s # optional`} advanced={`meters:
     - name: my_battery
       type: template
       template: zendure
       usage: battery
-      account: # optional
-      serial: # optional
+      account: [email protected]
+      serial: VU5D99F74021B04 # Zu finden in der Zendure App in den Einstellungen des Geräts
+      region: EU # optional
       timeout: 10s # optional
       capacity: 2 # Akkukapazität in kWh (optional)`} />
 
@@ -11391,12 +11454,27 @@ Zu Demonstrationszwecken. Zähler mit festen Werten.
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-### Shelly 1PM, EM, Plug S
+### Shelly 1PM, EM, Plug S, Pro 3EM in monophase mode
 
 <DeviceFeatures features="" />
 
 <Tabs>
-<TabItem value="pv" label="PV" default>
+<TabItem value="grid" label="Netz" default>
+
+<DeviceConfig code={`meters:
+    - name: my_grid
+      type: template
+      template: shelly-1pm
+      usage: grid
+      host: 192.0.2.2 # IP-Adresse oder Hostname
+      user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional)
+      password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional)
+      channel: 0 # optional`}  />
+
+
+
+</TabItem>
+<TabItem value="pv" label="PV">
 
 <DeviceConfig code={`meters:
     - name: my_pv

diff --git a/docs/devices/vehicles.mdx b/docs/devices/vehicles.mdx
@@ -133,6 +133,7 @@ Die Qualität und Verfügbarkeit der Fahrzeugschnittstellen variiert von Herstel
       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)
       region: EU # 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)`} />
 
 
@@ -1440,6 +1441,37 @@ Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Vorausse
 
 
 
+<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/vehicle  -->
+
+### Tessie
+
+Verbinden Sie Ihr Tesla-Fahrzeug über die Tessie-API. Dies wird das Fahrzeug niemals aufwecken; das Polling kann auf „always“ und interval „1M“ eingestellt werden. Wenn das Fahrzeug wach ist, sind die Daten normalerweise weniger als 15 Sekunden alt. Wenn das Fahrzeug schläft, stammen die Daten aus dem Zeitpunkt, zu dem es eingeschlafen ist. Holen Sie sich Ihr Token unter https://dash.tessie.com/settings/api
+
+<DeviceConfig code={`vehicles:
+    - name: my_car
+      type: template
+      template: tessie
+      title: # Wird in der Benutzeroberfläche angezeigt (optional)
+      vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind
+      token:
+      capacity: 50 # Akkukapazität in kWh (optional)`} advanced={`vehicles:
+    - name: my_car
+      type: template
+      template: tessie
+      title: # Wird in der Benutzeroberfläche angezeigt (optional)
+      vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind
+      token:
+      capacity: 50 # Akkukapazität in kWh (optional)
+      phases: 3 # Die maximale Anzahl der Phasen welche genutzt werden können (optional)
+      icon: car # Icon in der Benutzeroberfläche (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)`} />
+
+
+
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/vehicle  -->
 
 ### Tronity

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx
@@ -5257,6 +5257,65 @@ The values are updated approximately every 15 seconds, hence the evcc `interval`
 
 
 
+</TabItem>
+</Tabs>
+
+<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
+
+## QCells Hybrid-Inverter (Cloud)
+
+<DeviceFeatures features="" />
+
+The QCells hybrid inverter has to be registered in the QCellsCloud.
+
+**Attention**: Values can only be fetched every 150s and then also can be 5 minutes old. Charging by PV will not be optimal because of this! Only use as fallback if no local access is available.
+
+<Tabs>
+<TabItem value="grid" label="Netz" default>
+
+<DeviceConfig code={`meters:
+    - name: my_grid
+      type: template
+      template: qcells-hybrid-cloud
+      usage: grid
+      tokenid: # Go to https://qhome-ess-g3.q-cells.eu/#/api/ and take the value of "ObtaintokenID".
+      serial: # Go to https://qhome-ess-g3.q-cells.eu/blue/#/inverter and take the value of registration number.`}  />
+
+
+
+</TabItem>
+<TabItem value="pv" label="PV">
+
+<DeviceConfig code={`meters:
+    - name: my_pv
+      type: template
+      template: qcells-hybrid-cloud
+      usage: pv
+      tokenid: # Go to https://qhome-ess-g3.q-cells.eu/#/api/ and take the value of "ObtaintokenID".
+      serial: # Go to https://qhome-ess-g3.q-cells.eu/blue/#/inverter and take the value of registration number.`}  />
+
+
+
+</TabItem>
+<TabItem value="battery" label="Batterie">
+
+<DeviceConfig code={`meters:
+    - name: my_battery
+      type: template
+      template: qcells-hybrid-cloud
+      usage: battery
+      tokenid: # Go to https://qhome-ess-g3.q-cells.eu/#/api/ and take the value of "ObtaintokenID".
+      serial: # Go to https://qhome-ess-g3.q-cells.eu/blue/#/inverter and take the value of registration number.`} advanced={`meters:
+    - name: my_battery
+      type: template
+      template: qcells-hybrid-cloud
+      usage: battery
+      tokenid: # Go to https://qhome-ess-g3.q-cells.eu/#/api/ and take the value of "ObtaintokenID".
+      serial: # Go to https://qhome-ess-g3.q-cells.eu/blue/#/inverter and take the value of registration number.
+      capacity: 50 # Battery capacity in kWh (optional)`} />
+
+
+
 </TabItem>
 </Tabs>
 
@@ -6423,7 +6482,8 @@ In the web interface of the SMA Data Manager you need to activate "Modbus Server
       host: 192.0.2.2 # Hostname
       port: 502 # Port
       capacity: 50 # Battery capacity in kWh (optional)
-      watchdog: 30s # optional`} />
+      watchdog: 30s # optional
+      chargepower: 100000 # Charging power for grid charging in W (optional)`} />
 
 
 
@@ -10549,7 +10609,7 @@ An externally connected S0 generation meter is required to record the solar prod
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## Zendure Hyper V
+## Zendure Hyper 2000
 
 <DeviceFeatures features="skiptest" />
 
@@ -10561,8 +10621,9 @@ An externally connected S0 generation meter is required to record the solar prod
       type: template
       template: zendure
       usage: pv
-      account: # optional
-      serial: # optional
+      account: [email protected]
+      serial: VU5D99F74021B04 # You can find this in the Zendure App in the settings of the device
+      region: EU # optional
       timeout: 10s # optional`}  />
 
 
@@ -10575,15 +10636,17 @@ An externally connected S0 generation meter is required to record the solar prod
       type: template
       template: zendure
       usage: battery
-      account: # optional
-      serial: # optional
+      account: [email protected]
+      serial: VU5D99F74021B04 # You can find this in the Zendure App in the settings of the device
+      region: EU # optional
       timeout: 10s # optional`} advanced={`meters:
     - name: my_battery
       type: template
       template: zendure
       usage: battery
-      account: # optional
-      serial: # optional
+      account: [email protected]
+      serial: VU5D99F74021B04 # You can find this in the Zendure App in the settings of the device
+      region: EU # optional
       timeout: 10s # optional
       capacity: 2 # Battery capacity in kWh (optional)`} />
 
@@ -11392,12 +11455,27 @@ For demonstration purposes. Meter with a fixed set of values.
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-### Shelly 1PM, EM, Plug S
+### Shelly 1PM, EM, Plug S, Pro 3EM in monophase mode
 
 <DeviceFeatures features="" />
 
 <Tabs>
-<TabItem value="pv" label="PV" default>
+<TabItem value="grid" label="Netz" default>
+
+<DeviceConfig code={`meters:
+    - name: my_grid
+      type: template
+      template: shelly-1pm
+      usage: grid
+      host: 192.0.2.2 # IP address or hostname
+      user: # User account (e.g. email address, user id, etc.) (optional)
+      password: # Password of the user account (use single quotes in case of leading zeros) (optional)
+      channel: 0 # optional`}  />
+
+
+
+</TabItem>
+<TabItem value="pv" label="PV">
 
 <DeviceConfig code={`meters:
     - name: my_pv

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx
@@ -136,6 +136,7 @@ The availability and general quality of Vehicle data can vary greatly by manufac
       identifiers: # Mostly this can be added later, see: https://docs.evcc.io/en/docs/features/vehicle (optional)
       priority: # Priority of the loadpoint or vehicle in relation to other loadpoints or vehicles for allocating pv energy (optional)
       region: EU # optional
+      coarsecurrent: # 1A current control (optional)
       welcomecharge: # Charger will enable charging for short time when vehicle is connected, irrespective of configured charge mode. This is useful for vehicles that require power supply when connecting. (optional)`} />
 
 
@@ -1443,6 +1444,37 @@ Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT bro
 
 
 
+<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/vehicle  -->
+
+### Tessie
+
+Connect your Tesla using the Tessie API. This will never wake up the car, polling can be set to "always" and interval "1M". If the vehicle is awake, the data is usually less than 15 seconds old. If the vehicle is asleep, the data is from the time the vehicle went to sleep. Get your token at https://dash.tessie.com/settings/api
+
+<DeviceConfig code={`vehicles:
+    - name: my_car
+      type: template
+      template: tessie
+      title: # Will be displayed in the user interface (optional)
+      vin: W... # Required if you own multiple vehicles of the same brand
+      token:
+      capacity: 50 # Battery capacity in kWh (optional)`} advanced={`vehicles:
+    - name: my_car
+      type: template
+      template: tessie
+      title: # Will be displayed in the user interface (optional)
+      vin: W... # Required if you own multiple vehicles of the same brand
+      token:
+      capacity: 50 # Battery capacity in kWh (optional)
+      phases: 3 # The maximum number of phases which can be used (optional)
+      icon: car # Icon as shown in user interface (optional)
+      mode: # Possible values are Off, Now, MinPV and PV, or empty if none should be set (optional)
+      minCurrent: 6 # The minimum amperage per connected phase with which the car should be charged (optional)
+      maxCurrent: 16 # The maximum amperage per connected phase with which the car shuold be charged (optional)
+      identifiers: # Mostly this can be added later, see: https://docs.evcc.io/en/docs/features/vehicle (optional)
+      priority: # Priority of the loadpoint or vehicle in relation to other loadpoints or vehicles for allocating pv energy (optional)`} />
+
+
+
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/vehicle  -->
 
 ### Tronity