diff --git a/docs/devices/chargers.mdx b/docs/devices/chargers.mdx index d36f733fae..db2cd0c3be 100644 --- a/docs/devices/chargers.mdx +++ b/docs/devices/chargers.mdx @@ -2607,3 +2607,8689 @@ chargers: standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) ``` + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + + + +## ABB Terra AC + + + +Erfordert Firmware >= 1.6.5 + +```yaml +chargers: + - name: my_charger + type: template + template: abb + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## ABL + +### eM4 (SBCx) + + + +```yaml +chargers: + - name: my_charger + type: template + template: abl-em4 + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### eMH1, eMH2 + + + +```yaml +chargers: + - name: my_charger + type: template + template: abl + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 38400 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8E1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 10s # optional +``` + + + + + +## Alfen Eve + + + +Die "Active load balancing" Lizenz wird benötigt um die Wallbox via Modbus extern zu steuern. In den Einstellungen muss "Active Load Balancing" aktiviert und "Energy Management System" als Data Source ausgewählt werden. Falls die "Double"-Box verwendet wird müssen beide Ladepunkte getrennt voneinander hinzugefügt werden. Der erste Port (oder einzelne Port) ist unter ID 1 zugänglich, der zweite unter ID 2. + +```yaml +chargers: + - name: my_charger + type: template + template: alfen + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Alphatec Wallbox Mini/ AW1eM + + + +```yaml +chargers: + - name: my_charger + type: template + template: alphatec + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 10s # optional +``` + + + + + +## Amperfied + +### Wallbox connect.business + + + +```yaml +chargers: + - name: my_charger + type: template + template: amperfied + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### Wallbox connect.home + + + +```yaml +chargers: + - name: my_charger + type: template + template: amperfied + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### Wallbox Energy Control + + + +Bitte das Handbuch zur Verkabelung und Konfiguration genau lesen. Alle Boxen müssen für die externe Steuerung auf Follower-Modus konfiguriert sein (DIP S5/4 OFF). Jede Box braucht eine individuelle Modbus-ID (DIP S4). Auf korrekte RS485-Verkabelung inkl. Busterminierung (DIP S6/2) achten. + +```yaml +chargers: + - name: my_charger + type: template + template: heidelberg + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Audi + +### Audi Wallbox pro (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +### Wallbox plus (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +Hinweis: Wenn du deiner Wallbox nachträglich einen Energiezähler hinzugefügt hast, nutze bitte die Pro bzw. Connected+ Integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +## Bender CC612/613 + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## BMW + +### i Wallbox + + + +Erfordert Firmwareversion 3.10.42 (C-series) bzw. 1.11 (X-series). Zur Phasenumschaltung wird zusätzlich der Keba Phasenumschalter (KeContact S10) benötigt. + +```yaml +chargers: + - name: my_charger + type: template + template: keba-modbus + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### i Wallbox (legacy UDP protocol) + + + +Es muss eine sogenannte UDP Funktion über den DIP Schalter 1.3 eingeschaltet (ON) werden. Die Installationsanleitung der Wallbox hilft hier weiter. + +```yaml +chargers: + - name: my_charger + type: template + template: keba + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## cFos Power Brain, Power Brain Solar + + + +Der Zähler- falls vorhanden- muss separat als Ladezähler konfiguriert werden. +Phasenumschaltung bietet nur die Solar-Variante und muss vom Anwender freigeschaltet werden. + +```yaml +chargers: + - name: my_charger + type: template + template: cfos + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + +## Compleo eBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: innogy-ebox + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Cupra + +### Charger Connect (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +Hinweis: Wenn du deiner Wallbox nachträglich einen Energiezähler hinzugefügt hast, nutze bitte die Pro bzw. Connected+ Integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +### Charger Pro (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +## Dadapower Premium Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: dadapower + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## DaheimLaden + +### Wallbox + + + +Für die Nutzung mit evcc muss die Wallbox im RFID Modus betrieben werden. + +```yaml +chargers: + - name: my_charger + type: template + template: daheimladen + token: # Sie bekommen dieses Access Token vom Daheimladen Support: info@daheimladen.de. (optional) + stationid: # Die Seriennummer, welche auf dem Bildschirm der Wallbox angezeigt wird. (optional) +``` + + + +### Wallbox (via ModbusTCP) + + + +Die Wallbox muss über eine aktuelle Firmware mit Modbus-Unterstützung verfügen. In den Einstellungen muss "Nachladen" (Smart) bzw. "RSDA" (Touch) aktiviert sein + +```yaml +chargers: + - name: my_charger + type: template + template: daheimladen-mb + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + +## E.ON Drive + +### eBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: innogy-ebox + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### vBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: vestel + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## E3/DC Easy Connect + + + +DIP Schalter 10 des Controllers muss auf 'ON' gestellt sein. Eine aktuelle Controller-Firmware wird empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-eth + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Easee Home + + + +```yaml +chargers: + - name: my_charger + type: template + template: easee + user: # Emailadresse + password: # wie Login für Easee App oder Web Portal (https://easee.cloud) + charger: EH______ + timeout: 10s # optional + authorize: # Steuert ob evcc die Authentifizierung am Charger vornimmt. Vorteil ist ein kontrollierter Ladestart. Nicht kompatibel mit RFID Identifikation von Fahrzeugen. (optional) +``` + + + + + +## Ebee Wallbox + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## echarge + +### cPH1 + + + +Als Betriebsmodus muss `manual` ausgewählt sein + +```yaml +chargers: + - name: my_charger + type: template + template: hardybarth-ecb1 + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + +### cPH2, cPμ2 + + + +```yaml +chargers: + - name: my_charger + type: template + template: hardybarth-salia + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + +## Elli + +### Charger Connect (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +Hinweis: Wenn du deiner Wallbox nachträglich einen Energiezähler hinzugefügt hast, nutze bitte die Pro bzw. Connected+ Integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +### Charger Pro (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +## EM2GO Pro Power/OCPP/ONC + + + +Aktuelle Firmware mit Modbus-Unterstützung notwendig (Pro Power: 1.01 bzw. OCPP/ONC: 3.15) + +```yaml +chargers: + - name: my_charger + type: template + template: em2go + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Ensto Chago Wallbox + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## ESL Walli LIGHT + + + +DIP Schalter 10 des Controllers muss auf 'ON' gestellt sein. Eine aktuelle Controller-Firmware wird empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-eth + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Etrel + +### INCH + + + +Die Wallbox muss sich im "Power" Modus befinden. + +```yaml +chargers: + - name: my_charger + type: template + template: etrel + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +### INCH Duo + + + +Die Wallbox muss sich im "Power" Modus befinden. + +```yaml +chargers: + - name: my_charger + type: template + template: etrel-duo + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## EVBox Elvi + + + +```yaml +chargers: + - name: my_charger + type: template + template: elvi + timeout: 2m # optional + meter: true # Deaktiveren wenn die Wallbox keinen integrierten Zähler verbaut hat (optional) +``` + + + +## EVSE DIN + + + +```yaml +chargers: + - name: my_charger + type: template + template: evse-din + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## EVSE-WiFi + + + +```yaml +chargers: + - name: my_charger + type: template + template: evsewifi + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## Fronius Wattpilot + + + +Benötigt mindestens Firmware 36.3 oder neuer. + +```yaml +chargers: + - name: my_charger + type: template + template: fronius-wattpilot + host: 192.0.2.2 # IP-Adresse oder Hostname + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + +## Garo GLB, GLB+, LS4, LS4 compact + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## go-e + +### Charger Gemini, HOME+, HOMEfix (V3) + + + +Benötigt mindestens Firmware 052.1 oder neuer. + +Für 1P/3P-Phasenumschaltung muss die HTTP API v2 im Charger aktiviert sein. + +In der Go-E App (Menüpunkt "Auto") sollte die Option "Ausstecken simulieren" aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: go-e-v3 + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + +### Charger HOME+, HOMEfix, Pro + + + +Benötigt mindestens Firmware 040.0 oder neuer. Das HTTP API v1 oder v2 muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: go-e + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + +## HardyBarth + +### cPH1 + + + +Als Betriebsmodus muss `manual` ausgewählt sein + +```yaml +chargers: + - name: my_charger + type: template + template: hardybarth-ecb1 + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + +### cPH2, cPμ2 + + + +```yaml +chargers: + - name: my_charger + type: template + template: hardybarth-salia + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + +## Heidelberg Energy Control + + + +Bitte das Handbuch zur Verkabelung und Konfiguration genau lesen. Alle Boxen müssen für die externe Steuerung auf Follower-Modus konfiguriert sein (DIP S5/4 OFF). Jede Box braucht eine individuelle Modbus-ID (DIP S4). Auf korrekte RS485-Verkabelung inkl. Busterminierung (DIP S6/2) achten. + +```yaml +chargers: + - name: my_charger + type: template + template: heidelberg + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Hesotec eSat, eBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: hesotec + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Homecharge Homecharger HC11L, HC22L + + + +Die Verwendung mit evcc erfordert einen eingebauten Stromzähler (Ausführungen HC11L/HC22L Energy oder Profi). +Die OCPP-Konfiguration erfolgt über den EFR-SECC-Ladecontroller über die URL http://host/secc. +Den Zugang erfragen Sie bitte beim Hersteller EFR (www.efr.de) oder Ihrem Händler. + +```yaml +chargers: + - name: my_charger + type: template + template: homecharge + timeout: 2m # optional +``` + + + +## Huawei FusionCharge AC + + + +```yaml +chargers: + - name: my_charger + type: template + template: huawei-ac + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Innogy eBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: innogy-ebox + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## INRO Pantabox + + + +```yaml +chargers: + - name: my_charger + type: template + template: pantabox + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## Juice Charger Me + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## KEBA + +### KeContact P20, P30, C/X Series + + + +Erfordert Firmwareversion 3.10.42 (C-series) bzw. 1.11 (X-series). Zur Phasenumschaltung wird zusätzlich der Keba Phasenumschalter (KeContact S10) benötigt. + +```yaml +chargers: + - name: my_charger + type: template + template: keba-modbus + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### KeContact P20, P30, C/X Series (legacy UDP protocol) + + + +Es muss eine sogenannte UDP Funktion über den DIP Schalter 1.3 eingeschaltet (ON) werden. Die Installationsanleitung der Wallbox hilft hier weiter. + +```yaml +chargers: + - name: my_charger + type: template + template: keba + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## KSE wBX16 + + + +```yaml +chargers: + - name: my_charger + type: template + template: kse + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 100 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8E1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 100 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## LadeFoxx EvLoad/ Mikro 2.0 + + + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-charx + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Mennekes + +### Amedio, Amtron ChargeControl, Professional + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +### Amtron Compact 2.0s + + + +Die Wallbox muss mit Hilfe der DIP-Schalter auf der Hauptplatine als Satellit konfiguriert werden. + +```yaml +chargers: + - name: my_charger + type: template + template: mennekes + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 50 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 57600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N2" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 50 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### Amtron Start 2.0s + + + +Die Wallbox muss mit Hilfe der DIP-Schalter auf der Hauptplatine als Satellit konfiguriert werden. + +```yaml +chargers: + - name: my_charger + type: template + template: mennekes + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 50 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 57600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N2" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 50 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### AMTRON XTRA, AMTRON PREMIUM + + + +```yaml +chargers: + - name: my_charger + type: template + template: amtron + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## NRGKick + +### Bluetooth + + + +NRGkick Ladeeinheit via Bluetooth (älter als 2022/2023) + +```yaml +chargers: + - name: my_charger + type: template + template: nrgkick-bluetooth + mac: + pin: +``` + + + +### Connect + + + +NRGkick Ladeeinheit via HTTP (älter als 2022/2023) + +```yaml +chargers: + - name: my_charger + type: template + template: nrgkick-connect + host: 192.0.2.2 # IP-Adresse oder Hostname + mac: + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +## OBO Bettermann Ion + + + +```yaml +chargers: + - name: my_charger + type: template + template: obo + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 101 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 101 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 101 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## OpenEVSE + + + +Benötigt mindestens Firmware 7.0 oder neuer. + +```yaml +chargers: + - name: my_charger + type: template + template: openevse + 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) +``` + + + +## openWB + +### Pro + + + +```yaml +chargers: + - name: my_charger + type: template + template: openwb-pro + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +### series2 + + + +Die Wallbox muss als Ladepunkt konfiguriert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: openwb + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +### Software 2.x + + + +Erfordert Software 2.x + +```yaml +chargers: + - name: my_charger + type: template + template: openwb-2.0 + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port +``` + + + +## Optec Mobility One + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## Orbis Viaris Uni + + + +```yaml +chargers: + - name: my_charger + type: template + template: orbis-viaris + timeout: 2m # optional +``` + + + +## PC Electric Garo + + + +Es können momentan nur als Master konfigurierte Geräte verwendet werden! + +```yaml +chargers: + - name: my_charger + type: template + template: pcelectric-garo + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8080 # Port (optional) +``` + + + + + +## Phoenix Contact + +### CHARX + + + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-charx + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### EM-CP-PP-ETH + + + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-em-eth + + # Modbus TCP + modbus: tcpip + id: 180 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### EV-CC-AC1-M3-CBC-RCM-ETH, EV-CC-AC1-M3-CBC-RCM-ETH-3G, EV-CC-AC1-M3-RCM-ETH-XP, EV-CC-AC1-M3-RCM-ETH-3G-XP + + + +DIP Schalter 10 des Controllers muss auf 'ON' gestellt sein. Eine aktuelle Controller-Firmware wird empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-eth + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### EV-SER (Modbus RTU) + + + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-ser + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Porsche + +### Mobile Charger Connect + + + +```yaml +chargers: + - name: my_charger + type: template + template: pmcc + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### Mobile Charger Plus + + + +```yaml +chargers: + - name: my_charger + type: template + template: pmcp + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +## Pracht Alpha XT, XT+, Mono XT, Mono XT+, PNI + + + +```yaml +chargers: + - name: my_charger + type: template + template: pracht-alpha + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 10s # optional +``` + + + + + +## Pulsares SimpleBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: pulsares + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Schneider EVlink Wallbox, EVlink Parkplatz + + + +```yaml +chargers: + - name: my_charger + type: template + template: schneider-evlink + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Schrack i-CHARGE CION + + + +```yaml +chargers: + - name: my_charger + type: template + template: ichargecion + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## SENEC + +### Wallbox pro + + + +```yaml +chargers: + - name: my_charger + type: template + template: abl + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 38400 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8E1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 10s # optional +``` + + + + + +### Wallbox pro s + + + +Bitte das Handbuch zur Verkabelung und Konfiguration genau lesen. Alle Boxen müssen für die externe Steuerung auf Follower-Modus konfiguriert sein (DIP S5/4 OFF). Jede Box braucht eine individuelle Modbus-ID (DIP S4). Auf korrekte RS485-Verkabelung inkl. Busterminierung (DIP S6/2) achten. + +```yaml +chargers: + - name: my_charger + type: template + template: heidelberg + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Siemens Versicharge GEN3 + + + +Erfordert Firmware >= 2.121.5 + +```yaml +chargers: + - name: my_charger + type: template + template: versicharge + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Skoda + +### iV Charger Connect (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +Hinweis: Wenn du deiner Wallbox nachträglich einen Energiezähler hinzugefügt hast, nutze bitte die Pro bzw. Connected+ Integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +### iV Charger Connect+ (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +## SMA EV Charger + + + +Der EV Charger muss sich im Modus "Fast" befinden und der Benutzer muss die Rechte "Administrator" haben. + +```yaml +chargers: + - name: my_charger + type: template + template: smaevcharger + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + + + +## smartWB + + + +```yaml +chargers: + - name: my_charger + type: template + template: smartwb + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## SolarEdge Home EV Charger + + + +Erfordert Firmwareversion 3.10.42 (C-series) bzw. 1.11 (X-series). Zur Phasenumschaltung wird zusätzlich der Keba Phasenumschalter (KeContact S10) benötigt. + +```yaml +chargers: + - name: my_charger + type: template + template: keba-modbus + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Sonnen sonnenCharger + + + +Die Wallbox muss sich im "Power" Modus befinden. + +```yaml +chargers: + - name: my_charger + type: template + template: etrel + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## Stark in Strom Easy + + + +```yaml +chargers: + - name: my_charger + type: template + template: evse-din + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## TechniSat Technivolt + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## Tesla TWC3 + + + +Die TWC Wallbox ist nicht direkt regelbar. Die Regelung erfolgt über das Fahrzeug. Das Fahrzeug muss dem TWC3 Ladepunkt zugewiesen sein. Aktuell ausschließlich mit Tesla Fahrzeugen nutzbar. + +```yaml +chargers: + - name: my_charger + type: template + template: twc3 + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## TinkerForge + +### WARP Charger Pro + + + +Firmware v2 erforderlich. Für automatische Phasenumschaltung wird zusätzlich der WARP Energy Manager benötigt. + +```yaml +chargers: + - name: my_charger + type: template + template: tinkerforge-warp + host: 192.0.2.2 # IP Adresse oder der Hostname des MQTT Brokers + port: 1883 # MQTT Broker Port (optional) + topic: warp # Topic (ohne / am Anfang) (optional) + timeout: 30s # Akzeptiere keine Daten die älter sind als dieser Wert (optional) + energymanager: # EnergyManager MQTT Topic (falls installiert) (optional) +``` + + + +### WARP Charger Smart + + + +Firmware v2 erforderlich. Für automatische Phasenumschaltung wird zusätzlich der WARP Energy Manager benötigt. + +```yaml +chargers: + - name: my_charger + type: template + template: tinkerforge-warp + host: 192.0.2.2 # IP Adresse oder der Hostname des MQTT Brokers + port: 1883 # MQTT Broker Port (optional) + topic: warp # Topic (ohne / am Anfang) (optional) + timeout: 30s # Akzeptiere keine Daten die älter sind als dieser Wert (optional) + energymanager: # EnergyManager MQTT Topic (falls installiert) (optional) +``` + + + +## Ubitricity Heinz + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +## Vestel EVC04 Home Smart/Connect Plus + + + +```yaml +chargers: + - name: my_charger + type: template + template: vestel + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Victron EV charging station + + + +Wallbox muss sich im Modus "Manual" befinden und Modbus ID 100 konfiguriert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: victron + + # Modbus TCP + modbus: tcpip + id: 100 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Volkswagen + +### ID. Charger Connect (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +Hinweis: Wenn du deiner Wallbox nachträglich einen Energiezähler hinzugefügt hast, nutze bitte die Pro bzw. Connected+ Integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +### ID. Charger Pro (Beta) + + + +Dem Gerät muss eine feste IP Adresse zugewiesen sein (Manuell oder per DHCP). + +Eine Identifikation des Fahrzeugs über die RFID Karte ist nicht möglich. + +Wichtig: Die möglichst reibungslose Funktionalität ist aufgrund von Software-Fehlern in der Wallbox nur mit einem externen Energiezähler und ohne Stromwandlerspulen möglich! Eine LAN Anbindung wird sehr empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse +``` + + + +## Wallbe + +### Eco, Eco 2.0(s), Pro + + + +DIP Schalter 10 des Controllers muss auf 'ON' gestellt sein. Eine aktuelle Controller-Firmware wird empfohlen. + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-eth + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### Eco, Pro + + + +Die Wallbox muss über ein Netzwerkkabel angebunden sein und im Gerät muss der DIP Schalter 10 auf 'ON' gestellt sein. + +```yaml +chargers: + - name: my_charger + type: template + template: wallbe + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + +### Eco, Pro (mit Strommessgerät) + + + +Im Gerät muss der DIP Schalter 10 auf 'ON' gestellt sein. + +```yaml +chargers: + - name: my_charger + type: template + template: wallbe-meter + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + +### Eco, Pro (vor ~2019) + + + +Im Gerät muss der DIP Schalter 10 auf 'ON' gestellt sein. + +```yaml +chargers: + - name: my_charger + type: template + template: wallbe-pre2019 + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + +### Eco, Pro (vor ~2019, mit Strommessgerät) + + + +Im Gerät muss der DIP Schalter 10 auf 'ON' gestellt sein. + +```yaml +chargers: + - name: my_charger + type: template + template: wallbe-pre2019-meter + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + +## wallbox Pulsar Plus / Commander 2 / Copper SB + + + +Anleitung: https://support.wallbox.com/en/knowledge-base/ocpp-activation-and-setup-guide/ +* “OCPP aktivieren” (myWallbox app) bzw. den “OCPP-WebSocket-Verbindung” Schalter (myWallbox Portal) aktivieren +* Zusätzlich die “Verbesserte Ladegerätsteuerung” (Profil -> Experimentelle Funktionen) einschalten (myWallbox app) +* URL: ws://[evcc-adresse]:8887/ (Verbindung über das lokale Netzwerk) +* Ladepunktidentität: beliebiger Wert (z.B. die Seriennummer der Box), der als *stationid* verwendet wird +* Passwort: leer lassen + +```yaml +chargers: + - name: my_charger + type: template + template: pulsarplus + timeout: 2m # optional +``` + + + +## Walther Werke Basic Evo Pro + + + +Bitte das Handbuch zur Verkabelung und Konfiguration genau lesen. Alle Boxen müssen für die externe Steuerung auf Follower-Modus konfiguriert sein (DIP S5/4 OFF). Jede Box braucht eine individuelle Modbus-ID (DIP S4). Auf korrekte RS485-Verkabelung inkl. Busterminierung (DIP S6/2) achten. + +```yaml +chargers: + - name: my_charger + type: template + template: heidelberg + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Webasto + +### Live + + + +Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +### NEXT + + + +Modus "HEMS activated" muss aktiviert sein. RFID-Tags können durch evcc nur gelesen werden. + +```yaml +chargers: + - name: my_charger + type: template + template: webasto-next + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + +### Unite + + + +```yaml +chargers: + - name: my_charger + type: template + template: vestel + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Zaptec Go/Pro + + + +```yaml +chargers: + - name: my_charger + type: template + template: zaptec + id: # Wallbox ID (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + +## Generische Unterstützung + +### manuell + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Dokumentation der Werte für `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp + +### EEBUS kompatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # Die SKI der Wallbox, üblicherweise im Web Interface der Wallbox zu finden + ip: 192.0.2.2 # IP-Adresse (optional) +``` + + + +### OCPP 1.6J kompatible Wallbox mit Smart Charging Profil + + + +Bei OCPP verbindet sich die Wallbox (Client) zu evcc (Server). +Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können. +Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet. +Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden. +Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies händisch geschehen `ws://:8887/`. +Gegebenenfalls benötigt der Ladepunkt eine vorkonfigurierte (virtuelle) Token-ID/RFID-Kennung (`idtag: `) mit der die Ladevorgänge ohne Authentifizierung gestartet werden können. +Für Zählermesswerte sollte in der Wallbox ein kurzes Zeitintervall konfiguriert werden. + +Voraussetzungen: +* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen +* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (evtl noch um `stationid` erweitern) +* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä. +* Keine Verschlüsselung, keine Authentifizierung, kein Passwort +* Verbindung über das lokale Netzwerk + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Schaltbare Steckdosen + +Die von evcc unterstützten schaltbaren Steckdosen und SmartHome Schalter, können in zwei Modi betrieben werden: + +- Charger Modus (Standard) +- Static-Switch Modus + +Der _Charger Modus_ erlaubt die Nutzung der schaltbaren Steckdose als Ladesteuerung von Akku betriebenen Geräten (E-Motorrad, E-Bikes ...). +Dabei wird der Ladestrom gemessen und von evcc angezeigt, sowie beim Erreichen des Erhaltungsladungsstroms ( < `standbypower`) des Akkus der Status geladen ausgegeben. + +Demgegenüber dient der _Static-Switch_ Modus zum einfachen Schalten von Verbrauchern, wie Wärmepumpen, Klimaanlagen etc. +Der von der Steckdose gelieferte Status hängt dabei direkt vom Schaltzustand der Steckdose ab (An=Lade, Aus=Geladen). + +:::note +Um im _Static-Switch_ Modus eine aussagefähige Leistungsinformation anzuzeigen, empfiehlt es sich ein separates Custom-Meter zu definieren. +::: + +Bei allen schaltbaren Steckdosen wird der Modus über den Parameter `standbypower` eingestellt. + +Ist der Wert größer oder gleich 0, ist der _Charger Modus_ aktiviert. Der eingestellte Wert dient als Schwellwert in Watt. +Solange die durch die Steckdose gemessene Leistung sich über diesem Schellwert befindet, wird der Ladevorgang gemeldet, +fällt die Leistung unter diesen Schwellwert, ist der Erhaltungsladebereich bei vollem Akku erreicht und es wird der Ladevorgang als abgeschlossen gemeldet. + +Setzt man `standbypower` auf einen negativen Wert, arbeitet die schaltbare Steckdose im _Static-Switch_ Modus. + +:::info +Der Ladepunkt-Parameter `phases` **muss** bei Nutzung einer schaltbaren Steckdose zwingend auf **1** gesetzt werden, um eine ordnungsgemäße Lade-Steuerung zu gewährleisten. +Beispiel: + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Schaltkanal (1-8) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP-Adresse oder Hostname + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + standbypower: 15 # Leistung oberhalb des angegebenen Wertes wird als Ladeleistung gewertet (optional) +``` + diff --git a/docs/devices/meters.mdx b/docs/devices/meters.mdx index d9304acc08..4c4d745276 100644 --- a/docs/devices/meters.mdx +++ b/docs/devices/meters.mdx @@ -6818,3 +6818,22382 @@ meters: password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) ``` + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + + + +## ABB A43, A44, B23, B24 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: abb-ab + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: abb-ab + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Acrel ADW300 Wireless Metering Meter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: acrel-adw300 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 1200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: acrel-adw300 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 1200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: acrel-adw300 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 1200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Ads-tec StoraXe + + + +```yaml +meters: + - name: my_battery + type: template + template: storaxe + usage: battery + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Alpha ESS Storion SMILE + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: alpha-ess-smile + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 85 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: alpha-ess-smile + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 85 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: alpha-ess-smile + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 85 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Anker Micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-mi + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Bernecker Engineering MPM3PM + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: mpm3pm + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mpm3pm + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Bosswerk + +### MI series micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: solarman + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: admin # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: admin # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + +### Micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-mi + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Carlo Gavazzi + +### EM/ET 330/340 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: cg-emt3xx + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: cg-emt3xx + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### EM24 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: cg-em24 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: cg-em24 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## cFos PowerBrain Meter + + + +```yaml +meters: + - name: my_charger + type: template + template: cfos + usage: charge + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 4702 # Port +``` + + + + + +## Deye + +### 3p hybrid inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: deye-hybrid-3p + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-hybrid-3p + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: deye-hybrid-3p + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-mi + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### Storage (hybrid) inverter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-storage + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: deye-storage + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_grid + type: template + template: deye-storage + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### String inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-string + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### SUN series micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: solarman + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: admin # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: admin # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + +## Discovergy + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: discovergy + usage: grid + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + meter: 1ESY1161229886 +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: discovergy + usage: pv + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + meter: 1ESY1161229886 +``` + + + + + + +## DSMR + + + +```yaml +meters: + - name: my_grid + type: template + template: dsmr + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 1502 # Port (optional) +``` + + + +## DZG DVH4013 + + + +```yaml +meters: + - name: my_charger + type: template + template: dzg + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## E3/DC + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: e3dc + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: e3dc + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: e3dc + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + + +## Eastron + +### SDM120-Modbus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron-sdm120 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron-sdm120 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SDM220/230 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron-sdm220_230 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron-sdm220_230 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SDM630-Modbus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SDM72D-M + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron-sdm72 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron-sdm72 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SDM72DM-V2 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Enphase IQ Envoy + + + +Als Batteriespeicher werden seitens der Enphase-API derzeit nur die Batterien vom Typ "AC Battery" unterstützt. + + + + +```yaml +meters: + - name: my_grid + type: template + template: enphase + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + token: # Ab Envoy Firmware D7.x.xxx notwendig. Token ist ein Jahr gültig. Anleitung (Obtaining a token via web UI): https://enphase.com/download/accessing-iq-gateway-local-apis-or-local-ui-token-based-authentication (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: enphase + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + token: # Ab Envoy Firmware D7.x.xxx notwendig. Token ist ein Jahr gültig. Anleitung (Obtaining a token via web UI): https://enphase.com/download/accessing-iq-gateway-local-apis-or-local-ui-token-based-authentication (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: enphase + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + token: # Ab Envoy Firmware D7.x.xxx notwendig. Token ist ein Jahr gültig. Anleitung (Obtaining a token via web UI): https://enphase.com/download/accessing-iq-gateway-local-apis-or-local-ui-token-based-authentication (optional) +``` + + + + + + +## ESPHome DSMR + + + +```yaml +meters: + - name: my_grid + type: template + template: slimmelezer + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## FENECON + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: openems + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: openems + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: openems + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +## FoxESS + +### H1 Series Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fox-ess-h1 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fox-ess-h1 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### H3 Series Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: fox-ess-h3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: fox-ess-h3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fox-ess-h3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Fronius + +### Primo GEN24 Plus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: fronius-gen24 + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: fronius-gen24 + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fronius-gen24 + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + + +### Solar API V1 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: fronius-solarapi-v1 + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: fronius-solarapi-v1 + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fronius-solarapi-v1 + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Symo GEN24 Plus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: fronius-gen24 + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: fronius-gen24 + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fronius-gen24 + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + + +## Ginlong Solis inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: solarman + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: admin # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: admin # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + +## go-e Controller + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: go-e-controller + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: go-e-controller + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +## GoodWe ET/EH/BH/BT Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: goodwe-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: goodwe-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: goodwe-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Growatt + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: growatt-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: growatt-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: growatt-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### TL-X(H) Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: growatt-hybrid-tlxh + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: growatt-hybrid-tlxh + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: growatt-hybrid-tlxh + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## HomeWizard Wi-Fi P1 Meter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homewizard + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homewizard + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +## Hoymiles HM and HMS Series (via OpenDTU) + + + +```yaml +meters: + - name: my_pv + type: template + template: hoymiles-opendtu + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## Huawei + +### SmartLogger + + + +```yaml +meters: + - name: my_pv + type: template + template: huawei-smartlogger + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + +### SUN2000 via RS485 Modbus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: huawei-sun2000-rs485 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: huawei-sun2000-rs485 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: huawei-sun2000-rs485 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SUN2000 with SDongle + + + +```yaml +meters: + - name: my_pv + type: template + template: huawei-dongle + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 15s # optional +``` + + + +### SUN2000 with SDongle & Power Sensor + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: huawei-dongle-powersensor + usage: grid + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 15s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: huawei-dongle-powersensor + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 15s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: huawei-dongle-powersensor + usage: battery + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 15s # optional +``` + + + + + + +## IGEN Tech Solarman Logger + + + +```yaml +meters: + - name: my_pv + type: template + template: solarman + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: admin # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: admin # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + +## inepro PRO380-MOD + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: inepro + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: inepro + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Janitza B series, UMG series + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: janitza + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: janitza + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Kostal + +### Piko (legacy) + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-legacy + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + +### Piko Hybrid + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: kostal-piko-hybrid + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-hybrid + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: kostal-piko-hybrid + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Piko MP Plus + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-mp-plus + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +### Piko, Piko BA + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: kostal-piko-pv + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-pv + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Plenticore Hybrid + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-plenticore + usage: pv + + # Modbus TCP + modbus: tcpip + id: 71 + host: 192.0.2.2 # Hostname + port: 1502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: kostal-plenticore + usage: battery + + # Modbus TCP + modbus: tcpip + id: 71 + host: 192.0.2.2 # Hostname + port: 1502 # Port +``` + + + + + + +### Smart Energy Meter + + + +```yaml +meters: + - name: my_grid + type: template + template: kostal-ksem + usage: grid + + # Modbus TCP + modbus: tcpip + id: 71 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### Smart Energy Meter (über den Wechselrichter) + + + +Der Zähler muss in Sensorposition 2 (Netzanschluss) installiert sein. Sensorposition 1 (Haushaltsverbrauch) wird nicht unterstützt. + +```yaml +meters: + - name: my_grid + type: template + template: kostal-ksem-inverter + usage: grid + + # Modbus TCP + modbus: tcpip + id: 71 + host: 192.0.2.2 # Hostname + port: 1502 # Port +``` + + + +## LG ESS Home 8/10 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: lg-ess-home-8-10 + 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. Alterativ kann die Registriernummer für Administratorlogin verwendet werden. (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: lg-ess-home-8-10 + 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. Alterativ kann die Registriernummer für Administratorlogin verwendet werden. (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: lg-ess-home-8-10 + 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. Alterativ kann die Registriernummer für Administratorlogin verwendet werden. (optional) +``` + + + + + + +## Loxone Miniserver + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: loxone + 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) + meterblock: # Bezeichnung aus Loxone Config + socblock: # Bezeichnung aus Loxone Config, nur für Batterie (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: loxone + usage: pv + 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) + meterblock: # Bezeichnung aus Loxone Config + socblock: # Bezeichnung aus Loxone Config, nur für Batterie (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: loxone + usage: battery + 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) + meterblock: # Bezeichnung aus Loxone Config + socblock: # Bezeichnung aus Loxone Config, nur für Batterie (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: loxone + usage: charge + 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) + meterblock: # Bezeichnung aus Loxone Config + socblock: # Bezeichnung aus Loxone Config, nur für Batterie (optional) +``` + + + + + + +## M-TEC + +### Energy Butler GEN2 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: mtec-eb-gen2 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: mtec-eb-gen2 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: mtec-eb-gen2 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Energy Butler GEN3 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: mtec-eb-gen3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: mtec-eb-gen3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: mtec-eb-gen3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## my-PV WiFi Meter + + + +```yaml +meters: + - name: my_grid + type: template + template: mypv-wifi-meter + usage: grid + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## OpenEMS + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: openems + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: openems + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: openems + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +## Orno OR-WE-516, OR-WE-517 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: orno + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: orno + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## P1Monitor P1 Monitor + + + +```yaml +meters: + - name: my_grid + type: template + template: p1monitor + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## Powerdog + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: powerdog + usage: grid + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: powerdog + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Powerfox Poweropti + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: powerfox-poweropti + usage: grid + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: powerfox-poweropti + usage: pv + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + + + + + + +## Qcells Q.HOME ESS HYB-G3 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solax + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solax + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solax + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## RCT Power + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: rct-power + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: rct-power + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: rct-power + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +## Saia-Burgess Controls ALE3, AWD3 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sbc-axx3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: sbc-axx3 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## SAJ H2 Series Hybrid Solar Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: saj-h2 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 115200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: saj-h2 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 115200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: saj-h2 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 115200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## SAX Homespeicher + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sax + usage: grid + + # Modbus TCP + modbus: tcpip + id: 64 + host: 192.0.2.2 # Hostname + port: 3600 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sax + usage: battery + + # Modbus TCP + modbus: tcpip + id: 64 + host: 192.0.2.2 # Hostname + port: 3600 # Port +``` + + + + + + +## Schneider Electric iEM3xxx Modbus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: schneider-iem3000 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: schneider-iem3000 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## SENEC .Home + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: senec-home + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + schema: https # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: senec-home + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + schema: https # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: senec-home + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + schema: https # optional +``` + + + + + + +## Senergy SE 4/5/6KTL-S1/G2 Inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: senergy + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Shelly + +### 3EM + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: shelly-3em + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-3em + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-3em + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Pro 3 EM + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: shelly-pro-3em + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-pro-3em + usage: pv + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-pro-3em + usage: charge + 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) +``` + + + + + + +## Siemens + +### 7KT1665 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: siemens-7kt1665 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: siemens-7kt1665 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### PAC 2200 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: siemens-pac2200 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: siemens-pac2200 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## SMA + +### Data Manager + + + +In der Weboberfläche des SMA Data Manager muss im Bereich "Externe Kommunikation" der Schalter "Modbus Server aktivieren" eingeschaltet sein. + + + + +```yaml +meters: + - name: my_grid + type: template + template: sma-data-manager + usage: grid + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-data-manager + usage: pv + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sma-data-manager + usage: battery + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Energy Meter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sma-energy-meter + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-energy-meter + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +## Smartfox Smartfox Reg/Reg extended/Pro/Pro 2/Pro Light/Pro Light 2/Light + + + +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). + + + + +```yaml +meters: + - name: my_grid + type: template + template: smartfox + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: smartfox + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +## SMA + +### Smart Energy Hybrid-Wechselrichter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-hybrid + usage: pv + + # Modbus TCP + modbus: tcpip + id: 3 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sma-hybrid + usage: battery + + # Modbus TCP + modbus: tcpip + id: 3 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Sunny Home Manager 2.0 + + + +```yaml +meters: + - name: my_grid + type: template + template: sma-home-manager + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +### WebBox + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-webbox + usage: pv + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-inverter + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + password: # Passwort für Benutzergruppe Benutzer (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sma-inverter + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + password: # Passwort für Benutzergruppe Benutzer (optional) +``` + + + + + + +## SofarSolar + +### HYD 3…6K-EP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar-g3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar-g3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar-g3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + + + +### HYD 5…20K-3PH + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar-g3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar-g3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar-g3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + + + +### Inverter / Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SOFAR 5…24KTL-G3 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar-g3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar-g3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar-g3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + + + +### SOFAR 80…136KTL + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar-g3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar-g3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar-g3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + + + +## Solaranzeige Solaranzeige + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solaranzeige + usage: grid + host: 192.0.2.2 # IP Adresse oder der Hostname des MQTT Brokers + port: 1883 # MQTT Broker Port (optional) + topic: solaranzeige/box1 # Topic (ohne / am Anfang) (optional) + timeout: 30s # Akzeptiere keine Daten die älter sind als dieser Wert (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solaranzeige + usage: pv + host: 192.0.2.2 # IP Adresse oder der Hostname des MQTT Brokers + port: 1883 # MQTT Broker Port (optional) + topic: solaranzeige/box1 # Topic (ohne / am Anfang) (optional) + timeout: 30s # Akzeptiere keine Daten die älter sind als dieser Wert (optional) +``` + + + + + + +## SolarEdge + +### Hybrid Inverter + + + +Nur ein System kann und darf auf den Wechselrichter zugreifen! + + + + +```yaml +meters: + - name: my_grid + type: template + template: solaredge-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solaredge-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solaredge-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + + + +### Wechselrichter + + + +Nur ein System kann und darf auf den Wechselrichter zugreifen! + + + + +```yaml +meters: + - name: my_grid + type: template + template: solaredge-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solaredge-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + + + +## Solarlog + + + +Wir empfehlen dieses Gerät für den Netzbezug/Einspeisewerte nur zu verwenden, wenn kein anderes Gerät diese Daten liefert. +Falls eine Hausbatterie angeschlossen ist sollte dieses Gerät auf keinen Fall für die erwähnten Werte verwendet werden! + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarlog + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarlog + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + + +## SolarMax + +### MAX.STORAGE / MAX.STORAGE Ultimate + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarmax-maxstorage + usage: grid + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarmax-maxstorage + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solarmax-maxstorage + usage: battery + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SP Series Inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: senergy + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Solarwatt + +### EnergyManager, EnergyManager Pro + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarwatt + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarwatt + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solarwatt + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### MyReserve + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarwatt + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarwatt + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solarwatt + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### MyReserve Matrix (LAN oder PowerGateway) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarwatt-myreserve-matrix + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8080 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarwatt-myreserve-matrix + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8080 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solarwatt-myreserve-matrix + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8080 # Port (optional) +``` + + + + + + +## Solax + +### Hybrid X1/X3 G3/G4 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solax + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solax + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solax + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Hybrid-Wechselrichter (Cloud) + + + +Der Solax Hybrid-Wechselrichter 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! Nur als Notfalloption nutzen wenn kein lokaler Zugriff möglich ist. + + + + +```yaml +meters: + - name: my_grid + 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. +``` + + + + +```yaml +meters: + - name: my_pv + 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. +``` + + + + +```yaml +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. +``` + + + + + + +### PV-Wechselrichter (Cloud) + + + +Der Solax PV-Wechselrichter 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! Nur als Notfalloption nutzen wenn kein lokaler Zugriff möglich ist. + +```yaml +meters: + - name: my_pv + 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. +``` + + + +## Sonnen + +### comfort, eco 5, eco 6, oem 6.5 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sonnenbatterie-eco56 + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 7979 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sonnenbatterie-eco56 + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 7979 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sonnenbatterie-eco56 + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 7979 # Port (optional) +``` + + + + + + +### sonnenBatterie + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sonnenbatterie + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8080 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sonnenbatterie + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8080 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sonnenbatterie + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8080 # Port (optional) +``` + + + + + + +## Steca coolcept fleX + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-mp-plus + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## Sungrow + +### SG Series Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sungrow-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sungrow-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SH Series Hybrid Inverter + + + +Die Verbindung ist seriell (RS485) oder über die native (hintere) LAN-Buchse am Wechselrichter möglich. Verbindungen über das WiNet-S-Dongle (WiFi oder LAN) funktionieren NICHT korrekt. + + + + +```yaml +meters: + - name: my_grid + type: template + template: sungrow-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sungrow-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sungrow-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Sunsynk + +### 3p hybrid inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: deye-hybrid-3p + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-hybrid-3p + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: deye-hybrid-3p + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-mi + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### Storage (hybrid) inverter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-storage + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: deye-storage + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_grid + type: template + template: deye-storage + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### String inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-string + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Tesla Powerwall + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tesla-powerwall + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + password: # Passwort des Benutzers "Kunde" +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tesla-powerwall + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + password: # Passwort des Benutzers "Kunde" +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tesla-powerwall + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + password: # Passwort des Benutzers "Kunde" +``` + + + + + + +## Tibber Pulse + + + +```yaml +meters: + - name: my_grid + type: template + template: tibber-pulse + usage: grid + token: 5K4MVS-OjfWhK_4yrjOlFe1F6kJXPVf7eQYggo8ebAE + homeid: 96a14971-525a-4420-aae9-e5aedaa129ff # optional +``` + + + +## TQ + +### Energy Manager EM2xx/EM3xx + + + +```yaml +meters: + - name: my_grid + type: template + template: tq-em + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 80 # Port (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + +### Energy Manager EM420 + + + +```yaml +meters: + - name: my_grid + type: template + template: tq-em420 + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 80 # Port (optional) + device: local # JSON-Schnittstelle -> Datenendpunkt (optional) + token: ey... # Token des EM420 (Erstellen unter Profil -> Zugangsschlüssel) +``` + + + +## VARTA pulse/ pulse neo/ element (PV nur verfügbar mit PV-Sensor) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: varta + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: varta + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: varta + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + + +## Victron Energy + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: victron-energy + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: victron-energy + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: victron-energy + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 502 # Port (optional) +``` + + + + + + +## Youless Energy Monitor + + + +Zur Erfassung der PV-Produktion wird ein extern angebundenener S0-Erzeugungszähler benötigt. + + + + +```yaml +meters: + - name: my_grid + type: template + template: youless + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: youless + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +## ZCS Azzurro Inverter / Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Zuidwijk SlimmeLezer(+) + + + +```yaml +meters: + - name: my_grid + type: template + template: slimmelezer + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +## Generische Unterstützung + +### manuell + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybridwechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Beispiel: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # Die URL ist zum Beispiel: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + port: 8081 # Port (optional) + uuid: +``` + + + +### Wechselrichter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Schaltbare Steckdosen + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) Adresse (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + ain: 307788992233 # Die AIN ist auf dem Typenschild auf der Geräterückseite aufgedruckt. Bei führenden Nullen bitte in doppelte Hochkommata setzen. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + device: '0001EE89AAD848' # Homematic Geräte Id, wie im CCU Webfrontend angezeigt. + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) + channel: 1 # Meterkanal (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Standard-User ist admin (optional) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP-Adresse oder Hostname + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) +``` + diff --git a/docs/devices/vehicles.mdx b/docs/devices/vehicles.mdx index 01b1354c17..462b5dbf5c 100644 --- a/docs/devices/vehicles.mdx +++ b/docs/devices/vehicles.mdx @@ -814,3 +814,5856 @@ vehicles: capacity: 4 # Akkukapazität in kWh (optional) ``` + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + + + + + +## Aiways + + + +```yaml +vehicles: + - name: my_car + type: template + template: aiways + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Audi + + + +```yaml +vehicles: + - name: my_car + type: template + template: audi + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: WAUZZZ... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## BMW + + + +```yaml +vehicles: + - name: my_car + type: template + template: bmw + title: # Wird in der Benutzeroberfläche angezeigt (optional) + 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) +``` + + + +## Citroën + + + +```yaml +vehicles: + - name: my_car + type: template + template: citroen + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Dacia + + + +```yaml +vehicles: + - name: my_car + type: template + template: dacia + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## DS + + + +```yaml +vehicles: + - name: my_car + type: template + template: ds + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Fiat + + + +```yaml +vehicles: + - name: my_car + type: template + template: fiat + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: ZFAE... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) + pin: # optional +``` + + + +## Ford + + + +```yaml +vehicles: + - name: my_car + type: template + template: ford + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: WF0FXX... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Hyundai Bluelink + + + +```yaml +vehicles: + - name: my_car + type: template + template: hyundai + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) + language: en # 'de' für Deutsch und 'en' für Englisch (optional) +``` + + + +## Jaguar + + + +```yaml +vehicles: + - name: my_car + type: template + template: jaguar-landrover + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Jeep + + + +```yaml +vehicles: + - name: my_car + type: template + template: fiat + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: ZFAE... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) + pin: # optional +``` + + + +## Kia Bluelink + + + +```yaml +vehicles: + - name: my_car + type: template + template: kia + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) + language: en # 'de' für Deutsch und 'en' für Englisch (optional) +``` + + + +## Land Rover + + + +```yaml +vehicles: + - name: my_car + type: template + template: jaguar-landrover + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Mini + + + +```yaml +vehicles: + - name: my_car + type: template + template: mini + title: # Wird in der Benutzeroberfläche angezeigt (optional) + 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) +``` + + + +## Nissan + +### Leaf + + + +```yaml +vehicles: + - name: my_car + type: template + template: nissan + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Leaf (pre 2019) + + + +```yaml +vehicles: + - name: my_car + type: template + template: carwings + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Opel + + + +```yaml +vehicles: + - name: my_car + type: template + template: opel + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: WP0... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Peugeot + + + +```yaml +vehicles: + - name: my_car + type: template + template: peugeot + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Porsche + + + +```yaml +vehicles: + - name: my_car + type: template + template: porsche + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Renault + + + +```yaml +vehicles: + - name: my_car + type: template + template: renault + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: WREN... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Seat + +### CupraConnect Gen3 (Ateca, Leon, Formentor) + + + +```yaml +vehicles: + - name: my_car + type: template + template: seat + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### CupraConnect Gen4 (Born) + + + +```yaml +vehicles: + - name: my_car + type: template + template: cupra + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Skoda + +### Andere + + + +```yaml +vehicles: + - name: my_car + type: template + template: skoda + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Enyaq + + + +```yaml +vehicles: + - name: my_car + type: template + template: enyaq + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 10s # optional +``` + + + +## Smart EQ + + + +```yaml +vehicles: + - name: my_car + type: template + template: smart + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Tesla + + + +Es wird ein `access` und ein `refresh` Token für die Kommunikation mit der Tesla API erstellt werden. + +Folgende Apps ermöglichen das Erstellen von den beiden Tokens: +- [Auth app for Tesla (iOS)](https://apps.apple.com/us/app/auth-app-for-tesla/id1552058613#?platform=iphone) +- [Tesla Tokens (Android)](https://play.google.com/store/apps/details?id=net.leveugle.teslatokens) +- [Tesla Auth (macOS, Linux)](https://github.com/adriankumpf/tesla_auth) + +```yaml +vehicles: + - name: my_car + type: template + template: tesla + title: # Wird in der Benutzeroberfläche angezeigt (optional) + accessToken: # Siehe https://docs.evcc.io/docs/devices/vehicles#tesla + refreshToken: # Siehe https://docs.evcc.io/docs/devices/vehicles#tesla + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Volkswagen + +### We Connect (legacy) + + + +ältere Modelle wie e-Up, e-Golf, etc. + +```yaml +vehicles: + - name: my_car + type: template + template: vw + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: WVWZZZ... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 10s # optional +``` + + + +### We Connect ID + + + +ID.3, ID.4 (funktioniert auch für e-Golf, e-Up) + +```yaml +vehicles: + - name: my_car + type: template + template: id + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: WVWZZZ... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 10s # optional +``` + + + +## Volvo + +### + + + +```yaml +vehicles: + - name: my_car + type: template + template: volvo-connected + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) + vccapikey: # Volvo developer portal VCC API Key, siehe https://github.com/evcc-io/evcc/discussions/3677#discussioncomment-4106300 +``` + + + +### legacy + + + +```yaml +vehicles: + - name: my_car + type: template + template: volvo + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +## Generische Unterstützung + +### manuell + +```yaml +vehicles: + - name: my_car + type: custom + title: Mein Auto # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Wird in der Benutzeroberfläche angezeigt (optional) + akey: + token: + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### ISO15118 + + + +Nur unterstützt wenn das Fahrzeug den Ladestand (Soc) an die verbundene Wallbox übermitteln kann. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### mazda2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und eine mazda2mqtt Installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Voraussetzung ist ein konfigurierter MQTT Broker und ein SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway oder https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind + capacity: 50 # Akkukapazität in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Wird in der Benutzeroberfläche angezeigt (optional) + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Unterstützung für alle Fahrzeuge via ODB2 Adapter im Fahrzeug. Mehr Infos bei [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Wird in der Benutzeroberfläche angezeigt (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + vehicleid: + capacity: 12 # Akkukapazität in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Wird in der Benutzeroberfläche angezeigt (optional) + url: http://192.0.2.2 + vin: W... # Erforderlich + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### TeslaMate + + + +Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Wird in der Benutzeroberfläche angezeigt (optional) + id: 1 # optional + capacity: 50 # Akkukapazität in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Wird in der Benutzeroberfläche angezeigt (optional) + clientid: # Einrichtung unter https://app.tronity.tech + clientsecret: # Einrichtung unter https://app.tronity.tech + vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional) + capacity: 10 # Akkukapazität in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Wird in der Benutzeroberfläche angezeigt (optional) + icon: scooter # Icon in der Benutzeroberfläche (optional) + user: # Benutzerkonto (bspw. E-Mail Adresse, User Id, etc.) + password: # Passwort des Benutzerkontos (bei führenden Nullen bitte in einfache Hochkommata setzen) + serial: + capacity: 4 # Akkukapazität in kWh (optional) +``` + diff --git a/docs/guides/faq.mdx b/docs/guides/faq.mdx index 78d1c2e4a8..4b855ba6b2 100644 --- a/docs/guides/faq.mdx +++ b/docs/guides/faq.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 6 --- import SponsorshipRequired from "/docs/_sponsorship_required.mdx"; diff --git a/docs/guides/meters.mdx b/docs/guides/meters.mdx index be69bc8723..8619f7aa0e 100644 --- a/docs/guides/meters.mdx +++ b/docs/guides/meters.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 4 --- import SponsorshipRequired from "/docs/_sponsorship_required.mdx"; diff --git a/docs/guides/wallbox.mdx b/docs/guides/wallbox.mdx index 1d8ffb937c..c96a0d79c0 100644 --- a/docs/guides/wallbox.mdx +++ b/docs/guides/wallbox.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 5 --- import SponsorshipRequired from "/docs/_sponsorship_required.mdx"; diff --git a/docs/inner-workings/_category_.json b/docs/inner-workings/_category_.json new file mode 100644 index 0000000000..f6ec09491a --- /dev/null +++ b/docs/inner-workings/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Inner-workings", + "position": 6 +} diff --git a/docs/inner-workings/available-charging-power.mdx b/docs/inner-workings/available-charging-power.mdx new file mode 100644 index 0000000000..5fc026190f --- /dev/null +++ b/docs/inner-workings/available-charging-power.mdx @@ -0,0 +1,83 @@ +--- +sidebar_position: 5 +--- + +import Drawio from '@theme/Drawio' +import diagrams from '!!raw-loader!./img/diagrams.drawio'; + +# Available charging power + +--- +**What you'll learn**: how available surplus is calculated in `Solar` and `Min+Solar` mode. + +--- + +In the `Solar` and `Min+Solar` mode, the system constantly monitors the `available charging power` (surplus), and [starts](./startstop) the charging process if it exceeds the [`minimum charging power`](./minmaxphases) required for the vehicle and charger. If the `available charging power` changes, evcc adapts the charging power or [stops](./startstop) charging accordingly. + +The `Min+Solar` mode adapts the charging power in the same fashion, but continuously charges the EV with at least `minimum charging power` instead of starting or stopping based on surplus. + +For calulating the `available charging power`, an electric meter measuring the power on your grid connection point (grid meter) is important. Power generated by the photovoltaic system can also be measured and displayed, but has no effect on the function, [except if no grid meter is available](./meters#i-have-a-solar-installation-but-i-dont-have-a-readable-grid-connection-meter---can-i-still-use-evcc). Evcc also considers power consumption by batteries and other devices, which may be diverted to vehicle charging depending on your priorities. + +The `available charging power` is calculated in [intervals](./timing-interval). If you have [multiple loadpoints](./timing-multiple-loadpoints), at each `interval` only one will be calculated and adjusted. This way each `loadpoint` represents its own independent control circuit. `Available charging power` for one `loadpoint` also includes the `charging power` used by `loadpoints` with lower priority, enabling power to be diverted from them. + +## Inputs and configuration + +Let's start with a closer look at the inputs that are used in the calculation of `available charging power`. + +For power values in Watt, the tables below will indicate the meaning of positive and negative values. Generally, for `grid power`, `PV power` and `battery power` as suppliers, positive means power being supplied and negative means power being feed into grid or battery. For `charging power` and `aux power` as consumers, positive means power consumed. In line with `charging power` also the calculated values for `minimum charging power`, `maximum charging power` and `available charging power` are positive. + +|Input|Description|Positive|Negative|Aggregation| +|-----|-----------|--------|--------|-----------| +|[Grid power](../reference/configuration/site/#metersgrid) (W)|The most important factor in the calculation, showing available surplus that is fed into the grid.|Power drawn from the grid|Power is feed to the grid|-| +|[Battery power](../reference/configuration/site/#metersbattery) (W)|With power readings from batteries that are also charged with surplus, evcc can prioritize vehicle charging. It does that by increasing the charging power of the vehicle, practically forcing the battery to reduce or stop charging.|Power is drawn from the battery|Power is charged into the battery|Sum of all batteries| +|[Battery state-of-charge](../reference/configuration/site/#metersbattery) (%)|Enables prioritization of vehicle charging depending on the charge level of the batteries (see above).|-|-|Average of all batteries, weighted by capacity| +|[Aux power](../reference/configuration/site/#metersaux) (W)|Represents power used by other surplus-operated devices that should be diverted to vehicle charging.|Power available for vehicle charging|Power that should be left for the aux device|Sum of all aux devices| +|[PV power](../reference/configuration/site/#meterspv) (W)|The output of your PV system(s) can also be measured, mostly for display purposes. Only if [grid power cannot be measured](./meters#i-have-a-solar-installation-but-i-dont-have-a-readable-grid-connection-meter---can-i-still-use-evcc), PV power will be used instead and you can set `residualPower` (see below) to a constant value for assumed house consumption to approximate surplus|Power that is produced by the PV system|-|Sum of all PV systems| +|[Charging power](../devices/chargers) (W)|The actual charging power consumed by the charger is also measured. If the charger itself does not provide this measurement, [a separate meter](../reference/configuration/loadpoints#meter) can be configured for the `loadpoint` representing the charger. If that is not available as well, then instead the power last set by evcc will be used.|The amount of power the vehicle(s) is/are currently charged with|-|If multiple `loadpoints`, `charging power` also includes `loadpoints` with lower `priority`.| + +Additionally, the following other configuration parameters influence the calculation of `available charging power`: + +|Parameter|Description|Positive|Negative| +|---------|-----------|--------|--------| +|[`site.residualPower`](../reference/configuration/site/#residualpower) (W)|Is incorporated in the `available charging power` to set the target operating level for `grid power`. In other words, the system will aim to keep `grid power` at the value set for `residualPower`.|Power vehicle charging should leave for grid or battery|Power vehicle charging may draw from the grid or battery| +|[`site.prioritySoc`](../reference/configuration/site/#prioritysoc) (%)|If the `battery state-of-charge` is above this limit, vehicle charging will be prioritized.|-|-| +|[`loadpoint.priority`](../reference/configuration/loadpoints/#priority) (Int)|Defines priorities between multiple chargers. The higher the number, the higher the priority.|-|-| +|[`site.maxGridSupplyWhileBatteryCharging`](../reference/configuration/site/#maxgridsupplywhilebatterycharging) (W)|Deals with situations where vehicle charging is prioritized over battery charging but measured battery power may not be fully accessible for vehicle charging.

With an inverter with directly connected DC battery, the DC capacity of the panels may exceed the inverter’s AC output capacity, additional surplus can then only be charged into the battery. In this case, evcc would still include the battery power into available charging power, but the power then has to be drawn from the grid because of the bottle neck of the inverter’s AC output. `maxGridSupplyWhileBatteryCharging` was introduced to help with that: if consumed `grid power` exceeds that limit, then `battery power` will be excluded from `available charging power`, even if `battery state-of-charge` is higher than `prioritySoc`.|-|-| + +Next, we'll learn how `available charging power` is calculated under different circumstances. + +## Calculation of available charging power + +`Available charging power` is a positive value indicating how much power in Watt is available for charging the vehicle connected to a `loadpoint`. + +The following diagrams shows how the variables listed above are factored into the calculation of `available charging power`. The formulas are not necessarily those programmed into evcc, but rather provide a mathematical model that helps understanding how the software works. + +### Based on grid power + +Without a battery, the following formula shows how 'available charging power' is calculated with data from a grid meter: + +
+ +### With a battery + +If you have a battery for which you can measure `battery power` and `battery state-of-charge`, then depending on the charge level and configured `prioritySoc` the `battery power` will be included in the `available charging power`. That increases the power going to the vehicle, practically forcing the battery to reduce or stop charging. + + Note that in combination with battery it is possible but not recommended to set a negative `residualPower`. With a battery, a negative `residualPower` will lead to power be drawn from the battery for vehicle charging, regardless of configured priorities. + +
+ +In the next chapter we'll have a look at how `minimum charging power` and `maximum charging power` are calculated. + +### With a battery and maxGridSupplyWhileBatteryCharging + +As outlined above, `maxGridSupplyWhileBatteryCharging` introduces another condition for including battery power into the `available charging power`, to deal with situations where power that is fed into the battery cannot be diverted to vehicle charging due to limits in the interface between the battery inverter and rest of the system. + +If `maxGridSupplyWhileBatteryCharging` is set, then `battery power` is included only if both `grid power` is below that set limit and `battery state-of-charge` is higher than `prioritySoc`. + +
+ +### Based on PV power + +If you have [no grid meter](./meters#i-have-a-solar-installation-but-i-dont-have-a-readable-grid-connection-meter---can-i-still-use-evcc), you can use PV power instead. House consumption is not known in this case, but as described above, you can use a positive value for `residualPower` to assume a constant for house consumption. If no grid meter is configured, the system will replace `charging power` and `grid power` with `PV power`: + +
diff --git a/docs/inner-workings/charging-modes.mdx b/docs/inner-workings/charging-modes.mdx new file mode 100644 index 0000000000..55922a8f94 --- /dev/null +++ b/docs/inner-workings/charging-modes.mdx @@ -0,0 +1,24 @@ +--- +sidebar_position: 2 +--- + +# Charging modes + +--- +**What you'll learn**: what's the purpose of the the three charging modes `Fast`, `Solar` and `Min+Solar` as well as charging plans. A basic introduction can also be found in the [charging guide](/docs/guides/charging). + +--- + +With evcc you can use one of the following three modes to charge your vehicle: + +- `Fast` mode enables charging with the highest amount of power possible, without consideration of PV surplus. This mode basically replicates what the typical charger is already able to do on its own. + +- `Solar` mode is where the magic happens: based on available surplus, evcc starts and stops the charging process and adapts the amount of power. If you have a battery you can set priorities between battery and EV charging. + +- `Min+Solar` mode charges continuously with the minimum power needed by the charger, regardless of surplus. If more surplus is available, evcc will adapt the amount of power. + +Charging plans are an additional option to control charging. Departure plans set a time when a certain charge limit shall be reached, the vehicle is charged in `Solar` mode with surplus and at the latest possible time `Fast` mode is activated to meet the targeted charge limit. With arrival plans the vehicle will be charged in `Fast` mode to a certain charge limit, and after that with surplus in `Solar` mode. + +The following screenshot shows the selection of the charging modes: + +![charging modes](img/screenshot-modes.png) \ No newline at end of file diff --git a/docs/inner-workings/conclusion.mdx b/docs/inner-workings/conclusion.mdx new file mode 100644 index 0000000000..86fa653255 --- /dev/null +++ b/docs/inner-workings/conclusion.mdx @@ -0,0 +1,7 @@ +--- +sidebar_position: 9 +--- + +# Conclusion + +We hope this section of the documentation succeeded in providing you a comprehensible overview of the intricate but powerful charging modes of evcc. While the dependencies between the different settings are not always easy to understand, they allow the system to adapt to many situations - the right setup is always a balance between many factors, among them: the output of your PV system, the consumption of your house and vehicle, the presence of batteries or other surplus controlled devices and the rates that apply to feeding power into the grid or drawing from it. With evcc you have a powerful tool at hand to accommodate these factors and optimize solar-charging of your vehicle based on your individual needs. diff --git a/docs/inner-workings/config-io.mdx b/docs/inner-workings/config-io.mdx new file mode 100644 index 0000000000..4d14a91948 --- /dev/null +++ b/docs/inner-workings/config-io.mdx @@ -0,0 +1,23 @@ +--- +sidebar_position: 3 +--- + +import Drawio from '@theme/Drawio' +import diagrams from '!!raw-loader!./img/diagrams.drawio'; + +# Configuration and interactions + +--- +**What you'll learn**: what are the inputs and settings that define evcc's control of your vehicle’s charging. + +--- + +Let's start with a diagram showing the settings we'll discuss in the subsequent chapters of this section. As mentioned in the introduction, we will leave aside the details of how devices are integrated with evcc but will focus evcc's control of your vehicle’s charging, especially in the `Solar` and `Min+Solar` modes. + +
+ +Evcc is just in process of migrating from file-based to user-interface-based configuration. Most parameters still need to be set in `evcc.yaml`, but the battery settings can already be done on the user interface and will be saved in the evcc database. + +The next diagram shows evcc's configuration sources, internal computations and interactions with external devices: + +
\ No newline at end of file diff --git a/docs/inner-workings/img/diagrams.drawio b/docs/inner-workings/img/diagrams.drawio new file mode 100644 index 0000000000..8694cc29ea --- /dev/null +++ b/docs/inner-workings/img/diagrams.drawio @@ -0,0 +1,3486 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/inner-workings/img/screenshot-modes.png b/docs/inner-workings/img/screenshot-modes.png new file mode 100644 index 0000000000..6d191d98c6 Binary files /dev/null and b/docs/inner-workings/img/screenshot-modes.png differ diff --git a/docs/inner-workings/introduction.mdx b/docs/inner-workings/introduction.mdx new file mode 100644 index 0000000000..61585a2894 --- /dev/null +++ b/docs/inner-workings/introduction.mdx @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +sidebar_label: Introduction +--- + +# Introduction + +In this section, we'll introduce you to the inner-workings of evcc and all you'd ever want to know about about customizing the charging process. + +Let‘s start with why you‘d want to use evcc. In a nutshell: evcc takes control of your charger/wallbox and enables you to charge your electric vehicle (EV) with surplus from your photovoltaic (PV) system. Its power lies in its openness and the many interfaces implemented for different inverters, battery systems, vehicles and other energy-management equipment. This enables you to bring together hardware from different manufacturers and control EV charging at a level most similar systems cannot offer. + +Evcc is highly customizable, and can therefore adapt to many different setups and requirements. Before you read this sectioin, make sure you are familiar with the [structure of the configuration](../reference/configuration/). Here we will leave aside the details of how devices are integrated with evcc but will focus on how different inputs and settings define evcc's control of your vehicle’s charging, especially in the `Solar` and `Min+Solar` modes. + +## Table of contents + +This inner-workings section of the documentation is divided into the following chapters: + +|Chapter|What you'l learn| +|-------|----------------| +|[Charging modes](./charging-modes)|What's the purpose of the the three charging modes `Fast`, `Solar` and `Min+Solar` as well as charging plans.| +|[Configuration and interactions](./config-io)|What are the inputs and settings that define evcc's control of your vehicle’s charging.| +|[Minimum/maximum charging power](./minmaxphases)|How `minimum charging power` and `maximum charging power` are calculate and how this often leads to a gap between the power ranges usable for 1-phase and 3-phase charging.| +|[Available charging power](./available-charging-power)|How available surplus is calculated in `Solar` and `Min+Solar` mode.| +|[Starting and stopping charging](./startstop)|When evcc starts or stops charging your vehicle, and how in `Solar` mode this can be customized using `enable` and `disable` thresholds.| +|[Timing: interval and delays](./timing-interval)|How interval and delay settings affect when charging is started, stopped and charging power is adjusted.| +|[Timing: multiple loadpoints](./timing-multiple-loadpoints)|How evcc manages multiple `loadpoints` with different priorities.| + +## Color codes + +In the diagrams in this section, we'll use the following color codes: + +- Blue are settings that define integrations with external devices, for example meters, inverters, chargers, vehicles or batteries. +- Green are other configuration parameters controlling the logic inside evcc. +- Orange are computed values and outputs of evcc. \ No newline at end of file diff --git a/docs/inner-workings/minmaxphases.mdx b/docs/inner-workings/minmaxphases.mdx new file mode 100644 index 0000000000..c53797026d --- /dev/null +++ b/docs/inner-workings/minmaxphases.mdx @@ -0,0 +1,24 @@ +--- +sidebar_position: 4 +sidebar_label: Min/max charging power +--- + +import Drawio from '@theme/Drawio' +import diagrams from '!!raw-loader!./img/diagrams.drawio'; + +# Minimum/maximum charging power + +--- +**What you'll learn**: how `minimum charging power` and `maximum charging power` are calculate and how this often leads to a gap between the power ranges usable for 1-phase and 3-phase charging. + +--- + +`Minimum charging power` is calculated from `minCurrent` and the `phases` setting and represents the lowest amount of power the vehicle is charged with in `Solar` and `Min+Solar` modes. + +`Maximum charging power` is calculated from `maxCurrent` and `phases` and represents both the upper limit used in `Solar` and `Min+Solar` mode as well as the power used for `Fast` mode. + +If your charger supports it, you can enable automatic switching between 1-phase and 3-phase charging. The system will then use three phases if `available charging power` allows it, and otherwise only one. In such a setup, `minCurrent` and `maxCurrent` settings apply to both 1-phase and 3-phase charging. Depending on the range of those settings in your system, you’ll likely have gap between 1-phase and 3-phase charging, were evcc needs to continue charging with the `maximum charging power` of one phase and additional surplus has to be fed into the grid or a battery. + +The following diagram shows the calculations of `minimum charging power`, `maximum charging power` and the resulting gap between 1-phase and 3-phase charging: + +
diff --git a/docs/inner-workings/startstop.mdx b/docs/inner-workings/startstop.mdx new file mode 100644 index 0000000000..b8bf41a721 --- /dev/null +++ b/docs/inner-workings/startstop.mdx @@ -0,0 +1,68 @@ +--- +sidebar_position: 6 +--- + +import Drawio from '@theme/Drawio' +import diagrams from '!!raw-loader!./img/diagrams.drawio'; + +# Starting and stopping charging + +--- +**What you'll learn**: when evcc starts or stops charging your vehicle, and how in `Solar` mode this can be customized using `enable` and `disable` thresholds. + +--- + +Let's start with the basic conditions under which charging is started and stopped: + +- In `Fast` and `Min+Solar` mode, charging is started immediately when a vehicle is connected and the mode is activated. + +- Charging plans in `Solar` and `Min+Solar` enable charging independent of surplus. A `departure` plan enables `Fast` charging as late as possible to reach the target `battery state-of-charge` at a set time. An `arrival` plan activates `Fast` charging immediately when a vehicle is connected, charges it to a set `battery state-of-charge` and then switches to surplus charging. + +- In `Solar` mode, charging is started and stopped depending on battery settings and `available charging power`. + +- In all modes charging is stopped when the target `battery state-of-charge` is reached or the vehicle is disconnected. + +## Starting and stopping in Solar mode + +In `Solar` mode, [`loadpoint.enable`](../reference/configuration/loadpoints#enable) and [`disable`](../reference/configuration/loadpoints#disable) sets thresholds in Watt that start and stop charging based on `available charging power`. + +Both thresholds default to [`minimum charging power`](./minmaxphases), i.e. charging is started if `available charging power` exceeds `minimum charging power` and stopped if it falls below. + +Note that the values for `minimum charging power` and `available charging power` as defined in the previous chapters are positive, while for the enable threshold a negative value indicates surplus. Therefore mathematically the thresholds actually default to a negated `minimum charging power` and are checked against a negated `available charging power`. + +### Equations without a battery + +The following diagram shows the equations checking the thresholds against `available charging power`: + +
+ +### Equations with a battery + +If evcc is integrated with a battery, you can also use [`site.bufferSoc`](../reference/configuration/site/#buffersoc) and [`bufferStartSoc`](../reference/configuration/site/#bufferstartsoc) to control charging based on the charge level of the battery: + +- Below `bufferSoc`, charging is started and stopped based on `available charging power`. + +- Between 'bufferSoc' and `bufferStartSoc` charging is started based on `available charging power` but continues regardless of surplus. + +- Above `bufferStartSoc` additionally charging is started immediately, regardless of surplus. + +Effectively, above `bufferSoc`, this leads to battery-supported charging: if surplus drops below `minimum charging power`, charging continues with `minimum charging power` and the missing power is drawn from the battery. + +The following diagram visualizes these rules: + +
+ +### Making adjustments + +As mentioned before, both thresholds default to a negated `minimum charging power`, but you adjust them depending on the behavior you'd like to achieve: + +
+ +Setting the thresholds lower will charge the vehicle only when higher amounts of surplus are available, for example to avoid the proportionally higher vehicle charging losses at lower powers and charge a house battery instead. + +To give an instance: with minCurrent set to 6A your `minimum charging power` with one phase is 1 x 6A x 230V = 1380W and the default for enable/disable thresholds is -1380W. Setting enable/disable tresholds to -2300W will charge the vehicle only if enough surplus for charging with 10A (1 x 10A x 230V = 2300W) is available. Especially with automatic phase switching it is better to use the tresholds for this, since raising `minCurrent` would also [increase the gap between 1-phase and 3-phase charging power](./minmaxphases). + +Setting the thresholds higher will charge the vehicle even if not enough surplus is available and supplement the surplus with power from grid or battery. Note that evcc cannot enforce power being drawn from the grid instead of a battery, so this would override the other battery settings and draw power from the battery even if the `battery state-of-charge` is lower than `bufferSoc`. + +To give an instance: with minCurrent set to 6A your `minimum charging power` with one phase is 1 x 6A x 230V = 1380W and the default for enable/disable thresholds is -1380W. Setting enable/disable tresholds to -690W will charge the vehicle if at least 690W of surplus are available and thus at least 50% of the power comes from the solar panels. A remaining max of 690W will be drawn from grid or battery. + diff --git a/docs/inner-workings/timing-interval.mdx b/docs/inner-workings/timing-interval.mdx new file mode 100644 index 0000000000..b0a5bee510 --- /dev/null +++ b/docs/inner-workings/timing-interval.mdx @@ -0,0 +1,29 @@ +--- +sidebar_position: 7 +--- + +import Drawio from '@theme/Drawio' +import diagrams from '!!raw-loader!./img/diagrams.drawio'; + +# Timing: interval and delays + +--- +**What you'll learn**: how `interval` and delay settings affect when charging is started, stopped and charging power is adjusted. + +--- + +The calculation of `available charging power` and resulting actions and adjustments are executed in the [`interval`](../reference/configuration/interval/) defined in the configuration file. Therefore evcc does not react to any change in the inputs but only to the state detected at each interval, as the next diagram illustrates: + +
+ +The time in between the `intervals` gives the charger or other device represented by the loadpoint as well as other surplus-controlled devices chances to react before the state is checked again and further adjustments are made. + +To avoid vehicle charging being started and stopped in the typically relatively short `intervals`, several delays are applied: + +- [`loadpoint.enable:delay`](../reference/configuration/loadpoints/#delay) defines the time the enable threshold must be met before charging is started. Also applies to switching from 1-phase to 3-phase charging. +- [`loadpoint.disable:delay`](../reference/configuration/loadpoints/#delay-1) defines the time the disable threshold must be met before charging is stopped. Also applies to switching from 3-phase to 1-phase charging. +- [`loadpoint.guardduration`](../reference/configuration/loadpoints/#guardduration) defines the time that after starting charging must pass before charging can be stopped again, and vice versa the time that must pass after stopping before charging can start again. + +The next diagram shows the application of those settings and their relationship with the control cycle `interval`: + +
\ No newline at end of file diff --git a/docs/inner-workings/timing-multiple-loadpoints.mdx b/docs/inner-workings/timing-multiple-loadpoints.mdx new file mode 100644 index 0000000000..47e49bf27b --- /dev/null +++ b/docs/inner-workings/timing-multiple-loadpoints.mdx @@ -0,0 +1,25 @@ +--- +sidebar_position: 8 +--- + +import Drawio from '@theme/Drawio' +import diagrams from '!!raw-loader!./img/diagrams.drawio'; + +# Timing: multiple loadpoints + +--- +**What you'll learn**: how evcc manages multiple `loadpoints` with different priorities. + +--- + +If you have two or more `loadpoints`, at each `interval` only one will be calculated and adjusted. This way each `loadpoint` represents its own independent control circuit. + +The control circuit of each `loadpoint` only takes into account the measurement inputs from the devices represented by the other loadpoints, but is not aware of their ongoing adjustments or delay timers. `Loadpoints` with lower priority may grab surplus before `loadpoints` with higher priorities, but the control circuits of the higher priority `loadpoints` wil recognize that and divert power. + +The next diagram shows such independent control circuits for two `loadpoints`. In this example, we have Loadpoint A with lower `priority` grabbing surplus first but then releasing it again, after Loadpoint B with higher `priority` also starts charging: + +
+ +Note that this back-and-forth can be avoided by setting a longer `enable:delay` for the `loadpoint` with lower `priority`: + +
diff --git a/docs/sponsorship.mdx b/docs/sponsorship.mdx index 04f622c050..011afc86a8 100644 --- a/docs/sponsorship.mdx +++ b/docs/sponsorship.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 --- import SponsorToken from "/docs/_sponsortoken.mdx"; diff --git a/docusaurus.config.js b/docusaurus.config.js index 31866362c3..caf6f728c0 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -23,6 +23,9 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula"); }, }, }, + plugins: [ + ['drawio', {}], + ], presets: [ [ "@docusaurus/preset-classic", diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx index 90b727343b..c9ca74476c 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/chargers.mdx @@ -2606,3 +2606,8637 @@ chargers: standbypower: 15 # Power values above this value will be considered as charging pow (optional) ``` + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + + + +## ABB Terra AC + + + +Requires firmware >= 1.6.5 + +```yaml +chargers: + - name: my_charger + type: template + template: abb + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## ABL + +### eM4 (SBCx) + + + +```yaml +chargers: + - name: my_charger + type: template + template: abl-em4 + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### eMH1, eMH2 + + + +```yaml +chargers: + - name: my_charger + type: template + template: abl + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 38400 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8E1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 10s # optional +``` + + + + + +## Alfen Eve + + + +The "Active load balancing" license is required for external Modbus control of the charger. Enable "Active Load Balancing" and select "Energy Management System" as Data Source in the configuration. When using "Double" charger both loadpoints need to be added. The the first port (or single) is accessable on ID 1, second port on ID 2. + +```yaml +chargers: + - name: my_charger + type: template + template: alfen + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Alphatec Wallbox Mini/ AW1eM + + + +```yaml +chargers: + - name: my_charger + type: template + template: alphatec + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 10s # optional +``` + + + + + +## Amperfied + +### Wallbox connect.business + + + +```yaml +chargers: + - name: my_charger + type: template + template: amperfied + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### Wallbox connect.home + + + +```yaml +chargers: + - name: my_charger + type: template + template: amperfied + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### Wallbox Energy Control + + + +Please read the wiring and configuration manual carefully. All boxes must be configured for external control in follower mode (DIP S5/4 OFF). Each box needs an individual Modbus ID (DIP S4). Ensure correct RS485 cabling including bus termination (DIP S6/2). + +```yaml +chargers: + - name: my_charger + type: template + template: heidelberg + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Audi + +### Audi Wallbox pro (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +### Wallbox plus (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +Note: If you've added an energy meter to your charger please use the Pro or Connected+ integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +## Bender CC612/613 + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## BMW + +### i Wallbox + + + +Requires firmware version 3.10.42 (C-series) bzw. 1.11 (X-series). For phase switching the Keba phase switch (KeContact S10) is also required. + +```yaml +chargers: + - name: my_charger + type: template + template: keba-modbus + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### i Wallbox (legacy UDP protocol) + + + +This requires the UDP function to be enabled with DIP 1.3 = ON, see the installation manual. + +```yaml +chargers: + - name: my_charger + type: template + template: keba + host: 192.0.2.2 # IP address or hostname +``` + + + +## cFos Power Brain, Power Brain Solar + + + +The meter- if present- must be configured separately as charge meter. +Phase switching is only available with the Solar variant and must be enabled by the user. + +```yaml +chargers: + - name: my_charger + type: template + template: cfos + host: 192.0.2.2 # IP address or hostname +``` + + + + + +## Compleo eBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: innogy-ebox + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Cupra + +### Charger Connect (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +Note: If you've added an energy meter to your charger please use the Pro or Connected+ integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +### Charger Pro (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +## Dadapower Premium Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: dadapower + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## DaheimLaden + +### Wallbox + + + +For use with evcc, the wallbox must be operated in RFID mode. + +```yaml +chargers: + - name: my_charger + type: template + template: daheimladen + token: # Request your access token from Daheimladen support: info@daheimladen.de. (optional) + stationid: # Serial number as displayed on the wallbox display. (optional) +``` + + + +### Wallbox (via ModbusTCP) + + + +Wallbox must be operated with a recent firmware including Modbus support. Furthermore, “Nachladen” (Smart) or “RSDA” (Touch) must be activated in settings. + +```yaml +chargers: + - name: my_charger + type: template + template: daheimladen-mb + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + +## E.ON Drive + +### eBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: innogy-ebox + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### vBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: vestel + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## E3/DC Easy Connect + + + +DIP switch 10 at the controller needs to be set to 'ON'. A recent controller firmware is recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-eth + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Easee Home + + + +```yaml +chargers: + - name: my_charger + type: template + template: easee + user: # Email address + password: # same as Easee app or the web portal (https://easee.cloud) + charger: EH______ + timeout: 10s # optional + authorize: # Controls wether evcc shall perform authentication against charger. Benefit is a contolled start of charging. Not compatible with RFID identification of vehicles. (optional) +``` + + + + + +## Ebee Wallbox + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## echarge + +### cPH1 + + + +Charge mode must be configured as `manual` + +```yaml +chargers: + - name: my_charger + type: template + template: hardybarth-ecb1 + host: 192.0.2.2 # IP address or hostname +``` + + + + + +### cPH2, cPμ2 + + + +```yaml +chargers: + - name: my_charger + type: template + template: hardybarth-salia + host: 192.0.2.2 # IP address or hostname +``` + + + + + +## Elli + +### Charger Connect (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +Note: If you've added an energy meter to your charger please use the Pro or Connected+ integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +### Charger Pro (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +## EM2GO Pro Power/OCPP/ONC + + + +Recent firmware with Modbus support required (Pro Power: 1.01 and OCPP/ONC: 3.15) + +```yaml +chargers: + - name: my_charger + type: template + template: em2go + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Ensto Chago Wallbox + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## ESL Walli LIGHT + + + +DIP switch 10 at the controller needs to be set to 'ON'. A recent controller firmware is recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-eth + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Etrel + +### INCH + + + +The charger must be switched to "Power" charging mode. + +```yaml +chargers: + - name: my_charger + type: template + template: etrel + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +### INCH Duo + + + +The charger must be switched to "Power" charging mode. + +```yaml +chargers: + - name: my_charger + type: template + template: etrel-duo + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## EVBox Elvi + + + +```yaml +chargers: + - name: my_charger + type: template + template: elvi + timeout: 2m # optional + meter: true # Deactivate if the charger has no integrated metering device installed (optional) +``` + + + +## EVSE DIN + + + +```yaml +chargers: + - name: my_charger + type: template + template: evse-din + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## EVSE-WiFi + + + +```yaml +chargers: + - name: my_charger + type: template + template: evsewifi + host: 192.0.2.2 # IP address or hostname +``` + + + +## Fronius Wattpilot + + + +Requires firmware 36.3 or later. + +```yaml +chargers: + - name: my_charger + type: template + template: fronius-wattpilot + host: 192.0.2.2 # IP address or hostname + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + +## Garo GLB, GLB+, LS4, LS4 compact + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## go-e + +### Charger Gemini, HOME+, HOMEfix (V3) + + + +Requires firmware 052.1 or later. + +For 1P/3P-Phase switching the HTTP API v2 in the charger setup needs to be activated. + +The “simulate unplugging” option should be activated in the Go-E app ("Car" menu item). + +```yaml +chargers: + - name: my_charger + type: template + template: go-e-v3 + host: 192.0.2.2 # IP address or hostname +``` + + + + + +### Charger HOME+, HOMEfix, Pro + + + +Requires firmware 040.0 or later. HTTP API v1 or v2 must be activated. + +```yaml +chargers: + - name: my_charger + type: template + template: go-e + host: 192.0.2.2 # IP address or hostname +``` + + + + + +## HardyBarth + +### cPH1 + + + +Charge mode must be configured as `manual` + +```yaml +chargers: + - name: my_charger + type: template + template: hardybarth-ecb1 + host: 192.0.2.2 # IP address or hostname +``` + + + + + +### cPH2, cPμ2 + + + +```yaml +chargers: + - name: my_charger + type: template + template: hardybarth-salia + host: 192.0.2.2 # IP address or hostname +``` + + + + + +## Heidelberg Energy Control + + + +Please read the wiring and configuration manual carefully. All boxes must be configured for external control in follower mode (DIP S5/4 OFF). Each box needs an individual Modbus ID (DIP S4). Ensure correct RS485 cabling including bus termination (DIP S6/2). + +```yaml +chargers: + - name: my_charger + type: template + template: heidelberg + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Hesotec eSat, eBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: hesotec + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Homecharge Homecharger HC11L, HC22L + + + +The charger must be equipped with a built-in meter (models HC11L/HC22L Energy or Profi). +For the OCPP configuration, you need to access the EFR-SECC charge controller at http://host/secc. +For login credentials, ask your dealer or the vendor EFR (www.efr.de). + +```yaml +chargers: + - name: my_charger + type: template + template: homecharge + timeout: 2m # optional +``` + + + +## Huawei FusionCharge AC + + + +```yaml +chargers: + - name: my_charger + type: template + template: huawei-ac + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Innogy eBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: innogy-ebox + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## INRO Pantabox + + + +```yaml +chargers: + - name: my_charger + type: template + template: pantabox + host: 192.0.2.2 # IP address or hostname +``` + + + +## Juice Charger Me + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## KEBA + +### KeContact P20, P30, C/X Series + + + +Requires firmware version 3.10.42 (C-series) bzw. 1.11 (X-series). For phase switching the Keba phase switch (KeContact S10) is also required. + +```yaml +chargers: + - name: my_charger + type: template + template: keba-modbus + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### KeContact P20, P30, C/X Series (legacy UDP protocol) + + + +This requires the UDP function to be enabled with DIP 1.3 = ON, see the installation manual. + +```yaml +chargers: + - name: my_charger + type: template + template: keba + host: 192.0.2.2 # IP address or hostname +``` + + + +## KSE wBX16 + + + +```yaml +chargers: + - name: my_charger + type: template + template: kse + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 100 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8E1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 100 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## LadeFoxx EvLoad/ Mikro 2.0 + + + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-charx + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Mennekes + +### Amedio, Amtron ChargeControl, Professional + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +### Amtron Compact 2.0s + + + +The charger needs to be configured as Satellite with help of the DIP-Switches on the baseboard. + +```yaml +chargers: + - name: my_charger + type: template + template: mennekes + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 50 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 57600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N2" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 50 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### Amtron Start 2.0s + + + +The charger needs to be configured as Satellite with help of the DIP-Switches on the baseboard. + +```yaml +chargers: + - name: my_charger + type: template + template: mennekes + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 50 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 57600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N2" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 50 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### AMTRON XTRA, AMTRON PREMIUM + + + +```yaml +chargers: + - name: my_charger + type: template + template: amtron + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## NRGKick + +### Bluetooth + + + +NRGkick charging unit via Bluetooth (older than 2022/2023) + +```yaml +chargers: + - name: my_charger + type: template + template: nrgkick-bluetooth + mac: + pin: +``` + + + +### Connect + + + +NRGkick charging unit via HTTP (older than 2022/2023) + +```yaml +chargers: + - name: my_charger + type: template + template: nrgkick-connect + host: 192.0.2.2 # IP address or hostname + mac: + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +## OBO Bettermann Ion + + + +```yaml +chargers: + - name: my_charger + type: template + template: obo + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 101 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 101 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 101 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## OpenEVSE + + + +Requires firmware 7.0 or later. + +```yaml +chargers: + - name: my_charger + type: template + template: openevse + 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) +``` + + + +## openWB + +### Pro + + + +```yaml +chargers: + - name: my_charger + type: template + template: openwb-pro + host: 192.0.2.2 # IP address or hostname +``` + + + +### series2 + + + +The wallbox has to be configured as loadpoint. + +```yaml +chargers: + - name: my_charger + type: template + template: openwb + host: 192.0.2.2 # IP address or hostname +``` + + + +### Software 2.x + + + +Requires software 2.x + +```yaml +chargers: + - name: my_charger + type: template + template: openwb-2.0 + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port +``` + + + +## Optec Mobility One + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## Orbis Viaris Uni + + + +```yaml +chargers: + - name: my_charger + type: template + template: orbis-viaris + timeout: 2m # optional +``` + + + +## PC Electric Garo + + + +Only devices configured as master can be used right now! + +```yaml +chargers: + - name: my_charger + type: template + template: pcelectric-garo + host: 192.0.2.2 # IP address or hostname + port: 8080 # Port (optional) +``` + + + + + +## Phoenix Contact + +### CHARX + + + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-charx + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### EM-CP-PP-ETH + + + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-em-eth + + # Modbus TCP + modbus: tcpip + id: 180 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### EV-CC-AC1-M3-CBC-RCM-ETH, EV-CC-AC1-M3-CBC-RCM-ETH-3G, EV-CC-AC1-M3-RCM-ETH-XP, EV-CC-AC1-M3-RCM-ETH-3G-XP + + + +DIP switch 10 at the controller needs to be set to 'ON'. A recent controller firmware is recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-eth + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### EV-SER (Modbus RTU) + + + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-ser + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Porsche + +### Mobile Charger Connect + + + +```yaml +chargers: + - name: my_charger + type: template + template: pmcc + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### Mobile Charger Plus + + + +```yaml +chargers: + - name: my_charger + type: template + template: pmcp + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +## Pracht Alpha XT, XT+, Mono XT, Mono XT+, PNI + + + +```yaml +chargers: + - name: my_charger + type: template + template: pracht-alpha + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 10s # optional +``` + + + + + +## Pulsares SimpleBox + + + +```yaml +chargers: + - name: my_charger + type: template + template: pulsares + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Schneider EVlink Wallbox, EVlink Parkplatz + + + +```yaml +chargers: + - name: my_charger + type: template + template: schneider-evlink + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Schrack i-CHARGE CION + + + +```yaml +chargers: + - name: my_charger + type: template + template: ichargecion + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## SENEC + +### Wallbox pro + + + +```yaml +chargers: + - name: my_charger + type: template + template: abl + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 38400 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8E1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 10s # optional +``` + + + + + +### Wallbox pro s + + + +Please read the wiring and configuration manual carefully. All boxes must be configured for external control in follower mode (DIP S5/4 OFF). Each box needs an individual Modbus ID (DIP S4). Ensure correct RS485 cabling including bus termination (DIP S6/2). + +```yaml +chargers: + - name: my_charger + type: template + template: heidelberg + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Siemens Versicharge GEN3 + + + +Requires firmware >= 2.121.5 + +```yaml +chargers: + - name: my_charger + type: template + template: versicharge + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Skoda + +### iV Charger Connect (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +Note: If you've added an energy meter to your charger please use the Pro or Connected+ integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +### iV Charger Connect+ (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +## SMA EV Charger + + + +The charger must be switched to "Fast" charging mode and the user must have "Administrator" rights. + +```yaml +chargers: + - name: my_charger + type: template + template: smaevcharger + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + + + +## smartWB + + + +```yaml +chargers: + - name: my_charger + type: template + template: smartwb + host: 192.0.2.2 # IP address or hostname +``` + + + +## SolarEdge Home EV Charger + + + +Requires firmware version 3.10.42 (C-series) bzw. 1.11 (X-series). For phase switching the Keba phase switch (KeContact S10) is also required. + +```yaml +chargers: + - name: my_charger + type: template + template: keba-modbus + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Sonnen sonnenCharger + + + +The charger must be switched to "Power" charging mode. + +```yaml +chargers: + - name: my_charger + type: template + template: etrel + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## Stark in Strom Easy + + + +```yaml +chargers: + - name: my_charger + type: template + template: evse-din + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## TechniSat Technivolt + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## Tesla TWC3 + + + +The TWC wallbox cannot be controlled directly. Control is via the vehicle. The vehicle must be associated with the TWC3 loadpoint. At this time only Tesla vehicles are supported. + +```yaml +chargers: + - name: my_charger + type: template + template: twc3 + host: 192.0.2.2 # IP address or hostname +``` + + + +## TinkerForge + +### WARP Charger Pro + + + +Firmware v2 required. Automatic phase switching requires the additional WARP Energy Manager. + +```yaml +chargers: + - name: my_charger + type: template + template: tinkerforge-warp + host: 192.0.2.2 # IP address or hostname of the MQTT broker + port: 1883 # MQTT broker port (optional) + topic: warp # Topic (omit leading /) (optional) + timeout: 30s # Don't accept values older than this value (optional) + energymanager: # EnergyManager MQTT topic if installed (optional) +``` + + + +### WARP Charger Smart + + + +Firmware v2 required. Automatic phase switching requires the additional WARP Energy Manager. + +```yaml +chargers: + - name: my_charger + type: template + template: tinkerforge-warp + host: 192.0.2.2 # IP address or hostname of the MQTT broker + port: 1883 # MQTT broker port (optional) + topic: warp # Topic (omit leading /) (optional) + timeout: 30s # Don't accept values older than this value (optional) + energymanager: # EnergyManager MQTT topic if installed (optional) +``` + + + +## Ubitricity Heinz + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +## Vestel EVC04 Home Smart/Connect Plus + + + +```yaml +chargers: + - name: my_charger + type: template + template: vestel + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Victron EV charging station + + + +Charger has to be in manual mode and Modbus has to be configured for ID 100. + +```yaml +chargers: + - name: my_charger + type: template + template: victron + + # Modbus TCP + modbus: tcpip + id: 100 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Volkswagen + +### ID. Charger Connect (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +Note: If you've added an energy meter to your charger please use the Pro or Connected+ integration. + +```yaml +chargers: + - name: my_charger + type: template + template: elliconnect + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +### ID. Charger Pro (Beta) + + + +The device has to have a fix IP address (manuall or via DHCP). + +The identification of a vehicle using the RFID card is not possible. + +Important: A mostly flawless functionality can only be provided with an external energy meter and no usage of CT coils, due to sosftware bugs of the Wallbox. Using a LAN connection is highly recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: ellipro + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address +``` + + + +## Wallbe + +### Eco, Eco 2.0(s), Pro + + + +DIP switch 10 at the controller needs to be set to 'ON'. A recent controller firmware is recommended. + +```yaml +chargers: + - name: my_charger + type: template + template: phoenix-ev-eth + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +### Eco, Pro + + + +The Wallbe must be connected using Ethernet and the DIP switch 10 must be set to 'ON'. + +```yaml +chargers: + - name: my_charger + type: template + template: wallbe + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + +### Eco, Pro (pre ~2019) + + + +DIP switch 10 must be set to 'ON'. + +```yaml +chargers: + - name: my_charger + type: template + template: wallbe-pre2019 + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + +### Eco, Pro (pre ~2019, with meter) + + + +DIP switch 10 must be set to 'ON'. + +```yaml +chargers: + - name: my_charger + type: template + template: wallbe-pre2019-meter + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + +### Eco, Pro (with meter) + + + +DIP switch 10 must be set to 'ON'. + +```yaml +chargers: + - name: my_charger + type: template + template: wallbe-meter + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + +## wallbox Pulsar Plus / Commander 2 / Copper SB + + + +Setup Guide: https://support.wallbox.com/en/knowledge-base/ocpp-activation-and-setup-guide/ +* Switch on “Enable OCPP” (myWallbox app) or enable the “OCPP WebSocket connection” switch (myWallbox Portal) +* Enable “Improved charger control” (Profile -> Experimental functions) (myWallbox app) +* URL: ws://[evcc-adresse]:8887/ (local network connection) +* Charge Point Identity: Custom value (e.g. serial number of charger) which is reused in configuration as *stationid* +* Password: leave empty + +```yaml +chargers: + - name: my_charger + type: template + template: pulsarplus + timeout: 2m # optional +``` + + + +## Walther Werke Basic Evo Pro + + + +Please read the wiring and configuration manual carefully. All boxes must be configured for external control in follower mode (DIP S5/4 OFF). Each box needs an individual Modbus ID (DIP S4). Ensure correct RS485 cabling including bus termination (DIP S6/2). + +```yaml +chargers: + - name: my_charger + type: template + template: heidelberg + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + 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 TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Webasto + +### Live + + + +The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On. + +```yaml +chargers: + - name: my_charger + type: template + template: bender + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +### NEXT + + + +Mode "HEMS activated" must be enabled. RFID tags can only be read by evcc. + +```yaml +chargers: + - name: my_charger + type: template + template: webasto-next + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + +### Unite + + + +```yaml +chargers: + - name: my_charger + type: template + template: vestel + + # Modbus TCP + modbus: tcpip + id: 255 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + +## Zaptec Go/Pro + + + +```yaml +chargers: + - name: my_charger + type: template + template: zaptec + id: # Charger ID (optional) + 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) +``` + + + + + +## Generic support + +### Custom + +```yaml +chargers: + - name: my_charger + type: custom + status: # charger status A..F + source: ... + # ... + enabled: # charger enabled state (true/false or 0/1) + source: ... + # ... + enable: # set charger enabled state (true/false or 0/1) + source: ... + # ... + maxcurrent: # set charger max current (A) + source: ... + # ... +``` + +- Documentation regarding `status A..F`: https://evsim.gonium.net/#der-control-pilot-cp (DE) + +### EEBUS compatible Wallbox + + + +```yaml +chargers: + - name: my_charger + type: template + template: eebus + ski: # The SKI of the wallbox, usually found on the web interface of the wallbox + ip: 192.0.2.2 # IP address (optional) +``` + + + +### OCPP 1.6J compatible charger with Smart Charging Profile + + + +With OCPP the connection will be established from charger (client) to evcc (server). +The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887. +By default, the first incoming connection with any station identifier is used. +In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured. +Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://:8887/`. +The charger may need a pre-configured (virtual) token ID/RFID identifier (`idtag: `) with which the charging sessions can be started without authorization. +If the charger supports sending metering values try to adjust the interval to a short time span. + +Requirements: +* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration +* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`) +* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar +* No encryption, no authentication, no password +* Local network connection + +```yaml +chargers: + - name: my_charger + type: template + template: ocpp + timeout: 2m # optional +``` + + + +## Switchable sockets + +Switchable Sockets (including smart-home switches) supported by evcc can be operated in one of two modes: + +- Charger Mode (default) +- Static-Switch Mode + +_Charger Mode_ allows use of the Switchable Socket to control the charging of battery-operated devices such as e-Motorcycles, e-Bikes, etc). +Charging current is measured and displayed by evcc, and the device is considered "charged" when power draw drops to a trickle (i.e `power < standbypower`) + +In contrast, _Static-Switch Mode_ can be used to easily control consumers such as heat pumps, air conditioning systems, and more. +The status of the device is determined by whether the Socket is on or off (on = "charging", off = "charged"). + +:::note +When using _Static-Switch Mode_, it is recommended to define a separate custom _Meter_ in order to display meaningful performance information. +::: + +For all Switchable Sockets, the _mode_ depends on how `standbypower` is configured. + +If the value of `standbypower` is greater than or equal to 0 (`standbypower >= 0`), then the Socket uses _Charger Mode_, +and the set value is treated as the threshold value (in Watts). +So long as the measured socket power is above this threshold value, the device is treated as "charging". If the power falls below this value (usually when the device is trickle-charging when its battery is full), it is treated as "charged" / complete. + +If `standbypower` is set to a negative value, then the Socket uses _Static-Switch Mode_. +:::info +The Charging Point parameter `phases` **must** be set to **1** when using a switchable socket to ensure proper control. + +```yaml +# loadpoint describes the charger, charge meter and connected vehicle +loadpoints: + - title: Shelly # display name for UI + charger: my_charger # charger + vehicle: audi + mode: pv +--- +mincurrent: 9 # 9A*220V=1980W minimum charge current (default 6A) +maxcurrent: 10 # 10A*220V=2200W maximum charge current (default 16A) +phases: 1 # ev phases (default 3) +``` + +::: + +### AVM FritzDECT + + + +```yaml +chargers: + - name: my_charger + type: template + template: fritzdect + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Homematic / Homematic IP + + + +```yaml +chargers: + - name: my_charger + type: template + template: homematic + host: 192.0.2.2 # IP address or hostname + port: 2010 # Port (optional) + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### HomeWizard + + + +```yaml +chargers: + - name: my_charger + type: template + template: homewizard + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### myStrom Switch + + + +```yaml +chargers: + - name: my_charger + type: template + template: mystrom + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Shelly + + + +```yaml +chargers: + - name: my_charger + type: template + template: shelly + 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 + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### Tasmota (1 Phase Charger) + + + +```yaml +chargers: + - name: my_charger + type: template + template: tasmota + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Relaychannel number (1-8) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tplink + host: 192.0.2.2 # IP address or hostname + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +chargers: + - name: my_charger + type: template + template: tapo + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + standbypower: 15 # Power values above this value will be considered as charging pow (optional) +``` + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx index b84f89a589..7ea5859043 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx @@ -6820,3 +6820,22382 @@ meters: password: # Password of the user account (use single quotes in case of leading zeros) ``` + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + + + +## ABB A43, A44, B23, B24 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: abb-ab + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: abb-ab + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Acrel ADW300 Wireless Metering Meter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: acrel-adw300 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 1200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: acrel-adw300 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 1200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: acrel-adw300 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 1200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Ads-tec StoraXe + + + +```yaml +meters: + - name: my_battery + type: template + template: storaxe + usage: battery + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Alpha ESS Storion SMILE + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: alpha-ess-smile + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 85 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: alpha-ess-smile + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 85 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: alpha-ess-smile + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 85 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 85 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Anker Micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-mi + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Bernecker Engineering MPM3PM + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: mpm3pm + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mpm3pm + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Bosswerk + +### MI series micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: solarman + usage: pv + host: 192.0.2.2 # IP address or hostname + user: admin # User account (e.g. email address, user id, etc.) (optional) + password: admin # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + +### Micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-mi + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Carlo Gavazzi + +### EM/ET 330/340 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: cg-emt3xx + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: cg-emt3xx + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### EM24 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: cg-em24 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: cg-em24 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## cFos PowerBrain Meter + + + +```yaml +meters: + - name: my_charger + type: template + template: cfos + usage: charge + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 4702 # Port +``` + + + + + +## Deye + +### 3p hybrid inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: deye-hybrid-3p + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-hybrid-3p + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: deye-hybrid-3p + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-mi + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### Storage (hybrid) inverter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-storage + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: deye-storage + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_grid + type: template + template: deye-storage + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### String inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-string + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### SUN series micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: solarman + usage: pv + host: 192.0.2.2 # IP address or hostname + user: admin # User account (e.g. email address, user id, etc.) (optional) + password: admin # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + +## Discovergy + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: discovergy + usage: grid + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + meter: 1ESY1161229886 +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: discovergy + usage: pv + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + meter: 1ESY1161229886 +``` + + + + + + +## DSMR + + + +```yaml +meters: + - name: my_grid + type: template + template: dsmr + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 1502 # Port (optional) +``` + + + +## DZG DVH4013 + + + +```yaml +meters: + - name: my_charger + type: template + template: dzg + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## E3/DC + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: e3dc + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: e3dc + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: e3dc + usage: battery + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + + +## Eastron + +### SDM120-Modbus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron-sdm120 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron-sdm120 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SDM220/230 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron-sdm220_230 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron-sdm220_230 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SDM630-Modbus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SDM72D-M + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron-sdm72 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron-sdm72 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SDM72DM-V2 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: eastron + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: eastron + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Enphase IQ Envoy + + + +Only batteries of type "AC Battery" are currently supported by Enphase-API. + + + + +```yaml +meters: + - name: my_grid + type: template + template: enphase + usage: grid + host: 192.0.2.2 # IP address or hostname + token: # Required if Envoy Firmware D7.x.xxx. Token is valid for one year. Instructions for obtaining a token via web UI: https://enphase.com/download/accessing-iq-gateway-local-apis-or-local-ui-token-based-authentication (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: enphase + usage: pv + host: 192.0.2.2 # IP address or hostname + token: # Required if Envoy Firmware D7.x.xxx. Token is valid for one year. Instructions for obtaining a token via web UI: https://enphase.com/download/accessing-iq-gateway-local-apis-or-local-ui-token-based-authentication (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: enphase + usage: battery + host: 192.0.2.2 # IP address or hostname + token: # Required if Envoy Firmware D7.x.xxx. Token is valid for one year. Instructions for obtaining a token via web UI: https://enphase.com/download/accessing-iq-gateway-local-apis-or-local-ui-token-based-authentication (optional) +``` + + + + + + +## ESPHome DSMR + + + +```yaml +meters: + - name: my_grid + type: template + template: slimmelezer + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + +## FENECON + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: openems + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: openems + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: openems + usage: battery + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +## FoxESS + +### H1 Series Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fox-ess-h1 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fox-ess-h1 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### H3 Series Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: fox-ess-h3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: fox-ess-h3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fox-ess-h3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Fronius + +### Primo GEN24 Plus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: fronius-gen24 + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: fronius-gen24 + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fronius-gen24 + usage: battery + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + + +### Solar API V1 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: fronius-solarapi-v1 + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: fronius-solarapi-v1 + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fronius-solarapi-v1 + usage: battery + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Symo GEN24 Plus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: fronius-gen24 + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: fronius-gen24 + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: fronius-gen24 + usage: battery + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + + +## Ginlong Solis inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: solarman + usage: pv + host: 192.0.2.2 # IP address or hostname + user: admin # User account (e.g. email address, user id, etc.) (optional) + password: admin # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + +## go-e Controller + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: go-e-controller + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: go-e-controller + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +## GoodWe ET/EH/BH/BT Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: goodwe-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: goodwe-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: goodwe-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Growatt + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: growatt-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: growatt-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: growatt-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### TL-X(H) Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: growatt-hybrid-tlxh + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: growatt-hybrid-tlxh + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: growatt-hybrid-tlxh + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## HomeWizard Wi-Fi P1 Meter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homewizard + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homewizard + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +## Hoymiles HM and HMS Series (via OpenDTU) + + + +```yaml +meters: + - name: my_pv + type: template + template: hoymiles-opendtu + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +## Huawei + +### SmartLogger + + + +```yaml +meters: + - name: my_pv + type: template + template: huawei-smartlogger + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + +### SUN2000 via RS485 Modbus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: huawei-sun2000-rs485 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: huawei-sun2000-rs485 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: huawei-sun2000-rs485 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SUN2000 with SDongle + + + +```yaml +meters: + - name: my_pv + type: template + template: huawei-dongle + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 15s # optional +``` + + + +### SUN2000 with SDongle & Power Sensor + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: huawei-dongle-powersensor + usage: grid + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 15s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: huawei-dongle-powersensor + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 15s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: huawei-dongle-powersensor + usage: battery + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + timeout: 15s # optional +``` + + + + + + +## IGEN Tech Solarman Logger + + + +```yaml +meters: + - name: my_pv + type: template + template: solarman + usage: pv + host: 192.0.2.2 # IP address or hostname + user: admin # User account (e.g. email address, user id, etc.) (optional) + password: admin # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + +## inepro PRO380-MOD + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: inepro + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: inepro + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Janitza B series, UMG series + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: janitza + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: janitza + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Kostal + +### Piko (legacy) + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-legacy + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + +### Piko Hybrid + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: kostal-piko-hybrid + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-hybrid + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: kostal-piko-hybrid + usage: battery + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Piko MP Plus + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-mp-plus + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +### Piko, Piko BA + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: kostal-piko-pv + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-pv + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Plenticore Hybrid + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-plenticore + usage: pv + + # Modbus TCP + modbus: tcpip + id: 71 + host: 192.0.2.2 # Hostname + port: 1502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: kostal-plenticore + usage: battery + + # Modbus TCP + modbus: tcpip + id: 71 + host: 192.0.2.2 # Hostname + port: 1502 # Port +``` + + + + + + +### Smart Energy Meter + + + +```yaml +meters: + - name: my_grid + type: template + template: kostal-ksem + usage: grid + + # Modbus TCP + modbus: tcpip + id: 71 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### Smart Energy Meter (via inverter) + + + +The energy meter must be installed in sensor position 2 (grid connection). Sensor position 1 (House consumption) is not supported. + +```yaml +meters: + - name: my_grid + type: template + template: kostal-ksem-inverter + usage: grid + + # Modbus TCP + modbus: tcpip + id: 71 + host: 192.0.2.2 # Hostname + port: 1502 # Port +``` + + + +## LG ESS Home 8/10 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: lg-ess-home-8-10 + usage: grid + host: 192.0.2.2 # IP address or hostname + password: # User password, see https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alteratively, use registration id for admin login. (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: lg-ess-home-8-10 + usage: pv + host: 192.0.2.2 # IP address or hostname + password: # User password, see https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alteratively, use registration id for admin login. (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: lg-ess-home-8-10 + usage: battery + host: 192.0.2.2 # IP address or hostname + password: # User password, see https://github.com/Morluktom/ioBroker.lg-ess-home/tree/master#getting-the-password. Alteratively, use registration id for admin login. (optional) +``` + + + + + + +## Loxone Miniserver + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: loxone + 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) + meterblock: # Name from Loxone Config + socblock: # Name from Loxone Config, only for battery (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: loxone + usage: pv + 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) + meterblock: # Name from Loxone Config + socblock: # Name from Loxone Config, only for battery (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: loxone + usage: battery + 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) + meterblock: # Name from Loxone Config + socblock: # Name from Loxone Config, only for battery (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: loxone + usage: charge + 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) + meterblock: # Name from Loxone Config + socblock: # Name from Loxone Config, only for battery (optional) +``` + + + + + + +## M-TEC + +### Energy Butler GEN2 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: mtec-eb-gen2 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: mtec-eb-gen2 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: mtec-eb-gen2 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Energy Butler GEN3 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: mtec-eb-gen3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: mtec-eb-gen3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: mtec-eb-gen3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 247 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 247 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## my-PV WiFi Meter + + + +```yaml +meters: + - name: my_grid + type: template + template: mypv-wifi-meter + usage: grid + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## OpenEMS + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: openems + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: openems + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: openems + usage: battery + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +## Orno OR-WE-516, OR-WE-517 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: orno + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: orno + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## P1Monitor P1 Monitor + + + +```yaml +meters: + - name: my_grid + type: template + template: p1monitor + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + +## Powerdog + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: powerdog + usage: grid + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: powerdog + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Powerfox Poweropti + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: powerfox-poweropti + usage: grid + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: powerfox-poweropti + usage: pv + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + + + + + + +## Qcells Q.HOME ESS HYB-G3 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solax + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solax + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solax + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## RCT Power + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: rct-power + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: rct-power + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: rct-power + usage: battery + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +## Saia-Burgess Controls ALE3, AWD3 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sbc-axx3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: sbc-axx3 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## SAJ H2 Series Hybrid Solar Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: saj-h2 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 115200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: saj-h2 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 115200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: saj-h2 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 115200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## SAX Homespeicher + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sax + usage: grid + + # Modbus TCP + modbus: tcpip + id: 64 + host: 192.0.2.2 # Hostname + port: 3600 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sax + usage: battery + + # Modbus TCP + modbus: tcpip + id: 64 + host: 192.0.2.2 # Hostname + port: 3600 # Port +``` + + + + + + +## Schneider Electric iEM3xxx Modbus + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: schneider-iem3000 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: schneider-iem3000 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## SENEC .Home + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: senec-home + usage: grid + host: 192.0.2.2 # IP address or hostname + schema: https # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: senec-home + usage: pv + host: 192.0.2.2 # IP address or hostname + schema: https # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: senec-home + usage: battery + host: 192.0.2.2 # IP address or hostname + schema: https # optional +``` + + + + + + +## Senergy SE 4/5/6KTL-S1/G2 Inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: senergy + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Shelly + +### 3EM + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: shelly-3em + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-3em + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-3em + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Pro 3 EM + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: shelly-pro-3em + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-pro-3em + usage: pv + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-pro-3em + usage: charge + 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) +``` + + + + + + +## Siemens + +### 7KT1665 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: siemens-7kt1665 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: siemens-7kt1665 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### PAC 2200 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: siemens-pac2200 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: siemens-pac2200 + usage: charge + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## SMA + +### Data Manager + + + +In the web interface of the SMA Data Manager you need to activate "Modbus Server activated" in the section "External communication". + + + + +```yaml +meters: + - name: my_grid + type: template + template: sma-data-manager + usage: grid + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-data-manager + usage: pv + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sma-data-manager + usage: battery + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Energy Meter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sma-energy-meter + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-energy-meter + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-inverter + usage: pv + host: 192.0.2.2 # IP address or hostname + password: # Password for user group Standard (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sma-inverter + usage: battery + host: 192.0.2.2 # IP address or hostname + password: # Password for user group Standard (optional) +``` + + + + + + +## Smartfox Smartfox Reg/Reg extended/Pro/Pro 2/Pro Light/Pro Light 2/Light + + + +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'). + + + + +```yaml +meters: + - name: my_grid + type: template + template: smartfox + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: smartfox + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +## SMA + +### Smart Energy Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-hybrid + usage: pv + + # Modbus TCP + modbus: tcpip + id: 3 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sma-hybrid + usage: battery + + # Modbus TCP + modbus: tcpip + id: 3 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Sunny Home Manager 2.0 + + + +```yaml +meters: + - name: my_grid + type: template + template: sma-home-manager + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + +### WebBox + + + +```yaml +meters: + - name: my_pv + type: template + template: sma-webbox + usage: pv + + # Modbus TCP + modbus: tcpip + id: 2 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## SofarSolar + +### HYD 3…6K-EP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar-g3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar-g3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar-g3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + + + +### HYD 5…20K-3PH + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar-g3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar-g3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar-g3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + + + +### Inverter / Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SOFAR 5…24KTL-G3 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar-g3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar-g3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar-g3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + + + +### SOFAR 80…136KTL + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar-g3 + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar-g3 + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar-g3 + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + delay: 1s # optional +``` + + + + + + +## Solaranzeige Solaranzeige + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solaranzeige + usage: grid + host: 192.0.2.2 # IP address or hostname of the MQTT broker + port: 1883 # MQTT broker port (optional) + topic: solaranzeige/box1 # Topic (omit leading /) (optional) + timeout: 30s # Don't accept values older than this value (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solaranzeige + usage: pv + host: 192.0.2.2 # IP address or hostname of the MQTT broker + port: 1883 # MQTT broker port (optional) + topic: solaranzeige/box1 # Topic (omit leading /) (optional) + timeout: 30s # Don't accept values older than this value (optional) +``` + + + + + + +## SolarEdge + +### Hybrid Inverter + + + +Only one system may access the inverter! + + + + +```yaml +meters: + - name: my_grid + type: template + template: solaredge-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solaredge-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solaredge-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + + + +### Inverter + + + +Only one system may access the inverter! + + + + +```yaml +meters: + - name: my_grid + type: template + template: solaredge-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solaredge-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 1502 # Port + timeout: 10s # optional +``` + + + + + + +## Solarlog + + + +We recommend to use this device for grid power values only, if no other device is available providing this data. +If you have a home battery installed, please do not use this device at all for grid power values. + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarlog + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarlog + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + + +## SolarMax + +### MAX.STORAGE / MAX.STORAGE Ultimate + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarmax-maxstorage + usage: grid + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarmax-maxstorage + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solarmax-maxstorage + usage: battery + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SP Series Inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: senergy + usage: pv + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Solarwatt + +### EnergyManager, EnergyManager Pro + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarwatt + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarwatt + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solarwatt + usage: battery + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### MyReserve + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarwatt + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarwatt + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solarwatt + usage: battery + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### MyReserve Matrix (LAN oder PowerGateway) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solarwatt-myreserve-matrix + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8080 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solarwatt-myreserve-matrix + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 8080 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solarwatt-myreserve-matrix + usage: battery + host: 192.0.2.2 # IP address or hostname + port: 8080 # Port (optional) +``` + + + + + + +## Solax + +### Hybrid X1/X3 G3/G4 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: solax + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solax + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solax + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Hybrid-Inverter (Cloud) + + + +The Solax hybrid 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! Only use as fallback if no local access is available. + + + + +```yaml +meters: + - name: my_grid + type: template + template: solax-hybrid-cloud + usage: grid + tokenid: # Go to https://www.solaxcloud.com/#/api and take the value of "ObtaintokenID". + serial: # Go to https://www.solaxcloud.com/#/inverter and take the value of registration number. +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: solax-hybrid-cloud + usage: pv + tokenid: # Go to https://www.solaxcloud.com/#/api and take the value of "ObtaintokenID". + serial: # Go to https://www.solaxcloud.com/#/inverter and take the value of registration number. +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: solax-hybrid-cloud + usage: battery + tokenid: # Go to https://www.solaxcloud.com/#/api and take the value of "ObtaintokenID". + serial: # Go to https://www.solaxcloud.com/#/inverter and take the value of registration number. +``` + + + + + + +### Inverter (Cloud) + + + +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! Only use as fallback if no local access is available. + +```yaml +meters: + - name: my_pv + type: template + template: solax-inverter-cloud + usage: pv + tokenid: # Use the ObtaintokenID from https://www.solaxcloud.com/#/api. + serial: # Use the registration number from https://www.solaxcloud.com/#/inverter. +``` + + + +## Sonnen + +### comfort, eco 5, eco 6, oem 6.5 + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sonnenbatterie-eco56 + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 7979 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sonnenbatterie-eco56 + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 7979 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sonnenbatterie-eco56 + usage: battery + host: 192.0.2.2 # IP address or hostname + port: 7979 # Port (optional) +``` + + + + + + +### sonnenBatterie + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sonnenbatterie + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8080 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sonnenbatterie + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 8080 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sonnenbatterie + usage: battery + host: 192.0.2.2 # IP address or hostname + port: 8080 # Port (optional) +``` + + + + + + +## Steca coolcept fleX + + + +```yaml +meters: + - name: my_pv + type: template + template: kostal-piko-mp-plus + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +## Sungrow + +### SG Series Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sungrow-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sungrow-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### SH Series Hybrid Inverter + + + +The connection can be serial (RS485) or via the native (rear) LAN socket on the inverter. Connections via the WiNet-S dongle (WiFi or LAN) do NOT work correctly. + + + + +```yaml +meters: + - name: my_grid + type: template + template: sungrow-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sungrow-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sungrow-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Sunsynk + +### 3p hybrid inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: deye-hybrid-3p + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-hybrid-3p + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: deye-hybrid-3p + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Micro inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-mi + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +### Storage (hybrid) inverter + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-storage + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: deye-storage + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_grid + type: template + template: deye-storage + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### String inverter + + + +```yaml +meters: + - name: my_pv + type: template + template: deye-string + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + +## Tesla Powerwall + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tesla-powerwall + usage: grid + host: 192.0.2.2 # IP address or hostname + password: # Password of the user "customer" +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tesla-powerwall + usage: pv + host: 192.0.2.2 # IP address or hostname + password: # Password of the user "customer" +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tesla-powerwall + usage: battery + host: 192.0.2.2 # IP address or hostname + password: # Password of the user "customer" +``` + + + + + + +## Tibber Pulse + + + +```yaml +meters: + - name: my_grid + type: template + template: tibber-pulse + usage: grid + token: 5K4MVS-OjfWhK_4yrjOlFe1F6kJXPVf7eQYggo8ebAE + homeid: 96a14971-525a-4420-aae9-e5aedaa129ff # optional +``` + + + +## TQ + +### Energy Manager EM2xx/EM3xx + + + +```yaml +meters: + - name: my_grid + type: template + template: tq-em + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 80 # Port (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + +### Energy Manager EM420 + + + +```yaml +meters: + - name: my_grid + type: template + template: tq-em420 + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 80 # Port (optional) + device: local # JSON-API -> Data Endpoint (optional) + token: ey... # Access token for EM420 (Create in Profile -> Access tokens) +``` + + + +## VARTA pulse/ pulse neo/ element (PV only available with PV sensor) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: varta + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: varta + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: varta + usage: battery + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + + +## Victron Energy + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: victron-energy + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: victron-energy + usage: pv + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: victron-energy + usage: battery + host: 192.0.2.2 # IP address or hostname + port: 502 # Port (optional) +``` + + + + + + +## Youless Energy Monitor + + + +An externally connected S0 generation meter is required to record the solar production. + + + + +```yaml +meters: + - name: my_grid + type: template + template: youless + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: youless + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +## ZCS Azzurro Inverter / Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sofarsolar + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sofarsolar + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sofarsolar + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +## Zuidwijk SlimmeLezer(+) + + + +```yaml +meters: + - name: my_grid + type: template + template: slimmelezer + usage: grid + host: 192.0.2.2 # IP address or hostname +``` + + + +## Generic support + +### Custom + +```yaml +meters: + - name: my_meter + type: custom + power: # power (W) + source: # plugin type + # ... + energy: # optional energy (kWh) + source: # plugin type + # ... + soc: # optional battery soc (%) + source: # plugin type + # ... + currents: # optional currents (A) + - source: # L1 plugin type + # ... + - source: # L2 plugin type + # ... + - source: # L3 plugin type + # ... +``` + +### Hybrid Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-hybrid + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-hybrid + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-hybrid + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Inverter + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: sunspec-inverter + usage: grid + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: sunspec-inverter + usage: pv + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: sunspec-inverter + usage: battery + + # RS485 via adapter (Modbus RTU) + modbus: rs485serial + id: 1 + device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse + baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200 + comset: "8N1" # Kommunikationsparameter für den Adapter + + # RS485 via TCP/IP (Modbus RTU) + modbus: rs485tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port + + # Modbus TCP + modbus: tcpip + id: 1 + host: 192.0.2.2 # Hostname + port: 502 # Port +``` + + + + + + +### Volkszähler + +#### HTTP API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-http + usage: grid + url: # Example: http://zaehler.network.local:8080/api/data (optional) + uuid: +``` + + + +#### HTTP API, Import & Export + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-importexport + usage: grid + url: # The URL is for example: http://zaehler.network.local:8080/api/data (optional) + importuuid: + exportuuid: +``` + + + +#### WebSocket API + + + +```yaml +meters: + - name: my_grid + type: template + template: volkszaehler-ws + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8082 # Port (optional) + uuid: +``` + + + +### vzlogger + + + +```yaml +meters: + - name: my_grid + type: template + template: vzlogger + usage: grid + host: 192.0.2.2 # IP address or hostname + port: 8081 # Port (optional) + uuid: +``` + + + +## Switchable sockets + +### AVM FritzDECT + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: fritzdect + usage: pv + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: fritzdect + usage: charge + uri: https://fritz.box # HTTP(S) address (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + ain: 307788992233 # The AIN is printed on the type label on the back of the device. Embed it in double quotes in case of leading zeroes. +``` + + + + + + +### Homematic IP + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: homematic + usage: grid + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: homematic + usage: pv + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: homematic + usage: charge + host: 192.0.2.2 # IP address or hostname + device: '0001EE89AAD848' # Homematic device id like shown in the CCU web user interface. + 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) +``` + + + + + + +### myStrom Switch + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: mystrom + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: mystrom + usage: charge + host: 192.0.2.2 # IP address or hostname +``` + + + + + + +### Shelly 1PM, EM, Plug S + + + + + + +```yaml +meters: + - name: my_pv + type: template + template: shelly-1pm + usage: pv + 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 +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: shelly-1pm + usage: charge + 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 +``` + + + + + + +### Tasmota (1 Phase Meter) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) + channel: 1 # Meterchannel number (1-8) +``` + + + + + + +### Tasmota (3 Phase Meter - meter channels 1,2+3 must be used) + + + + + + +```yaml +meters: + - name: my_grid + type: template + template: tasmota-3p + usage: grid + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_pv + type: template + template: tasmota-3p + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_battery + type: template + template: tasmota-3p + usage: battery + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + +```yaml +meters: + - name: my_charger + type: template + template: tasmota-3p + usage: charge + host: 192.0.2.2 # IP address or hostname + user: # admin is default (optional) + password: # Password of the user account (use single quotes in case of leading zeros) (optional) +``` + + + + + + +### TP-Link + +#### H-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tplink + usage: pv + host: 192.0.2.2 # IP address or hostname +``` + + + +#### Tapo P-Series Smart Plug + + + +```yaml +meters: + - name: my_pv + type: template + template: tapo + usage: pv + host: 192.0.2.2 # IP address or hostname + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) +``` + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx index f3e7f122d0..5a71abd035 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/vehicles.mdx @@ -816,3 +816,5856 @@ vehicles: capacity: 4 # Battery capacity in kWh (optional) ``` + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + + + + + +## Aiways + + + +```yaml +vehicles: + - name: my_car + type: template + template: aiways + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Audi + + + +```yaml +vehicles: + - name: my_car + type: template + template: audi + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: WAUZZZ... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## BMW + + + +```yaml +vehicles: + - name: my_car + type: template + template: bmw + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: WBMW... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Citroën + + + +```yaml +vehicles: + - name: my_car + type: template + template: citroen + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Dacia + + + +```yaml +vehicles: + - name: my_car + type: template + template: dacia + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## DS + + + +```yaml +vehicles: + - name: my_car + type: template + template: ds + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Fiat + + + +```yaml +vehicles: + - name: my_car + type: template + template: fiat + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: ZFAE... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) + pin: # optional +``` + + + +## Ford + + + +```yaml +vehicles: + - name: my_car + type: template + template: ford + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: WF0FXX... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Hyundai Bluelink + + + +```yaml +vehicles: + - name: my_car + type: template + template: hyundai + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) + language: en # 'en' for English and 'de' for German (optional) +``` + + + +## Jaguar + + + +```yaml +vehicles: + - name: my_car + type: template + template: jaguar-landrover + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Jeep + + + +```yaml +vehicles: + - name: my_car + type: template + template: fiat + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: ZFAE... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) + pin: # optional +``` + + + +## Kia Bluelink + + + +```yaml +vehicles: + - name: my_car + type: template + template: kia + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) + language: en # 'en' for English and 'de' for German (optional) +``` + + + +## Land Rover + + + +```yaml +vehicles: + - name: my_car + type: template + template: jaguar-landrover + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Mini + + + +```yaml +vehicles: + - name: my_car + type: template + template: mini + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: WBMW... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Nissan + +### Leaf + + + +```yaml +vehicles: + - name: my_car + type: template + template: nissan + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Leaf (pre 2019) + + + +```yaml +vehicles: + - name: my_car + type: template + template: carwings + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Opel + + + +```yaml +vehicles: + - name: my_car + type: template + template: opel + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: WP0... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Peugeot + + + +```yaml +vehicles: + - name: my_car + type: template + template: peugeot + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Porsche + + + +```yaml +vehicles: + - name: my_car + type: template + template: porsche + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Renault + + + +```yaml +vehicles: + - name: my_car + type: template + template: renault + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: WREN... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Seat + +### CupraConnect Gen3 (Ateca, Leon, Formentor) + + + +```yaml +vehicles: + - name: my_car + type: template + template: seat + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### CupraConnect Gen4 (Born) + + + +```yaml +vehicles: + - name: my_car + type: template + template: cupra + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Skoda + +### Enyaq + + + +```yaml +vehicles: + - name: my_car + type: template + template: enyaq + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) + timeout: 10s # optional +``` + + + +### Others + + + +```yaml +vehicles: + - name: my_car + type: template + template: skoda + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Smart EQ + + + +```yaml +vehicles: + - name: my_car + type: template + template: smart + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Tesla + + + +You need to generate an `access` and a `refresh` token for communicating with the Tesla API. + +The following apps allow to create these tokens: +- [Auth app for Tesla (iOS)](https://apps.apple.com/us/app/auth-app-for-tesla/id1552058613#?platform=iphone) +- [Tesla Tokens (Android)](https://play.google.com/store/apps/details?id=net.leveugle.teslatokens) +- [Tesla Auth (macOS, Linux)](https://github.com/adriankumpf/tesla_auth) + +```yaml +vehicles: + - name: my_car + type: template + template: tesla + title: # Will be displayed in the user interface (optional) + accessToken: # See https://docs.evcc.io/en/docs/devices/vehicles#tesla + refreshToken: # See https://docs.evcc.io/en/docs/devices/vehicles#tesla + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Volkswagen + +### We Connect (legacy) + + + +older Models like e-Up, e-Golf, etc. + +```yaml +vehicles: + - name: my_car + type: template + template: vw + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: WVWZZZ... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) + timeout: 10s # optional +``` + + + +### We Connect ID + + + +ID.3, ID.4 (also works for e-Golf, e-Up) + +```yaml +vehicles: + - name: my_car + type: template + template: id + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: WVWZZZ... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) + timeout: 10s # optional +``` + + + +## Volvo + +### + + + +```yaml +vehicles: + - name: my_car + type: template + template: volvo-connected + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) + vccapikey: # Volvo developer portal VCC API Key, see https://github.com/evcc-io/evcc/discussions/3677#discussioncomment-4106300 +``` + + + +### legacy + + + +```yaml +vehicles: + - name: my_car + type: template + template: volvo + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +## Generic support + +### Custom + +```yaml +vehicles: + - name: my_car + type: custom + title: My Car # display name for UI + capacity: 50 # byttery capacity (kWh) + soc: # battery soc (%) + source: # plugin type + # ... + status: # optional charge status (A..F) + source: # plugin type + # ... + range: # optional electric range (km) + source: # plugin type + # ... +``` + +### evNotify + + + +```yaml +vehicles: + - name: my_car + type: template + template: evnotify + title: # Will be displayed in the user interface (optional) + akey: + token: + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### ISO15118 + + + +Only supported if the vehicle can provided the state of charge (Soc) to the connected wallbox. + +```yaml +vehicles: + - name: my_car + type: template + template: iso15118 + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### mazda2mqtt + + + +Required MQTT broker configuration and a mazda2mqtt installation https://github.com/C64Axel/mazda2mqtt. + +```yaml +vehicles: + - name: my_car + type: template + template: mazda2mqtt + title: # Will be displayed in the user interface (optional) + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) + timeout: 720h # optional +``` + + + +### mg2mqtt + + + +Required MQTT broker configuration and a SAIC/MQTT Gateway (https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway or https://github.com/SAIC-iSmart-API/saic-java-client) + +```yaml +vehicles: + - name: my_car + type: template + template: mg2mqtt + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + vin: W... # Required if you own multiple vehicles of the same brand + capacity: 50 # Battery capacity in kWh (optional) + timeout: 1h # optional +``` + + + +### Offline + + + +```yaml +vehicles: + - name: my_car + type: template + template: offline + title: # Will be displayed in the user interface (optional) + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Open Vehicle Monitoring System + + + +Support for all vehicles via ODB2 adapter in the vehicle. More info at [Open Vehicle Monitoring System](http://api.openvehicles.com/). + +```yaml +vehicles: + - name: my_car + type: template + template: ovms + title: # Will be displayed in the user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + vehicleid: + capacity: 12 # Battery capacity in kWh (optional) +``` + + + +### PSA Car Controller + + + +Remote Control of PSA car https://github.com/flobz/psa_car_controller + +```yaml +vehicles: + - name: my_car + type: template + template: flobz + title: # Will be displayed in the user interface (optional) + url: http://192.0.2.2 + vin: W... # Required + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### TeslaMate + + + +Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required. + +```yaml +vehicles: + - name: my_car + type: template + template: teslamate + title: # Will be displayed in the user interface (optional) + id: 1 # optional + capacity: 50 # Battery capacity in kWh (optional) +``` + + + +### Tronity + + + +```yaml +vehicles: + - name: my_car + type: template + template: tronity + title: # Will be displayed in the user interface (optional) + clientid: # Setup at https://app.tronity.tech + clientsecret: # Setup at https://app.tronity.tech + vin: W... # Required if you own multiple vehicles of the same brand (optional) + capacity: 10 # Battery capacity in kWh (optional) +``` + + + + + +## Scooter + +### NIU E-Scooter + + + +```yaml +vehicles: + - name: my_car + type: template + template: niu-e-scooter + title: # Will be displayed in the user interface (optional) + icon: scooter # Icon as shown in user interface (optional) + user: # User account (e.g. email address, user id, etc.) + password: # Password of the user account (use single quotes in case of leading zeros) + serial: + capacity: 4 # Battery capacity in kWh (optional) +``` + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/guides/charging.mdx b/i18n/en/docusaurus-plugin-content-docs/current/guides/charging.mdx index 755d694572..8db50b50a2 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/guides/charging.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/guides/charging.mdx @@ -32,7 +32,9 @@ The newer standard [ISO 15118](https://de.wikipedia.org/wiki/ISO_15118) is suppo When using the Charge Mode **Solar**, a Solar Excess greater than the minimum relevant value must be available before charging begins. If this Excess is not available, then after a configurable length of time, charging is stopped. -Solar Excess is calculated by monitoring the feed-in power delivered back to the Grid. Excess calculation (and, indeed, the Solar Charge Mode) therefore does not function if this is not available. +Solar Excess is calculated by monitoring the feed-in power delivered back to the Grid. Excess calculation therefore does not function if this is not available, but you [can still use Solar mode if you have a PV meter](https://docs.evcc.io/en/docs/guides/meters#i-have-a-solar-installation-but-i-dont-have-a-readable-grid-connection-meter---can-i-still-use-evcc) and configure an assumed, constant consumption for the rest of your house. + +Have a look at the [inner-workings section](../inner-workings/) for an in-depth explanation of how `Solar` and `Min+Solar` modes work and the parameters defining their behavior. ### I have a house battery, and it's being discharged to charge my vehicle. Help! diff --git a/i18n/en/docusaurus-plugin-content-docs/current/guides/meters.mdx b/i18n/en/docusaurus-plugin-content-docs/current/guides/meters.mdx index 0adb5e59ea..2089e71cd8 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/guides/meters.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/guides/meters.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 --- import SponsorshipRequired from "/docs/_sponsorship_required.mdx"; diff --git a/i18n/en/docusaurus-plugin-content-docs/current/guides/setup.mdx b/i18n/en/docusaurus-plugin-content-docs/current/guides/setup.mdx index 8998d240e5..bdfa691ddc 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/guides/setup.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/guides/setup.mdx @@ -18,6 +18,8 @@ If you start making changes, remember the golden rule: Since parameters sometimes influence each other, **it is STRONGLY encouraged to only make one change at a time**, and test the effects of each change before making further modifications. ::: +Have a look at the [inner-workings section](../inner-workings/) for an in-depth explanation of how `Solar` and `Min+Solar` modes work and the parameters defining their behavior. + ### Syntax Error in evcc.yaml Yaml is very sensitive to syntax - and errors don't always catch the eye straight away. Linters such as (https://onlineyamltools.com/validate-yaml) can be super useful, and are worth checking to find simple mistakes. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/guides/wallbox.mdx b/i18n/en/docusaurus-plugin-content-docs/current/guides/wallbox.mdx index 1b6eb91167..d192d08761 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/guides/wallbox.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/guides/wallbox.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 --- import SponsorshipRequired from "/docs/_sponsorship_required.mdx"; diff --git a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/index.md b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/index.md index 2e7d82db30..84c895577a 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/index.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/index.md @@ -66,17 +66,11 @@ graph TD; ### How does evcc work? (A look into the innards) -In order for the system to function, an electricity meter is important. This -allows us to calculate at any point in time the surplus power. Measuring the -generated power is interesting, but has no effect on the function, with -[this exception](../../guides/meters#i-have-a-solar-installation-but-i-dont-have-a-readable-grid-connection-meter---can-i-still-use-evcc) +The magic of evcc happens in the Solar mode, where the vehicle is charged with surplus from your photovoltaic system. For calulating the power available for charging, an electric meter measuring the power on your grid connection point (grid meter) is important. Power generated by the photovoltaic system can also be measured and displayed, but has no effect on the function, [except if no grid meter is available](../../guides/meters#i-have-a-solar-installation-but-i-dont-have-a-readable-grid-connection-meter---can-i-still-use-evcc). -The surplus power is compared with the minimum power required to charge. If -this is sufficient, the charging process is started. +Evcc also considers power consumption by batteries and other devices, which may be diverted to vehicle charging depending on your priorities. The system constantly monitors the available charging power and starts the charging process if it exceeds the minimum power required for the vehicle (minimum charging power). If the available charging power changes, evcc adapts the charging power or stops charging accordingly. -The minimum power required to charge is calculated from the values `minCurrent` -and `phases`, defined per `loadpoint` (a group of colocated chargers) -See [`loadpoints`](./loadpoints) for more +The minimum charging power is calculated from the values `minCurrent` and `phases`, defined per `loadpoint` (a group of colocated chargers) See [`loadpoints`](./loadpoints) for more information. For example: `phases: 1` und `minCurrent: 8` @@ -85,22 +79,19 @@ For example: `phases: 1` und `minCurrent: 8` #### Manipulation Options -Normally, the surplus power corresponds to the available charging power. -However, the available charging power can be individually adjusted using -several parameters. These are: +The calculation of the `available charging power` as well as thresholds for starting or stopping can be individually adjusted using several parameters. These are: - Site: `residualpower` - Site: `prioritySoc` - Site: `bufferSoc` +- Site: `bufferStartSoc` +- Site: `maxGridSupplyWhileBatteryCharging` - Site: `aux` - Loadpoint: `enable: threshold` - Loadpoint: `disable: threshold` +- Loadpoint: `priority` -Please refer to the description of each respective parameter for the available -settings. - -- [Site Configuration Parameters](./site) -- [Loadpoint Configuration Parameters](./loadpoints) +Have a look at the [inner-workings section](../inner-workings/) for an in-depth explanation of how `Solar` and `Min+Solar` modes work and the parameters defining their behavior. ### Site diff --git a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/loadpoints.md b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/loadpoints.md index ca062d9d08..42efe963ed 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/loadpoints.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/loadpoints.md @@ -205,7 +205,7 @@ estimate: false # No interpolation ### `enable` -Defines the behaviour of starting charging in PV mode. Additionally, it defines the behaviour during automatic phase switching from 1p to 3p. +Defines the behaviour of starting charging in PV mode. Additionally, the delay defined for `enable` is also used for automatic phase switching from 1-phase to 3-phase. **For example**: @@ -217,11 +217,11 @@ enable: #### `threshold` -Defines the power threshold at the grid connection point in watts (W). +Defines the power threshold for starting charging in watts (W). Charging is started once the [`available charging power`](/docs/inner-workings/solar-mode#calculation-of-available-charging-power) exceeds this threshold. `Available charging power` is calculated based on power readings from the grid connection point, aux devices and battery power, depending on your battery settings. The default threshold is the [`minimum charging power`](/docs/inner-workings/minmaxphases). Setting a lower value will start charging even if not enough surplus is available and draw the additionally needed power from grid or if available a battery. **Possible values**: A positive value for grid consumption, a negative value for grid export. When set to `0`, export must reach the minimum charging power. -**Default value:** `0` +**Default value:** `0` (the system will use minimum charging power) **For example**: @@ -232,14 +232,12 @@ threshold: 0 :::info If a residual power offset for the desired operating point of the surplus regulation is defined for the evcc site using the `residualPower` parameter, this value must be considered when setting the `threshold` value. -For example, if `residualPower` is set to 200 (the evcc control sets the desired operating point to 200W feed-in), then setting an `enable` `threshold` value of 100 doesn't mean that charging will start at 100W grid consumption. Instead, the remaining feed-in power will be reduced by 100W, starting the charging at 100W feed-in. - -To start charging at 100W grid consumption in this case, the `threshold` value should be set to 300. +The `residualPower` is included in the [calculation of `available charging power`](/docs/inner-workings/solar-mode#calculation-of-available-charging-power) and a positive value for `residualPower` will reduce the available charging power. So for example, if `residualPower` is set to 200 (the evcc control sets the desired operating point to 200W feed-in) and 2,000W surplus is available, the `available charging power` is only 1,800kW. The remaining 200W will remain available for grid or battery feed-in. In other words, when `residualPower` is 200W and the `enable:threshold` is set to -1,800W, then charging will be started when 2,000W surplus is available. ::: #### `delay` -Defines how long the `threshold` must be met. +Defines how long the `available charging power` must exceed the `threshold` before charging is started. Also defines how long sufficient power for 3-phase charging must be available, before the system automatically switches from 1-phase to 3-phase. **Default value:** `1m` @@ -249,11 +247,13 @@ Defines how long the `threshold` must be met. delay: 1m ``` +See also [this section](/docs/inner-workings/timing-interval) for more information how the delay is applied. + --- ### `disable` -Defines the behaviour of stopping charging in PV mode. Additionally, it defines the behaviour during automatic phase switching from 3p to 1p. +Defines the behaviour of stopping charging in PV mode. Additionally, the delay defined for `disable` is also used for automatic phase switching from 3-phase to 1-phase. **For example**: @@ -265,11 +265,11 @@ disable: #### `threshold` -Defines the power threshold at the grid connection point in watts (W). +Defines the power threshold for stopping charging in watts (W). Charging is stopped once the [`available charging power`](/docs/inner-workings/solar-mode#calculation-of-available-charging-power) is less than this threshold. `Available charging power` is calculated based on power readings from the grid connection point, aux devices and battery power, depending on your battery settings. The default threshold is the [`minimum charging power`](/docs/inner-workings/minmaxphases). Setting a lower value will continue charging even if not enough surplus is available and draw the additionally needed power from grid or if available a battery. **Possible values**: A positive value for grid consumption, a negative value for grid export. -**Default value:** `0` +**Default value:** `0` (the system will use minimum charging power) **For example**: @@ -283,7 +283,7 @@ If a residual power offset for the desired operating point of the surplus regula #### `delay` -Defines how long the `threshold` must be met. +Defines how long the `available charging power` must fall under `threshold` before charging is stopped. Also defines how long power must fall under the `minimum charging power` for 3-phase charging, before the system automatically switches from 3-phase to 1-phase. **Default value:** `3m` @@ -293,6 +293,8 @@ Defines how long the `threshold` must be met. delay: 10m ``` +See also [this section](/docs/inner-workings/timing-interval) for more information how the delay is applied. + --- ### `guardduration` @@ -309,6 +311,8 @@ At least 15 minutes interval between turning on and off the charging process. guardduration: 15m ``` +See also [this section](/docs/inner-workings/timing-interval) for more information how the `guardduration` is applied. + --- ### `phases` diff --git a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/site.mdx b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/site.mdx index 474666980a..717fb0e5a6 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/site.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/reference/configuration/site.mdx @@ -178,6 +178,8 @@ It is disabled (equivalent to 0%) if no value is provided. prioritySoc: 50 # House battery has priority for charging up to 50% SoC ``` +Have a look at [this inner-workings section](/docs/inner-workings/solar-mode#calculation-of-available-charging-power) to learn how `prioritySoc` affects the calculation of `available charging power`. + ### `bufferSoc` :::note deprecated in yaml @@ -197,6 +199,7 @@ It is disabled (equivalent to >100%) if no value is provided. ```yaml bufferSoc: 80 # House battery is used as a buffer above 80% SoC ``` +Have a look at [this inner-workings section](/docs/inner-workings/solar-mode#calculation-of-available-charging-power) to learn how `bufferSoc` affects the calculation of `available charging power`. ### `bufferStartSoc` @@ -218,6 +221,8 @@ It is disabled (equivalent to 0%) if no value is provided. bufferStartSoc: 90 # Charging process starts when the house battery reaches 90% SoC ``` +Have a look at [this inner-workings section](/docs/inner-workings/solar-mode#calculation-of-available-charging-power) to learn how `bufferStartSoc` affects the rules to start charging. + ### `residualPower` Sets the target operating point of the surplus regulation at the grid connection (grid meter). The default value is 0 W. @@ -257,6 +262,8 @@ Minimum charging power: 1 phase _ 6A _ 230V = 1380 W, 50% of it: 690 W residualPower: -690 ``` +Have a look at [this inner-workings section](/docs/inner-workings/solar-mode#calculation-of-available-charging-power) to learn how `residualPower` affects the calculation of `available charging power`. + ### `smartCostLimit` (formerly `cheap`) This parameter can set a price or gCO2-equivalent limit. In PV mode, charging starts when this limit is undercut. @@ -289,3 +296,5 @@ A recommended value is at least 50 Watts. Depending on the responsiveness of the ```yaml maxGridSupplyWhileBatteryCharging: 50 ``` + +Have a look at [this inner-workings section](/docs/inner-workings/solar-mode#calculation-of-available-charging-power) to learn how `maxGridSupplyWhileBatteryCharging` affects the calculation of `available charging power`. diff --git a/package-lock.json b/package-lock.json index 42c464ef78..10c720d505 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,6 +13,7 @@ "@docusaurus/theme-search-algolia": "^2.0.0-beta.21", "@svgr/webpack": "^6.1.2", "clsx": "^1.1.1", + "docusaurus-plugin-drawio": "^0.4.0", "file-loader": "^6.2.0", "js-yaml": "^4.1.0", "js-yaml-loader": "^1.2.2", @@ -6207,6 +6208,14 @@ "node": ">=6" } }, + "node_modules/docusaurus-plugin-drawio": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-drawio/-/docusaurus-plugin-drawio-0.4.0.tgz", + "integrity": "sha512-7y3cgtwdQ3evWY/phq/iGJectDlRzpRrKzbcBeT79o+w+OStU0noTcTOmVd/oTiylu2OJXhQWF9z+4CoxTgAtA==", + "dependencies": { + "raw-loader": "^4.0.2" + } + }, "node_modules/dom-converter": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", diff --git a/package.json b/package.json index 8a5a846c49..ba5d24b8c2 100644 --- a/package.json +++ b/package.json @@ -21,6 +21,7 @@ "@docusaurus/theme-search-algolia": "^2.0.0-beta.21", "@svgr/webpack": "^6.1.2", "clsx": "^1.1.1", + "docusaurus-plugin-drawio": "^0.4.0", "file-loader": "^6.2.0", "js-yaml": "^4.1.0", "js-yaml-loader": "^1.2.2",