Victron Energy

User Tools

Site Tools

You are here: Documentation » Open source
open_source:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
open_source:start [2019-05-31 07:23] – mvaderopen_source:start [2025-06-23 10:00] (current) – [4.2 VE.Direct (MPPT Solar Chargers and BMV Battery Monitors)] guy_stewart
Line 9: Line 9:
 Looking for Victron protocol documentation? Read our [[https://www.victronenergy.com/upload/documents/Whitepaper-Data-communication-with-Victron-Energy-products_EN.pdf|Data communication whitepaper]] as well. Looking for Victron protocol documentation? Read our [[https://www.victronenergy.com/upload/documents/Whitepaper-Data-communication-with-Victron-Energy-products_EN.pdf|Data communication whitepaper]] as well.
  
-===== Color Control GX, BBB, RaspberryPi: the Venus OS ===== +Also, see our [[https://community.victronenergy.com/spaces/31/index.html|Modifications forum]]. 
-Venus OS is the Victron Energy Unix like distro with a linux kernel. Its the heart of our [[https://www.victronenergy.com/panel-systems-remote-monitoring/color-control|Color Control GX]] and [[https://www.victronenergy.com/panel-systems-remote-monitoring/venus-gx|Venus GX]] two very successful central and remote monitoring systems.+ 
 +===== 1. Venus OS: the software on our GX product range and also for the Raspberry Pi===== 
 +Venus OS is the Victron Energy Unix like distro with a linux kernel. It's the software that runs on our [[venus-os:start|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: 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:
Line 16: Line 18:
   * Add logic on the product, for example to control the relay, or do other things.   * Add logic on the product, for example to control the relay, or do other things.
  
-Full information about the Venus OS; and compatible boards and hardware is here: https://github.com/victronenergy/venus/wiki 
  
-In case you want to develop something, please share your thoughts with us. We want to help making it a success, and preferably also include it in our main repositories and images.+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
  
-==== More information ==== 
-  * [[open_source:ccgx:start|Introduction to CCGX hardware and software platform]] 
-  * [[https://github.com/victronenergy/venus/wiki/howto-install-and-use-the-sdk|Howto install and use the SDK]] 
-  * [[ccgx:root_access|Root access]] 
-  * [[open_source:ccgx:commandline|Command line introduction]] 
-  * [[open_source:ccgx:d-bus|D-Bus - CCGX internal communication bus]] 
-  * developers mailing list: https://groups.google.com/forum/m/#!forum/victron-dev-venus 
-  * [[https://github.com/victronenergy/venus/wiki/porting-venus|Beaglebone aka Venus GX project]] 
-  * [[https://github.com/victronenergy/venus/wiki/raspberrypi|Installing CCGX functionality on a raspberry pi]] 
-  * [[open_source:ccgx:ccgx_traffic_counting|Traffic counting on the CCGX]] 
-  * [[https://github.com/sbender9/signalk-venus-plugin|SignalK Venus Plugin]] 
  
-===== VRM Portal (https://vrm.victronenergy.com/) ===== +==== 1.1 Dockerised Influx database & Grafana dashboard for Venus OS / GX Devices =====
-  * [[https://vrmapi.victronenergy.com/v2/docs|VRM JSON REST API]] +
-  * [[https://github.com/victronenergy/apps_vrm_ios|VRM App iOS]] +
-  * [[https://github.com/victronenergy/apps_vrm_android|VRM App Android]]+
  
-===== Why is the Bluetooth API not public? =====+See https://github.com/victronenergy/venus-docker-grafana.
  
-Making the bluetooth API an official public one would mean that we can’t change it as simply as we can today; and also it means that we’ll get question about it: bluetooth is not simple. Far more complicated than a serial port.+===== 2. VRM Portal (https://vrm.victronenergy.com/) =====
  
-And then only our developers will be able to answer them: taking away development resources. Hence we chose to not make the Bluetooth API public.+While in itself not being an open source project, the VRM Portal database can be queried using the [[https://vrmapi.victronenergy.com/v2/docs|VRM JSON REST API]].
  
 +Also, you can interface to the GX product range using MQTT, see the [[https://github.com/victronenergy/dbus-mqtt|dbus-mqtt]] readme for more information.
  
-===== Other Victron related open source projects =====+===== 3. Signal K ===== 
 + 
 +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/]] 
 + 
 +===== 4. Other Victron related open source projects =====
  
 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. 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: makre 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 :-D.+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 :-D.
  
 Want to list your project here? Please go ahead and change this page yourself! See Login on upper right. Want to list your project here? Please go ahead and change this page yourself! See Login on upper right.
  
-==== Multis / Quattros / MK2 ====+==== 4.1 Multis / Quattros / MK2 ====
  
   * 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.   * 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.
Line 71: Line 69:
     * [[https://github.com/swissembedded/em|Open Source BASIC programs on github ]]     * [[https://github.com/swissembedded/em|Open Source BASIC programs on github ]]
  
-  * want to list your project here? Please go ahead and change this page yourself!+want to list your project here? Please go ahead and change this page yourself!
  
-==== VE.Direct (MPPT Solar Chargers and BMV Battery Monitors) ====+==== 4.2 VE.Direct (MPPT Solar Chargers and BMV Battery Monitors) ====
  
 Arduino: Arduino:
   * [[http://caravanersforum.com/viewtopic.php?t=63614|Victron on Arduino - Caravaners Forum]]   * [[http://caravanersforum.com/viewtopic.php?t=63614|Victron on Arduino - Caravaners Forum]]
   * https://github.com/physee/Victron.Arduino-ESP8266   * https://github.com/physee/Victron.Arduino-ESP8266
 +  * [[https://community.victronenergy.com/questions/21377/basic-lightweight-vedirect-reading-library-for-ard.html|VE.Direct reading library for Arduino]]
 +  * [[https://github.com/cterwilliger/VeDirectFrameHandler | Arduino VE.Direct library based on Victron's reference implementation]]
 +  * [[https://github.com/giacinti/VeDirectFrameHandler | Arduino & ESP32 VE.Direct library supporting HEX protocol (fork of previous project, see below for ESPHOME sensor)]]
 +
 +Battery/BMS:
 +  * [[https://github.com/mr-manuel/venus-os_dbus-serialbattery|Serial battery driver for GX devices]] supporting multiple BMS/Battery types.
  
 Other: Other:
Line 83: Line 87:
   * PvMonit : small real-time web interface and export to emonCMS for history (Brick from [[https://openenergymonitor.org/emon/emoncms|OpenEnergyMonitor]])   * PvMonit : small real-time web interface and export to emonCMS for history (Brick from [[https://openenergymonitor.org/emon/emoncms|OpenEnergyMonitor]])
     * https://github.com/kepon85/PvMonit/ (fr)     * https://github.com/kepon85/PvMonit/ (fr)
-    * http://david.mercereau.info/pvmonit-monitoring-de-mon-installation-photovoltaique-autonome/ (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://pypi.python.org/pypi/BMV/0.2.1
   * https://github.com/karioja/vedirect   * https://github.com/karioja/vedirect
 +  * https://github.com/mano8/vedirect_m8
   * https://github.com/jepefe/bmvmonitor   * https://github.com/jepefe/bmvmonitor
   * Nodejs monitor Raspberry PI https://github.com/Moki38/vedirect   * Nodejs monitor Raspberry PI https://github.com/Moki38/vedirect
Line 94: Line 103:
   * SignalK: https://github.com/sbender9/vedirect   * 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]]   * 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]]   * velog: Serial log application for VE.Direct devices [[https://github.com/ullman/velog]]
 +  * [[https://github.com/giacinti/vedirect | ESPHOME VE.Direct sensor]]
  
-==== SignalK ==== +===== Bluetooth Protocol =====
- +
-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 on [[http://signalk.org/]]. +
- +
-  * SignalK Venus Plugin: https://github.com/sbender9/signalk-venus-plugin +
-  * SignalK plug-in for USB- connected MPPT Solar Charger: https://github.com/sbender9/vedirect+
  
 +  * https://community.victronenergy.com/questions/187303/victron-bluetooth-advertising-protocol.html
  
 ===== DISQUS ===== ===== DISQUS =====
 ~~DISQUS~~ ~~DISQUS~~
open_source/start.1559280219.txt.gz · Last modified: by mvader
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki