Command Line and Query Parameters - victronenergy/gui-v2 GitHub Wiki
This document describes which command-line arguments and URL query parameters are available for the Venus OS GUI v2 project.
Overview
The application supports configuration via both command-line arguments (for desktop/native builds) and URL query parameters (for WebAssembly builds).
This allows flexible startup configuration for MQTT, D-Bus, color scheme, mock data, and more.
Supported Options
Command-Line Arguments
The following options are supported (short and long forms where available):
| Option | Description | Example Value |
|---|---|---|
-d, --dbus |
Use D-Bus data source: connect to specified address | tcp:host=localhost,port=3000 |
--dbus-default |
Use D-Bus data source: connect to default address | no value needed |
-m, --mqtt |
Use MQTT data source: connect to specified broker | ws://192.168.5.96:9001/ |
-i, --id |
MQTT data source device portal id | abcdef123456 |
-s, --shard |
MQTT VRM webhost shard | vrm or 114 |
-u, --user |
MQTT data source username | [email protected] |
-p, --pass |
MQTT data source password | yourpassword |
-t, --token |
MQTT data source token | eyJhbGciOiJIUzI1NiIsInR5cCI6... |
-f, --fpsCounter |
Enable FPS counter | no value needed |
--skip-splash |
Skip splash screen | no value needed |
-k, --mock |
Use mock data source for testing | no value needed |
-mc, --mock-conf |
Name of mock configuration | maximal |
--no-mock-timers |
Disable mock timers on startup | no value needed |
--nodeRedUrl |
Node-RED URL | https://192.168.1.132:1881/ |
--signalKUrl |
Signal K URL | http://192.168.1.132:3000/ |
--colorScheme |
Color scheme (dark, light, auto, default) | dark |
WebAssembly Query Parameters
For WebAssembly builds, the following URL query parameters are supported (example: ?mqtt=ws://...&colorScheme=dark):
| Query Parameter | Description | Example Value |
|---|---|---|
mqtt |
MQTT broker address | ws://192.168.5.96:9001/ |
id |
MQTT device portal id | abcdef123456 |
shard |
MQTT VRM webhost shard | vrm or 114 |
user |
MQTT username | [email protected] |
pass |
MQTT password | yourpassword |
token |
MQTT auth token (JWT) | eyJhbGciOiJIUzI1NiIsInR5cCI6... |
fpsCounter |
Enable FPS counter | enabled |
nodeRedUrl |
Node-RED URL | https://192.168.1.132:1881/ |
signalKUrl |
Signal K URL | http://192.168.1.132:3000/ |
colorScheme |
Color scheme (dark, light, auto, default) |
dark |
download |
Set to vrm to download the WASM file from VRM |
vrm |
default |
Use default display mode | no value needed |
fullscreen |
Force fullscreen display mode | no value needed |
noframe |
Always hide GX device frame | no value needed |
frame |
Always show GX device frame | no value needed |
mock |
Display mock data instead of real data | Available configurations are in data/mock/conf. Just use the filename without the .json extension, e.g. ?mock=maximal |
Example Usage
Desktop/Native
Run on desktop or GX device:
./venus-gui-v2 --mqtt ws://192.168.5.96:9001 --colorScheme dark
WebAssembly
Open in browser:
http://venus.local/gui-v2/?colorScheme=dark&fullscreen
Code references
The command-line and query parameters are defined in this files: