User Tools

Site Tools


venus-os:extended

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
Last revisionBoth sides next revision
venus-os:extended [2020-06-17 00:11] – [Appendix A - Repartitioning Venus GX flash memory] mvadervenus-os:extended [2020-10-19 16:00] – [5.4 First use & configuring] pbu
Line 1: Line 1:
-====== Venus OS Extended image: Signal K and Node-RED ======+====== Venus OS Large image: Signal K and Node-RED ======
  
 (DRAFT - THIS DOCUMENT IS ABOUT NOT YET COMPLETELY FINISHED FUNCTIONALITY) (DRAFT - THIS DOCUMENT IS ABOUT NOT YET COMPLETELY FINISHED FUNCTIONALITY)
Line 5: Line 5:
 ===== 1. Introduction ===== ===== 1. Introduction =====
  
-This manual documents the extended version of Venus OS, which adds Signal K and Node-RED. For more information on either of the two, see Google.+This manual documents the "large" version of Venus OS, which adds Signal K and Node-RED. For more information on either of the two, see Google.
  
  
Line 35: Line 35:
 ===== 2. Where to find support ===== ===== 2. Where to find support =====
  
-There is and will be no official support on the functionalities included in this image. For support, turn to the [[https://community.victronenergy.com/spaces/31/index.html|Modifications Space on Victron Community]].+There is and will be **no official support** on the functionalities included in this image. For support, turn to the [[https://community.victronenergy.com/spaces/31/index.html|Modifications Space on Victron Community]].
  
 ===== 3. Requirements ===== ===== 3. Requirements =====
 +
 +==== 3.1 GX Device compatibility ====
  
 A compatible GX device: A compatible GX device:
Line 49: Line 51:
  
 Venus OS extended is also available for certain RaspberryPi models. Installation files below, and installation & other raspberrypi specific instructions [[https://github.com/victronenergy/venus/wiki/raspberrypi-install-venus-image|here]]. Venus OS extended is also available for certain RaspberryPi models. Installation files below, and installation & other raspberrypi specific instructions [[https://github.com/victronenergy/venus/wiki/raspberrypi-install-venus-image|here]].
 +
 +==== 3.2 CPU & Memory resources ====
 +
 +Both SignalK as well as Node-red are rather resource intensive software applications to run on the GX Device. From a CPU usage point of view as well as RAM memory.
 +
 +Ofcourse, how intensive depends on what kind of flows (node-red) or how many messages & handling of them (SignalK) happens in the system.
 +
 +From a GX device point of view, from the support models the Venus GX is the one with the least resources. Running both SignalK and Node-RED at the same time will be "pushing it" to say it simply.
 +
 +Cerbo GX is already much faster, as it has a dual core CPU as well as much more RAM.
 +
 +More details about CPU & RAM differences are in this document: https://github.com/victronenergy/venus/wiki/machines.
 +
 +When running out of RAM or CPU, the device will slow down. And eventually also reboot by itself due to the watchdog.
  
 ===== 3. How to install ===== ===== 3. How to install =====
Line 195: Line 211:
 Open a web browser, and go to the SignalK Dashboard by navigating to http://venus.local:3000. Open a web browser, and go to the SignalK Dashboard by navigating to http://venus.local:3000.
  
-Further documentation about that is ... (some link to singalk-node documentation?)+Further documentation about that is ... (some link to signalk-node documentation?)
  
 === Step 2. Configure serial connections === === Step 2. Configure serial connections ===
Line 241: Line 257:
 Tbd. Actually a NMEA0183-network is probably something that doesnt exist: you can't have NMEA0183 in a network, its point to point. Tbd. Actually a NMEA0183-network is probably something that doesnt exist: you can't have NMEA0183 in a network, its point to point.
  
 +===== 6. Remote access via VRM =====
 +==== 6.1 Node-RED flow editor and Signal K ====
 +It it possible to access Node-RED flow editor and Signal K remotely via VRM - the interface and functionality is identical to access via LAN (ie. via **http://venus.local:1880** or **http://venus.local:3000**) .
 +
 +=== Step by step instructions ===
 +  * **Step 1.** Log into/open the regular VRM 'dashboard' or 'advanced' page for the site
 +{{ :venus-os:vrm_node_red_step_1.png?direct&600 |VRM Node-RED - Step 1}}
 +
 +  * **Step 2.** Modify the URL to include **/proxy/** after the site URL ID number (note that the last **/** is required)
 +  As an example: **https://vrm.victronenergy.com/installation/12345/proxy/** where **12345** is the unique site URL ID
 +{{ :venus-os:vrm_node_red_step_2.png?direct&600 |VRM Node-RED - Step 2}}
 +
 +  * **Step 3.** Click on the **Node-RED** or **Signal K** button in the Proxy relay screen; depending on location and the speed of internet connection, there may be a short delay while loading
 +{{ :venus-os:vrm_node_red_step_3a.png?direct&600 |VRM Node-RED - Step 3a}}
 +{{ :venus-os:vrm_node_red_step_3b.png?direct&600 |VRM Node-RED - Step 3b}}
 +
 +  * **Step 4.** The Node-RED flow editor or Signal K interface screen will appear
 +{{ :venus-os:vrm_node_red_step_4.png?direct&600 |VRM Node-RED - Step 4}}
 +==== 6.2 Node-RED Dashboard/User Interface ====
 +It it also possible to access the Node-RED dashboard/User Interface remotely via VRM - the interface and functionality is identical to access via LAN (ie. via **http://venus.local:1880/ui**)
 +
 +=== Step by step instructions ===
 +  * **Step 1.** Follow steps #1 to 4 in section 6.1 above in order to 'open' the remote connection
  
 +  * **Step 2.** The 'new' proxy URL needs to be modified to include **/ui** after **.....victronenergy.com**
 +  As an example: **https://12345-nodered.proxyrelay3.victronenergy.com/ui** where **12345** is the unique site URL ID
 +{{ :venus-os:vrm_node_red_ui_step_2.png?direct&600 |VRM Node-RED UI - Step 2}}
  
 +  * **Step 3.** The Node-RED dashboard/user interface screen will appear
 +{{ :venus-os:vrm_node_red_ui_step_3.png?direct&600 |VRM Node-RED UI - Step 3}}
  
 ===== Appendix A - Repartitioning Venus GX flash memory ===== ===== Appendix A - Repartitioning Venus GX flash memory =====
venus-os/extended.txt · Last modified: 2021-01-06 22:04 by mvader

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki