This talks to the device on your own network rather than to Victron's portal, which is what makes it usable off-grid and on a boat with no connectivity. Start with the setup call: it tests both transports, finds what is connected, and saves you guessing which family tool applies to your hardware. Keep the raw register tools in reserve — they cover whatever the decoded tools do not, and the bundled offline register list is what turns an address into a meaning without a browser.
A reader for Victron GX systems on your own network. One tool per device family returns that family's live values already decoded, and the raw register tools are there for anything the decoded set does not cover.
- A system overview in one call: battery state of charge, voltage, current and power, PV power, grid power, AC consumption and inverter state
- Battery detail from the monitor — cell voltages, temperature, time-to-go and history — and solar charger detail including yield today, yesterday and total, charger state and error code
- Grid metering per phase with voltage, current, frequency and forward and reverse energy counters, and the same shape for AC-coupled PV inverters, AC loads and current sensors
- Inverter and charger families covered separately: VE.Bus Multi and Quattro, Multi RS, standalone Phoenix and Inverter RS, AC chargers such as Skylla and Blue Smart, and the Orion XS DC-DC converter
- The rest of the installation: tank levels with capacity and fluid type, temperature sensors, digital inputs, GPS position and fix, IMT solar irradiance and wind, EV charging station status, DC energy meters, and alternator regulators from Wakespeed, Arco and Revatek
- Generators from both sides — AC gensets from Fischer Panda, ComAp, DSE, CRE and DEIF, DC gensets, and the GX's own auto start/stop state and manual command
- Discovery before any of it: scan the network for Modbus TCP on port 502 and MQTT on port 1883, probe unit IDs for connected devices, auto-discover Venus OS services over MQTT, or run the combined setup that tests both transports at once
- Raw Modbus registers read directly, the register list for a device category shown with addresses, data types and scale factors, and every register of a category read at once
- An offline copy of the Victron register list, searchable locally, with links to the current online sources when it does not have the answer
Network reach to the GX device, and Modbus TCP enabled on it. VICTRON_HOST names the device, but it is optional — the host can be passed per call, or found with the network scan. VICTRON_TRANSPORT chooses modbus or mqtt, defaulting to modbus; MQTT additionally wants VICTRON_PORTAL_ID for its topics. Ports default to 502 for Modbus and 1883 for MQTT, and the default Modbus unit ID is 100. Raw register reads are Modbus TCP only and are not available over MQTT. It runs on Node over stdio as npx victron-tcp. MIT.
One command — npx -y victron-tcp