Differences

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

--- open_source:ccgx:commandline [2019-01-22 10:43] – external edit 127.0.0.1
+++ open_source:ccgx:commandline [2019-08-15 11:56] – [1.1 No support warning] - VicCom link guy_stewart
@@ Line 1: / Line 1: @@
-====== Venus command-line manual ======
+====== Venus OS operational commandline manual ======
 ===== 1. Introduction =====
-This page explains how to change settings and/or update firmware for various Victron products which are connected to a [[venus-os:start|Venus-device]], for example the Color Control GX, via the command line, ie ssh.
+This page explains how to change settings and/or update firmware for various Victron products which are connected to a [[venus-os:start|GX device]], for example the Color Control GX, via the command line, ie ssh.
-For more software developer oriented command line tips & tricks, see [[https://github.com/victronenergy/venus/wiki/commandline-introduction|here]] on the Venus wiki.
+This document is part of the Venus OS developer documentation. The main document is [[https://github.com/victronenergy/venus/wiki|the Venus OS wiki on github]].
+For more software developer oriented command line tips & tricks, see [[https://github.com/victronenergy/venus/wiki/commandline-introduction|the Venus OS commandline manual for software development]] on the Venus wiki.
 ==== 1.1 No support warning ====
 Note regarding support: this document is made available for convenience only. There is no support on this type of using our products. Using the command line is outside normal use;
-In case of questions, you can use the [[https://groups.google.com/forum/#!forum/victron-dev-venus|Venus developers mailing list]].
+In case of questions, you can use the [[https://groups.google.com/forum/#!forum/victron-dev-venus|Venus developers mailing list]], or the [[https://community.victronenergy.com/spaces/31/index.html|modifications space on Victron Community]].
 Our support staff on all official channels, Disqus and elsewhere, does not know how these tools can be used.
@@ Line 132: / Line 133: @@
 On that computer, open the file by double clicking it, make the modifications, and save the file again.
-Then transfer the new file back onto the [[venus-os:start|Venus-device]].
+Then transfer the new file back onto the [[venus-os:start|GX device]].
 === Step 3. Writing the new settings to the system ===
@@ Line 155: / Line 156: @@
 Updating a MultiGrid and also a MultiPlus-II is not (yet) possible with vbdup.
-Make sure that the [[venus-os:start|Venus-device]] (fe. CCGX), as well as routers or any other used communications equipment, are __not__ powered by the VE.Bus devices. If they are, you'll lose power and connection as soon as the update is started, resulting in a dead system.
+Make sure that the [[venus-os:start|GX device]] (fe. CCGX), as well as routers or any other used communications equipment, are __not__ powered by the VE.Bus devices. If they are, you'll lose power and connection as soon as the update is started, resulting in a dead system.
 The product that you want to update needs to have application firmware running: just bootloader is not enough. The update starts with requesting the hardware IDs (VE.Bus discovery) from the running application. Those hardware IDs are then used to address the VE.Bus devices once in bootloader mode. After the discovery, the hardware IDs aare stored in a file. In case, for example because of a power loss, the update fails, vbdup will automatically use the hardware IDs stored in that file.
@@ Line 284: / Line 285: @@
 Querying devices
 Update end send
+</code>
+==== 4.4 vreg: changing settings from the command line ====
+<code>
+# vreg --help
+vreg - Victron registers
+  -b,--bin
+   Output in binary format.
+  -g,--get
+   Get a register.
+  -n,--nad
+   The NAD of the target device.
+  -r,--run
+   Keep running.
+  -s,--set
+   Set a register. Data is set with e.g. un16:2800 un16:12
+COMMON OPTIONS:
+  -c, --canbus
+   Specifies the CAN-bus interface to use, formatted as [driver]:[channel].
+   kvaser:1 will for example select the first Kvaser channel.
+   -c ? will list the available gateways.
+  -d, --dump
+   Dump the contents of the CAN bus frames. Specifying multiple times increases verbosity.
+  -h, --help
+   Print this help.
+  --log-before <count>
+   When set to non zero <count> number of log lines, which are
+   not enabled themselves, are nevertheless shown before an
+   log which is enabled. For example an error message will be
+   preceeded by <count> warning and info messages which occured
+   before the error. Combined with -v also warning messages will
+   be preceeded by info messages
+  --log-after <count>
+   Like -log-before, but temporarily enables tracing of disabled messages
+   after a warning or error occured.
+  --silent
+   Only listen, no messages or acks are sent
+  -v --verbose
+   Enable log messages. Specifying multiple times increases verbosity.
+Victron Energy B.V.
 </code>
 ===== 5. VE.Direct products =====
-List all services running:
+==== 5.1 See connected devices ====
-  svstat /service/*
+<code>
+# svstat /service/* | grep vedirect
+/service/vedirect-interface.ttyO2: up (pid 2020) 1210220 seconds, normally down
+/service/vedirect-interface.ttyO4: up (pid 2105) 1210218 seconds, normally down
+</code>
-Look for the product that you want to update, and claim the serial port:
+==== 5.2 Firmware update ====
+First stop the driver:
   /opt/victronenergy/serial-starter/stop-tty.sh /dev/ttyUSB0
@@ Line 322: / Line 384: @@
   /opt/victronenergy/serial-starter/start-tty.sh /dev/ttyUSB0
+==== 5.3 Changing settings & other remote commands ====
+See here: https://github.com/victronenergy/venus/wiki/dbus-api.
+That API allows to read and write VREGs. See MPPT, BMV and other HEX Protocol documents on our white paper section on the website for more information. Once you understood it all; its possible to reset a BMV too 100% with a one liner from the command line, ie "dbus -y com.victronenergy.battery.ttyO1 [find the right path] SetVreg [VREG] [DATA].
+The API will be used for a feature thats in progress: remotely changing settings of MPPTs, BMVs and other products connected to a GX device on the internet.
 ===== 6. Screenshot =====