User Tools

Site Tools


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 [2016-05-12 14:40] – [Other Victron related open source projects] mvaderopen_source:start [2023-06-01 06:40] (current) – [Q1. Why is the Bluetooth API not public?] guy_stewart
Line 3: Line 3:
 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. 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.
  
-Also there is a list of other people's open source projects that work with Victron equipment.+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. 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.
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 & Venus ===== +Also, see our [[https://community.victronenergy.com/spaces/31/index.html|Modifications forum]]. 
-While being a very successful product for us in its standard configuration, the CCGX can also be perfect platform for many other projects. Such as:+ 
 +===== 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:
   * Add drivers for certain products, if interesting enough we will add transmission and readout of that data on the [[https://vrm.victronenergy.com/|VRM Portal]]. Adding generators readout and start/stop, and also temperature sensors for example would be very interesting!   * Add drivers for certain products, if interesting enough we will add transmission and readout of that data on the [[https://vrm.victronenergy.com/|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.   * Add logic on the product, for example to control the relay, or do other things.
  
-And we are currently working to make the software that runs on the CCGX, called Venus, run on the Beaglebone Black, a 45 USD single board computer similar to the RaspberryPi. Also running the full Venus image on a RaspberryPi should perfectly possible. But since it does not have canbus we have chosen for the Beaglebone Black instead. In case you are interested to dive into Openembedded, all Venus recipes and make and maintain a fully functional Venus image for a RaspberryPi: very welcome! Communication to Victron Products can then be done using our standard USB interfaces, such as the VE.Direct USB cable. 
  
-==== Getting started ==== +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
-The CCGX runs Venus, our own unix like distribution with a Linux kernel. It contains the kernel and many other base level drivers and code. But also contains all our applications, such as the drivers to communicate with VE.Bus products, VE.Direct producs and the VRM Portal+
  
-Venus is currently available in three ways: 
-  - Image for the CCGX 
-  - Image for the Beaglebone Black, aka BBB. Still a beta version, see venus-dev mailinglist for latest status. 
-  - Packages for Rasbian Wheezy, Rasbian Jessie and Debian Wheezy.  
  
-Note that those packages are supplied on an as-is basis: no official support on thoseJust best effort on the [[https://groups.google.com/forum/m/#!forum/victron-dev-venus|venus developers mailinglist]].+==== 1.1 Dockerised Influx database & Grafana dashboard for Venus OS GX Devices =====
  
-In case you want to develop something, please share your thoughts with usWe want to help making it a success, and preferably also include it in our main repositories and images.+See https://github.com/victronenergy/venus-docker-grafana.
  
-==== More information ==== +===== 2. VRM Portal (https://vrm.victronenergy.com/) =====
-  * [[open_source:ccgx:start|Introduction to CCGX hardware and software platform]] +
-  * [[open_source:ccgx:setup_development_environment|Setting up a development environment]] +
-  * [[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 Black project]] +
-  * [[open_source:ccgx:installing_ccgx_func_on_raspberry_pi|Installing CCGX functionality on a raspberry pi]] +
-  * [[open_source:ccgx:ccgx_traffic_counting|Traffic counting on the CCGX]]+
  
-For the die-hards: build your own CCGX image +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]].
-    * [[https://github.com/victronenergy/venus|Venus repository and readme]] +
-    * [[https://github.com/victronenergy/venus/wiki|Venus wiki]] +
-    * [[open_source:ccgx:bitbake|Bitbake tips]]+
  
-===== VRM Portal (https://vrm.victronenergy.com/) ===== +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.
-  * [[vrm_portal:vrm_juice_json_api_notes]] +
-  * [[https://github.com/victronenergy/apps_vrm_ios|VRM App iOS]] +
-  * [[https://github.com/victronenergy/apps_vrm_android|VRM App Android]]+
  
-===== Other Victron related open source projects =====+===== 3. Signal K =====
  
-Many, many people all over the world are writing code to integrate Victron products and protocols into their systemsBelow list of public projects, aiming to help each other. Tip: also simply type 'Victron' in the search field on Github and other open source hubsor 'Victron git' in Google. That is how I found below links :-D.+Signal K is a modern and open data format for marine useBuilt on standard web technologies including JSON, WebSockets and HTTP, Signal K provides method for sharing information independently of the underlying communications protocol (e.g. NMEA0183NMEA2000, 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/]].
  
-=== Multis / Quattros / MK2 ===+  * 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. 
 + 
 +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. 
 + 
 +==== 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 66: Line 63:
     * [[http://hackaday.io/project/2333-my-off-grid-solar-system-monitoring|Project description]]     * [[http://hackaday.io/project/2333-my-off-grid-solar-system-monitoring|Project description]]
     * [[https://drive.google.com/folderview?id=0B8X1ITc5xR0eVGp4NmFvcnhWS2M&usp=sharing|Source code]]     * [[https://drive.google.com/folderview?id=0B8X1ITc5xR0eVGp4NmFvcnhWS2M&usp=sharing|Source code]]
- 
-  * [[http://www.deszynski.com/victron-bmv-700-lan-port/|BMV-700 with LAN port]] 
  
   * [[https://github.com/izak/ib.victron|Python library for MK2]] (Izak Burger)   * [[https://github.com/izak/ib.victron|Python library for MK2]] (Izak Burger)
-  * want to list your project here? Please go ahead and change this page yourself!+  * EMDO can do! Energy manager to increase self-consumption quote, switch loads when energy is available. Programmable over BASIC interpreter (MM-BASIC). 
 +    * [[https://www.kickstarter.com/projects/1983254852/emdo-can-do-your-energy-manager-for-renewable-ener/description|EMDO101 on kickstarter,swissEmbedded GmbH ]] 
 +    * [[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! 
 + 
 +==== 4.2 VE.Direct (MPPT Solar Chargers and BMV Battery Monitors) ==== 
 + 
 +Arduino: 
 +  * [[http://caravanersforum.com/viewtopic.php?t=63614|Victron on Arduino - Caravaners Forum]] 
 +  * 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/Louisvdw/dbus-serialbattery|Serial battery driver for GX devices]] supporting multiple BMS/Battery types.
  
-=== VE.Direct (MPPT Solar Chargers and BMV Battery Monitors) === +Other: 
-  * Use VE.Direct compatible Victron equipment with EMON (Open Energy Monitor) https://github.com/openenergymonitor/emonhub/blob/emon-pi/conf/VEDirect.readme.md+  * 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 [[https://openenergymonitor.org/emon/emoncms|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://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
-  * [[http://caravanersforum.com/viewtopic.php?t=63614|Victron on Arduino Caravaners Forum]] +  * http://www.deszynski.com/victron-bmv-700-lan-port/ 
-  * want to list your project here? Please go ahead and change this page yourself!+  * pgf's client/server bash script for access to VE.Direct: https://github.com/foxharp/ve.direct 
 +  * [[http://www.deszynski.com/victron-bmv-700-lan-port/|BMV-700 with LAN port]] 
 +  * Raspberry Pi / PHP Victron Data Logger (Text-Mode) Open Source: [[https://github.com/oekoluk/Victron-Data-Reader-and-Logger|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]] 
 +  * [[https://github.com/giacinti/vedirect | ESPHOME VE.Direct sensor]] 
 + 
 +===== Bluetooth Protocol ===== 
 + 
 +  * https://community.victronenergy.com/questions/187303/victron-bluetooth-advertising-protocol.html 
 ===== DISQUS ===== ===== DISQUS =====
 ~~DISQUS~~ ~~DISQUS~~
open_source/start.1463056815.txt.gz · Last modified: 2016-05-12 14:40 by mvader

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki