From eb67169436d4097a521da2cfb8df9573a4b39897 Mon Sep 17 00:00:00 2001 From: Andreas Linde <42185+DerAndereAndi@users.noreply.github.com> Date: Fri, 28 Jan 2022 16:00:50 +0100 Subject: [PATCH] Template Updates (#2392) - Fix Powerdog template PV section - Add Solax Hybrid X3 template - Add Solax Cloud templates - Add SMA Data Manager M Lite template - Add Senec Wallbox pro s - Update Victron template - Improve text if no charge meter could be detected - Add `phases` parameter for vehicles in advanced mode --- cmd/configure/helper.go | 4 + cmd/configure/localization/de.toml | 4 +- cmd/configure/localization/en.toml | 4 +- templates/definition/charger/heidelberg.yaml | 3 + templates/definition/defaults.yaml | 15 ++++ templates/definition/meter/powerdog.yaml | 2 +- .../meter/sma-datamanager-m-lite.yaml | 35 +++++++++ .../definition/meter/solax-hybrid-cloud.yaml | 70 +++++++++++++++++ .../meter/solax-inverter-cloud.yaml | 45 +++++++++++ templates/definition/meter/solax-x3.yaml | 68 +++++++++++++++++ .../definition/meter/victron-energy.yaml | 75 +++++++++++++++---- templates/definition/vehicle/evnotify.yaml | 5 ++ templates/definition/vehicle/ovms.yaml | 5 ++ templates/definition/vehicle/tesla.yaml | 5 ++ templates/definition/vehicle/tronity.yaml | 5 ++ templates/docs/charger/heidelberg_1.yaml | 4 +- templates/docs/charger/heidelberg_2.yaml | 19 +++++ .../docs/meter/sma-data-manager-m-lite_0.yaml | 14 ++++ .../docs/meter/solax-hybrid-cloud_0.yaml | 31 ++++++++ .../docs/meter/solax-inverter-cloud_0.yaml | 17 +++++ templates/docs/meter/solax-x3_0.yaml | 28 +++++++ templates/docs/vehicle/audi_0.yaml | 2 +- templates/docs/vehicle/bmw_0.yaml | 2 +- templates/docs/vehicle/carwings_0.yaml | 2 +- templates/docs/vehicle/citroen_0.yaml | 2 +- templates/docs/vehicle/dacia_0.yaml | 2 +- templates/docs/vehicle/ds_0.yaml | 2 +- templates/docs/vehicle/enyaq_0.yaml | 2 +- templates/docs/vehicle/evnotify_0.yaml | 1 + templates/docs/vehicle/fiat_0.yaml | 2 +- templates/docs/vehicle/ford_0.yaml | 2 +- templates/docs/vehicle/hyundai_0.yaml | 2 +- templates/docs/vehicle/id_0.yaml | 2 +- templates/docs/vehicle/kia_0.yaml | 2 +- templates/docs/vehicle/mini_0.yaml | 2 +- templates/docs/vehicle/nissan_0.yaml | 2 +- templates/docs/vehicle/opel_0.yaml | 2 +- templates/docs/vehicle/ovms_0.yaml | 1 + templates/docs/vehicle/peugeot_0.yaml | 2 +- templates/docs/vehicle/porsche_0.yaml | 2 +- templates/docs/vehicle/renault_0.yaml | 2 +- templates/docs/vehicle/seat_0.yaml | 2 +- templates/docs/vehicle/seat_1.yaml | 2 +- templates/docs/vehicle/skoda_0.yaml | 2 +- templates/docs/vehicle/tesla_0.yaml | 1 + templates/docs/vehicle/tronity_0.yaml | 1 + templates/docs/vehicle/volvo_0.yaml | 2 +- templates/docs/vehicle/vw_0.yaml | 2 +- util/templates/template_documentation.go | 4 +- util/templates/template_types.go | 1 + 50 files changed, 465 insertions(+), 48 deletions(-) create mode 100644 templates/definition/meter/sma-datamanager-m-lite.yaml create mode 100644 templates/definition/meter/solax-hybrid-cloud.yaml create mode 100644 templates/definition/meter/solax-inverter-cloud.yaml create mode 100644 templates/definition/meter/solax-x3.yaml create mode 100644 templates/docs/charger/heidelberg_2.yaml create mode 100644 templates/docs/meter/sma-data-manager-m-lite_0.yaml create mode 100644 templates/docs/meter/solax-hybrid-cloud_0.yaml create mode 100644 templates/docs/meter/solax-inverter-cloud_0.yaml create mode 100644 templates/docs/meter/solax-x3_0.yaml diff --git a/cmd/configure/helper.go b/cmd/configure/helper.go index d487e09c7..85293dcab 100644 --- a/cmd/configure/helper.go +++ b/cmd/configure/helper.go @@ -408,6 +408,10 @@ func (c *CmdConfigure) processParams(templateItem templates.Template, params []t continue } + if param.Deprecated { + continue + } + if param.Hidden && param.Default != "" { additionalConfig[param.Name] = param.Default continue diff --git a/cmd/configure/localization/de.toml b/cmd/configure/localization/de.toml index 2d1e099f0..cb826cd4b 100644 --- a/cmd/configure/localization/de.toml +++ b/cmd/configure/localization/de.toml @@ -87,7 +87,7 @@ Config_AddAnotherValue = "Möchtest du einen weiteren Wert hinzufügen?" Config_Yes = "Ja" Config_No = "Nein" -Cancel = "Die Konfiguration wurde abgebrochen.\n\nFalls diese geführte Konfiguration für dich noch nicht funktioniert, versuche es doch mal mit der manuellen Konfiguration. Details findest du auf der folgenden Webseite: https://docs.evcc.io/docs/installation/configuration\n" +Cancel = "Die Konfiguration wurde abgebrochen.\n\nFalls diese geführte Konfiguration für dich noch nicht funktioniert, versuche es doch mal mit der manuellen Konfiguration. Details findest du auf der folgenden Webseite: https://docs.evcc.io/docs/\n" InputError = "Bei der Eingabe ist ein Fehler aufgetreten:" Value_Required = "erforderlich" @@ -110,7 +110,7 @@ Loadpoint_DefaultTitle = "Garage" Loadpoint_ResetOnDisconnect = "Soll beim Abstecken des Ladekables von einem Fahrzeug, die Lade-Standardeinstellungen wieder hergestellt werden?" -Loadpoint_WallboxWOMeter = "Die Wallbox hat keinen Ladestromzähler. Hast du einen externen Zähler dafür installiert, der verwendet werden kann?" +Loadpoint_WallboxWOMeter = "Das System konnte nicht erkennen ob ein Ladestromzähler in der Wallbox eingebaut ist. Möchtest du einen externen Ladestromzähler hinzufügen?" Loadpoint_WallboxMaxPower = "Was ist die maximale Leistung, welche die Wallbox zur Verfügung stellen kann?" Loadpoint_WallboxMinAmperage = "Was ist die MINIMALE Stromstärke, welche die Wallbox auf einer Phase zur Verfügung stellen kann?" Loadpoint_WallboxMaxAmperage = "Was ist die MAXIMALE Stromstärke, welche die Wallbox auf einer Phase zur Verfügung stellen kann?" diff --git a/cmd/configure/localization/en.toml b/cmd/configure/localization/en.toml index 7023eba59..a3f35161c 100644 --- a/cmd/configure/localization/en.toml +++ b/cmd/configure/localization/en.toml @@ -87,7 +87,7 @@ Config_AddAnotherValue = "Do you want to add another value?" Config_Yes = "Yes" Config_No = "No" -Cancel = "The configuration was cancelled.\n\nIf this guided configuration process doesn't work for you yet, please try the manual configuration. You can find more details about that on our website: https://docs.evcc.io/docs/installation/configuration\n" +Cancel = "The configuration was cancelled.\n\nIf this guided configuration process doesn't work for you yet, please try the manual configuration. You can find more details about that on our website: https://docs.evcc.io/docs/\n" InputError = "An input error occurred:" Value_Required = "required" @@ -110,7 +110,7 @@ Loadpoint_DefaultTitle = "Garage" Loadpoint_ResetOnDisconnect = "Shall disconnecting the charging cable from the vehicle reset the charging settings to the defaults?" -Loadpoint_WallboxWOMeter = "The wallbox does not provide power data. Do you have an external meter that can be used?" +Loadpoint_WallboxWOMeter = "The system could not detect if the wallbox provides power data. Do you want to add an external meter instead?" Loadpoint_WallboxMaxPower = "What is the maximum power your wallbox can provide?" Loadpoint_WallboxMinAmperage = "What is the MINIMUM amperage your wallbox can provide on a single phase?" Loadpoint_WallboxMaxAmperage = "What is the MAXIMUM amperage your wallbox can provide on a single phase?" diff --git a/templates/definition/charger/heidelberg.yaml b/templates/definition/charger/heidelberg.yaml index 5c40aa086..263d36fd6 100644 --- a/templates/definition/charger/heidelberg.yaml +++ b/templates/definition/charger/heidelberg.yaml @@ -3,6 +3,9 @@ products: - brand: Heidelberg description: generic: Energy Control (Modbus RTU) +- brand: SENEC + description: + generic: Wallbox pro s - brand: Walther Werke description: generic: Basic Evo Pro diff --git a/templates/definition/defaults.yaml b/templates/definition/defaults.yaml index 66c6fff72..058cd4246 100644 --- a/templates/definition/defaults.yaml +++ b/templates/definition/defaults.yaml @@ -84,6 +84,15 @@ params: de: Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind en: Required if you own multiple vehicles of the same brand example: W... +- name: phases + description: + de: Maximale Phasenanzahl + en: Maximum number of phases + help: + de: Die maximale Anzahl der Phasen welche genutzt werden können + en: The maximum number of phases which can be used + example: 3 + valuetype: number - name: cache description: de: Cache @@ -163,8 +172,11 @@ presets: required: true - name: vin - name: capacity + - name: phases + advanced: true - name: cache advanced: true + deprecated: true render: | {{define "vehicle-base"}} {{- if ne .title "" }} @@ -178,6 +190,9 @@ presets: {{- if ne .vin "" }} vin: {{ .vin }} {{- end }} + {{- if ne .phases "" }} + phases: {{ .phases }} + {{- end }} {{- if ne .cache "" }} cache: {{ .cache }} {{- end }} diff --git a/templates/definition/meter/powerdog.yaml b/templates/definition/meter/powerdog.yaml index 154d728fb..fa8955f44 100644 --- a/templates/definition/meter/powerdog.yaml +++ b/templates/definition/meter/powerdog.yaml @@ -30,7 +30,7 @@ render: | scale: -1 #scale with -1 to get a substraction {{- end }} {{- if eq .usage "pv" }} - type: modbus + source: modbus {{ include "modbus" . | indent 2 }} register: address: 40002 #register for pv effort diff --git a/templates/definition/meter/sma-datamanager-m-lite.yaml b/templates/definition/meter/sma-datamanager-m-lite.yaml new file mode 100644 index 000000000..6a75f0165 --- /dev/null +++ b/templates/definition/meter/sma-datamanager-m-lite.yaml @@ -0,0 +1,35 @@ +template: sma-data-manager-m-lite +products: +- brand: SMA + description: + generic: Data Manager M Lite +guidedsetup: + enable: true + linked: + - template: sma-energy-meter + usage: grid + - template: sma-inverter + usage: battery + multiple: true +requirements: + description: + de: In der Weboberfläche des SMA Data Manager muss im Bereich "Externe Kommunikation" der Schalter "Modbus Server aktivieren" eingeschaltet sein. + en: In the web interface of the SMA Data Manager you need to activate "Modbus Server activated" in the section "External communication". +params: +- name: usage + choice: ["pv"] +- name: host + example: 192.0.2.2 + required: true +- name: port + default: 502 +render: | + type: custom + power: + source: modbus + uri: {{ .host }}:{{ .port }} # Port 502 + id: 2 + register: + address: 30775 # Aktuelle PV-Einspeiseleistung + type: holding + decode: int32 \ No newline at end of file diff --git a/templates/definition/meter/solax-hybrid-cloud.yaml b/templates/definition/meter/solax-hybrid-cloud.yaml new file mode 100644 index 000000000..065e65614 --- /dev/null +++ b/templates/definition/meter/solax-hybrid-cloud.yaml @@ -0,0 +1,70 @@ +template: solax-hybrid-cloud +products: +- brand: Solax + description: + generic: Hybrid (Cloud) +requirements: + description: + de: | + Der Solax Inverter muss in der SolaxCloud 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! + en: | + The Solax inverter has to be registered in the SolaxCloud. + + **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! +guidedsetup: + enable: true +params: +- name: usage + choice: [ "grid", "pv", "battery" ] +- name: tokenid + required: true + description: + generic: SolaxCloud TokenID + help: + de: Auf https://www.solaxcloud.com/#/api den Wert von "ObtaintokenID" hier eintragen. + en: Go to https://www.solaxcloud.com/#/api and take the value of "ObtaintokenID". +- name: serial + required: true + description: + de: Seriennummer + en: Serial number + help: + de: Auf https://www.solaxcloud.com/#/inverter die Registriernummer hier eintragen. + en: Go to https://www.solaxcloud.com/#/inverter and take the value of registration number +render: | + type: custom + power: + {{- if eq .usage "grid" }} + source: http + uri: https://www.eu.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do?tokenId=={{ .tokenid }}&sn={{ .serial}} + jq: .result.feedinpower + cache: 2m30s + {{- end}} + {{- if eq .usage "pv" }} + source: calc + add: + # Hybrid WR XXXXXXXXXXXXXX + # DC MPPT1 + MPPT2 + - source: http + uri: https://www.eu.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do?tokenId={{ .tokenid }}&sn={{ .serial}} + jq: .result.powerdc1 # Solax API Inverter.DC.PV.power.MPPT1 + cache: 2m30s + - source: http + uri: https://www.eu.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do?tokenId={{ .tokenid }}&sn={{ .serial}} + jq: .result.powerdc2 # Solax API Inverter.DC.PV.power.MPPT2 + cache: 2m30s + {{- end }} + {{- if eq .usage "battery" }} + source: http + uri: https://www.eu.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do?tokenId={{ .tokenid }}&sn={{ .serial}} + jq: .result.batPower # Solax API inverter.DC.battery.power.total + scale: -1 + cache: 2m30s + soc: + source: http + uri: https://www.eu.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do?tokenId={{ .tokenid }}&sn={{ .serial}} + jq: .result.soc # Solax API inverter.DC.battery.energy.SOC + cache: 2m30s + {{- end }} diff --git a/templates/definition/meter/solax-inverter-cloud.yaml b/templates/definition/meter/solax-inverter-cloud.yaml new file mode 100644 index 000000000..58c056813 --- /dev/null +++ b/templates/definition/meter/solax-inverter-cloud.yaml @@ -0,0 +1,45 @@ +template: solax-inverter-cloud +products: +- brand: Solax + description: + de: Wechselrichter (Cloud) + en: Inverter (Cloud) +requirements: + description: + de: | + Der Solax Inverter muss in der SolaxCloud 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! + en: | + The Solax inverter has to be registered in the SolaxCloud. + + **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! +params: +- name: usage + choice: [ "pv" ] +- name: tokenid + required: true + description: + generic: SolaxCloud TokenID + help: + de: Auf https://www.solaxcloud.com/#/api den Wert von "ObtaintokenID" hier eintragen. + en: Go to https://www.solaxcloud.com/#/api and take the value of "ObtaintokenID". +- name: serial + required: true + description: + de: Seriennummer + en: Serial number + help: + de: Auf https://www.solaxcloud.com/#/inverter die Registriernummer hier eintragen. + en: Go to https://www.solaxcloud.com/#/inverter and take the value of registration number +render: | + type: custom + power: + {{- if eq .usage "pv" }} + # Mini WR XXXXXXXXXXXX + # AC Power + source: http + uri: https://www.eu.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do?tokenId={{ .tokenid }}&sn={{ .serial}} + jq: if .result.acpower < 10 then 0 else .result.acpower end # Solax API Inverter.AC.power.total + cache: 2m30s + {{- end }} diff --git a/templates/definition/meter/solax-x3.yaml b/templates/definition/meter/solax-x3.yaml new file mode 100644 index 000000000..d5ba3ef05 --- /dev/null +++ b/templates/definition/meter/solax-x3.yaml @@ -0,0 +1,68 @@ +template: solax-x3 +products: +- brand: Solax + description: + generic: Hybrid X3 +requirements: + description: + de: Der Solax Inverter muss via Ethernet an das lokale Netzwerk angeschlossen sein. + en: The Solax inverter has to be connected to the local network via ethernet. +guidedsetup: + enable: true +params: +- name: usage + choice: [ "grid", "pv", "battery" ] +- name: host + required: true + example: 192.0.2.2 +- name: port + required: true + default: 502 +render: | + type: custom + power: + {{- if eq .usage "grid" }} + source: modbus + uri: {{ .host }}:{{ .port }} + id: 1 + register: # manual non-sunspec register configuration + address: 192 #(see Hybrid.X1.X3-G3.ModbusTCP.RTU.V3.21-.English.pdf) + type: input + decode: int32s + scale: -1 + {{- end }} + {{- if eq .usage "pv" }} + source: calc + add: + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 1 + register: # manual non-sunspec register configuration + address: 10 #(see Hybrid.X1.X3-G3.ModbusTCP.RTU.V3.21-.English.pdf) + type: input + decode: uint16 + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 1 + register: # manual non-sunspec register configuration + address: 11 #(see Hybrid.X1.X3-G3.ModbusTCP.RTU.V3.21-.English.pdf) + type: input + decode: uint16 + {{- end }} + {{- if eq .usage "battery" }} + source: modbus + uri: {{ .host }}:{{ .port }} + id: 1 + register: # manual non-sunspec register configuration + address: 22 #(see Hybrid.X1.X3-G3.ModbusTCP.RTU.V3.21-.English.pdf) + type: input + decode: int16 + soc: + source: modbus + uri: {{ .host }}:{{ .port }} + id: 1 + register: + address: 28 #(see Hybrid.X1.X3-G3.ModbusTCP.RTU.V3.21-.English.pdf) + type: input + decode: Uint16 + {{- end }} diff --git a/templates/definition/meter/victron-energy.yaml b/templates/definition/meter/victron-energy.yaml index 4965fe4d6..5db33d5cf 100644 --- a/templates/definition/meter/victron-energy.yaml +++ b/templates/definition/meter/victron-energy.yaml @@ -21,34 +21,78 @@ render: | add: - source: modbus uri: {{ .host }}:{{ .port }} - id: 50 # com.victronenergy.grid + id: 100 # com.victronenergy.system register: - address: 2600 # L1 grid power + address: 820 # L1 grid power type: input decode: int16 - source: modbus uri: {{ .host }}:{{ .port }} - id: 50 # com.victronenergy.grid + id: 100 # com.victronenergy.system register: - address: 2601 # L2 grid power + address: 821 # L2 grid power type: input decode: int16 - source: modbus uri: {{ .host }}:{{ .port }} - id: 50 # com.victronenergy.grid + id: 100 # com.victronenergy.system register: - address: 2602 # L3 grid power + address: 822 # L3 grid power type: input decode: int16 {{- end }} {{- if eq .usage "pv" }} - source: modbus - uri: {{ .host }}:{{ .port }} - id: 20 # com.victronenergy.pvinverter - register: - address: 1052 # Total AC Power - type: input - decode: int32 + source: calc + add: + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 100 # com.victronenergy.system + register: + address: 808 # ACout pv power L1 + type: input + decode: uint16 + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 100 # com.victronenergy.system + register: + address: 809 # ACout pv power L2 + type: input + decode: uint16 + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 100 # com.victronenergy.system + register: + address: 810 # ACout pv power L3 + type: input + decode: uint16 + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 100 # com.victronenergy.system + register: + address: 811 # ACin pv power L1 + type: input + decode: uint16 + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 100 # com.victronenergy.system + register: + address: 812 # ACin pv power L2 + type: input + decode: uint16 + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 100 # com.victronenergy.system + register: + address: 813 # ACin pv power L3 + type: input + decode: uint16 + - source: modbus + uri: {{ .host }}:{{ .port }} + id: 100 # com.victronenergy.system + register: + address: 850 # DC pv power + type: input + decode: uint16 {{- end }} {{- if eq .usage "battery" }} source: modbus @@ -62,10 +106,9 @@ render: | soc: source: modbus uri: {{ .host }}:{{ .port }} - id: 225 # com.victronenergy.battery + id: 100 # com.victronenergy.system register: - address: 266 # SoC + address: 843 # SoC type: input decode: uint16 - scale: 0.1 {{- end }} diff --git a/templates/definition/vehicle/evnotify.yaml b/templates/definition/vehicle/evnotify.yaml index 37917d11b..dfce0aa96 100644 --- a/templates/definition/vehicle/evnotify.yaml +++ b/templates/definition/vehicle/evnotify.yaml @@ -12,6 +12,8 @@ params: - name: capacity default: 64 valuetype: float +- name: phases + advanced: true - preset: vehicleidentify render: | type: custom @@ -19,6 +21,9 @@ render: | title: {{ .title }} {{- end }} capacity: {{ .capacity }} + {{- if ne .phases "" }} + phases: {{ .phases }} + {{- end }} soc: type: http uri: https://app.evnotify.de/soc?akey={{ .akey }}&token={{ .token }} # evNotify Server + AKEY diff --git a/templates/definition/vehicle/ovms.yaml b/templates/definition/vehicle/ovms.yaml index dc379b4ce..d59b6be42 100644 --- a/templates/definition/vehicle/ovms.yaml +++ b/templates/definition/vehicle/ovms.yaml @@ -14,6 +14,8 @@ params: required: true - name: capacity default: 12 +- name: phases + advanced: true - preset: vehicleidentify render: | type: ovms @@ -24,5 +26,8 @@ render: | password: {{ .password }} vehicleid: {{ .vehicleid }} # vehicle id capacity: {{ .capacity }} + {{- if ne .phases "" }} + phases: {{ .phases }} + {{- end }} server: dexters-web.de # used ovms server [dexters-web.de or api.openvehicles.com] diff --git a/templates/definition/vehicle/tesla.yaml b/templates/definition/vehicle/tesla.yaml index e1704bbd1..85a582761 100644 --- a/templates/definition/vehicle/tesla.yaml +++ b/templates/definition/vehicle/tesla.yaml @@ -33,6 +33,8 @@ params: example: W... - name: capacity default: 90 +- name: phases + advanced: true - preset: vehicleidentify render: | type: tesla @@ -43,6 +45,9 @@ render: | access: {{ .accessToken }} refresh: {{ .refreshToken }} capacity: {{ .capacity }} + {{- if ne .phases "" }} + phases: {{ .phases }} + {{- end }} {{- if ne .vin "" }} vin: {{ .vin }} {{- end }} diff --git a/templates/definition/vehicle/tronity.yaml b/templates/definition/vehicle/tronity.yaml index be6fc9885..380a58e76 100644 --- a/templates/definition/vehicle/tronity.yaml +++ b/templates/definition/vehicle/tronity.yaml @@ -19,6 +19,8 @@ params: example: W... - name: capacity default: 10 +- name: phases + advanced: true - preset: vehicleidentify render: | type: tronity @@ -32,6 +34,9 @@ render: | access: {{ .accessToken }} refresh: {{ .refreshToken }} capacity: {{ .capacity }} + {{- if ne .phases "" }} + phases: {{ .phases }} + {{- end }} {{- if ne .vin "" }} vin: {{ .vin }} {{- end }} diff --git a/templates/docs/charger/heidelberg_1.yaml b/templates/docs/charger/heidelberg_1.yaml index ea84a9a4f..86eb479c0 100644 --- a/templates/docs/charger/heidelberg_1.yaml +++ b/templates/docs/charger/heidelberg_1.yaml @@ -1,6 +1,6 @@ product: - brand: Walther Werke - description: Basic Evo Pro + brand: SENEC + description: Wallbox pro s requirements: ["sponsorship"] render: diff --git a/templates/docs/charger/heidelberg_2.yaml b/templates/docs/charger/heidelberg_2.yaml new file mode 100644 index 000000000..ea84a9a4f --- /dev/null +++ b/templates/docs/charger/heidelberg_2.yaml @@ -0,0 +1,19 @@ +product: + brand: Walther Werke + description: Basic Evo Pro +requirements: ["sponsorship"] + +render: +- default: | + type: template + template: heidelberg + # Modbus Start + id: 1 + # RS485 via adapter: + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8E1" # Kommunikationsparameter für den Adapter + # RS485 via TCPIP: + uri: 192.0.2.2:502 # IP-Adresse oder Hostname: Port + rtu: true + # Modbus End \ No newline at end of file diff --git a/templates/docs/meter/sma-data-manager-m-lite_0.yaml b/templates/docs/meter/sma-data-manager-m-lite_0.yaml new file mode 100644 index 000000000..ca7108288 --- /dev/null +++ b/templates/docs/meter/sma-data-manager-m-lite_0.yaml @@ -0,0 +1,14 @@ +product: + brand: SMA + description: Data Manager M Lite +description: | + In der Weboberfläche des SMA Data Manager muss im Bereich "Externe Kommunikation" der Schalter "Modbus Server aktivieren" eingeschaltet sein. + +render: +- usage: pv + default: | + type: template + template: sma-data-manager-m-lite + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port # Optional \ No newline at end of file diff --git a/templates/docs/meter/solax-hybrid-cloud_0.yaml b/templates/docs/meter/solax-hybrid-cloud_0.yaml new file mode 100644 index 000000000..8f09efd77 --- /dev/null +++ b/templates/docs/meter/solax-hybrid-cloud_0.yaml @@ -0,0 +1,31 @@ +product: + brand: Solax + description: Hybrid (Cloud) +description: | + Der Solax Inverter muss in der SolaxCloud 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! + + +render: +- usage: grid + default: | + 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. +- usage: pv + default: | + 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. +- usage: battery + default: | + 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. \ No newline at end of file diff --git a/templates/docs/meter/solax-inverter-cloud_0.yaml b/templates/docs/meter/solax-inverter-cloud_0.yaml new file mode 100644 index 000000000..b1c3d148b --- /dev/null +++ b/templates/docs/meter/solax-inverter-cloud_0.yaml @@ -0,0 +1,17 @@ +product: + brand: Solax + description: Wechselrichter (Cloud) +description: | + Der Solax Inverter muss in der SolaxCloud 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! + + +render: +- usage: pv + default: | + type: template + template: solax-inverter-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. \ No newline at end of file diff --git a/templates/docs/meter/solax-x3_0.yaml b/templates/docs/meter/solax-x3_0.yaml new file mode 100644 index 000000000..f20c76cb1 --- /dev/null +++ b/templates/docs/meter/solax-x3_0.yaml @@ -0,0 +1,28 @@ +product: + brand: Solax + description: Hybrid X3 +description: | + Der Solax Inverter muss via Ethernet an das lokale Netzwerk angeschlossen sein. + +render: +- usage: grid + default: | + type: template + template: solax-x3 + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port +- usage: pv + default: | + type: template + template: solax-x3 + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port +- usage: battery + default: | + type: template + template: solax-x3 + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port \ No newline at end of file diff --git a/templates/docs/vehicle/audi_0.yaml b/templates/docs/vehicle/audi_0.yaml index a78a66c32..88eb9b197 100644 --- a/templates/docs/vehicle/audi_0.yaml +++ b/templates/docs/vehicle/audi_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: WAUZZZ... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 60 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/bmw_0.yaml b/templates/docs/vehicle/bmw_0.yaml index 2769873f8..e80955c02 100644 --- a/templates/docs/vehicle/bmw_0.yaml +++ b/templates/docs/vehicle/bmw_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: WBMW... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 65 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/carwings_0.yaml b/templates/docs/vehicle/carwings_0.yaml index 9d83dba85..b479d3222 100644 --- a/templates/docs/vehicle/carwings_0.yaml +++ b/templates/docs/vehicle/carwings_0.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 50 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/citroen_0.yaml b/templates/docs/vehicle/citroen_0.yaml index 8b12fd642..85706713c 100644 --- a/templates/docs/vehicle/citroen_0.yaml +++ b/templates/docs/vehicle/citroen_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 50 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/dacia_0.yaml b/templates/docs/vehicle/dacia_0.yaml index e42851769..09521e953 100644 --- a/templates/docs/vehicle/dacia_0.yaml +++ b/templates/docs/vehicle/dacia_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 27.4 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/ds_0.yaml b/templates/docs/vehicle/ds_0.yaml index 0d335b4dc..4e654bb2a 100644 --- a/templates/docs/vehicle/ds_0.yaml +++ b/templates/docs/vehicle/ds_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 50 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/enyaq_0.yaml b/templates/docs/vehicle/enyaq_0.yaml index 20274b9bc..6d1e3fa4e 100644 --- a/templates/docs/vehicle/enyaq_0.yaml +++ b/templates/docs/vehicle/enyaq_0.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 50 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/evnotify_0.yaml b/templates/docs/vehicle/evnotify_0.yaml index 6158ec212..118566fd4 100644 --- a/templates/docs/vehicle/evnotify_0.yaml +++ b/templates/docs/vehicle/evnotify_0.yaml @@ -17,6 +17,7 @@ render: akey: token: capacity: 64 # Akku-Kapazität in kWh # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/fiat_0.yaml b/templates/docs/vehicle/fiat_0.yaml index 5db6225cd..e2b89e3b9 100644 --- a/templates/docs/vehicle/fiat_0.yaml +++ b/templates/docs/vehicle/fiat_0.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: ZFAE... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 42 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # Optional + phases: 3 # Die maximale Anzahl der Phasen welche genutzt werden können # Optional pin: # Optional mode: # Möglich sind Off, Now, MinPV und PV, oder leer wenn keiner definiert werden soll # Optional minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional diff --git a/templates/docs/vehicle/ford_0.yaml b/templates/docs/vehicle/ford_0.yaml index b6545a6ce..9abe31fff 100644 --- a/templates/docs/vehicle/ford_0.yaml +++ b/templates/docs/vehicle/ford_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: WF0FXX... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 10 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/hyundai_0.yaml b/templates/docs/vehicle/hyundai_0.yaml index d1b86d015..de0c0ba49 100644 --- a/templates/docs/vehicle/hyundai_0.yaml +++ b/templates/docs/vehicle/hyundai_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 64 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/id_0.yaml b/templates/docs/vehicle/id_0.yaml index 76cc354f2..4458b23b4 100644 --- a/templates/docs/vehicle/id_0.yaml +++ b/templates/docs/vehicle/id_0.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: WVWZZZ... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 50 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/kia_0.yaml b/templates/docs/vehicle/kia_0.yaml index 1e37062e3..32b418c77 100644 --- a/templates/docs/vehicle/kia_0.yaml +++ b/templates/docs/vehicle/kia_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 64 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/mini_0.yaml b/templates/docs/vehicle/mini_0.yaml index f1083d475..705177280 100644 --- a/templates/docs/vehicle/mini_0.yaml +++ b/templates/docs/vehicle/mini_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: WBMW... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 32 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/nissan_0.yaml b/templates/docs/vehicle/nissan_0.yaml index d1fd70c2e..56ebd6d7e 100644 --- a/templates/docs/vehicle/nissan_0.yaml +++ b/templates/docs/vehicle/nissan_0.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 60 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/opel_0.yaml b/templates/docs/vehicle/opel_0.yaml index d1ab4e23f..eee6cf4f8 100644 --- a/templates/docs/vehicle/opel_0.yaml +++ b/templates/docs/vehicle/opel_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: WP0... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 50 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/ovms_0.yaml b/templates/docs/vehicle/ovms_0.yaml index 28c514a7c..0f3a5e42a 100644 --- a/templates/docs/vehicle/ovms_0.yaml +++ b/templates/docs/vehicle/ovms_0.yaml @@ -19,6 +19,7 @@ render: password: # Passwort des Benutzerkontos vehicleid: capacity: 12 # Akku-Kapazität in kWh # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/peugeot_0.yaml b/templates/docs/vehicle/peugeot_0.yaml index 7b940ea40..b8e60a8f8 100644 --- a/templates/docs/vehicle/peugeot_0.yaml +++ b/templates/docs/vehicle/peugeot_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 50 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/porsche_0.yaml b/templates/docs/vehicle/porsche_0.yaml index 4b545151e..8e7c85166 100644 --- a/templates/docs/vehicle/porsche_0.yaml +++ b/templates/docs/vehicle/porsche_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 83.4 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/renault_0.yaml b/templates/docs/vehicle/renault_0.yaml index 2b8da2fcb..6196c23da 100644 --- a/templates/docs/vehicle/renault_0.yaml +++ b/templates/docs/vehicle/renault_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: WREN... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 60 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/seat_0.yaml b/templates/docs/vehicle/seat_0.yaml index 59e9b3dbb..95709edf4 100644 --- a/templates/docs/vehicle/seat_0.yaml +++ b/templates/docs/vehicle/seat_0.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 10 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/seat_1.yaml b/templates/docs/vehicle/seat_1.yaml index f001851aa..cf97cb125 100644 --- a/templates/docs/vehicle/seat_1.yaml +++ b/templates/docs/vehicle/seat_1.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 10 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/skoda_0.yaml b/templates/docs/vehicle/skoda_0.yaml index 4b8d7b672..f40aeaff5 100644 --- a/templates/docs/vehicle/skoda_0.yaml +++ b/templates/docs/vehicle/skoda_0.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 10 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/tesla_0.yaml b/templates/docs/vehicle/tesla_0.yaml index ab3d58013..278abff4e 100644 --- a/templates/docs/vehicle/tesla_0.yaml +++ b/templates/docs/vehicle/tesla_0.yaml @@ -26,6 +26,7 @@ render: refreshToken: # Siehe https://docs.evcc.io/docs/devices/vehicles#tesla vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 90 # Akku-Kapazität in kWh # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/tronity_0.yaml b/templates/docs/vehicle/tronity_0.yaml index b9b8ec9b8..ffac5aaa5 100644 --- a/templates/docs/vehicle/tronity_0.yaml +++ b/templates/docs/vehicle/tronity_0.yaml @@ -24,6 +24,7 @@ render: refreshToken: vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 10 # Akku-Kapazität in kWh # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/volvo_0.yaml b/templates/docs/vehicle/volvo_0.yaml index 795f32a5c..7317180df 100644 --- a/templates/docs/vehicle/volvo_0.yaml +++ b/templates/docs/vehicle/volvo_0.yaml @@ -18,7 +18,7 @@ render: password: # Passwort des Benutzerkontos vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 50 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/templates/docs/vehicle/vw_0.yaml b/templates/docs/vehicle/vw_0.yaml index fbd6fd8c8..a263f88d6 100644 --- a/templates/docs/vehicle/vw_0.yaml +++ b/templates/docs/vehicle/vw_0.yaml @@ -19,7 +19,7 @@ render: password: # Passwort des Benutzerkontos vin: WVWZZZ... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind # Optional capacity: 10 # Akku-Kapazität in kWh # Optional - cache: 5m # Das zeitliche Interval, in welchem Daten vom Fahrzeug neu geladen werden soll # 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 minSoC: 25 # Lade sofort mit maximaler Geschwindigkeit bis zu dem angegeben Ladestand, wenn der Lademodus nicht auf 'Aus' steht # Optional targetSoC: 80 # Bis zu welchem Ladestand (SoC) soll das Fahrzeug geladen werden # Optional diff --git a/util/templates/template_documentation.go b/util/templates/template_documentation.go index 06dbdfddb..b5a0924f9 100644 --- a/util/templates/template_documentation.go +++ b/util/templates/template_documentation.go @@ -63,11 +63,11 @@ func (t *Template) RenderDocumentation(product Product, values map[string]interf } } - // remove usage from params and check if there are advanced params + // remove usage and deprecated from params and check if there are advanced params var hasAdvancedParam bool var newParams []Param for _, param := range t.Params { - if param.Name == ParamUsage { + if param.Deprecated || param.Name == ParamUsage { continue } if param.Advanced { diff --git a/util/templates/template_types.go b/util/templates/template_types.go index f3d536c0a..f9533528e 100644 --- a/util/templates/template_types.go +++ b/util/templates/template_types.go @@ -172,6 +172,7 @@ type Param struct { Mask bool // cli if the value should be masked, e.g. for passwords Advanced bool // cli if the user does not need to be asked. Requires a "Default" to be defined. Hidden bool // cli if the parameter should not be presented in the cli, the default value be assigned + Deprecated bool // if the parameter is deprecated and thus should not be presented in the cli or docs Default string // default value if no user value is provided in the configuration Example string // cli example value Help TextLanguage // cli configuration help