Differences

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

--- venus-os:large [2024-06-11 07:40] – [5. Node-RED] dfaber
+++ venus-os:large [2025-06-15 23:47] (current) – [8.1 Disk space issues / data partition full] mvader
@@ Line 9: / Line 9: @@
 Also Node-RED features a [[https://flows.nodered.org/node/node-red-dashboard|fully customisable dashboard]], viewable in a webbrowser - both locally but also remotely, via the VRM Servers.
-To get a good idea of its possibilities, see our [[https://github.com/victronenergy/node-red-contrib-victron/wiki/Example-Flows|example flows]].
+To get a good idea of its possibilities, see the [[https://github.com/victronenergy/node-red-contrib-victron/wiki/Example-Flows|example flows]].
 **Signal K server** Signal K Server is a server application that runs on a central hub in a boat; in this case a Victron GX device. A few of its most used features are:
@@ Line 28: / Line 28: @@
 There is and will be no official support on the functionalities of Venus OS large.
-For support, turn to the [[https://community.victronenergy.com/spaces/31/index.html|Modifications Space on Victron Community]] and/or the [[https://community.victronenergy.com/smart-spaces/71/node-red.html|Node-RED Space on Victron Community]].
+For support, turn to the [[https://community.victronenergy.com/c/modifications/5 |Modifications Space on Victron Community]]. Another good resource is [[https://community.victronenergy.com/tag/node-red|all posts tagged as Node-RED]].
-There, first search if someone else had a similar question already. And if you can’t find such, then create a new question. Make sure you add Node-RED to the topic.
+On Community, first search if someone else had a similar question already. And if you can’t find such, then create a new question. Make sure to tag it with Node-RED.
 For support on SignalK, there is a #victron channel in [[http://slack-invite.signalk.org/|the SignalK Slack]] workspace.
@@ Line 56: / Line 56: @@
 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.
+The level of intensity largely depends on the system's specific configuration - whether it's the type of flows in node-red or the volume and processing requirements of messages in SignalK.
 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. The 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.
@@ Line 82: / Line 82: @@
 Go to Settings -> Firmware -> Online updates -> Image type:
+{{ :venus-os:venus-os_image_type_selector_v2.png?nolink&500 |}}
-{{ :venus-os:image_type_selector.png?nolink&500 |}}
 Now, change the Image type to Large. Then go one menu up, and Check for a new version and install that.
+This typically takes about 2 minutes.
+=== Step 4. Verify and enable ===
-=== Step 3. Verify and enable ===
+  - Verify that the image was successfully installed: go to the Settings menu, and check that under the integrations for availability.
+  - Enable either Signal K or Node-RED. Note that though its possible to enable both, doing that on a Venus GX is "pushing it", the system might become slow. This is less of a problem on a Cerbo GX or an Ekrano GX, as it has more resources (faster CPU). Installer access level is required to enable/disable these settings.
-  - Verify that the image was successfully installed: go to the Settings menu, and check that the Venus OS Large menu is available.
+Visible once successfully installed, the integration settings:
-  - Enable either Signal K or Node-RED. Note that though its possible to enable both, doing that on a Venus GX is "pushing it", the system might become slow. This is less of a problem on a Cerbo GX, as it has more resources (faster CPU). Installer access level is required to enable/disable these settings.
+{{ :venus-os:venus_os_large_menu_v2.png?nolink&500 |}}
-Visible once successfully installed, the Venus OS Large menu:
-{{ :venus-os:venus_os_large_menu.png?nolink&500 |}}
 === How to update ===
@@ Line 120: / Line 121: @@
 ===== 5. Node-RED =====
-{{:venus-os:node-palette.png?direct&nolink |}}
+{{ https://raw.githubusercontent.com/victronenergy/node-red-contrib-victron/master/docs/images/node-palette.png?nolink |}}
 ==== 5.1 Introduction ====
@@ Line 150: / Line 151: @@
 For developers: source code for the node-red-contrib-victron modules is [[https://github.com/victronenergy/node-red-contrib-victron/|here]], and note that updating is not possible from either the Node-RED editor as the commandline. The recommended way to get to the new node-red-contrib-victron version is to await a new Venus OS large build.
+==== 5.4 Examples ====
+Our most up to date library of examples can be accessed from within Node-RED. See the main menu (accessible from the top right), and then click Import. Or ctrl-i.
+{{ :venus-os:examples_node-red.png?direct |}}
+To see the examples when you don't have access to a Node-RED installation and flow-editor, see their copy here: https://github.com/victronenergy/node-red-contrib-victron/wiki/Example-Flows.
-==== 5.2 Back-up and restore ====
+==== 5.5 Back-up and restore ====
 Just as with other software it is important to keep your Node-RED flows save and secure. We advise you to periodically backup your flows using the palette manager "//Export -> all flows//" option to download the ''flows.json'' file to your PC.
@@ Line 161: / Line 169: @@
 Do note that the above instruction only makes a backup of your flows, not of the Node-RED configuration. The configuration is stored in ''.config.*.json'' files under ''/data/home/nodered/.node-red/''.
-==== 5.3 Installing extra nodes ====
+==== 5.6 Installing extra nodes ====
 Node-RED comes with a core set of useful nodes, but there are many more available from both the Node-RED project as well as the wider community.
@@ Line 183: / Line 191: @@
 Make sure that there is always 30MB of free space remaining on the data partition. One of the [[https://github.com/victronenergy/node-red-contrib-victron/wiki/Example-Flows#monitor-disk-usage | example flows]] shows how to check the free space using a Node-RED dashboard .
-==== 5.4 Controlling relays ====
+==== 5.7 Controlling relays ====
 For a relay to be controllable via Node-RED, it needs to be switched to manual control first. In most cases this needs to be done by using [[https://www.victronenergy.com/panel-systems-remote-monitoring/victronconnect|VictronConnect]].
@@ Line 218: / Line 226: @@
 === Charger relays ===
 The only charger which has a relay that is controllable is the Smart IP43 Charger. To use that for remote control, set its mode, using the VictronConnect app, to be remote controllable. Note that its use is limited: the relay is only powered (and thus only controllable) when the charger is switched on. It doesn't work when it's turned off with AC connected. This limitation applies to the 230V models as well as the later 120V/240V models.
-==== 5.5 Node-RED Dashboard ====
+==== 5.8 Node-RED Dashboard ====
 Besides the flow and automation functionally, Node-RED also offers a fully customisable dashboard. Including graphs, indicators as well as controls such as switches and sliders.
@@ Line 231: / Line 239: @@
 {{ :venus-os:vrm_node_red_ui_step_3.png?direct&600 |VRM Node-RED UI - Step 3}}
-==== 5.6 Configuration files ====
+==== 5.9 Configuration files ====
 WARNING: the vast majority of systems using Node-RED will not, and should not (!), have to modify any of the files here described. Venus OS itself, including Venus OS large and Node-RED, is made such that its not necessary to dive into the command line.
@@ Line 250: / Line 258: @@
 For more information on such Node-RED configuration customisations, see https://nodered.org/docs/user-guide/runtime/configuration.
-==== 5.7. Ready-to-use solutions ====
+==== 5.10 Ready-to-use solutions ====
 Node-RED can also be used for doing more advanced tasks. Some examples of ready-to-use solutions are:
@@ Line 256: / Line 264: @@
   * [[https://flows.nodered.org/node/node-red-contrib-eskomsepush|EskomSePush]] - use Node-RED for charging the batteries before the next load shedding happens (for South African users)
-==== 5.8. Using data from VRM  ====
+==== 5.11 Using data from VRM  ====
 For some flows it can be useful to retrieve data from the VRM Portal Database. For example to retrieve de Solar irradiation or yield forecasts.
@@ Line 281: / Line 289: @@
 The [[https://flows.nodered.org/node/victron-vrm-api|Victron VRM API node]] makes it easy to use the VRM API from a Node-RED flow. Alternatively take a look at above mentioned Dynamic-ESS flow.
-==== 5.9. Node-RED FAQ ====
+==== 5.12 Node-RED FAQ ====
 === Q1: Write/read file gives "Error: EACCESS: permission denied' ===
@@ Line 293: / Line 301: @@
 In case you see that there is a newer version Victron pallette available online, and thats not yet shipping in a Venus OS Large version, then the only option is to wait: a new Venus OS Large version is usually made available shortly after updating that pallette.
-=== Q3: How can I password protect Node-RED ===
+=== Q3: How can I password protect Node-RED / My Node-RED is password protected ===
-Password protection of Node-Red is linked to the remote console. If a password is set for the remote console, this password is also used for securing Node-Red. The username is ''admin'', the password is the remote console password.
+__Venus OS v3.50 and later__
+For systems that have a security profile set (under Settings -> General -> Security Profile), the password protection is linked to the chosen security profile. The password that has been set for either security profile "weak" or "secured" is also used to access Node-RED, in combination with username ''admin''.
+__ Venus OS versions prior to v3.50__
+The Node-RED's password protection is tied to the remote console. If a password is set for the remote console, this password is also used for securing Node-Red. The username is ''admin'', the password is the remote console password.
 === Q4: How do I restart Node-RED from the Venus GUI? ===
@@ Line 427: / Line 441: @@
 ==== 6.3 First use & configuring ====
-=== Step 1. Opening the dashboard ===
+Follow these steps to turn your GX into a NMEA to WiFi gateway within 5 minutes.
-Open a web browser, and go to the SignalK Dashboard by navigating to http://venus.local:3000.
+These instructions assume that your GX device has already been set-up with Venus OS Large, and Signal K is enabled.
+=== Step 1. Signal K Admin page ===
-Further documentation about that is ... (some link to signalk-node documentation?)
+Open a web browser, and go to the Signal K admin page by navigating to http://venus.local:3000.
-=== Step 2. Configure serial connections ===
+{{ :venus-os:img_2580.jpeg |}}
-Use this to, for example, configure a USB-connected NMEA0183 connection in SignalK. To do so, go to the dashboard (http://0.0.0.0:3000), and there to Server -> Connections.
+=== Step 2. Set the admin password ===
-Make sure to not add a connection using any of the built-in serial ports (/dev/ttyO0, /dev/ttyO2, /dev/ttyO4, /dev/ttyO5). These are the VE.Bus- and VE.Direct ports on the Venus GX, and it is not necessary to configure them in SignalK. Data from any devices there connected is already available in SignalK, by means of the "Victron Venus Plugin"; see Dashboard -> Server -> Plugin Config.
+Go to Security -> Users and create an admin user for Signal K and protect it with a secure password.
-Note that once configured in SignalK, for example a USB-serial port, that port is no longer normally available in Venus OS. For example, when plugging in a USB-GPS; and then adding a connection for its corresponding tty in the SignalK, makes for that GPS to be no longer be recognised and available in Venus OS.
+{{ :venus-os:img_2579.png |}}
+=== Step 3. Vessel information ===
+Go to Settings and enter some basic information about your boat.
+{{ :venus-os:img_9926.png |}}
+=== Step 4. NMEA2000 Can-bus connection ===
+For NMEA2000 networks, its recommended to have all connected devices use isolated connections. Therefore, when connecting the an NMEA2000 network, we recommend using the Ekrano GX and the Cerbo MK2 GX. Connect to the port physically labelled “VE.Can 1”.
-=== Step 3. Configure can-bus connections ===
+Signal K is preconfigured to have its port operational for this.
-For the Venus GX, and Cerbo GX, SignalK comes pre-configured with a NMEA2000 listener for the VE.Can ports, its named "n2k-on-ve.can-socket", and uses the canboatjs. Here is how you can see the same in the Signal K Admin UI:
+Here is how you can see the preconfigured connection in the Signal K Dashboard:
 ;#;
@@ Line 449: / Line 475: @@
 ;#;
-Note that, to keep that operational, that port must be configured as a 250kbit VE.Can & NMEA2000 port in the Remote Console.
+Note that, to keep that operational, that port must remain configured as a 250kbit VE.Can & NMEA2000 port in the Remote Console:
 ;#;
@@ Line 457: / Line 483: @@
 For more information on CAN-busses, see chapter 6.4.
-=== Step 4. Adding Signalk Plugins or Webapps ===
+=== Step 5. Optional: Configure NMEA0183 serial connections ===
-TODO: explain & warn about data partition size & space (since thats where plugins are installed by signalk on Venus OS). Filling up the datapartition can corrupt Venus OS. More information about data partition on Venus OS here: https://github.com/victronenergy/venus/wiki/data-partition
+Use this to, for example, configure a USB-connected NMEA0183 connection in SignalK. Go to Server -> Connections.
+Make sure to not add a connection using any of the built-in serial ports (/dev/ttyO0, /dev/ttyO2, /dev/ttyO4, /dev/ttyO5). These are the VE.Bus- and VE.Direct ports on the Venus GX, and it is not necessary to configure them in SignalK. Data from any devices there connected is already available in SignalK, via the "Victron Venus Plugin"; see Dashboard -> Server -> Plugin Config.
+Note that once configured in SignalK, for example a USB-serial port, that port is no longer normally available in Venus OS. For example, when plugging in a USB-GPS; and then adding a connection for its corresponding tty in the SignalK, makes for that GPS to be no longer be recognised and available in Venus OS.
+=== Step 6. Verify received data ===
+Go to the Databrowser to see the data now available to Signal K, and to tablets and nav. apps on   WiFi:
+{{ :venus-os:img_2578.png |}}
+=== Step 7. Configure your nav app ===
+Steps needed here will differ per app. The key required data is:
+  * Host/IP address: **venus.local**
+  * Protocol: **TCP**
+  * Port: **10110**
+=== Done! ===
+Now you should have all your data such as position from the boat’s GPS, speed, wind data, as well as AIS targets in your favourite nav app. Like here in Navionics:
+{{ :venus-os:img_2581.jpeg?nolink |}}
+=== Where to go from here? Anchor alarms, trip recording, automatic log books and more ===
+  * Anchor alarm: https://demo.signalk.org/documentation/features/anchoralarm/anchoralarm.html
+  * Automatic log book & trip recording: https://svrenaissance.com/starlink-and-victron-a-match-made-in-heaven-for-boaters/
 ==== 6.4 CAN-bus ports ====
@@ Line 476: / Line 530: @@
 ^ Enclosure label ^ Interface ^ Notes ^
-| VE.Can 1 | can0 | Isolated and default enabled in SignalK |
+| VE.Can 1 | vecan0 | Isolated and default enabled in SignalK |
-| VE.Can 2 | can1 | Non-isolated |
+| VE.Can 2 | vecan1 | Non-isolated |
 === Ekrano GX ===
 ^ Enclosure label ^ Interface ^ Notes ^
-| VE.Can 1 | vecan0 | Isolated |
+| VE.Can 1 | vecan0 | Isolated and default enabled in SignalK |
 | VE.Can 2 | vecan1 | Non-isolated |
-When using SignalK on Venus OS on an Ekrano, there is currently no port enabled for N2K traffic in the default configuration. Configure it manually instead, see here for more information: https://community.victronenergy.com/questions/263126/ekrano-gx-vs-signal-k-no-n2k-on-vecan-socket.html?childToView=263206#answer-263206.
 ==== 6.5 Signal K FAQ ====
@@ Line 607: / Line 659: @@
 ==== 8.1 Disk space issues / data partition full ====
-Using both Signal K Server, as well as Node-RED, it is quite easy to completely fill up the data partition. Which can cause all sorts of issues, like:
+Using both Signal K Server, as well as Node-RED, it is possible to completely fill up the data partition.
+The GX device will issue a warning, #46 Data partition full, as soon as the free space of the data partition is below 5%.
+To see the exact free space, go to Settings -> General -> Modifications.
+Having the data partition full will lead to unexpected results. The system is not built to be resilient for that. Some examples:
   - Venus OS itself no longer working correctly,
@@ Line 613: / Line 671: @@
   - Node-RED refuses to start,
   - and similar.
-Note that Venus OS itself does **not** show a notification or warning when the data disk is full. And know that the other disks are read-only unless remounted to read/write as per [[https://www.victronenergy.com/live/ccgx:root_access|these root access instructions]].
 Depending on what the issue is, there are a few things you can do:
+  - Remove all Node-RED flows and installed node palettes. See next chapter on how to do that.
+  - Remove all Signal K Server log files. In case you're using SignalK, then we recommend to try that option first. See next chapter on how to do that (requires a USB stick or SD Card), and once done make sure to double check you're Signal K log setup; Most importantly, make sure that the ''Keep only most recent data log files'' option is enabled. That feature is enabled by default, and can be found in the Signal K -> Server -> Settings section.
   - Do full GX factory reset, as per the instructions in the GX user manuals. This includes downloading a file called venus-data.tgz; see GX manual for details. Disadvantage is that you'll need to reconfigure the GX.
-  - Remove all Signal K Server log files. In case you're using SignalK, then we recommend to try that option first. See next chapter on how to do that (requires a USB stick or SD Card), and once done make sure to double check you're Signal K log setup; Most importantly, enable the ''Keep only most recent data log files'' option.
+  - A more detailed approach is logging into the SSH console, and checking for disk space:
-  - A more detailed approach is logging in on SSH, and checking for disk space:
 **Tips and tricks to login a diagnose disk space**
@@ Line 676: / Line 733: @@
   * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-00-backup-data-partition.tgz|venus-data-00-backup-data-partition.tgz]] - copies all that is on the ''/data'' partition onto the usb stick
-  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-20-signalk-reset.tgz|venus-data-20-signalk-reset.tgz]] - wipes everything from ''/data/conf/signalk/''
+  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-20-signalk-reset.tgz|venus-data-20-signalk-reset.tgz]] - removes all files and directories from ''/data/conf/signalk/'', which lets you start over again with SignalK.
-  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-30-signalk-delete-data-logs.tgz|venus-data-30-signalk-delete-data-logs.tgz]] - removes all SignalK loging
+  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-30-signalk-delete-data-logs.tgz|venus-data-30-signalk-delete-data-logs.tgz]] - removes only the SignalK log files
-  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-20-node-red-reset.tgz|venus-data-20-node-red-reset.tgz]] - wipes all in ''/data/home/nodered/''
+  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-20-node-red-reset.tgz|venus-data-20-node-red-reset.tgz]] - removes the files from ''/data/home/nodered/'', which lets you start with Node-RED from scratch.
 See [[https://www.victronenergy.com/live/ccgx:root_access#hooks_to_install_run_own_code_at_boot|here]] for more information on how this process works.