Skip to content

Commit

Permalink
Make a few explanations more clear
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-manuel committed May 27, 2024
1 parent bdc0b10 commit 185fad5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/docs/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ See [this page](../general/install#how-to-change-the-default-limits).

## What is the `config.ini` and `config.default.ini`?

The `config.ini` is a file where you can specify your own configuration changes. Like when you want to change default values, e.g. increase the charge and discharge limits. Lookup the `config.default.ini` to see which settings are available. This file is preserved after a version update.
The `config.ini` is a file where you can specify your own configuration changes. Like when you want to change default values, e.g. increase the charge and discharge limits. This file is preserved after a version update. Lookup the `config.default.ini` to see which settings are available.

The `config.default.ini` is a file where all possible configuration settings are stored with their default values. Every setting is also well documented in order to understand what the setting does. This file is overwritten after a version update.
The `config.default.ini` is a file where all possible configuration settings are stored with their default values. Every setting is also well documented in order to understand what the setting does. This file is overwritten every time you update the driver.

Click [here](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini`.

Expand Down
16 changes: 7 additions & 9 deletions docs/docs/general/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,6 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
## Install or update

### Installation video (`<= v0.14.3`)

[![dbus-serialbattery install](https://img.youtube.com/vi/Juht6XGLcu0/0.jpg)](https://www.youtube.com/watch?v=Juht6XGLcu0)

### Install or update automatically with USB/SD card

> It might be, that this doesn't work on older CerboGX devices. In this case use SSH option instead.
Expand Down Expand Up @@ -238,28 +234,30 @@ If you use the cell voltage limits, temperature limits and/or SoC limits you als

## Settings location/path

💡 After updating the settings reboot the device or run `/data/etc/dbus-serialbattery/reinstall-local.sh` to apply the changes.
💡 After updating the settings, reboot the device or run `/data/etc/dbus-serialbattery/reinstall-local.sh` to apply the changes.

The path of the settings file depends on you driver version. If you don't know which driver version you have installed see [Which version do I have installed?](../faq/#which-version-do-i-have-installed)

### Driver version `<= v0.14.3` (`utils.py`)
Edit `/data/etc/dbus-serialbattery/utils.py` to update the constants. Note that any updates will override this change.

### Driver version `>= v1.0.0` (`config.ini`)
Copy the values you want to change from `/data/etc/dbus-serialbattery/config.default.ini` and insert in the `/data/etc/dbus-serialbattery/config.ini`.
Copy the values you want to change from `/data/etc/dbus-serialbattery/config.default.ini` and insert them in the `/data/etc/dbus-serialbattery/config.ini`.

All available options can also be found [here](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini).

## How to edit `utils.py` or `config.ini`

There are two ways to edit the files. You can edit them:

1. Inside the GX device/Raspberry Pi over SSH
2. On your PC and then copy only the `utils.py` or `config.ini` over to the GX device/Raspberry Pi
* Directly on the GX device/Raspberry Pi over SSH
* On your PC and then copy only the `utils.py` or `config.ini` over to the GX device/Raspberry Pi

See [Settings location/path](#settings-locationpath) to know which file is relevant for you.

### SSH edit using Nano editor (recommended)

Log into your GX device/Raspberry Pi using SSH and run this command. Replace `FILE_NAME` with the file name you want to edit.
Log into your GX device/Raspberry Pi using SSH and run this command. Replace `FILE_NAME` with the file name you want to edit, e.g. `utils.py` or `config.ini`.

```bash
nano /data/etc/dbus-serialbattery/FILE_NAME
Expand Down

0 comments on commit 185fad5

Please sign in to comment.