Victron VRM API
Victron VRM API Integration für Home Assistant
Ich bin stolz euch meine erste Integration vorstellen zu können. Es hat doch einiges an Arbeit gekostet, aber das Ergebnis schaut wirklich schon gut aus und ich mache das schließlich auch alles nur in meiner Freizeit.
Diese Integration nutzt das Victron VRM-Portal, um Daten von der API abzurufen. Alles was ihr dafür braucht, sind ein paar Zahlen aus eurem VRM Portal. Aktuell könnt ihr Daten von Batterie, MultiPlus, PV Inverter, Tank und SolarCharger auslesen. Außerdem erhaltet ihr die Gesamtstatistiken für Tag, Woche, Monat und Jahr von Solar, Netz, und Total.
Ich arbeite daran, weitere Daten von der Victron-API abzurufen. Leider ist der Intervall der API auf 5min begrenzt, obwohl die API eigentlich laut Doku schnellere Abfragen zulässt. (sollte inzwischen bei Verbraucher ca. bei 1min liegen)
Wenn euch die Integration gefällt, würde ich mich über eine Sternebewertung im github
freuen. ![]()
VRM API unterstützte Geräte und Sensoren
Übersicht Geräte
| Device Type | Number of Sensors |
|---|---|
| Battery | 11 |
| MultiPlus | 11 |
| PV Inverter | 16 |
| Tank | 6 |
| Solar Charger | 7 |
| Overall Stats | 16 |
| Total | 67 |
Sensor Details
| Device Type | Sensor Name | VRM ID / Key | Unit | Description |
|---|---|---|---|---|
| Battery | State of charge | 51 |
% | State of Charge (SOC) |
| Battery | Voltage | 47 |
V | Battery Voltage |
| Battery | Current | 49 |
A | Battery Current |
| Battery | Consumed Amphours | 50 |
Ah | Consumed Amphours |
| Battery | Time to go | 52 |
h | Time to go until empty |
| Battery | Battery Temperature | 115 |
°C | Battery Temperature |
| Battery | Minimum Cell Voltage | 173 |
V | Minimum Cell Voltage (BMS) |
| Battery | Maximum Cell Voltage | 174 |
V | Maximum Cell Voltage (BMS) |
| Battery | Battery Power | (Calculated) | W | Current Power (V*A) |
| Battery | Battery to Consumers (Today) | Bc |
kWh | Energy to Load (Today) |
| Battery | Battery to Grid (Today) | Bg |
kWh | Energy to Grid (Today) |
| — | — | — | — | — |
| MultiPlus | AC Input Voltage L1 | 8 |
V | AC Input Voltage Phase 1 |
| MultiPlus | AC Input Power L1 | 17 |
W | AC Input Power Phase 1 |
| MultiPlus | AC Output Voltage L1 | 20 |
V | AC Output Voltage Phase 1 |
| MultiPlus | AC Output Power L1 | 29 |
W | AC Output Power Phase 1 |
| MultiPlus | DC Bus Voltage | 32 |
V | DC Bus Voltage |
| MultiPlus | DC Bus Current | 33 |
A | DC Bus Current |
| MultiPlus | VE.Bus State | 40 |
- | Operating State (e.g., Inverting) |
| MultiPlus | MultiPlus Temperature | 521 |
°C | Device Temperature |
| MultiPlus | DC Bus Power | (Calculated) | W | Current DC Power (V*A) |
| MultiPlus | Grid to Consumers (Today) | Gc |
kWh | Energy from Grid to Load (Today) |
| MultiPlus | Grid to Battery (Today) | Gb |
kWh | Energy from Grid to Battery (Today) |
| — | — | — | — | — |
| PV Inverter | L1 Voltage | 203 |
V | Voltage Phase 1 |
| PV Inverter | L1 Current | 204 |
A | Current Phase 1 |
| PV Inverter | L1 Power | 205 |
W | Power Phase 1 |
| PV Inverter | L1 Energy | 206 |
kWh | Energy Yield Phase 1 (Total) |
| PV Inverter | L2 Voltage | 207 |
V | Voltage Phase 2 |
| PV Inverter | L2 Current | 208 |
A | Current Phase 2 |
| PV Inverter | L2 Power | 209 |
W | Power Phase 2 |
| PV Inverter | L2 Energy | 210 |
kWh | Energy Yield Phase 2 (Total) |
| PV Inverter | L3 Voltage | 211 |
V | Voltage Phase 3 |
| PV Inverter | L3 Current | 212 |
A | Current Phase 3 |
| PV Inverter | L3 Power | 213 |
W | Power Phase 3 |
| PV Inverter | L3 Energy | 214 |
kWh | Energy Yield Phase 3 (Total) |
| PV Inverter | Status | 246 |
- | Status Code |
| PV Inverter | PV to Consumers (Today) | Pc |
kWh | Energy from PV to Load (Today) |
| PV Inverter | PV to Battery (Today) | Pb |
kWh | Energy from PV to Battery (Today) |
| PV Inverter | PV to Grid (Today) | Pg |
kWh | Energy from PV to Grid (Today) |
| PV Inverter | PV Total Today | (Calculated) | kWh | Total PV Yield Today (Pc+Pb+Pg) |
| — | — | — | — | — |
| Tank | Capacity | 328 |
m³ | Tank Capacity |
| Tank | Type | 329 |
- | Fluid Type |
| Tank | Level | 330 |
% | Fluid Level in Percent |
| Tank | Remaining | 331 |
m³ | Remaining Fluid Volume |
| Tank | Status | 443 |
- | Tank Status (e.g., OK) |
| Tank | Custom Name | 638 |
- | User Defined Name |
| — | — | — | — | — |
| Solar Charger | Battery Watts | 107 |
W | Charging Power to Battery |
| Solar Charger | Battery Voltage | 81 |
V | Battery Voltage |
| Solar Charger | Charge State | 85 |
- | Charger State (e.g., Bulk, Float) |
| Solar Charger | Battery Temperature | 83 |
°C | Battery Temperature (external) |
| Solar Charger | Yield Today | 94 |
kWh | Energy Yield Today |
| Solar Charger | Yield Yesterday | 96 |
kWh | Energy Yield Yesterday |
| Solar Charger | Relay Status | 90 |
- | Relay State |
| — | — | — | — | — |
| Overall Stats | * Total Solar Yield | total_solar_yield |
kWh | Total PV Yield (for selected period) |
| Overall Stats | * Total Consumption | total_consumption |
kWh | Total Consumption (for selected period) |
| Overall Stats | * Grid Energy In | grid_history_from |
kWh | Energy from Grid (for selected period) |
| Overall Stats | * Grid Energy Out | grid_history_to |
kWh | Energy to Grid (for selected period) |
(Die Overall Stats Entities werden für Perioden Today, Week, Month and Year erstellt.)
Voraussetzungen
-
VRM-Zugriffstoken (bitte geheim halten!). Erstelle eines im VRM-Portal unter Einstellungen > Integrationen > Zugriffstoken oder verwende diesen Link.
-
Deine Side_ID
-
Instanz Nummer von Battery, Multiplus und PV Inverter
Installation der Integration
HACS
- Folge einfach dem Link, um dieses Repository in HACS zu integrieren.
- Gehe zu
Einstellungen→Geräte und Dienste→Integration. - Klicke auf
Integration hinzufügen. - Suche nach
victron vrm apioder kurzvrm. - Gebe deine Side_ID, dein Token und
deine Instance_ID für Battery, Multiplus und PV Inverter ein.
Manual
- Lade die neueste Version herunter.
- Kopiere den Ordner
victron-vrm-apiin deincustom_componentsOrdner von Home Assistant. - Starte Home Assistant neu.
- Gehe zu
Einstellungen→Geräte und Dienste→Integration. - Klicke auf
Integration hinzufügen. - Suche nach
victron vrm apioder kurzvrm. - Gebe deine Side_ID, dein Token und
deine Instance_ID für Battery, Multiplus und PV Inverter ein.
So sollte es aussehen in HA
Q&A
- Configuration Menu, if the instance number for Battery, Multiplus or PV Inverter is set to 0, then no device will be added!
(Example, if you have no Battery, then you don`t need the empty Device in HA.) - You get the Temperature value with a 1PH Multiplus Setup. With 3Ph Multiplus Setup you dont get this Sensor.
- You can add more instance ids separated by comma (100, 101, 102)
- You get Data from your 1Ph or 3Ph PV-Inverter. With 3Ph you get some more Sensors.













