Open source

Victron Energy has committed itself to make certain of its projects open source. On this page you'll find more information about available sources and projects.

Below some of our own projects, you'll also find a list of other people's open source projects that work with Victron equipment. See bottom of this page.

Note that all this information is made available as is, for free, without any warranty and we do not commit to giving support. Although ofcourse we like to help out where possible.

Looking for Victron protocol documentation? Read our Data communication whitepaper as well.

Also, see our Modifications forum.

Venus OS is the Victron Energy Unix like distro with a linux kernel. It's the software that runs on our GX Product range: central and remote monitoring systems.

While being a very successful project for us in its standard configuration, the Venus OS, and compatible hardware platforms can also be the perfect platform for many other projects. Such as:

• Add drivers for certain products, if interesting enough we will add transmission and readout of that data on the VRM Portal. Adding generators readout and start/stop, and also temperature sensors for example would be very interesting!
• Add logic on the product, for example to control the relay, or do other things.

Full information about Venus OS; and compatible hardware as well as how to install on a Raspberry P is here: https://github.com/victronenergy/venus/wiki

See https://github.com/victronenergy/venus-docker-grafana.

While in itself not being an open source project, the VRM Portal database can be queried using the VRM JSON REST API.

Also, you can interface to the GX product range using MQTT, see the dbus-mqtt readme for more information.

Signal K is a modern and open data format for marine use. Built on standard web technologies including JSON, WebSockets and HTTP, Signal K provides a method for sharing information independently of the underlying communications protocol (e.g. NMEA0183, NMEA2000, SeaTalk, I2C, 1-Wire, ZigBee, etc) in a way that is friendly to WiFi, cellphones, tablets, and the Internet. More information at http://signalk.org/.

• Signal K Node Server plugin: https://github.com/sbender9/signalk-venus-plugin
• Raspberry Pi Venus image: https://github.com/victronenergy/venus/wiki/raspberrypi-install-venus-image
• Signal K plugin for VE.Direct Serial to USB interface: https://github.com/SignalK/vedirect-serial-usb
• Blog - Sailing with Signal K: https://www.victronenergy.com/blog/2019/06/13/sailing-with-signal-k/
• Blog - Signal K: Embracing connectivity with Victron Energy: https://www.victronenergy.com/blog/2018/05/28/signal-k-embracing-connectivity-with-victron-energy/

Many, many people all over the world are writing code to integrate Victron products and protocols into their systems. Below a list of public projects, aiming to help each other.

Tip: make sure to search for 'Victron' on Github and other open source hubs, or for 'Victron git' in Google. That is how I found below links .

Want to list your project here? Please go ahead and change this page yourself! See Login on upper right.

• https://github.com/hpdvanwyk/invertergui: A primitive HTTP based monitor for a Victron Multiplus inverter. Uses https://github.com/ncthompson/inverter_monitor as a data source.

• Fabien Fleutot made a monitoring system for his beautiful old Belgian barge called Elorn
  • Github source for controlling Victron BMV and inverters on a raspberry pi.
  • Blog, with posts outlining all the details of the project

• Michel Kuenemann transformed his house, using 1 X RPi B and 4 X LPC1769 Cortex M3 :
  • MyPV 2 minute presentation video
  • MyPV website (Raspberry pi hosted)
  • Project description
  • Source code

• Python library for MK2 (Izak Burger)
• EMDO can do! Energy manager to increase self-consumption quote, switch loads when energy is available. Programmable over BASIC interpreter (MM-BASIC).
  • EMDO101 on kickstarter,swissEmbedded GmbH
  • Open Source BASIC programs on github

want to list your project here? Please go ahead and change this page yourself!

Arduino:

• Victron on Arduino - Caravaners Forum
• https://github.com/physee/Victron.Arduino-ESP8266
• VE.Direct reading library for Arduino
• Arduino VE.Direct library based on Victron's reference implementation
• Arduino & ESP32 VE.Direct library supporting HEX protocol (fork of previous project, see below for ESPHOME sensor)

Battery/BMS:

• Serial battery driver for GX devices supporting multiple BMS/Battery types.

Other:

• Use VE.Direct compatible Victron equipment with EMON (Open Energy Monitor) https://github.com/openenergymonitor/emonhub/tree/emon-pi/conf/interfacer_examples/vedirect
• PvMonit : small real-time web interface and export to emonCMS for history (Brick from OpenEnergyMonitor)
  • https://github.com/kepon85/PvMonit/ (fr)
  • http://pvmonit.zici.fr (fr)
  • https://david.mercereau.info/pvmonit/ (fr)
  • PvMonit now knows how to exploit the solar surplus when you are not using it with the “home automation” module :
    • https://david.mercereau.info/pvmonit-v2-0-domotique-gestion-surplus-electrique-solaire-en-autonomie/ (fr)
    • https://vimeo.com/385514728 (fr)
• https://pypi.python.org/pypi/BMV/0.2.1
• https://github.com/karioja/vedirect
• https://github.com/mano8/vedirect_m8
• https://github.com/jepefe/bmvmonitor
• Nodejs monitor Raspberry PI https://github.com/Moki38/vedirect
• http://www.deszynski.com/victron-bmv-700-lan-port/
• pgf's client/server bash script for access to VE.Direct: https://github.com/foxharp/ve.direct
• BMV-700 with LAN port
• Raspberry Pi / PHP Victron Data Logger (Text-Mode) Open Source: https://github.com/oekoluk/Victron-Data-Reader-and-Logger
• SignalK: https://github.com/sbender9/vedirect
• victronPi: a Raspberry Pi driven graphical display of data from Victron equipment installed in a campervan http://www.chronicle.me.uk/victronPi
• Victron Blog about the victronPi above: https://www.victronenergy.com/blog/2018/04/11/homemade-pi-open-source-raspberry-flavour/
• velog: Serial log application for VE.Direct devices https://github.com/ullman/velog
• ESPHOME VE.Direct sensor

• https://community.victronenergy.com/questions/187303/victron-bluetooth-advertising-protocol.html

~~DISQUS~~