venus-os:large
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
venus-os:large [2024-10-18 14:37] – [5.9. Node-RED FAQ] mvader | venus-os:large [2025-08-05 23:13] (current) – warwickchapman | ||
---|---|---|---|
Line 7: | Line 7: | ||
**Node-RED** offers PLC like programming for connecting hardware devices, APIs and online services. It provides a browser-based editor that makes it easy to wire together flows. With it, one can for example program a functionality such as activating a relay based on a temperature measurement combined with time. Or make far more complex algorithms, tying relays, measurements, | **Node-RED** offers PLC like programming for connecting hardware devices, APIs and online services. It provides a browser-based editor that makes it easy to wire together flows. With it, one can for example program a functionality such as activating a relay based on a temperature measurement combined with time. Or make far more complex algorithms, tying relays, measurements, | ||
- | Also Node-RED features a [[https:// | + | Also Node-RED features a [[https:// |
- | To get a good idea of its possibilities, | + | To get a good idea of its possibilities, |
**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 26: | Line 26: | ||
===== 2. Where to find support ===== | ===== 2. Where to find support ===== | ||
- | There is and will be no official support on the functionalities | + | Victron maintains |
- | For support, turn to the [[https:// | + | **Node-RED |
+ | The Victron Community is a good place to ask questions and get answers: | ||
+ | * [[https:// | ||
+ | * [[https:// | ||
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. | 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 | + | **Signal K community** |
+ | For support on Signal K, the largest crowd of helpful people can be found in the Signal K Discord & Signal K GitHub discussions forum. Both are best found here: https:// | ||
===== 3. Requirements ===== | ===== 3. Requirements ===== | ||
Line 38: | Line 43: | ||
The compatible GX devices are: | The compatible GX devices are: | ||
- | + | | |
- | | + | * Cerbo GX (second-fastest processor) |
- | * Cerbo GX | + | |
* Cerbo-S GX | * Cerbo-S GX | ||
- | * Venus GX | + | * Venus GX (slowest processor) |
* Octo GX | * Octo GX | ||
- | * MultiPlus-II GX | + | * MultiPlus-II GX (fastest processor) |
- | * EasySolar-II GX | + | * EasySolar-II GX (fastest processor) |
+ | The Color Control GX (CCGX) and the CanVU GX are not able to run Venus OS Large. | ||
- | The Color Control GX (CCGX) as well as the CanVU GX are unfortunately not able to run Venus OS Large. | + | Venus OS large is also available for certain RaspberryPi models. Installation files below, and installation & other RaspberryPi specific instructions [[https:// |
- | Venus OS large is also available for certain RaspberryPi models. Installation files below, and installation | + | ==== 3.2 CPU & memory resources ==== |
- | ==== 3.2 CPU & Memory resources ==== | + | Both Signal K as well as Node-RED are resource intensive software applications relative to the CPU and memory of most GX devices. |
- | Both SignalK as well as Node-RED | + | The level of intensity largely depends on the system' |
- | Ofcourse, how intensive depends on what kind of flows (node-red) or how many messages & handling of them (SignalK) happens in the system. | + | **WARNING: Venus GX** |
+ | The Venus GX is the slowest GX-device still supported by Victron. Running both Signal K and Node-RED at the same time will very likely overload the device and may result it in becoming unstable. | ||
- | From a GX device | + | If a GX-device |
+ | |||
+ | More details about CPU & RAM differences | ||
- | 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 and update ===== | ===== 3. How to install and update ===== | ||
Line 75: | Line 82: | ||
Note, when installing on a RaspberryPi, | Note, when installing on a RaspberryPi, | ||
- | === Step 2. Update to the latest firmware version | + | === Step 2. Update to the latest firmware version === |
- | See Settings -> Firmware -> Online updates. For more information, | + | See Settings -> General -> Firmware -> Online updates (previously, |
=== Step 3. Set the image type Venus OS Large === | === Step 3. Set the image type Venus OS Large === | ||
- | Go to Settings -> Firmware -> Online updates -> Image type: | + | In the Online updates |
+ | {{ :venus-os:venus-os_image_type_selector_v2.png? | ||
- | {{ : | + | Set the Image type to ' |
- | Now, change the Image type to Large. Then go one menu up, and Check for a new version and install that. | + | The firmware will take some time to download depending on the speed of your Internet connection, after which the GX-device will reboot |
- | === Step 3. Verify and enable === | + | === Step 4. Verify and enable === |
- | - Verify that the image was successfully installed: go to the Settings menu, and check that the Venus OS Large menu is available. | + | - 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 " | + | - Enable either Signal K or Node-RED. Installer access level is required to enable/ |
+ | |||
+ | Visible once successfully installed, the integration settings: | ||
+ | {{ : | ||
- | Visible once successfully installed, the Venus OS Large menu: | ||
- | {{ : | ||
=== How to update === | === How to update === | ||
- | Both online and offline update methods can be used. The Image type setting, see the How to install chapter, defines what image type is being updated. See the GX manual for more details. | + | Both online and offline update methods can be used. The Image type setting, see the How to install chapter, defines what image type is being updated. See the manual |
===== 4. Accessing Node-RED and Signal K ====== | ===== 4. Accessing Node-RED and Signal K ====== | ||
- | After installing and then enabling | + | After installing and enabling |
- | To access the Node-RED flow editor, type https:// | + | To access the Node-RED flow editor, type https:// |
- | + | ||
- | See [[https:// | + | |
- | + | ||
- | To access the Signal K admin panel, type http:// | + | |
- | + | ||
- | These two screenshots show what you will see after successfully accessing the pages: | + | |
=== Node-RED flow editor === | === Node-RED flow editor === | ||
{{ : | {{ : | ||
+ | |||
+ | To access the Signal K admin panel, type http:// | ||
=== Signal K admin panel === | === Signal K admin panel === | ||
{{ : | {{ : | ||
+ | |||
+ | See [[https:// | ||
===== 5. Node-RED ===== | ===== 5. Node-RED ===== | ||
- | {{:venus-os:node-palette.png? | + | {{ https:// |
==== 5.1 Introduction ==== | ==== 5.1 Introduction ==== | ||
Node-RED is a tool for connecting hardware devices, APIs and online services in new and interesting ways. It provides a browser-based editor that makes it easy to wire together flows. With it, one can for example program a functionality such as activating a relay based on a temperature measurement. Or make far more complex algorithms, tying relays, measurements, | Node-RED is a tool for connecting hardware devices, APIs and online services in new and interesting ways. It provides a browser-based editor that makes it easy to wire together flows. With it, one can for example program a functionality such as activating a relay based on a temperature measurement. Or make far more complex algorithms, tying relays, measurements, | ||
- | Also Node-RED features a [[https:// | + | Also Node-RED features a [[https:// |
A good tutorial on how to work with Node-RED is here: https:// | A good tutorial on how to work with Node-RED is here: https:// | ||
Line 150: | Line 159: | ||
For developers: source code for the node-red-contrib-victron modules is [[https:// | For developers: source code for the node-red-contrib-victron modules is [[https:// | ||
+ | ==== 5.4 Examples ==== | ||
- | ==== 5.2 Back-up and restore ==== | + | 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. |
+ | |||
+ | {{ : | ||
+ | |||
+ | To see the examples when you don't have access to a Node-RED installation and flow-editor, | ||
+ | |||
+ | ==== 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 "// | 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 "// | ||
Line 161: | Line 177: | ||
Do note that the above instruction only makes a backup of your flows, not of the Node-RED configuration. The configuration is stored in '' | Do note that the above instruction only makes a backup of your flows, not of the Node-RED configuration. The configuration is stored in '' | ||
- | ==== 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 199: | ||
Make sure that there is always 30MB of free space remaining on the data partition. One of the [[https:// | Make sure that there is always 30MB of free space remaining on the data partition. One of the [[https:// | ||
- | ==== 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:// | 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:// | ||
Line 218: | Line 234: | ||
=== 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' | 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' | ||
- | ==== 5.5 Node-RED Dashboard ==== | + | ==== 5.8 Node-RED Dashboard ==== |
Besides the flow and automation functionally, | Besides the flow and automation functionally, | ||
Line 231: | Line 247: | ||
{{ : | {{ : | ||
- | ==== 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 266: | ||
For more information on such Node-RED configuration customisations, | For more information on such Node-RED configuration customisations, | ||
- | ==== 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 272: | ||
* [[https:// | * [[https:// | ||
- | ==== 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 297: | ||
The [[https:// | The [[https:// | ||
- | ==== 5.9. Node-RED FAQ ==== | + | ==== 5.12 Node-RED FAQ ==== |
=== Q1: Write/read file gives " | === Q1: Write/read file gives " | ||
Line 358: | Line 374: | ||
=== Q11: Is there a way to have the context survive reboots? === | === Q11: Is there a way to have the context survive reboots? === | ||
- | By default the context is stored in memory of the GX device only. If the GX device | + | By default the context is stored in RAM memory of the GX device only. When the GX device |
- | content of the memory gets reset and you loose the context information. | + | |
In order to keep the context data, it is needed to [[https:// | In order to keep the context data, it is needed to [[https:// | ||
Line 374: | Line 389: | ||
} | } | ||
| | ||
- | With the above settings, context files will get created periodically in ''/ | + | With the above settings, context files will get created periodically in ''/ |
===== 6. Signal K ===== | ===== 6. Signal K ===== | ||
Line 522: | Line 537: | ||
^ Enclosure label ^ Interface ^ Notes ^ | ^ Enclosure label ^ Interface ^ Notes ^ | ||
- | | VE.Can 1 | can0 | Isolated and default enabled in SignalK | | + | | VE.Can 1 | vecan0 |
- | | VE.Can 2 | can1 | Non-isolated | | + | | VE.Can 2 | vecan1 |
=== Ekrano GX === | === Ekrano GX === | ||
^ Enclosure label ^ Interface ^ Notes ^ | ^ Enclosure label ^ Interface ^ Notes ^ | ||
- | | VE.Can 1 | vecan0 | Isolated | | + | | VE.Can 1 | vecan0 | Isolated |
| VE.Can 2 | vecan1 | Non-isolated | | | VE.Can 2 | vecan1 | Non-isolated | | ||
==== 6.5 Signal K FAQ ==== | ==== 6.5 Signal K FAQ ==== | ||
Line 651: | Line 666: | ||
==== 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. | + | Using both Signal K Server, as well as Node-RED, it is possible |
+ | |||
+ | 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 657: | Line 678: | ||
- 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:// | ||
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, | - 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, | ||
+ | - Do full GX factory reset, as per the instructions in the GX user manuals. This includes downloading a file called venus-data.tgz; | ||
- 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 721: | Line 741: | ||
* [[https:// | * [[https:// | ||
* [[https:// | * [[https:// | ||
- | * [[https:// | + | * [[https:// |
* [[https:// | * [[https:// | ||
See [[https:// | See [[https:// |
venus-os/large.1729255068.txt.gz · Last modified: by mvader