Differences

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

--- venus-os:extended [2020-05-16 16:12] – [5.5 Signal K FAQ] mvader
+++ venus-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)
@@ Line 5: / Line 5: @@
 ===== 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 =====
-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.1 GX Device compatibility ====
 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]].
+==== 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 =====
@@ Line 57: / Line 73: @@
   * **Step 2.** Disable Auto updates. See Settings -> Firmware -> Online updates in Remote Console.
   * **Step 3.** Download the latest Venus-OS Extended image from the last comments on [[https://github.com/victronenergy/venus/issues/378|this issue]].
+  * **Step 4.** Install that file using the [[ccgx:firmware_updating|GX Offline install method]]. Requires a USB-stick or Micro SD-Card.
+  * **Step 5.** Verify that the image was successfully installed: go to Settings -> Services, and check that Signal K and Node-RED are now available to enable.
+  * **Step 6.** Enable either Signal K or Node-RED. Note that though its possible to enable both, doing so on a Venus GX is "pushing it", the system might become slow. Installer access level is required to enable/disable these servers, see Settings -> General.
+  * **Finished**. The Venus OS Extended image has now been installed successfully. Continue in either the Node-RED or the Signal K chapter below.
 === Special note for the RaspberryPi ===
@@ Line 67: / Line 87: @@
 The Node-RED editor is at http://venus.local:1880/. For some systems, you'll have to replace ''venus.local'' by the ip-address.
+The username is "admin", the password is the remote console password.
 ==== 4.1 Introduction ====
@@ Line 95: / Line 115: @@
 Make sure that there is always 30MB of free space remaining on the data partition. TODO: how can a user see that? Also mem usage / mem free & some cpu stats would be nice to see. Maybe with a dashboard & flow? ;o)
+==== 4.3 Controlling relays ====
+=== GX Device relays ===
+Controllable, make sure to configure them to be Manually controlled.
+=== MPPT Relay ===
+Note that while there is a Victron node that offers to control the relay in a solar charger (only large solar chargers have a relay!), its currently not workable since VictronConnect does not offer the required "Manual control" option in the list of selectable Relay modes for the MPPTs. This will be fixed at some point.
+=== BMV Relay ===
+Currently not possible, the driver in Venus OS doesn't support controlling it. This will be fixed at some point.
+=== Multi & Quattro Relays ===
+Includes alarm relays as well as the AC-out 2 relay: its not possible to control those; and there is no plan to make them controllable from within Node-RED.
 ===== 5. Signal K =====
@@ Line 177: / Line 211: @@
 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 ===
@@ Line 223: / 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.
+===== 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 =====
 The Venus GX has sufficient flash memory to run the Venus OS Extended image. But up until end of 2018 it was produced with a partition layout not suitable to run large versions of Venus OS. This appendix explains how to self update the partitions to the new format.
-Perform this procedure only when connected via Ethernet. Do not use the built-in WiFi AP to performing this procedure. The AP will not work half way the procedure.
+Perform this procedure only when connected via Ethernet port.
+Do not use the built-in WiFi AP to performing this procedure. The AP will not work half way the procedure. Similarly, any WiFi (client-) configuration will be wiped after running the installer. Therefore, as said, make sure to be able to connect on the LAN port before starting this procedure.
 **WARNING**: this procedure is available and documented here for the benefit of users that are technical enough to perform it. In order to make it possible for them to upgrade their Venus GX to make it compatible with the extended version of Venus OS. Victron offers no support or warranty on this. Running the installer is not something Victron normally asks end-users to do, its for in the factory.
@@ Line 295: / Line 360: @@
 Side info: see here for more details on installing an image.
-Once done, reboot the device, and then re-obtain yourself root access to continue. Note that all is reset, you'll need to go to Remote Console on LAN, then change access level again, enable ssh, change root password, and then login.
+Once done, reboot the device.
+After the boot (30 to 60 seconds) the LED will be slow blinking green. Indicating that the WiFi access point is off (as expected). More information about the LED operation is in the Venus GX manual.
+Now, re-obtain yourself root access to continue. Note that all settings will be wiped by the installer:
+  * you'll need to go to Remote Console on LAN, then change access level again, enable ssh, change root password, and then login.
+  * As warned above, you’ll need to do this on the LAN port. The built-in WiFi access-point will be disabled, and any previously configured WiFi (client-) configuration will be lost as the installer will have wiped all settings.
 === Step D. Restore the files ===
@@ Line 308: / Line 379: @@
 ssh 192.168.178.122 reboot
 </code>
+Once completed, the WiFi access point will be operational again.
 === Step E. Install extended Venus OS ===
 Now, the Venus GX has been repartitioned, and has a certain version of the normal Venus OS installed. Next step is to install the extended image. Refer to the Installation instruction chapter above.