Generate docs from templates

evcc-io · Nov 26, 2023 · a4b9ae7 · a4b9ae7
1 parent 3e5ef34
commit a4b9ae7
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 32 deletions.
diff --git a/docs/devices/chargers.mdx b/docs/devices/chargers.mdx
@@ -193,7 +193,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-### Wallbox Mini/Power
+### Wallbox Mini, Power
 
 <DeviceFeatures features="" />
 
@@ -732,7 +732,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## EM2GO Pro Power/OCPP/ONC
+## EM2GO Pro Power, OCPP/ONC
 
 <DeviceFeatures features="mA,sponsorfree" />
 
@@ -1217,7 +1217,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## LadeFoxx EvLoad/ Mikro 2.0
+## LadeFoxx EvLoad, Mikro 2.0
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -2080,7 +2080,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## Vestel EVC04 Home Smart/Connect Plus
+## Vestel EVC04 Home Smart, Connect Plus
 
 <DeviceFeatures features="" />
 
@@ -2101,7 +2101,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## Victron EV charging station
+## Victron EV Charging Station
 
 <DeviceFeatures features="" />
 
@@ -2263,7 +2263,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## wallbox Pulsar Plus / Commander 2 / Copper SB
+## wallbox Pulsar Plus, Commander 2, Copper SB
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -2375,7 +2375,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## Zaptec Go/Pro
+## Zaptec Go, Pro
 
 <DeviceFeatures features="" />
 
@@ -2523,7 +2523,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-### Homematic / Homematic IP 
+### Homematic IP 
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -2590,7 +2590,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-### Tasmota (1 Phase Charger) 
+### Tasmota einphasig
 
 <DeviceFeatures features="sponsorfree" />
 

diff --git a/docs/devices/meters.mdx b/docs/devices/meters.mdx
@@ -2618,6 +2618,9 @@ meters:
 
 <DeviceFeatures features="sponsorfree" />
 
+Nur ein System kann und darf auf den Wechselrichter zugreifen!
+Für die optionale Batteriesteuerung muss Modbus Bytereihenfolge auf BigEndian (Sunspec) konfiguriert sein.
+
 <Tabs>
 <TabItem value="pv" label="PV" default>
 
@@ -4002,12 +4005,12 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## Smartfox Smartfox Reg/Reg extended/Pro/Pro 2/Pro Light/Pro Light 2/Light
+## Smartfox Pro, Pro 2, Pro Light, Pro Light 2, Light, Reg, Reg extended
 
 <DeviceFeatures features="sponsorfree" />
 
-Kann verwendet werden, um Daten für 'grid', 'pv' und 'aux' zu erhalten.
-Wenn "usage" nicht definiert ist, wird die Leistung für die Warmwasserbereitung zurückgegeben (als "aux" zu verwenden).
+Kann verwendet werden, um Daten für `grid`, `pv` und `aux` zu erhalten.
+Wenn `usage` nicht definiert ist, wird die Leistung für die Warmwasserbereitung zurückgegeben (als `aux` zu verwenden).
 
 <Tabs>
 <TabItem value="grid" label="Netz" default>
@@ -4359,7 +4362,7 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-### Inverter / Hybrid Inverter
+### Inverter, Hybrid Inverter
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -5982,10 +5985,12 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## VARTA pulse/ pulse neo/ element (PV nur verfügbar mit PV-Sensor)
+## VARTA pulse, pulse neo, element
 
 <DeviceFeatures features="sponsorfree" />
 
+PV nur verfügbar mit PV-Sensor
+
 <Tabs>
 <TabItem value="grid" label="Netz" default>
 
@@ -6113,7 +6118,7 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## ZCS Azzurro Inverter / Hybrid Inverter
+## ZCS Azzurro Inverter, Hybrid Inverter
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -6756,10 +6761,12 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used)
+### Tasmota dreiphasig
 
 <DeviceFeatures features="sponsorfree" />
 
+Kanäle 1,2,3 müssen verwendet werden.
+
 <Tabs>
 <TabItem value="grid" label="Netz" default>
 

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx
@@ -194,7 +194,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-### Wallbox Mini/Power
+### Wallbox Mini, Power
 
 <DeviceFeatures features="" />
 
@@ -733,7 +733,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## EM2GO Pro Power/OCPP/ONC
+## EM2GO Pro Power, OCPP/ONC
 
 <DeviceFeatures features="mA,sponsorfree" />
 
@@ -1218,7 +1218,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## LadeFoxx EvLoad/ Mikro 2.0
+## LadeFoxx EvLoad, Mikro 2.0
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -2081,7 +2081,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## Vestel EVC04 Home Smart/Connect Plus
+## Vestel EVC04 Home Smart, Connect Plus
 
 <DeviceFeatures features="" />
 
@@ -2102,7 +2102,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## Victron EV charging station
+## Victron EV Charging Station
 
 <DeviceFeatures features="" />
 
@@ -2264,7 +2264,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## wallbox Pulsar Plus / Commander 2 / Copper SB
+## wallbox Pulsar Plus, Commander 2, Copper SB
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -2376,7 +2376,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-## Zaptec Go/Pro
+## Zaptec Go, Pro
 
 <DeviceFeatures features="" />
 
@@ -2522,7 +2522,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-### Homematic / Homematic IP 
+### Homematic IP 
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -2589,7 +2589,7 @@ chargers:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger  -->
 
-### Tasmota (1 Phase Charger) 
+### Tasmota single phase
 
 <DeviceFeatures features="sponsorfree" />
 

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx
@@ -2620,6 +2620,9 @@ meters:
 
 <DeviceFeatures features="sponsorfree" />
 
+Only one system may access the inverter!
+For optional battery control, Modbus byte order must be set to BigEndian (Sunspec).
+
 <Tabs>
 <TabItem value="pv" label="PV" default>
 
@@ -4039,12 +4042,12 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## Smartfox Smartfox Reg/Reg extended/Pro/Pro 2/Pro Light/Pro Light 2/Light
+## Smartfox Pro, Pro 2, Pro Light, Pro Light 2, Light, Reg, Reg extended
 
 <DeviceFeatures features="sponsorfree" />
 
-Can be used to get 'grid', 'pv' and 'aux' data.
-If 'usage' is not defined, then return the power for the water heating (to be used as 'aux').
+Can be used to get `grid`, `pv` and `aux` data.
+If `usage` is not defined, then return the power for the water heating (to be used as `aux`).
 
 <Tabs>
 <TabItem value="grid" label="Netz" default>
@@ -4361,7 +4364,7 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-### Inverter / Hybrid Inverter
+### Inverter, Hybrid Inverter
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -5984,10 +5987,12 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## VARTA pulse/ pulse neo/ element (PV only available with PV sensor)
+## VARTA pulse, pulse neo, element
 
 <DeviceFeatures features="sponsorfree" />
 
+PV only available with PV sensor
+
 <Tabs>
 <TabItem value="grid" label="Netz" default>
 
@@ -6115,7 +6120,7 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-## ZCS Azzurro Inverter / Hybrid Inverter
+## ZCS Azzurro Inverter, Hybrid Inverter
 
 <DeviceFeatures features="sponsorfree" />
 
@@ -6758,10 +6763,12 @@ meters:
 
 <!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/meter  -->
 
-### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used)
+### Tasmota three phase
 
 <DeviceFeatures features="sponsorfree" />
 
+Meter channels 1,2,3 must be used.
+
 <Tabs>
 <TabItem value="grid" label="Netz" default>