Skip to content

sbender9/signalk-venus-plugin

Repository files navigation

venus-signalk

This code is a Signal K Node Server plugin. It reads data from a Victron GX-device, such as the Cerbo GX into signalk-server.

Besides using the Cerbo GX, or any of the other commercially available GX devices, it is also possible to run Venus OS on a RaspberryPi2 or 3, for example.

Know that there is also a version of Venus OS with signalk-server, and this plug-in pre-installed. In which case you don't need to self install or configure this plugin. See Venus OS large.

Support

Use the #victron channel on Discord.

Plugin installation & configuration

Installing is simple. The plugin is available in the signalk app store. Simply click to install.

Then there are two settings. The first is how to connect to Venus OS. Choose between these:

  • A. Connect to localhost via dbus
  • B. Connect to a GX-device over tcp using MQTT (Plain text)
  • C. Connect to a GX-device over tcp using MQTT (SSL)
  • D. Connect via VRM

Use option A when signalk-server is installed on the GX-device itself.

Use option B or C in case signalk-server is a separate device, for example a raspberrypi running Raspbian, in which case the plugin needs to connect to the GX-device on the ethernet/wifi network. You should use SSL if GX-device is not on the local network.

When using option B or C go enter the hostname or ipaddress of the Venus device in the plugin configuration.

Also ensure that MQTT is turned on in the GX-devices Services Settings.

Option D is mostly usefull for developer testing/debugging with other peoples systems, but could also be used if running signalk in a different location or network that the GC device