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 [2021-02-07 12:45] – [2. Where to find support] mvader | venus-os:large [2024-10-18 14:37] (current) – [5.9. Node-RED FAQ] mvader | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Venus OS Large image: Signal K and Node-RED ====== | ====== Venus OS Large image: Signal K and Node-RED ====== | ||
+ | ===== 1. Introduction ===== | ||
- | (DRAFT - THIS DOCUMENT IS ABOUT NOT YET COMPLETELY FINISHED FUNCTIONALITY) | ||
- | ===== 1. Introduction ===== | + | This manual documents Venus OS Large. Venus OS is the the software running on our [[https:// |
- | ==== 1.1 Venus OS Large, Node-RED and Signal K server? ==== | + | **Node-RED** |
- | This manual documents Venus OS Large, an extended build of Venus OS, that adds [[https:// | + | |
- | + | ||
- | **Node-RED** | + | |
Also Node-RED features a [[https:// | Also Node-RED features a [[https:// | ||
+ | To get a good idea of its possibilities, | ||
- | **Signal K server** | + | **Signal K server** Signal K Server is a server application |
- | ==== 1.2 Status | + | - WiFi navigation and AIS data server to charting apps such as iSailor, Navionics, iNavX, Aqua Map. |
+ | - The perfect Anchor alarm, for features | ||
+ | - Automatic log book | ||
+ | - Serve full featured marine instrumentation package such as the iOS [[https:// | ||
- | Currently, these images are available as beta versions. They work well, several users are using this without any issues; and are super happy with the provided functionality. | + | The [[https:// |
- | The remaining work are mostly small improvements, clean ups and testing. | + | For more information on Signal K on Venus OS, see below chapter. |
- | There will be two flavours of Venus OS to install: | ||
- | - the normal one as we've been building for years now. With all normal & supported functionality. | ||
- | - the large flavour. All the same as the normal one, but with addition of Signal K & Node-RED. | ||
- | Switching between them will be easy: a simple switch in the gui. Updating will be easy as well, the online updates will work, just like they do now for the normal images. | + | ===== 2. Where to find support ===== |
- | For now not that easy yet: installing and updating | + | There is and will be no official support on the functionalities of Venus OS large. |
- | Why not keep it all in one like it has been until now? To save download and install time for the (vast majority) of users that will not use these features. These new features increase the download (& installed) size enormously, and also they are really cool; but do not fall within normal Victron support. Which is why we want to keep them separate. | + | 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]]. |
- | + | ||
- | More details of the development status here: | + | |
- | + | ||
- | * https://github.com/victronenergy/venus/issues/ | + | |
- | * https://github.com/SignalK/signalk-server-node/ | + | |
- | + | ||
- | ===== 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:// | + | 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:// | For support on SignalK, there is a #victron channel in [[http:// | ||
Line 48: | Line 39: | ||
The compatible GX devices are: | The compatible GX devices are: | ||
+ | * Ekrano GX | ||
* Cerbo GX | * Cerbo GX | ||
+ | * Cerbo-S GX | ||
* Venus GX | * Venus GX | ||
* Octo GX | * Octo GX | ||
Line 55: | Line 48: | ||
- | The CCGX and CanVU GX are unfortunately 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 & other raspberrypi specific instructions [[https:// | ||
Line 61: | Line 54: | ||
==== 3.2 CPU & Memory resources ==== | ==== 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. | + | 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. | Ofcourse, how intensive depends on what kind of flows (node-red) or how many messages & handling of them (SignalK) happens in the system. | ||
Line 69: | Line 62: | ||
When running out of RAM or CPU, the device will slow down. And eventually also reboot by itself due to the watchdog. | 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 |
=== Step 1. Preparations === | === Step 1. Preparations === | ||
* __Cerbo GX__ - No preparations required. | * __Cerbo GX__ - No preparations required. | ||
- | * __Venus GX__ - In case your Venus GX has a serial number below HQ1842, perform | + | * __Venus GX__ - First install & boot v2.73,or a later version. And only thereafter install Venus OS Large. The reason for this is to make sure the partitioning of the flash is per requirements of Venus OS Large. |
* __MultiPlus-II GX__ - No preparations required. | * __MultiPlus-II GX__ - No preparations required. | ||
* __EasySolar-II GX__ - No preparations required. | * __EasySolar-II GX__ - No preparations required. | ||
- | * __RaspberryPi 3__ - Unfortunately, | + | * __RaspberryPi 3__ - No preparations required. |
* __RaspberryPi 4__ - No preparations required. | * __RaspberryPi 4__ - No preparations required. | ||
Note, when installing on a RaspberryPi, | Note, when installing on a RaspberryPi, | ||
- | === Step 2. Download | + | === Step 2. Update to the latest firmware version (v2.90 or later) |
- | Download the right file from [[https:// | + | See Settings -> Firmware -> Online updates. For more information, |
- | ^ Which file to use? ^^ | + | === Step 3. Set the image type Venus OS Large === |
- | | Cerbo GX | venus-swu-einstein...swu | | + | |
- | | Venus GX | venus-swu-beaglebone...swu | + | |
- | | MultiPlus-II GX | venus-swu-nanopi...swu | + | |
- | | EasySolar-II GX | venus-swu-nanopi...swu | + | |
- | | RaspberryPi3 | + | |
- | | RaspberryPi4 | + | |
- | The change-log is embedded in the (rather long) [[https:// | + | Go to Settings |
- | === Step 3. Install the file === | + | {{ : |
+ | |||
+ | Now, change the Image type to Large. Then go one menu up, and Check for a new version and install that. | ||
+ | |||
+ | === Step 3. Verify and enable | ||
- | - Disable Auto updates. See Settings -> Firmware -> Online updates in Remote Console. | ||
- | - Install the downloaded file using the [[ccgx: | ||
- 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 the Venus OS Large menu is available. | ||
- | - 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. Note that though its possible to enable both, doing that on a Venus GX is " |
Visible once successfully installed, the Venus OS Large menu: | Visible once successfully installed, the Venus OS Large menu: | ||
- | {{ : | + | {{ : |
- | ===== 4. Node-RED ===== | + | === 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. | ||
+ | ===== 4. Accessing Node-RED and Signal K ====== | ||
- | ==== 4.1 Introduction ==== | + | After installing and then enabling either one or both of the features, they need to be configured through a website in your browser. |
+ | |||
+ | 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 | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | === Signal K admin panel === | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ===== 5. Node-RED ===== | ||
+ | |||
+ | {{: | ||
+ | ==== 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, | ||
Line 115: | Line 127: | ||
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:// |
- | The Node-RED editor is at http:// | + | ==== 5.2 Three part introductory webinar ==== |
- | The username | + | This is a 3 part introductory webinar on Node-RED and Venus available at the Victron Tech YouTube channel: |
- | ==== 4.2 Installing extra nodes ==== | + | |
+ | [[https:// | ||
+ | | ||
+ | [[https:// | ||
+ | | ||
+ | [[https:// | ||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | The Node-RED editor can be accessed from your LAN at https:// | ||
+ | |||
+ | ==== 5.3 Node specifications ==== | ||
+ | |||
+ | Node-RED comes with a core set of useful nodes, and within | ||
+ | |||
+ | For developers: source code for the node-red-contrib-victron modules is [[https:// | ||
+ | |||
+ | |||
+ | ==== 5.2 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 "// | ||
+ | |||
+ | On a fresh installation you can then use the " | ||
+ | |||
+ | It is always wise to create an extra backup before performing an update of the firmware. | ||
+ | |||
+ | 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 ==== | ||
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. | ||
- | For example nodes that give access to weather data, or with timer functionality, | + | For example nodes that give access to weather data, or with timer functionality, |
You can search for available nodes in the Node-RED library. | You can search for available nodes in the Node-RED library. | ||
Line 138: | Line 179: | ||
Refer to the remove button in the palette manager to remove self-installed palettes. | Refer to the remove button in the palette manager to remove self-installed palettes. | ||
- | When installing a newer version of a palette than what is pre-installed in Venus OS, node-red will use that newer version. | + | When installing a newer version of a palette than what is pre-installed in Venus OS, Node-RED will use that newer version. |
- | Make sure that there is always 30MB of free space remaining on the data partition. | + | Make sure that there is always 30MB of free space remaining on the data partition. |
- | ==== 4.3 Controlling relays ==== | + | ==== 5.4 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:// | ||
+ | |||
+ | ;#; | ||
+ | {{: | ||
+ | ;#; | ||
=== GX Device relays === | === GX Device relays === | ||
Line 151: | Line 198: | ||
;#; | ;#; | ||
- | === BMV Relay === | + | === Battery Monitor |
- | The relay in a BMV can be controlled. Make sure to set its option in the BMV configuration to REM, which is short for Remote Controlled. | + | The relay in a BMV can be controlled. Make sure to set, using VictronConnect, |
- | === MPPT Relay === | + | The relay in a Lynx Shunt VE.Can can be controlled. Make sure to set the relay function to " |
- | Currently it is not possible | + | |
+ | The Relay in the Lynx Smart BMS is not available for control via Node-RED. | ||
+ | |||
+ | === SolarCharger | ||
+ | In order to switch | ||
Note that only the larger model solar chargers feature a relay. | Note that only the larger model solar chargers feature a relay. | ||
- | === 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. | ||
- | ==== 4.4 Node-RED Dashboard ==== | + | === (VE.Bus connected-) Multi, Quattro and similar product relays === |
+ | Its not possible to control the alarm relay nor the AC-out 2 contactor of our inverter/ | ||
+ | |||
+ | === RS series (inverter, multi) relays === | ||
+ | First set the relay to //manual control// using VictronConnect. Once that has been done, the relay can be controlled using Node-RED. | ||
+ | |||
+ | === 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' | ||
+ | ==== 5.5 Node-RED Dashboard ==== | ||
Besides the flow and automation functionally, | Besides the flow and automation functionally, | ||
Line 167: | Line 224: | ||
It is viewable in a web browser - both locally as well as remote, via the VRM Servers. See chapter 6.2 for how to see it remotely. | It is viewable in a web browser - both locally as well as remote, via the VRM Servers. See chapter 6.2 for how to see it remotely. | ||
- | The dashboard needs to be installed, just like other extra palettes, using the Manage Palette feature. | + | The [[https:// |
+ | |||
+ | Once that is done, you can find the nodes in the palettes on the left. Once the dashboard has been configured and deployed, an extra tile will appear in the //Venus OS Large// menu on VRM, allowing to connect to the dashboard via VRM. | ||
Example dashboard: | Example dashboard: | ||
{{ : | {{ : | ||
- | ===== 5. Signal K ===== | + | ==== 5.6 Configuration files ==== |
- | ==== 5.1 Introduction ==== | + | 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. |
+ | |||
+ | The information here provided is for the benefit of the (few) users that do need or want to change them. | ||
+ | |||
+ | On startup of Node-RED on Venus reads three settings files. | ||
+ | - ''/ | ||
+ | - ''/ | ||
+ | - ''/ | ||
+ | When using these files, make sure that the configuration is enclosed within a '' | ||
+ | |||
+ | There are more configuration files in ''/ | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | For more information on such Node-RED configuration customisations, | ||
+ | |||
+ | ==== 5.7. Ready-to-use solutions ==== | ||
+ | |||
+ | Node-RED can also be used for doing more advanced tasks. Some examples of ready-to-use solutions are: | ||
+ | * [[https:// | ||
+ | * [[https:// | ||
+ | |||
+ | ==== 5.8. 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. | ||
+ | |||
+ | To access data from the VRM API, a VRM access token is needed. This is done by going to the [[https:// | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Thereafter, that token can be used to retrieve data from the VRM Portal API. | ||
+ | |||
+ | Full portal API documentation is here: https:// | ||
+ | |||
+ | To, for example, retrieve Solar Irradiation forecasts, see the [[https:// | ||
+ | |||
+ | 1221 vrm_pv_inverter_yield_fc 7 PV Inverter - Yield Forecast | ||
+ | 1220 vrm_pv_charger_yield_fc 4 Solar Charger - Yield Forecast | ||
+ | 1173 vrm_solar_irradiance_fc 0 Solar Irradiance Forecast | ||
+ | 1172 vrm_solar_irradiance 0 Solar Irradiance | ||
+ | |||
+ | Note that there could be more relevant attributes, see VRM documentation for that. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | The [[https:// | ||
+ | |||
+ | ==== 5.9. Node-RED FAQ ==== | ||
+ | |||
+ | === Q1: Write/read file gives " | ||
+ | |||
+ | Since Venus OS 2.90 and on wards, Node-RED no longer runs as user '' | ||
+ | |||
+ | === Q2: How can I update the Victron node pallette === | ||
+ | |||
+ | As that pallette is part of the total Venus OS large package, it can only be updated by installing a newer Venus OS large version. | ||
+ | |||
+ | 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 / 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 " | ||
+ | |||
+ | __ Venus OS versions prior to v3.50__ | ||
+ | |||
+ | The Node-RED' | ||
+ | |||
+ | === Q4: How do I restart Node-RED from the Venus GUI? === | ||
+ | |||
+ | In order to restart Node-RED you need to disable and enable it from the menu. You can find this under //Venus OS Large Features -> Node-RED// | ||
+ | |||
+ | === Q5: How does safe mode work and what is it? === | ||
+ | |||
+ | From the Venus GUI you can select Node-RED to be enabled in "safe mode". This means that Node-RED will start without starting the flows. This allows you to open the flows in the editor and make changes without the flows running. When you deploy your changes, the flows are then started. The safe mode can be handy if one of the flows has an error that causes high CPU loads on the Venus device or other issues. | ||
+ | |||
+ | === Q6: Can I install the @signalk/ | ||
+ | |||
+ | No, at least not into the node-red instance which comes as part of Venus OS Large. To @signalk/ | ||
+ | |||
+ | - enable Node-RED in the SignalK server, using its dashboard. | ||
+ | - disable the Venus OS Node-RED, in GX Device -> Settings -> Venus OS Large -> Node-RED | ||
+ | - install the Victron pallette into the Node-RED thats part of SignalK server | ||
+ | |||
+ | === Q7: I get the error: Failed to remove, unrecognised module === | ||
+ | |||
+ | This is seen when trying to remove a module that has been previously uninstalled, | ||
+ | - Determine the name and version of the complaining package. This information can be found in the pallete manager. | ||
+ | - Stop Node-RED (can be done via the remote console) | ||
+ | - Create a backup of your '' | ||
+ | - Edit the ''/ | ||
+ | - Add the complaining module and version to the '' | ||
+ | - Start Node-RED | ||
+ | |||
+ | After following these steps Node-RED should know about the module again and you should be able to remove or upgrade it. | ||
+ | |||
+ | === Q8: The browser complains about non private connection === | ||
+ | |||
+ | Node-RED on Venus now uses SSL for its connection. As the certificate is signed by a "self signed certificate", | ||
+ | |||
+ | Another implication might be that you need to prepend the connection with '' | ||
+ | |||
+ | Finally, if you want to use the Node-RED command line interface for administration, | ||
+ | |||
+ | export NODE_EXTRA_CA_CERTS=/ | ||
+ | |||
+ | === Q9: How often do the Victron input nodes send a msg? === | ||
+ | |||
+ | The input nodes send out a message on each value change. If the ‘//only changes// | ||
+ | |||
+ | === Q10: How can I get Node-RED to also listen to http port 1880 === | ||
+ | |||
+ | There are some nodes that are only able to connect to a http site. In that case you probably also want to enable http on port 1880. This can be achieved by creating (or adding to) a user configuration file ''/ | ||
+ | |||
+ | module.exports = { | ||
+ | /* Make sure that we also listen on port 1880 on all interfaces */ | ||
+ | | ||
+ | } | ||
+ | |||
+ | And restart Node-RED. | ||
+ | |||
+ | === 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 gets rebooted, the | ||
+ | content of the memory gets reset and you loose the context information. | ||
+ | |||
+ | In order to keep the context data, it is needed to [[https:// | ||
+ | |||
+ | module.exports = { | ||
+ | contextStorage: | ||
+ | default: { | ||
+ | module: " | ||
+ | config: { | ||
+ | flushInterval: | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | With the above settings, context files will get created periodically in ''/ | ||
+ | ===== 6. Signal K ===== | ||
+ | |||
+ | ==== 6.1 Introduction ==== | ||
- | === 5.1.1 Why have Signal K on your GX Device? === | + | === 6.1.1 Why have Signal K on your GX Device? === |
- | By adding Signal K, the GX device becomes a data hub for all marine electronics on your yacht. For example | + | By adding Signal K, the GX device becomes a data hub for all marine electronics on your yacht. For example |
Also, there are SignalK plugins to forward the data to influxdb & Grafana. | Also, there are SignalK plugins to forward the data to influxdb & Grafana. | ||
Line 184: | Line 387: | ||
Popular Apps compatible with Signal K: | Popular Apps compatible with Signal K: | ||
+ | * Auqua Map | ||
+ | * iNavX | ||
+ | * iSailor | ||
+ | * Navionics | ||
* [[https:// | * [[https:// | ||
* ... (welcome to add more here) | * ... (welcome to add more here) | ||
- | === 5.1.2 Instruments compatible with Signal K === | + | === 6.1.2 Instruments compatible with Signal K === |
* All Victron products that can be connected to a GX device | * All Victron products that can be connected to a GX device | ||
Line 197: | Line 404: | ||
- | === 5.1.3 What is Signal K ? === | + | === 6.1.3 What is Signal K ? === |
Signalk-server is a software application that, in the context of this manual, runs on your GX Device and interface to all Victron protocols and more. It uses plugins, and there is a large community of enthusiasts around it, making it one of the most flexible and complete pieces of software that understands the plethora of protocols of all different manufacturers that make marine electronics. | Signalk-server is a software application that, in the context of this manual, runs on your GX Device and interface to all Victron protocols and more. It uses plugins, and there is a large community of enthusiasts around it, making it one of the most flexible and complete pieces of software that understands the plethora of protocols of all different manufacturers that make marine electronics. | ||
- | For more information on Signal K, read [[http://signalk.org/overview.html|the Signal K website]]. And our blog post of a while ago. | + | For more information on Signal K, read the [[https://github.com/SignalK/ |
Note that Signal K is not a Victron project. At Victron, we are great fans of sailing, open source as well as community driven projects. And Signal K is a perfect example of such project. And when running on a GX Device its a perfect marriage. | Note that Signal K is not a Victron project. At Victron, we are great fans of sailing, open source as well as community driven projects. And Signal K is a perfect example of such project. And when running on a GX Device its a perfect marriage. | ||
- | === 5.1.4 Signal K - the data format | + | === 6.1.3 Considerations on how to install |
- | Strictly speaking, Signal K is not software but a data format. And Signalk-server is the name of the software. | + | The type of install described in this document, running Venus OS including SignalK, has these advantages: no need to use a rapsberrypi, |
- | This section explains | + | The other common type of Signal K Server install, installed on a RaspberryPi running Raspbian, has the advantages of more flexibility, |
- | Signal K is a modern and open data format | + | There is no one right way for everyone to do this; the best solution will depend on the requirement. |
- | - create a shared data model for marine related data | + | For raspberrypi owners, note that its very easy to try both methods |
- | - make marine related data easy to access, handle | + | |
- | The shared data model allows you to handle the data in a uniform way independent of how the data is produced. In practice this means that you can refer to your battery voltage with `electrical/ | + | ==== 6.2 Documentation |
- | Easy access means that you can use modern standards like HTTP, WebSockets and JSON that are in widespread. There is a wealth of knowledge and skilled people are easy to find, with no special | + | * [[https:// |
+ | * [[https:// | ||
+ | * [[https:// | ||
- | In Venus OS it brings all the data available in the GX system, including NMEA 2000 data, to a single data model and programming interface. | + | Do not contact normal Victron support for any help on SignalK. Its based on community support, not official support. |
- | === 5.1.3 Considerations on how to install Signal K === | ||
- | The type of install described in this document, running Venus OS including SignalK, has these advantages: TODO elaborate. Doing this was born out of a wish to make SignalK more mainstream, less of a rapsberrypi / hobbieists/ | + | ==== 6.3 First use & configuring ==== |
- | The other common type of SignalK install, installed on a RaspberryPi running Raspbian, has the advantages of more flexibility, | + | Follow these steps to turn your GX into a NMEA to WiFi gateway within 5 minutes. |
- | There is no one right way for everyone to do this; the best solution will depend on the requirement. | + | 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 === | ||
- | For raspberrypi owners, note that its very easy to try both methods | + | Open a web browser, and go to the Signal K admin page by navigating to http:// |
- | ==== 5.2 Where to find support? ==== | + | {{ : |
- | As above already introduced, use [[https:// | + | === Step 2. Set the admin password |
- | Do not contact normal Victron support | + | Go to Security -> Users and create an admin user for Signal K and protect it with a secure password. |
- | ==== 5.3 Signal K details ==== | + | {{ : |
- | TODO: remove these versions, and replace by a link to the change-log. | + | === Step 3. Vessel information === |
- | And instead add information | + | Go to Settings and enter some basic information |
- | | + | {{ :venus-os:img_9926.png |}} |
- | - Victron Venus Plugin, v1.22.0 | + | |
- | ==== 5.4 First use & configuring ==== | + | === Step 4. NMEA2000 Can-bus connection |
- | === Step 1. Opening | + | For NMEA2000 networks, its recommended to have all connected devices use isolated connections. Therefore, when connecting |
- | Open a web browser, and go to the SignalK Dashboard by navigating to http:// | + | Signal K is preconfigured |
- | Further documentation about that is ... (some link to signalk-node documentation? | + | Here is how you can see the preconfigured connection in the Signal K Dashboard: |
- | === Step 2. Configure serial connections === | + | ;#; |
+ | {{: | ||
+ | ;#; | ||
- | Use this to, for example, configure | + | Note that, to keep that operational, that port must remain configured as a 250kbit VE.Can & NMEA2000 port in the Remote Console: |
- | Make sure to not add a connection using any of the built-in serial ports (/ | + | ;#; |
+ | {{: | ||
+ | ;#; | ||
+ | |||
+ | For more information on CAN-busses, see chapter 6.4. | ||
+ | |||
+ | === Step 5. Optional: Configure NMEA0183 serial connections === | ||
+ | |||
+ | 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 (/ | ||
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. | 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 3. Configure can-bus connections | + | === Step 6. Verify received data === |
- | For the Venus GX, SignalK comes pre-configured with a NMEA2000 listener for the VE.Can ports, its named " | + | 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 === | ||
- | Note that, to keep that operational, | + | 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:// | ||
+ | * Automatic log book & trip recording: https:// | ||
+ | ==== 6.4 CAN-bus ports ==== | ||
+ | |||
+ | Below lists documents the mapping from physical ports on the device to the interface within Venus OS. This information is needed when you want to deviate from the standard configuration. | ||
+ | |||
+ | === Cerbo GX === | ||
+ | |||
+ | ^ Enclosure label ^ Interface ^ Notes ^ | ||
+ | | VE.Can 1 | can0 | Non-isolated and default enabled in SignalK | | ||
+ | | BMS-Can | can1 | Non-isolated, | ||
+ | |||
+ | Within the Victron product range, CAN-bus ports that are labelled BMS-Can are limited in their functionality due to hardware constraints. Their only use is to connect to a managed battery such as BYD and Pylontech, used in landbased ESS & Off-grid systems - not in the marine market. | ||
+ | === Cerbo GX MK2 === | ||
- | === Step 4. Adding Signalk Plugins or Webapps === | + | ^ Enclosure label ^ Interface ^ Notes ^ |
+ | | VE.Can 1 | can0 | Isolated and default enabled in SignalK | | ||
+ | | VE.Can 2 | can1 | Non-isolated | | ||
- | 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:// | + | === Ekrano GX === |
- | ==== 5.5 Signal K FAQ ==== | + | ^ Enclosure label ^ Interface ^ Notes ^ |
+ | | VE.Can 1 | vecan0 | Isolated | | ||
+ | | VE.Can 2 | vecan1 | Non-isolated | | ||
+ | ==== 6.5 Signal K FAQ ==== | ||
- | === Q1 How to best handle & install a GPS === | + | === Q1 - How to best handle & install a GPS === |
You want the data available in SignalK and in Venus OS, so that it gets to VRM. And preferably a quality GPS. | You want the data available in SignalK and in Venus OS, so that it gets to VRM. And preferably a quality GPS. | ||
Line 309: | Line 556: | ||
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:// | ||
- | === Step by step instructions | + | === Q2 - What happens when I updated a pre-installed Plugin? |
- | * **Step 1.** Log into/open the regular VRM ' | + | |
- | {{ : | + | |
- | * **Step 2.** Modify the URL to include | + | A few plugins are installed by default on Venus OS Large. These include |
- | As an example: **https:// | + | |
- | {{ : | + | |
- | * **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 | + | When a newer version of such plugin is available, it is still possible to install |
- | {{ :venus-os: | + | |
- | {{ : | + | |
- | * **Step 4.** The Node-RED flow editor or Signal K interface screen | + | The newer version of the plugin gets installed onto the data partition. And Signal K server |
- | {{ : | + | |
- | ==== 6.2 Node-RED Dashboard/ | + | WARNING: above also means that once Venus OS ships with a newer version of the plugin than the version installed manually, Signal K Server will keep using that older one. To get out of such situation, remove the plugin by using the Appstore |
- | It it also possible to access | + | |
- | === Step by step instructions === | + | Note that the same icon is also available for the pre-installed plugins. Pressing it does nothing |
- | * **Step 1.** Install | + | |
- | * **Step 2.** Follow steps #1 to 4 in section 6.1 above in order to ' | + | === Q3 - Can I update signalk-server? |
- | * **Step 3.** The ' | + | Signal K Server comes preinstalled with Venus OS. And except by " |
- | As an example: **https:// | + | |
- | {{ : | + | |
- | * **Step 4.** The Node-RED dashboard/ | + | The normal |
- | {{ :venus-os: | + | |
- | ===== Appendix A - Repartitioning Venus GX flash memory ===== | + | In case you can’t wait, and don’t mind the extra work as well as risks, here is how to update it yourself. |
- | The Venus GX has sufficient flash memory to run the Venus OS Large image. But up until end of 2018 it was produced with a partition layout | + | Be warned, this method might or might not remain working |
- | Perform this procedure only when connected via Ethernet port. | + | Note that all changes made to the rootfs will be overwritten the next time you do a Venus OS update. |
- | 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. | + | Step 1: Get yourself [[https:// |
- | **WARNING**: this procedure | + | Step 2: Follow |
- | It is impossible to brick the device using this procedure. Its always possible | + | < |
+ | ## Change | ||
+ | ## to use the complete partition. | ||
+ | / | ||
- | Venus GX-es with serial number HQ1842xxxxx | + | ## Backup a file you'll need to restore later |
+ | # dev-tip: a list of especially installed files on a Victron install is here: | ||
+ | # https:// | ||
+ | # in that folder, open the .bb file and read the do_install function | ||
+ | cp / | ||
- | === Requirements === | + | ## See version as well as install location for signalk-server |
+ | npm list -g | ||
- | * An SD Card | + | # output will be something like this: |
- | * Computer skills | + | # /usr/lib |
+ | # ├── @victronenergy/ | ||
+ | # ├── corepack@0.17.0 | ||
+ | # ├── node-red@3.1.0 | ||
+ | # ├── npm@9.5.1 | ||
+ | # └── signalk-server@1.46.3 | ||
- | Note that a USB stick will not work. Installer images can only be ran using an SD Card. | + | ## Stop signalk-server |
+ | svc -d / | ||
- | === Step A. Enable and obtain root access === | + | ## Update to a newer version, here is how to update to last released version: |
+ | npm install -g signalk-server | ||
- | See [[https://www.victronenergy.com/ | + | # And to update to a more specific version, do something similar to this: |
+ | # npm install -g signalk-server@2.3.0-beta.2 | ||
- | === Step B. Secure factory files === | + | # Output will be something like this: |
+ | # added 120 packages, removed 179 packages, and changed 586 packages in 6m | ||
+ | # | ||
+ | # 57 packages are looking for funding | ||
+ | # run `npm fund` for details | ||
- | Copy below four files to your computer. | + | ## Restore that file |
+ | mv / | ||
- | * /data/venus/serial-number | + | ## Install the signalk-venus-plugin in same place where it normally is on Venus OS |
- | | + | cd /usr/lib/ |
- | * /data/venus/part-number | + | npm install signalk-venus-plugin |
- | * / | + | |
- | Below commandline instructions show how to do that on linux from the commandline. For Windows try Mobaxterm, or WinSCP. Putty won't work, its not for transferring files. There is Putty SCP (PSCP), as well, but then you need to know how to handle the commandline in Windows. We recommend using the other two. | + | ## If you want, see updated version: |
+ | npm list -g | ||
- | Procedure on Linux: | + | # output will be similar as above, but then with newer version |
- | < | + | ## start signalk-server again, and see log output: |
- | mkdir my-temp | + | svc -u / |
- | cd my-temp | + | |
- | mkdir conf | + | ## press CTRL-C to stop seeing the log. signalk-server will keep running in the background. |
- | mkdir venus | + | |
- | scp " | + | |
- | scp " | + | |
</ | </ | ||
+ | ===== 7. Remote access via VRM ===== | ||
- | === Background information on the factory files === | + | The three available web interfaces, |
- | The first two are needed for the built-in accesspoint to work. Without | + | After enabling |
- | Third file is not used anywhere (at this moment), but easy enough to recreate by hand as well. | + | {{ : |
- | Fourth file: without it the system won't be able to send data to VRM anymore. Either make sure to keep that file, or after having booted the new version, go to the VRM Portal, Settings -> General. And scroll to the bottom. There will be an option to reset the token. This option is only visible after the portal has received data from the reflashed device. | + | ===== 8. Troubleshooting ===== |
- | === Step C. Run the installer image === | + | ==== 8.1 Disk space issues / data partition full ==== |
- | First, download | + | 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: |
- | Then, write it to an sdcard (tip: use BalenaEtcher, see Google) | + | - Venus OS itself no longer working correctly, |
+ | - Signal K Server refuses | ||
+ | - Node-RED refuses to start, | ||
+ | - and similar. | ||
- | Finally, run the installer by inserting | + | 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:// |
- | There is a bi-color LED on the other side of the same long green connector, indicating the status: | + | Depending |
- | | + | |
- | | + | |
- | * green on, done | + | |
- | | + | |
- | Side info: see here for more details on installing an image. | + | **Tips and tricks to login a diagnose disk space** |
- | Once done, reboot the device. | + | Require root access: https:// |
- | 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 | + | The '' |
- | 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 | + | < |
- | * 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. | + | root@einstein:/ |
+ | Filesystem | ||
+ | / | ||
+ | devtmpfs | ||
+ | tmpfs | ||
+ | tmpfs | ||
+ | / | ||
+ | tmpfs | ||
+ | overlay | ||
+ | </ | ||
- | === Step D. Restore | + | The '' |
- | + | ||
- | Again, | + | |
< | < | ||
- | scp ./ | + | root@Cerbo:/ |
- | scp ./venus/* " | + | 1103640 / |
+ | 1099352 / | ||
+ | 1099276 / | ||
+ | 87048 / | ||
+ | 65732 / | ||
+ | 7188 /data/ | ||
+ | 3920 /data/log | ||
+ | 744 / | ||
+ | 164 / | ||
+ | 160 / | ||
+ | 116 / | ||
+ | 116 / | ||
+ | </code> | ||
- | # reboot | + | This is a view of a more healthy tree: |
- | ssh 192.168.178.122 reboot | + | < |
+ | root@Cerbo:/ | ||
+ | 164608 / | ||
+ | 160312 / | ||
+ | 160240 / | ||
+ | 87048 / | ||
+ | 65732 / | ||
+ | 7188 / | ||
+ | 3924 / | ||
+ | 744 / | ||
</ | </ | ||
- | Once completed, the WiFi access point will be operational again. | + | ==== 8.2 Backup / Reset to factory defaults |
+ | |||
+ | There are scenarios where you want to make a backup of your data or when you want to clear logging or even start all over and go back to factory defaults. In order to make this process easy, you can put one (or more) of the following files on an USB stick and reboot your device. The files will be unpacked and the scripts within will execute. | ||
- | === Step E. Install Venus OS Large === | + | * [[https:// |
+ | * [[https:// | ||
+ | * [[https:// | ||
+ | * [[https:// | ||
- | Now, the Venus GX has been repartitioned, | + | See [[https:// |
venus-os/large.1612698304.txt.gz · Last modified: 2021-02-07 12:45 by mvader