open_source:ccgx:commandline
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
open_source:ccgx:commandline [2018-07-17 14:26] – [5. VE.Direct products] mvader | open_source:ccgx:commandline [2021-03-03 10:14] – [4.4 vreg: changing settings from the command line] mvader | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Venus command-line | + | ====== Venus OS operational commandline |
===== 1. Introduction ===== | ===== 1. Introduction ===== | ||
- | This page explains how to change settings and/or update firmware for various Victron products which are connected to a 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: |
- | For more software | + | This document is part of the Venus OS developer |
+ | For more software developer oriented command line tips & tricks, see [[https:// | ||
==== 1.1 No support warning ==== | ==== 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; | 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:// | + | In case of questions, you can use the [[https:// |
Our support staff on all official channels, Disqus and elsewhere, does not know how these tools can be used. | Our support staff on all official channels, Disqus and elsewhere, does not know how these tools can be used. | ||
Line 22: | Line 23: | ||
Changing settings with products featuring a VE.Bus comm. port (Inverters, Multis and Quattros) is normally done with VEConfigure. | Changing settings with products featuring a VE.Bus comm. port (Inverters, Multis and Quattros) is normally done with VEConfigure. | ||
- | Firmware updates are normally done with VEFlash, a computer tool that is installed together with VEConfigure. | + | Firmware updates are normally done with VEFlash, a computer tool that is installed together with VEConfigure, or VictronConnect. |
- | To change settings remotely, use [[ccgx:ccgx_ve_power_setup|Remote VEConfigure]]. | + | To change settings remotely, use [[vrm_portal:remote-veconfigure|Remote VEConfigure.]] |
Remotely updating firmware of a VE.Bus product is only possible from the command line, see below. | Remotely updating firmware of a VE.Bus product is only possible from the command line, see below. | ||
Line 38: | Line 39: | ||
Both firmware updating as well as changing settings is normally done with [[victronconnect: | Both firmware updating as well as changing settings is normally done with [[victronconnect: | ||
- | It is not possible to remotely change settings. Neither | + | [[https:// |
- | Updating firmware | + | Updating firmware |
==== 1.3 Connecting to the command line and file transfer ==== | ==== 1.3 Connecting to the command line and file transfer ==== | ||
Line 132: | Line 133: | ||
On that computer, open the file by double clicking it, make the modifications, | On that computer, open the file by double clicking it, make the modifications, | ||
- | Then transfer the new file back onto the Venus device. | + | Then transfer the new file back onto the [[venus-os: |
=== Step 3. Writing the new settings to the system === | === Step 3. Writing the new settings to the system === | ||
Line 143: | Line 144: | ||
==== 3.2 Updating VE.Bus firmware === | ==== 3.2 Updating VE.Bus firmware === | ||
+ | |||
+ | WARNING: At Victron we don't use this tool. Part of the code is shared with the VE.Bus firmware update functionality in VictronConnect, | ||
Requires Venus v2.00 or later. | Requires Venus v2.00 or later. | ||
Line 155: | Line 158: | ||
Updating a MultiGrid and also a MultiPlus-II is not (yet) possible with vbdup. | Updating a MultiGrid and also a MultiPlus-II is not (yet) possible with vbdup. | ||
- | Make sure that the 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: |
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. | 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 287: | ||
Querying devices | Querying devices | ||
Update end send | Update end send | ||
+ | </ | ||
+ | |||
+ | ==== 4.4 vreg: changing settings from the command line ==== | ||
+ | |||
+ | < | ||
+ | # vreg --help | ||
+ | vreg - Victron registers | ||
+ | |||
+ | -b,--bin | ||
+ | | ||
+ | |||
+ | -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 | ||
+ | | ||
+ | | ||
+ | -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 < | ||
+ | When set to non zero < | ||
+ | not enabled themselves, are nevertheless shown before an | ||
+ | log which is enabled. For example an error message will be | ||
+ | | ||
+ | | ||
+ | be preceeded by info messages | ||
+ | |||
+ | --log-after < | ||
+ | Like -log-before, | ||
+ | after a warning or error occured. | ||
+ | |||
+ | --silent | ||
+ | Only listen, no messages or acks are sent | ||
+ | |||
+ | -v --verbose | ||
+ | | ||
+ | |||
+ | Victron Energy B.V. | ||
+ | </ | ||
+ | |||
+ | Example of switching a solar charger off, and then on | ||
+ | < | ||
+ | OFF: (vreg 0x0200, value 4) | ||
+ | ccgx:~# vreg -n 0x45 -s 0x0200 un8:0x04 | ||
+ | # NAD 0x45, reg=0x200 | ||
+ | 0x04 0x00 0x00 0x00 | ||
+ | |||
+ | ON: (vreg 0x0200, value 1) | ||
+ | root@ccgx: | ||
+ | # NAD 0x45, reg=0x200 | ||
+ | 0x01 0x00 0x00 0x00 | ||
+ | root@ccgx: | ||
+ | |||
+ | Gets can be broadcasted, | ||
+ | |||
+ | vreg -c socketcan: | ||
+ | root@einstein: | ||
+ | # reminder, there are no error indications when broadcasting! | ||
+ | # NAD 0x24, reg=0x200 | ||
+ | 0x01 0x00 0x00 0x00 | ||
+ | # NAD 0x25, reg=0x200 | ||
+ | 0x01 0x00 0x00 0x00 | ||
+ | # NAD 0x26, reg=0x200 | ||
+ | 0x01 0x00 0x00 0x00 | ||
+ | and so forth | ||
</ | </ | ||
===== 5. VE.Direct products ===== | ===== 5. VE.Direct products ===== | ||
- | List all services running: | + | ==== 5.1 See connected devices ==== |
+ | |||
+ | < | ||
+ | # svstat /service/* | grep vedirect | ||
+ | / | ||
+ | / | ||
+ | </ | ||
- | svstat /service/* | + | ==== 5.2 Firmware update ==== |
- | Look for the product that you want to update, and claim the serial port: | + | First stop the driver: |
/ | / | ||
Line 322: | Line 413: | ||
/ | / | ||
+ | ==== 5.3 Changing settings & other remote commands ==== | ||
+ | |||
+ | See here: https:// | ||
+ | |||
+ | 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 ===== | ===== 6. Screenshot ===== | ||
open_source/ccgx/commandline.txt · Last modified: 2023-05-07 10:00 by mvader