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 [2017-06-20 14:34] – [4.2 Restoring VE.Can products to their defaults] 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. | + | 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 |
- | Note regarding support: below documentation are made available to be convenient only. There is no guaranteed support | + | For more software developer oriented command line tips & tricks, see [[https://github.com/ |
+ | ==== 1.1 No support warning ==== | ||
- | ==== 1.1 Use a normal tool instead of the command line ==== | + | 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:// | ||
+ | |||
+ | Our support staff on all official channels, Disqus and elsewhere, does not know how these tools can be used. | ||
+ | ==== 1.2 Use a normal tool instead of the command line ==== | ||
It is not at all necessary to use below command line instructions. We have far easier to use normal computer applications available: | It is not at all necessary to use below command line instructions. We have far easier to use normal computer applications available: | ||
Line 17: | 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 33: | 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.2 Connecting to the command line and file transfer ==== | + | ==== 1.3 Connecting to the command line and file transfer ==== |
See the [[ccgx: | See the [[ccgx: | ||
Line 45: | Line 51: | ||
===== 2. Venus software updates ===== | ===== 2. Venus software updates ===== | ||
- | ==== 2.1 Checking current | + | Check firmware |
< | < | ||
- | root@CCGX: | + | root@CCGX: |
v2.06 | v2.06 | ||
Color Control GX | Color Control GX | ||
Line 53: | Line 59: | ||
</ | </ | ||
- | ==== 2.2 Updating Venus version | + | Then to update, this depends on which version |
- | To trigger an update check, run | + | See [[ccgx: |
+ | |||
+ | ==== 2.2 Venus v2.00 and later ==== | ||
+ | |||
+ | Checking for updates and triggering a new update is all done with / | ||
+ | |||
+ | For an introduction, | ||
+ | |||
+ | |||
+ | ==== 2.3 Venus v1.74 and before ==== | ||
+ | |||
+ | === Updating to v2.00 and later === | ||
+ | This needs to be done with an sdcard. There is no other way. See instructions here: | ||
+ | |||
+ | https:// | ||
+ | |||
+ | === Updating Venus version === | ||
+ | To trigger an update check, run: | ||
< | < | ||
Line 61: | Line 84: | ||
</ | </ | ||
- | If there are new updates found, and if the GUI is running and automatic updates are enabled, the GUI will automatically initiate an update followed by a reboot. Otherwise, trigger the installation yourself with | + | If there are new updates found, and if the GUI is running and automatic updates are enabled, the GUI will automatically initiate an update followed by a reboot. Otherwise, trigger the installation yourself with: |
< | < | ||
Line 69: | Line 92: | ||
To change the Update-to setting, use set-feed.sh. | To change the Update-to setting, use set-feed.sh. | ||
- | ==== 2.3 Automatic | + | === Automatic |
To check if the device is configured to automatically update, query / | To check if the device is configured to automatically update, query / | ||
< | < | ||
Line 110: | 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 121: | 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 131: | Line 156: | ||
Updating other VE.Bus devices, such as the VE.Bus BMS and Digital Multi Control panels is not possible with vbdup. | Updating other VE.Bus devices, such as the VE.Bus BMS and Digital Multi Control panels is not possible with vbdup. | ||
- | Make sure that the Venus device (fe. CCGX), | + | Updating a MultiGrid and also a MultiPlus-II is not (yet) possible with vbdup. |
+ | |||
+ | 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 260: | 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 ===== | ||
- | First make sure to stop the serial starter: | + | ==== 5.1 See connected devices ==== |
- | | + | < |
- | + | # svstat /service/* | grep vedirect | |
- | List all services running: | + | /service/vedirect-interface.ttyO2: |
+ | / | ||
+ | </ | ||
- | svstat /service/* | + | ==== 5.2 Firmware update ==== |
- | + | ||
- | Look for the product you and to update, and stop that service as well: | + | First stop the driver: |
- | | + | /opt/victronenergy/ |
| | ||
Then update the product: | Then update the product: | ||
Line 298: | Line 409: | ||
</ | </ | ||
- | and when done, start the service and the serial-starter | + | and when done, release |
- | | + | /opt/victronenergy/ |
- | svc -u /service/ | + | |
+ | ==== 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 ===== | ||
Line 325: | Line 442: | ||
- < | - < | ||
- VE.Configure should now be able to connect to the CCGX | - VE.Configure should now be able to connect to the CCGX | ||
- | ===== DISQUS ===== | + | |
- | ~~DISQUS~~ | + |
open_source/ccgx/commandline.txt · Last modified: 2023-05-07 10:00 by mvader