Skip to content

Commit

Permalink
Adjusted paths for all versions
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-manuel committed Dec 5, 2024
1 parent 437fd53 commit b793d8f
Show file tree
Hide file tree
Showing 11 changed files with 45 additions and 53 deletions.
12 changes: 6 additions & 6 deletions docs/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `config.ini` is a file where you can specify your own configuration changes.

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/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini`.
Click [here](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini) to see the `config.default.ini`.

## How to edit the `config.ini`

Expand Down Expand Up @@ -285,7 +285,7 @@ You can remove the GUI changes or update your GX firmware to solve this.
Execute the command below to restore the GUI.

```bash
bash /data/etc/dbus-serialbattery/restore-gui.sh
bash /data/apps/dbus-serialbattery/restore-gui.sh
```

### Update to the latest firmware
Expand Down Expand Up @@ -314,10 +314,10 @@ It seems that the Victron GX device has a limit of maximum 8 USB to serial adapt
This indicates, that the line endlings were changed during the upload from `LF` to `CRLF`. Run this commands to repair the files:

```bash
sed -i 's/\r//' /data/etc/dbus-serialbattery/*.sh
sed -i 's/\r//' /data/etc/dbus-serialbattery/*.py
sed -i 's/\r//' /data/etc/dbus-serialbattery/service/run
sed -i 's/\r//' /data/etc/dbus-serialbattery/service/log/run
sed -i 's/\r//' /data/apps/dbus-serialbattery/*.sh
sed -i 's/\r//' /data/apps/dbus-serialbattery/*.py
sed -i 's/\r//' /data/apps/dbus-serialbattery/service/run
sed -i 's/\r//' /data/apps/dbus-serialbattery/service/log/run
```

Now reboot the device. If this doesn't help, then download/unpack and reinstall the driver again.
10 changes: 5 additions & 5 deletions docs/general/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ All listed data below depend on each [BMS capabilities](#bms-feature-comparison)
- Time-to-go
- Time to custom SoC (multiple points can be specified)

For more details and other options, check the [`config.sample.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini).
For more details and other options, check the [`config.sample.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini).

### SoC reset voltage

Some BMS need a higher voltage to trigger a reset to 100% SOC. `SOC_RESET_VOLTAGE` allows you to trigger this voltage once in a while. The driver will supress high voltage warnings from the driver

when it switches to this voltage. It might be that other systems (like the MultiPlus or Solar Charger) trigger a high voltage warning in this case when not properly configured.

See the `SOC reset voltage` section in the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) for more informations.
See the `SOC reset voltage` section in the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini) for more informations.

This has nothing to do with the `SOC calculation` or `SOC reset via driver on BMS`.

Expand All @@ -101,15 +101,15 @@ based on coloumb-counting (count the current flowing in and out).

It's also possible to create a map to correct wrong current measurements.

See the `SOC calculation` section in the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) for more informations.
See the `SOC calculation` section in the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini) for more informations.

This has nothing to do with the `SOC reset voltage` or `SOC reset via driver on BMS`.

## SoC reset via driver on BMS

Some BMS do not reset the SoC automatically, when the battery is full. This option allows the driver to reset the SoC of the BMS, when it swtiches the `CVL` from absorption to float.

See `AUTO_RESET_SOC` in the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) for more informations.
See `AUTO_RESET_SOC` in the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini) for more informations.

This has nothing to do with the `SOC calculation` or `SOC reset voltage`.

Expand Down Expand Up @@ -146,7 +146,7 @@ You can set CCCM limits for 3 attributes which can be enabled / disabled and adj

The smallest limit from all enabled will apply.

Check the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) for more informations.
Check the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini) for more informations.

### Cell voltage

Expand Down
34 changes: 13 additions & 21 deletions docs/general/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
1. Download and copy the [latest release](https://github.com/mr-manuel/venus-os_dbus-serialbattery/releases) `venus-data.tar.gz` to the root of a USB flash drive that is in FAT32 format (a SD card is also an option for GX devices, but not for Raspberry Pi).

1. OPTIONAL (`>= v1.0.0`): Create a `config.ini` file in the root of your USB flash drive with your custom settings. Put `[DEFAULT]` in the first line of the file and add all the values you want to change below. You only have to insert the values you want to change, all other values are fetched from the `config.default.ini`. In the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) you find all possible settings that you can copy over and change.
1. OPTIONAL: Create a `config.ini` file in the root of your USB flash drive with your custom settings. Put `[DEFAULT]` in the first line of the file and add all the values you want to change below. You only have to insert the values you want to change, all other values are fetched from the `config.default.ini`. In the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini) you find all possible settings that you can copy over and change.

> If you put a `config.ini` in the root of the USB flash drive, then an existing `config.ini` will be overwritten.
Expand All @@ -99,7 +99,7 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
1. Run these commands to start the installer.

```bash
wget -O /tmp/install.sh https://raw.githubusercontent.com/mr-manuel/venus-os_dbus-serialbattery/master/etc/dbus-serialbattery/install.sh
wget -O /tmp/install.sh https://raw.githubusercontent.com/mr-manuel/venus-os_dbus-serialbattery/master/dbus-serialbattery/install.sh

bash /tmp/install.sh
```
Expand Down Expand Up @@ -177,7 +177,7 @@ Place a `venus-data.tar.gz` file in the folder `/var/volatile/tmp/` by copying/u
* ECS BMS → Check [#254 ECS BMS (comment)](https://github.com/Louisvdw/dbus-serialbattery/issues/254#issuecomment-1275924313)
* MNB BMS → Check [MNB BMS setup](https://github.com/Louisvdw/dbus-serialbattery/issues/590)

Since driver version `>= v1.0.0` you can also get an overview of the BMS specific settings be checking the end of the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini).
You can also get an overview of the BMS specific settings by checking the end of the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini).


### Get BMS MAC address
Expand Down Expand Up @@ -254,11 +254,11 @@ 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, run `/data/apps/dbus-serialbattery/restart.sh` or reboot the device to apply the changes.

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`.
Copy the values you want to change from `/data/apps/dbus-serialbattery/config.default.ini` and insert them in the `/data/apps/dbus-serialbattery/config.ini`.

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

## How to edit the `config.ini`

Expand All @@ -272,7 +272,7 @@ There are two ways to edit the files. You can edit them:
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. `config.ini`.

```bash
nano /data/etc/dbus-serialbattery/FILE_NAME
nano /data/apps/dbus-serialbattery/FILE_NAME
```

You can use the arrow keys to scroll down and edit the values you need.
Expand All @@ -283,7 +283,7 @@ Use `Ctrl + O` (O like Oskar) to save and `Ctrl + X` to exit the editor.

You can edit the file in a plain text editor on you PC like Notepad (Windows) or TextEdit (macOS). Then you need a program that can do SFTP like [FileZilla](https://filezilla-project.org/download.php?show_all=1) (Windows/macOS/Linux), [WinSCP](https://winscp.net/eng/downloads.php) (Windows) or [Cyberduck](https://cyberduck.io/download/) (macOS).

Connect to your GX using the same login as with SSH and copy your edited file over the existing one at `/data/etc/dbus-serialbattery/config.ini`.
Connect to your GX using the same login as with SSH and copy your edited file over the existing one at `/data/apps/dbus-serialbattery/config.ini`.

⚠️ Sometimes it happens, that the line endings get changed from `LF` to `CRLF` with this method. Check the [FAQ --> `$'\r': command not found` or `syntax error: unexpected end of file`](../faq/index.md#r-command-not-found-or-syntax-error-unexpected-end-of-file) to solve.

Expand All @@ -301,30 +301,22 @@ Add your BMS to the setting `BMS_TYPE` in the `config.ini`. This way you don't h
You can disable the driver so that it will not be run by the GX device. To do that run the following command in SSH.

```bash
bash /data/etc/dbus-serialbattery/disable.sh
bash /data/apps/dbus-serialbattery/disable.sh
```

You also need to configure your MPPTs to run in `Stand alone mode` again. Follow the Victron guide for [Err 67 - BMS Connection lost](https://www.victronenergy.com/live/mppt-error-codes#err_67_-_bms_connection_lost).

## Enable the driver
To enable the driver again you can run the installer.
To enable the driver run:

```bash
bash /data/etc/dbus-serialbattery/reinstall-local.sh
bash /data/apps/dbus-serialbattery/enable.sh
```

## Uninstall/remove the driver

To uninstall the driver run the uninstall script.
To uninstall the driver run:

```bash
bash /data/etc/dbus-serialbattery/uninstall.sh
```

**Remove**

If you want to remove also the install files of the driver run this after you run the uninstall script/commands:

```bash
rm -rf /data/etc/dbus-serialbattery
bash /data/apps/dbus-serialbattery/uninstall.sh
```
6 changes: 3 additions & 3 deletions docs/general/supported-bms.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,19 +108,19 @@ There are two possibilities to add a new BMS.

### Add by opening a pull request

Fork the repository and use the [`battery_template.py`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/bms/battery_template.py) as template to add a new battery. As soon as the BMS works you can open a pull request (PR) to merge it.
Fork the repository and use the [`battery_template.py`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/bms/battery_template.py) as template to add a new battery. As soon as the BMS works you can open a pull request (PR) to merge it.

Here is a short checklist that should help you:

- [ ] 🚨 Make sure the GitHub Actions run fine in your repository. In order to make the GitHub Actions run please select in your repository settings under `Actions` -> `General` -> `Actions permissions` the option `Allow all actions and reusable workflows`. Check also in your repository settings under `Actions` -> `General` -> `Workflow permissions` if `Read and write permissions` are selected. After this changes you have to make a new commit, if you don't see any Actions run. This will check your code for Flake8 and Black Lint errors. [Here](https://py-vscode.readthedocs.io/en/latest/files/linting.html) is a short instruction on how to set up Flake8 and Black Lint checks in VS Code. This will save you a lot of time.
- [ ] Add your battery class and battery class import in alphabetical order in the [`etc/dbus-serialbattery/dbus-serialbattery.py`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/dbus-serialbattery.py)
- [ ] Add your battery class and battery class import in alphabetical order in the [`etc/dbus-serialbattery/dbus-serialbattery.py`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/dbus-serialbattery.py)
- [ ] Add your BMS to the [BMS feature comparison](../general/features#bms-feature-comparison) page by editing [`docs/general/features.md`](https://github.com/mr-manuel/venus-os_dbus-serialbattery_docs/blob/master/docs/general/features.md)
- [ ] Add your BMS to the [Supported BMS](../general/supported-bms) page by editing [`docs/general/supported-bms.md`](https://github.com/mr-manuel/venus-os_dbus-serialbattery_docs/blob/master/docs/general/supported-bms.md)
- [ ] Do not import wildcards `*`
- [ ] If available populate `self.max_battery_charge_current` and `self.max_battery_discharge_current` with values read from the BMS
- [ ] If available populate `self.unique_identifier` with a unique value to distinguish the BMS in a multiple battery setup
- [ ] If your BMS don't run with the default settings add installation notes to the [How to install, update, disable, enable and uninstall](../general/install.md#bms-specific-settings) [`docs/general/install.md`](https://github.com/mr-manuel/venus-os_dbus-serialbattery_docs/blob/master/docs/general/install.md)
- [ ] If your BMS needs custom settings that the user should be able to change, add it below the `; --------- BMS specific settings ---------` section in the [`etc/dbus-serialbattery/config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini)
- [ ] If your BMS needs custom settings that the user should be able to change, add it below the `; --------- BMS specific settings ---------` section in the [`etc/dbus-serialbattery/config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/master/dbus-serialbattery/config.default.ini)

### Request by opening a discussion

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshoot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ toc_max_heading_level: 4

## How the driver works

1. During installation (`execution of reinstall-local.sh`) the installer script creates a configuration file (`/data/conf/serial-starter.d/dbus-serialbattery.conf`) for the `serial starter`.
1. During installation (`execution of enable.sh`) the enabling script creates a configuration file (`/data/conf/serial-starter.d/dbus-serialbattery.conf`) for the `serial starter`.
This allows the `serial starter` to create services for `dbus-serialbattery`, if a new serial adapter is connected. The `serial starter` service (`/service/serial-starter`) then creates a
service (`/service/dbus-serialbattery.*`) for each found serial port.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
1. Run these commands to start the installer.

```bash
wget -O /tmp/install.sh https://raw.githubusercontent.com/mr-manuel/venus-os_dbus-serialbattery/master/etc/dbus-serialbattery/install.sh
wget -O /tmp/install.sh https://raw.githubusercontent.com/mr-manuel/venus-os_dbus-serialbattery/refs/tags/v1.3.20240705/etc/dbus-serialbattery/install.sh

bash /tmp/install.sh
```
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-v1.4.20240928/general/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
1. Download and copy the [latest release](https://github.com/mr-manuel/venus-os_dbus-serialbattery/releases) `venus-data.tar.gz` to the root of a USB flash drive that is in FAT32 format (a SD card is also an option for GX devices, but not for Raspberry Pi).

1. OPTIONAL (`>= v1.0.0`): Create a `config.ini` file in the root of your USB flash drive with your custom settings. Put `[DEFAULT]` in the first line of the file and add all the values you want to change below. You only have to insert the values you want to change, all other values are fetched from the `config.default.ini`. In the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/v1.4.20240928/etc/dbus-serialbattery/config.default.ini) you find all possible settings that you can copy over and change.
1. OPTIONAL: Create a `config.ini` file in the root of your USB flash drive with your custom settings. Put `[DEFAULT]` in the first line of the file and add all the values you want to change below. You only have to insert the values you want to change, all other values are fetched from the `config.default.ini`. In the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/v1.4.20240928/etc/dbus-serialbattery/config.default.ini) you find all possible settings that you can copy over and change.

> If you put a `config.ini` in the root of the USB flash drive, then an existing `config.ini` will be overwritten.
Expand All @@ -99,7 +99,7 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
1. Run these commands to start the installer.

```bash
wget -O /tmp/install.sh https://raw.githubusercontent.com/mr-manuel/venus-os_dbus-serialbattery/master/etc/dbus-serialbattery/install.sh
wget -O /tmp/install.sh https://raw.githubusercontent.com/mr-manuel/venus-os_dbus-serialbattery/refs/tags/v1.4.20240928/etc/dbus-serialbattery/install.sh

bash /tmp/install.sh
```
Expand Down Expand Up @@ -177,7 +177,7 @@ Place a `venus-data.tar.gz` file in the folder `/var/volatile/tmp/` by copying/u
* ECS BMS → Check [#254 ECS BMS (comment)](https://github.com/Louisvdw/dbus-serialbattery/issues/254#issuecomment-1275924313)
* MNB BMS → Check [MNB BMS setup](https://github.com/Louisvdw/dbus-serialbattery/issues/590)

Since driver version `>= v1.0.0` you can also get an overview of the BMS specific settings be checking the end of the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/v1.4.20240928/etc/dbus-serialbattery/config.default.ini).
You can also get an overview of the BMS specific settings by checking the end of the [`config.default.ini`](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/v1.4.20240928/etc/dbus-serialbattery/config.default.ini).


### Get BMS MAC address
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.5.20241202/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `config.ini` is a file where you can specify your own configuration changes.

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/mr-manuel/venus-os_dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini`.
Click [here](https://github.com/mr-manuel/venus-os_dbus-serialbattery/blob/v1.5.20241202/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini`.

## How to edit the `config.ini`

Expand Down
Loading

0 comments on commit b793d8f

Please sign in to comment.