Skip to content

Commit

Permalink
Make a few explanations more clear and fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-manuel committed May 27, 2024
1 parent bdc0b10 commit 7656c8a
Show file tree
Hide file tree
Showing 5 changed files with 101 additions and 45 deletions.
28 changes: 15 additions & 13 deletions docs/docs/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,39 +8,41 @@ sidebar_position: 3

## How to change the default limits

See [this page](../general/install#how-to-change-the-default-limits).
See [this page](../general/install.md#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`.

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

See [this page](../general/install#how-to-edit-utilspy-or-configini).
See [this page](../general/install.md#how-to-edit-utilspy-or-configini).

## How to enable a disabled BMS

See [this page](../general/install#how-to-enable-a-disabled-bms).
See [this page](../general/install.md#how-to-enable-a-disabled-bms).

## What is the username and password of the SSH connection?

See the Victron Energy documentation how to get [root access](https://www.victronenergy.com/live/ccgx:root_access#root_access).

## Which version do I have installed?

You check the installed version in the [driver log files](../troubleshoot/#driver-log-files) or in the remote console/GUI under SerialBattery -> Device -> Firmware version
You check the installed version in the [driver log files](../troubleshoot/index.md#driver-log-files) or in the remote console/GUI under SerialBattery -> Device -> Firmware version

## How to aggregate multiple batteries?

You need an additional driver for that. Here are a few listed:

### [dbus-aggregate-batteries](https://github.com/Dr-Gigavolt/dbus-aggregate-batteries) by [Dr-Gigavolt](https://github.com/Dr-Gigavolt)
### [dbus-aggregate-batteries](https://github.com/Dr-Gigavolt/dbus-aggregate-batteries) by [Dr-Gigavolt](https://github.com/Dr-Gigavolt) (recommended)

Automatically merges connected batteries. Takes consideration of SmartShunt, Multies, Quattros, SmartSolars, BlueSolars and MPPT for current calculation. Additional configuration possible. Currently the only driver, which switches to float AFTER all batteries are fully charged. See `KEEP_MAX_CVL`, default is `False`.
Automatically merges connected batteries. Takes consideration of SmartShunt, Multies, Quattros, SmartSolars, BlueSolars and MPPT for current calculation. Additional configuration possible.

💡 Currently the only driver, which switches to float AFTER all batteries are fully charged. See `KEEP_MAX_CVL`, default is `False`.

### [BatteryAggregator](https://github.com/pulquero/BatteryAggregator) by [pulquero](https://github.com/pulquero)

Expand All @@ -60,7 +62,7 @@ The BMS will prevent your battery reaching an unsafe situation (it will disconne

## Which BMS should I buy?

Most of the BMS that the driver support will work fine and the driver does support most features for all the BMS brands. See the [comparison table](../general/features#bms-feature-comparison) for any small differenaces.
Most of the BMS that the driver support will work fine and the driver does support most features for all the BMS brands. See the [comparison table](../general/features.md#bms-feature-comparison) for any small differenaces.

Find the BMS that fits your budget with the features that you need.

Expand Down Expand Up @@ -104,7 +106,7 @@ You can add both to your system and in the newer Venus OS firmwares you can sele

## Can the driver be used as monitor only?

> Please also read [Should I set the Smartshunt or the BMS as the Battery Monitor?](../faq/#should-i-set-the-smartshunt-or-the-bms-as-the-battery-monitor)
> Please also read [Should I set the Smartshunt or the BMS as the Battery Monitor?](../faq/index.md#should-i-set-the-smartshunt-or-the-bms-as-the-battery-monitor)
Yes it can, but there are certain limitations.

Expand Down Expand Up @@ -188,7 +190,7 @@ Go to the remote console/GUI under SerialBattery -> Parameters and go to the bot

## Does the driver work for `3.7V` based cells also?

Yes, but you will [need to adjust](../general/install#how-to-change-the-default-limits) the `MAX_CELL_VOLTAGE` and `MIN_CELL_VOLTAGE` values for `3.7V` cells instead of the default `3.2V` cells.
Yes, but you will [need to adjust](../general/install.md#how-to-change-the-default-limits) the `MAX_CELL_VOLTAGE` and `MIN_CELL_VOLTAGE` values for `3.7V` cells instead of the default `3.2V` cells.

Recommended values for `3.7V` cells are:

Expand Down Expand Up @@ -247,7 +249,7 @@ The Daly BMS alarms did not work in driver versions before `v1.0.20230531` and t

## Why is the battery current inverted?

Some Daly BMS send the current as inverted value. This can be corrected by setting `INVERT_CURRENT_MEASUREMENT` to `-1` in the `utils.py` or `config.ini` (depending on the installed driver version). See [How to edit `utils.py` or `config.ini`](../general/install#how-to-edit-utilspy-or-configini).
Some Daly BMS send the current as inverted value. This can be corrected by setting `INVERT_CURRENT_MEASUREMENT` to `-1` in the `utils.py` or `config.ini` (depending on the installed driver version). See [How to edit `utils.py` or `config.ini`](../general/install.md#how-to-edit-utilspy-or-configini).

## What can I do, if the BMS communication is unstable?

Expand Down Expand Up @@ -330,4 +332,4 @@ Now reboot the device. If this doesn't help, then download/unpack and reinstall

## `tar: conf/serial-starter.d: Cannot open: File exists`

See [this page](../general/install#downgrade-from--v100-to--v0143).
See [this page](../general/install.md#downgrade-from--v100-to--v0143).
28 changes: 13 additions & 15 deletions docs/docs/general/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ toc_max_heading_level: 4

> The driver does not do any setup of your BMS/battery. You need to have a working battery before you start.
> It is always recommended to use the latest Venus OS version with the latest driver version. To avoid a [white screen](../faq/#fix-white-screen-after-install) after install check the compatibility matrix below.
> It is always recommended to use the latest Venus OS version with the latest driver version. To avoid a [white screen](../faq/index.md#fix-white-screen-after-install) after install check the compatibility matrix below.
> Multi battery setup: If you are using multiple batteries you need to use a battery aggregator else you cannot use the full system power. See [How to aggregate multiple batteries?](../faq/#how-to-aggregate-multiple-batteries)
> Multi battery setup: If you are using multiple batteries you need to use a battery aggregator else you cannot use the full system power. See [How to aggregate multiple batteries?](../faq/index.md#how-to-aggregate-multiple-batteries)
> The Bluetooth and CAN connections are still not stable on some systems. If you want to have a stable connection use the serial connection.
Expand Down 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 @@ -157,7 +153,7 @@ Place a `venus-data.tar.gz` file in the folder `/var/volatile/tmp/` by copying/u

### BMS specific settings

* Daly BMS &rarr; Check [Why is the battery current inverted?](../faq/#why-is-the-battery-current-inverted) and [Daly Lost Connection because of standby](https://github.com/Louisvdw/dbus-serialbattery/issues/731#issuecomment-1613580083)
* Daly BMS &rarr; Check [Why is the battery current inverted?](../faq/index.md#why-is-the-battery-current-inverted) and [Daly Lost Connection because of standby](https://github.com/Louisvdw/dbus-serialbattery/issues/731#issuecomment-1613580083)
* ECS BMS &rarr; Check [#254 ECS BMS (comment)](https://github.com/Louisvdw/dbus-serialbattery/issues/254#issuecomment-1275924313)
* MNB BMS &rarr; Check [MNB BMS setup](https://github.com/Louisvdw/dbus-serialbattery/issues/590)

Expand Down Expand Up @@ -234,32 +230,34 @@ MAX_BATTERY_DISCHARGE_CURRENT = 60.0

See [Settings location/path](#settings-locationpath).

If you use the cell voltage limits, temperature limits and/or SoC limits you also need to adjust their values to match the new current, else CCL and DCL will not change. See also [Why is the charging/discharging current limit (CCL/DCL) smaller than the set one?](../faq/#why-is-the-chargingdischarging-current-limit-ccldcl-smaller-than-the-set-one).
If you use the cell voltage limits, temperature limits and/or SoC limits you also need to adjust their values to match the new current, else CCL and DCL will not change. See also [Why is the charging/discharging current limit (CCL/DCL) smaller than the set one?](../faq/index.md#why-is-the-chargingdischarging-current-limit-ccldcl-smaller-than-the-set-one).

## 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)
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/index.md#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 All @@ -275,7 +273,7 @@ You can edit the file in a plain text editor on you PC like Notepad (Windows) or
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/utils.py` or `/data/etc/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/#r-command-not-found-or-syntax-error-unexpected-end-of-file) to solve.
⚠️ 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.
> Don't copy all the files as the required file permissions will be destroyed and your driver might fail to start.

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/general/supported-bms.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ toc_max_heading_level: 4

## Currently supported
### &bull; ANT BMS
Disabled by default since driver version `v1.0.0` as it causes other issues. More informations can be found in [Add other use case (grid meter) or ignore devices - ANT BMS check missing](https://github.com/Louisvdw/dbus-serialbattery/issues/479) and if it was fixed. See [How to enable a disabled BMS](../general/install#how-to-enable-a-disabled-bms) to enable the BMS.
Disabled by default since driver version `v1.0.0` as it causes other issues. More informations can be found in [Add other use case (grid meter) or ignore devices - ANT BMS check missing](https://github.com/Louisvdw/dbus-serialbattery/issues/479) and if it was fixed. See [How to enable a disabled BMS](../general/install.md#how-to-enable-a-disabled-bms) to enable the BMS.

### &bull; Daly Smart BMS
Including:
#### - Sinowealth based Daly BMS
Disabled by default since driver version `v0.14.0` as it causes other issues. See [How to enable a disabled BMS](../general/install#how-to-enable-a-disabled-bms) to enable the BMS.
Disabled by default since driver version `v0.14.0` as it causes other issues. See [How to enable a disabled BMS](../general/install.md#how-to-enable-a-disabled-bms) to enable the BMS.

![Daly app](../../screenshots/bms-daly.jpg)

Expand Down Expand Up @@ -77,7 +77,7 @@ Here is a short checklist that should help you:
- [ ] 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#bms-specific-settings) [`docs/docs/general/install.md`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/docs/docs/general/install.md)
- [ ] 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/docs/general/install.md`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/docs/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/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini)
- [ ] 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/troubleshoot/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ sidebar_class_name: hidden

# FAQ (Frequently Asked Questions)

This page has been moved to [here](../faq/).
This page has been moved to [here](../faq/index.md).
Loading

0 comments on commit 7656c8a

Please sign in to comment.