Differences

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

--- venus-os:large [2024-05-02 00:04] – [6.2 Documentation and support for Signal K] mvader
+++ 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.
-For support, turn to the [[https://community.victronenergy.com/spaces/31/index.html|Modifications Space on Victron Community]] and/or the [[https://community.victronenergy.com/smart-spaces/71/node-red.html|Node-RED Space on Victron Community]].
+For support, turn to the [[https://community.victronenergy.com/c/modifications/5 |Modifications Space on Victron Community]]. Another good resource is [[https://community.victronenergy.com/tag/node-red|all posts tagged as Node-RED]].
-There, first search if someone else had a similar question already. And if you can’t find such, then create a new question. Make sure you add Node-RED to the topic.
+On Community, first search if someone else had a similar question already. And if you can’t find such, then create a new question. Make sure to tag it with Node-RED.
 For support on SignalK, there is a #victron channel in [[http://slack-invite.signalk.org/|the SignalK Slack]] workspace.
@@ Line 120: / Line 120: @@
 ===== 5. Node-RED =====
-{{ :venus-os:node-red-contrib-victron-nodes.png?nolink |}}
+{{:venus-os:node-palette.png?direct&nolink |}}
 ==== 5.1 Introduction ====
@@ Line 184: / Line 184: @@
 ==== 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://www.victronenergy.com/panel-systems-remote-monitoring/victronconnect|VictronConnect]].
+;#;
+{{:venus-os:victron-connect-relay-manual.png?400|}}
+;#;
 === GX Device relays ===
@@ Line 200: / Line 206: @@
 === SolarCharger MPPT Relay ===
-Currently it is not possible to control the relay in a MPPT Solar Charger, even though there is a Victron node offering such functionality. The reason it doesn't work, is that VictronConnect does not have the required "Manual control" option in the list of selectable Relay modes for the MPPTs. This will be fixed at some point.
+In order to switch the relay via Node-RED, first use VictronConnect to switch the operation mode to //manual control//.
 Note that only the larger model solar chargers feature a relay.
@@ Line 208: / Line 214: @@
 === 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 ===
@@ Line 287: / 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.
-=== Q3: How can I password protect Node-RED ===
+=== Q3: How can I password protect Node-RED / My Node-RED is password protected ===
-Password protection of Node-Red is linked to the remote console. If a password is set for the remote console, this password is also used for securing Node-Red. The username is ''admin'', the password is the remote console password.
+__Venus OS v3.50 and later__
+For systems that have a security profile set (under Settings -> General -> Security Profile), the password protection is linked to the chosen security profile. The password that has been set for either security profile "weak" or "secured" is also used to access Node-RED, in combination with username ''admin''.
+__ Venus OS versions prior to v3.50__
+The Node-RED's password protection is tied to the remote console. If a password is set for the remote console, this password is also used for securing Node-Red. The username is ''admin'', the password is the remote console password.
 === Q4: How do I restart Node-RED from the Venus GUI? ===
@@ Line 343: / Line 355: @@
 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://nodered.org/docs/api/context/store/localfilesystem|store the context to disk]]. This can be achieved by creating (or adding to) a user configuration file ''/data/home/nodered/.node-red/settings-user.js'', containing:
+  module.exports = {
+    contextStorage: {
+      default: {
+        module: "localfilesystem",
+        config: {
+          flushInterval: 300 // Save context data every 5 minutes
+        }
+      }
+    }
+  }
+With the above settings, context files will get created periodically in ''/data/home/nodered/.nodered/context/''. In order not to wear out the flash too much, don't write too often.
 ===== 6. Signal K =====
@@ Line 401: / Line 433: @@
 ==== 6.3 First use & configuring ====
-=== Step 1. Opening the dashboard ===
+Follow these steps to turn your GX into a NMEA to WiFi gateway within 5 minutes.
-Open a web browser, and go to the SignalK Dashboard by navigating to http://venus.local:3000.
+These instructions assume that your GX device has already been set-up with Venus OS Large, and Signal K is enabled.
+=== Step 1. Signal K Admin page ===
-Further documentation about that is ... (some link to signalk-node documentation?)
+Open a web browser, and go to the Signal K admin page by navigating to http://venus.local:3000.
-=== Step 2. Configure serial connections ===
+{{ :venus-os:img_2580.jpeg |}}
-Use this to, for example, configure a USB-connected NMEA0183 connection in SignalK. To do so, go to the dashboard (http://0.0.0.0:3000), and there to Server -> Connections.
+=== Step 2. Set the admin password ===
-Make sure to not add a connection using any of the built-in serial ports (/dev/ttyO0, /dev/ttyO2, /dev/ttyO4, /dev/ttyO5). These are the VE.Bus- and VE.Direct ports on the Venus GX, and it is not necessary to configure them in SignalK. Data from any devices there connected is already available in SignalK, by means of the "Victron Venus Plugin"; see Dashboard -> Server -> Plugin Config.
+Go to Security -> Users and create an admin user for Signal K and protect it with a secure password.
-Note that once configured in SignalK, for example a USB-serial port, that port is no longer normally available in Venus OS. For example, when plugging in a USB-GPS; and then adding a connection for its corresponding tty in the SignalK, makes for that GPS to be no longer be recognised and available in Venus OS.
+{{ :venus-os:img_2579.png |}}
+=== Step 3. Vessel information ===
+Go to Settings and enter some basic information about your boat.
+{{ :venus-os:img_9926.png |}}
+=== Step 4. NMEA2000 Can-bus connection ===
+For NMEA2000 networks, its recommended to have all connected devices use isolated connections. Therefore, when connecting the an NMEA2000 network, we recommend using the Ekrano GX and the Cerbo MK2 GX. Connect to the port physically labelled “VE.Can 1”.
-=== Step 3. Configure can-bus connections ===
+Signal K is preconfigured to have its port operational for this.
-For the Venus GX, and Cerbo GX, SignalK comes pre-configured with a NMEA2000 listener for the VE.Can ports, its named "n2k-on-ve.can-socket", and uses the canboatjs. Here is how you can see the same in the Signal K Admin UI:
+Here is how you can see the preconfigured connection in the Signal K Dashboard:
 ;#;
@@ Line 423: / Line 467: @@
 ;#;
-Note that, to keep that operational, that port must be configured as a 250kbit VE.Can & NMEA2000 port in the Remote Console.
+Note that, to keep that operational, that port must remain configured as a 250kbit VE.Can & NMEA2000 port in the Remote Console:
 ;#;
@@ Line 431: / Line 475: @@
 For more information on CAN-busses, see chapter 6.4.
-=== Step 4. Adding Signalk Plugins or Webapps ===
+=== Step 5. Optional: Configure NMEA0183 serial connections ===
-TODO: explain & warn about data partition size & space (since thats where plugins are installed by signalk on Venus OS). Filling up the datapartition can corrupt Venus OS. More information about data partition on Venus OS here: https://github.com/victronenergy/venus/wiki/data-partition
+Use this to, for example, configure a USB-connected NMEA0183 connection in SignalK. Go to Server -> Connections.
+Make sure to not add a connection using any of the built-in serial ports (/dev/ttyO0, /dev/ttyO2, /dev/ttyO4, /dev/ttyO5). These are the VE.Bus- and VE.Direct ports on the Venus GX, and it is not necessary to configure them in SignalK. Data from any devices there connected is already available in SignalK, via the "Victron Venus Plugin"; see Dashboard -> Server -> Plugin Config.
+Note that once configured in SignalK, for example a USB-serial port, that port is no longer normally available in Venus OS. For example, when plugging in a USB-GPS; and then adding a connection for its corresponding tty in the SignalK, makes for that GPS to be no longer be recognised and available in Venus OS.
+=== Step 6. Verify received data ===
+Go to the Databrowser to see the data now available to Signal K, and to tablets and nav. apps on   WiFi:
+{{ :venus-os:img_2578.png |}}
+=== Step 7. Configure your nav app ===
+Steps needed here will differ per app. The key required data is:
+  * Host/IP address: **venus.local**
+  * Protocol: **TCP**
+  * Port: **10110**
+=== Done! ===
+Now you should have all your data such as position from the boat’s GPS, speed, wind data, as well as AIS targets in your favourite nav app. Like here in Navionics:
+{{ :venus-os:img_2581.jpeg?nolink |}}
+=== Where to go from here? Anchor alarms, trip recording, automatic log books and more ===
+  * Anchor alarm: https://demo.signalk.org/documentation/features/anchoralarm/anchoralarm.html
+  * Automatic log book & trip recording: https://svrenaissance.com/starlink-and-victron-a-match-made-in-heaven-for-boaters/
 ==== 6.4 CAN-bus ports ====
@@ Line 458: / Line 530: @@
 | VE.Can 1 | vecan0 | Isolated |
 | VE.Can 2 | vecan1 | Non-isolated |
-When using SignalK on Venus OS on an Ekrano, there is currently no port enabled for N2K traffic in the default configuration. Configure it manually instead, see here for more information: https://community.victronenergy.com/questions/263126/ekrano-gx-vs-signal-k-no-n2k-on-vecan-socket.html?childToView=263206#answer-263206.
 ==== 6.5 Signal K FAQ ====
@@ Line 593: / Line 663: @@
   - Do full GX factory reset, as per the instructions in the GX user manuals. This includes downloading a file called venus-data.tgz; see GX manual for details. Disadvantage is that you'll need to reconfigure the GX.
-  - Remove all Signal K Server log files. In case you're using SignalK, then we recommend to try that option first. See next chapter on how to do that (requires a USB stick or SD Card), and once done make sure to double check you're Signal K log setup; Most importantly, enable the ''Keep only most recent data log files'' option.
+  - 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.
-  - A more detailed approach is logging in on SSH, and checking for disk space:
+  - A more detailed approach is logging into the SSH console, and checking for disk space:
 **Tips and tricks to login a diagnose disk space**
@@ Line 650: / Line 720: @@
   * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-00-backup-data-partition.tgz|venus-data-00-backup-data-partition.tgz]] - copies all that is on the ''/data'' partition onto the usb stick
-  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-20-signalk-reset.tgz|venus-data-20-signalk-reset.tgz]] - wipes everything from ''/data/conf/signalk/''
+  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-20-signalk-reset.tgz|venus-data-20-signalk-reset.tgz]] - removes all files and directories from ''/data/conf/signalk/'', which lets you start over again with SignalK.
   * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-30-signalk-delete-data-logs.tgz|venus-data-30-signalk-delete-data-logs.tgz]] - removes all SignalK loging
-  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-20-node-red-reset.tgz|venus-data-20-node-red-reset.tgz]] - wipes all in ''/data/home/nodered/''
+  * [[https://www.victronenergy.com/upload/software/venus-factory-default/venus-data-20-node-red-reset.tgz|venus-data-20-node-red-reset.tgz]] - removes the files from ''/data/home/nodered/'', which lets you start with Node-RED from scratch.
 See [[https://www.victronenergy.com/live/ccgx:root_access#hooks_to_install_run_own_code_at_boot|here]] for more information on how this process works.