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-02-09 16:54] – [8.1 Disk space issues / data partition full] dfaber | venus-os:large [2024-10-18 14:37] (current) – [5.9. Node-RED FAQ] mvader | ||
---|---|---|---|
Line 28: | Line 28: | ||
There is and will be no official support on the functionalities of Venus OS large. | There is and will be no official support on the functionalities of Venus OS large. | ||
- | For support, turn to the [[https:// | + | For support, turn to the [[https:// |
- | 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 | + | 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 120: | Line 120: | ||
===== 5. Node-RED ===== | ===== 5. Node-RED ===== | ||
- | {{ : | + | {{: |
==== 5.1 Introduction ==== | ==== 5.1 Introduction ==== | ||
Line 129: | Line 129: | ||
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:// | ||
- | There is also a 3 part introductory webinar on Node-RED and Venus available at the Victron Tech YouTube channel: | + | ==== 5.2 Three part introductory webinar ==== |
+ | |||
+ | This is a 3 part introductory webinar on Node-RED and Venus available at the Victron Tech YouTube channel: | ||
[[https:// | [[https:// | ||
Line 142: | Line 144: | ||
The Node-RED editor can be accessed from your LAN at https:// | The Node-RED editor can be accessed from your LAN at https:// | ||
- | __Standard nodes + Victron nodes__ | + | ==== 5.3 Node specifications ==== |
Node-RED comes with a core set of useful nodes, and within the Venus OS large install there is a set of Victron nodes added to that: the Victron Pallet. All of the different nodes are described [[https:// | Node-RED comes with a core set of useful nodes, and within the Venus OS large install there is a set of Victron nodes added to that: the Victron Pallet. All of the different nodes are described [[https:// | ||
Line 181: | Line 184: | ||
==== 5.4 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 197: | Line 206: | ||
=== SolarCharger MPPT Relay === | === SolarCharger MPPT Relay === | ||
- | Currently it is not possible | + | 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. | ||
Line 205: | Line 214: | ||
=== RS series (inverter, multi) relays === | === RS series (inverter, multi) relays === | ||
- | Currently not controllable. Will be controllable in the future. | + | First set the relay to //manual control// using VictronConnect. Once that has been done, the relay can be controlled using Node-RED. |
=== Charger relays === | === Charger relays === | ||
Line 284: | Line 293: | ||
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. | 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 |
- | Password | + | __Venus OS v3.50 and later__ |
+ | |||
+ | For systems that have a security profile set (under Settings -> General -> Security Profile), the password | ||
+ | |||
+ | __ Venus OS versions prior to v3.50__ | ||
+ | |||
+ | The Node-RED' | ||
=== Q4: How do I restart Node-RED from the Venus GUI? === | === Q4: How do I restart Node-RED from the Venus GUI? === | ||
Line 340: | Line 355: | ||
And restart Node-RED. | 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. Signal K ===== | ||
Line 391: | Line 426: | ||
* [[https:// | * [[https:// | ||
* [[https:// | * [[https:// | ||
- | * [[http://slack-invite.signalk.org/|Signal K Slack]] - a real time chat group including a special Victron channel. | + | * [[https://discord.gg/uuZrwz4dCS |
Do not contact normal Victron support for any help on SignalK. Its based on community support, not official support. | Do not contact normal Victron support for any help on SignalK. Its based on community support, not official support. | ||
- | ==== 6.4 First use & configuring ==== | + | ==== 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:// | + | 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:// |
- | === Step 2. Configure serial connections === | + | {{ : |
- | Use this to, for example, configure a USB-connected NMEA0183 connection in SignalK. To do so, go to the dashboard (http:// | + | === Step 2. Set the admin password === |
- | Make sure to not add a connection using any of the built-in serial ports (/ | + | Go to Security |
- | 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. Configure can-bus connections | + | === Step 3. Vessel information |
- | For the Venus GX, SignalK comes pre-configured with a NMEA2000 | + | Go to Settings and enter some basic information about your boat. |
+ | |||
+ | {{ : | ||
+ | |||
+ | === 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 | ||
+ | |||
+ | Signal K is preconfigured to have its port operational for this. | ||
+ | |||
+ | Here is how you can see the preconfigured connection in the Signal K Dashboard: | ||
;#; | ;#; | ||
Line 420: | Line 467: | ||
;#; | ;#; | ||
- | + | Note that, to keep that operational, | |
- | Note that, to keep that operational, | + | |
;#; | ;#; | ||
Line 427: | Line 473: | ||
;#; | ;#; | ||
+ | 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. | ||
+ | |||
+ | === 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: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | === 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: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | === 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 === |
+ | ^ Enclosure label ^ Interface ^ Notes ^ | ||
+ | | VE.Can 1 | vecan0 | Isolated | | ||
+ | | VE.Can 2 | vecan1 | Non-isolated | | ||
==== 6.5 Signal K FAQ ==== | ==== 6.5 Signal K FAQ ==== | ||
Line 562: | Line 660: | ||
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:// | 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:// | ||
- | The easy solution | + | 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 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, | ||
+ | - A more detailed approach is logging into the SSH console, and checking for disk space: | ||
+ | |||
+ | **Tips and tricks to login a diagnose disk space** | ||
- | A more detailed approach is logging in on SSH, and checking for disk space. Here are a few useful commands. | + | Require root access: https://www.victronenergy.com/ |
The '' | The '' | ||
Line 616: | Line 720: | ||
* [[https:// | * [[https:// | ||
- | * [[https:// | + | * [[https:// |
* [[https:// | * [[https:// | ||
- | * [[https:// | + | * [[https:// |
See [[https:// | See [[https:// |
venus-os/large.1707494057.txt.gz · Last modified: 2024-02-09 16:54 by dfaber