Victron GX for Home Assistant (built-in integration)

About

Victron GX is a built-in integration that connects Home Assistant to Victron GX devices over the local network. It talks to the device through its MQTT port, with options for host, port, password, username and SSL use. It adds sensors, binary sensors for alarms and status, numbers for limits and generator settings, selects for modes, switches such as force charge and EV charging, and a device reboot button. A location presence entity is included as well. Home Assistant can discover the device on the network, add new devices as they appear, and remove ones that are gone. Connection settings can be changed later, and repair notices cover legacy EV charger sensors. Setup is done in the UI.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Found by itself Home Assistant spots it on the network and offers to add it.
Adds new devices New devices show up without setting it up again.
Cleans up devices Devices that are gone are removed by themselves.
Change settings later Its connection settings can change without removing it.
Platinum quality Home Assistant's own rating of its code and setup experience.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Switches
Sensors
Presence

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Connect

HostHostname or IP address of Victron device, usually mDNS name like 'venus.local'
PasswordPassword for the Victron device, default is empty. This is not your VRM password.
PortThe MQTT port on the host. Normally it is 1883.
Uses an SSL certificateIndicates whether to use SSL to connect to the Victron device. Normally it is disabled.
UsernameUsername for the MQTT server, default is empty. Not needed by Victron devices. This is only needed if you route your MQTT messages through a non-Victron server and it does require a username.

Also asked when changing the connection.

Authenticate Victron GX

GX passwordPassword for the Victron device, default is empty. This is not your VRM password.
Uses an SSL certificateIndicates whether to use SSL to connect to the Victron device. Normally it is disabled.

Sign in again

PasswordPassword for the Victron device, default is empty. This is not your VRM password.
Uses an SSL certificateIndicates whether to use SSL to connect to the Victron device. Normally it is disabled.
UsernameUsername for the MQTT server, default is empty. Not needed by Victron devices. This is only needed if you route your MQTT messages through a non-Victron server and it does require a username.

Texts from Home Assistant's source code, Apache License 2.0.

Entities

Binary sensorsAllow to charge, Allow to discharge, At site, Connected, High temperature alarm, High voltage alarm, High voltage AC-out alarm, Low temperature alarm, Low voltage alarm, Low voltage AC-out alarm, Overload alarm, Ripple alarm, and 6 more
ButtonsDevice reboot
PresenceLocation
NumbersCharge current limit, AC input current limit, Max charging current, Min charging current, Charge current setpoint, Generator cooldown timer, Generator QH start on SoC, Generator QH start on voltage, Generator QH stop on SoC, Generator QH stop on voltage, Generator service interval, Generator shutdown timer, and 33 more
SelectsMode, State, AC input 1 source type, AC input 2 source type, ESS mode, ESS mode (Hub4), DESS mode, VRM portal access level
SensorsLoad current, Consumption, Frequency, Power, Voltage, DC output current, DC output power, DC output voltage, Input current, Input power, Input voltage, State, and 214 more
SwitchesInvert digital input, Auto start, EV charging, Auto-start enabled, Generator quiet hours enabled, Generator start on SoC enabled, Generator start on high temp enabled, Generator start on voltage enabled, Manual start, Force charge, ESS disable charge, ESS disable feed-in, and 18 more

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Legacy EV charger sensor removed, Legacy EV charger sensor in use