Victron Energy

User Tools

Site Tools

You are here: Documentation » Victron GX product range » Venus OS Large image: Signal K and Node-RED
venus-os:large

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
venus-os:large [2024-10-15 14:14] – [5.9. Node-RED FAQ] dfabervenus-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. 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: **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 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. 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. 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: 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. 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 === === How to update ===
Line 120: Line 121:
 ===== 5. Node-RED ===== ===== 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 ==== ==== 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.  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.  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/''.  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. 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 .  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]]. 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 === === 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. 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. 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}} {{ :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. 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. 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: 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)   * [[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. 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. 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' === === Q1: Write/read file gives "Error: EACCESS: permission denied' ===
Line 294: Line 302:
  
 === Q3: How can I password protect Node-RED / My Node-RED is password protected === === Q3: How can I password protect Node-RED / My Node-RED is password protected ===
 +
 +__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''.  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''. 
  
-For systems from before the security profile, 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 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? === === Q4: How do I restart Node-RED from the Venus GUI? ===
Line 518: Line 530:
  
 ^ Enclosure label ^ Interface ^ Notes ^ ^ 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 === === Ekrano GX ===
  
 ^ Enclosure label ^ Interface ^ Notes ^ ^ 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 | | VE.Can 2 | vecan1 | Non-isolated |
 ==== 6.5 Signal K FAQ ==== ==== 6.5 Signal K FAQ ====
Line 647: Line 659:
 ==== 8.1 Disk space issues / data partition full ==== ==== 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,   - Venus OS itself no longer working correctly,
Line 653: Line 671:
   - Node-RED refuses to start,   - Node-RED refuses to start,
   - and similar.   - 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: Depending on what the issue is, there are a few things you can do:
  
-  - 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 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.   - 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.
   - A more detailed approach is logging into the SSH console, and checking for disk space:   - A more detailed approach is logging into the SSH console, and checking for disk space:
  
Line 717: Line 734:
   * [[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-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]] - 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-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]] - removes the files from ''/data/home/nodered/'', which lets you start with Node-RED from scratch.   * [[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. 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.
venus-os/large.1728994459.txt.gz · Last modified: by dfaber
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki