Skip to content

Commit

Permalink
Merge docusaurus into master (#681)
Browse files Browse the repository at this point in the history 
* update faq

* Improved install doc

* Modified installation documentation

* fix broken link

* added faq

* Update install info
#638

* Updated docusaurus to the latest version

* Added checklist for new BMS

* fix typo in file reference

* fixed links

* Improved documentation

* added donation notes for mr-manuel

* fix error

* added bluetooth info

* updated introduction

* added how the driver works

* solve merge conflicts

* revert changes

---------

Co-authored-by: Raphael Mack <[email protected]>
  • Loading branch information
@mr-manuel @ramack
mr-manuel and ramack authored May 31, 2023
1 parent c61ba3c commit 86a6b95
Show file tree
Hide file tree
Showing 10 changed files with 1,089 additions and 936 deletions.
38 changes: 34 additions & 4 deletions docs/docs/faq/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@ See [this page](../general/install#how-to-change-the-default-limits).


## How to edit `utils.py` or `config.ini`
See [this page](../general/install#how-to-change-the-default-limits).
See [this page](../general/install#how-to-edit-utilspy-or-configini).


## How to enable a disabled BMS
See [this page](../general/install#how-to-change-the-default-limits).
See [this page](../general/install#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 check the installed version in the [driver log files](../troubleshoot/#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:
Expand Down Expand Up @@ -210,7 +214,7 @@ Balancing works when ever 1 cell go above the balance threshold, so you are tryi


## 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`. 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#how-to-edit-utilspy-or-configini).


## What can I do, if the BMS communication is unstable?
Expand All @@ -223,6 +227,10 @@ Most unstable communications arise due to:
* Cheap USB Hubs: Make sure you are using a qualitative USB Hub with enough power.
* Raspberry Pi: Do not use a charger for powering the Raspberry Pi. Instead buy a power supply with enough power.

## Why is my `utils.py` always reset to default values?

Probably you forgot to remove the USB/SD card with the `venus-data.tar.gz` after successful installation. Please delete the file or remove the USB/SD card. This is fixed with `>= v1.0.20230512`.


## Fix white screen after install
Normally this will happen, if you were on an older firmware for your GX.
Expand All @@ -231,17 +239,39 @@ You can remove the GUI changes or update your GX firmware to solve this.


### Remove GUI changes

Execute the command (matching your driver version) below to restore the GUI.

If you don't know which version of the driver you have installed then try first the option for `>= v1.0.0`. If you get the error `bash: /data/etc/dbus-serialbattery/restore-gui.sh: No such file or directory` try the option for `<= v0.14.3`.

#### Driver version `<= v0.14.3`
```bash
# restore original qml
cp -f /opt/victronenergy/gui/qml/PageBattery.qml.backup /opt/victronenergy/gui/qml/PageBattery.qml
reboot
# restart gui
svc -d /service/gui && sleep 1 && svc -u /service/gui
```

#### Driver version `>= v1.0.0`
```bash
bash /data/etc/dbus-serialbattery/restore-gui.sh
```

### Update to the latest firmware
If the removal of the GUI changes did not help, you can force a reinstall/update of the firmware. This takes about 5-15 minutes depending on your device and internet connection.

```bash
/opt/victronenergy/swupdate-scripts/check-updates.sh -update -force
```

If this also did not help then execute this command to prevent any driver to auto install after firmware update.

```bash
mv /data/rc.local /data/rc.local.backup
mv /data/rcS.local /data/rcS.local.backup
```

Now run again the reinstall/update of the firmware.

## How many USB to serial adapters can I connect?
It seems that the Victron GX device has a limit of maximum 8 USB to serial adapters. See [Serial battery driver not found if other VE.direct-USB devices are present](https://github.com/Louisvdw/dbus-serialbattery/issues/422)
Expand Down
43 changes: 22 additions & 21 deletions docs/docs/general/features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,27 +121,28 @@ If the `MAX_CELL_VOLTAGE` \* `cell count` is reached for `MAX_VOLTAGE_TIME_SEC`

## BMS feature comparison

| Feature | Ant | Daly | ECS | Heltec | HLPdataBMS4S | JK BMS | Life/Tian Power | LLT/JBD | MNB <sup>(1)</sup> | Renogy | Seplos | Sinowealth <sup>(1)</sup> |
| ---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Voltage | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Current | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Power | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| State Of Charge | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Battery temperature | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| MOSFET temperature | No | No | No | Yes | No | Yes | No | Yes | No | No | No | No |
| Consumed Ah | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Time-to-go | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc |
| Min/max cell voltages | Yes | Yes | No | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes |
| Min/max temperature | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Installed capacity | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Available capacity | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Cell details | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | ? |
| Balancing status | Yes | No | Yes | Yes | No | Yes | Yes | No | No | No | No | ? |
| Raise alarms from the BMS | Yes | Yes | Yes <sup>(2)</sup> | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ? |
| History of charge cycles | Yes | Yes | No | No | No | Yes | Yes | Yes | No | Yes | Yes | Yes |
| Get CCL/DCL from the BMS | No | No | No | Yes | No | Yes | No | No | No | No | No | No |
| Charge current control management (CCCM) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Set battery parameters (DVCC) | Calc | Calc | Yes | Calc | Yes | Calc | Calc | Calc | Yes | Calc | Calc | Calc |
| Feature | Ant | Daly | ECS | Heltec | HLPdataBMS4S | JK BMS | Life/Tian Power | LLT/JBD | MNB <sup>(1)</sup> | Renogy | Seplos | Sinowealth <sup>(1)</sup> |
| ---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Voltage | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Current | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Power | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| State Of Charge | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Battery temperature | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| MOSFET temperature | No | No | No | Yes | No | Yes | No | Yes | No | No | No | No |
| Consumed Ah | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Time-to-go | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc | Calc |
| Min/max cell voltages | Yes | Yes | No | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes |
| Min/max temperature | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Installed capacity | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Available capacity | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Cell details | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | ? |
| Balancing status | Yes | No | Yes | Yes | No | Yes | Yes | No | No | No | No | ? |
| Raise alarms from the BMS | Yes | Yes | Yes <sup>(2)</sup> | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ? |
| History of charge cycles | Yes | Yes | No | No | No | Yes | Yes | Yes | No | Yes | Yes | Yes |
| Get CCL/DCL from the BMS | No | No | No | Yes | No | Yes | No | No | No | No | No | No |
| Charge current control management (CCCM) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Set battery parameters (DVCC) | Calc | Calc | Yes | Calc | Yes | Calc | Calc | Calc | Yes | Calc | Calc | Calc |
| Bluetooth connection <img src="../img/bluetooth.svg" className="h-1em" /> | No | No | No | No | No | Yes | No | Yes | No | No | No | No |


`Calc` means that the value is calculated by the driver.
Expand Down
17 changes: 13 additions & 4 deletions docs/docs/general/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,26 @@ sidebar_position: 1
---

# dbus-serialbattery

This is a driver for Venus OS devices (any GX device sold by Victron or a Raspberry Pi running the Venus OS image).

The driver will communicate with a Battery Management System (BMS) that support serial communication (RS232, RS485 or TTL UART) and publish this data to the Venus OS system. The main purpose is to act as a Battery Monitor in your GX and supply State of Charge (SoC) and other values to the inverter.
The driver will communicate with a Battery Management System (BMS) that support serial (RS232, RS485 or TTL UART) and Bluetooth communication (see [BMS feature comparison](../general/features#bms-feature-comparison) for details). The data is then published to the Venus OS system (dbus). The main purpose is to act as a Battery Monitor in your GX and supply State of Charge (SoC) and other values to the inverter/charger.

## Supporting this project
### Supporting this project
If you find this driver helpful please consider supporting this project. You can buy me a Ko-Fi or get in contact, if you would like to donate hardware for development.

If you find this driver helpful please consider supporting this project. You can buy me a Ko-Fi or get in contact, if you would like to donate hardware.
### Support [Louisvdw](https://github.com/Louisvdw)
* Main developer
* Added most of the BMS drivers

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Z8Z73LCW1) or using [Paypal.me](https://paypal.me/innernet)

### Support [mr-manuel](https://github.com/mr-manuel)
* Added a lot of features, optimizations and improvements with `v1.0.x`
* Added a lot of documentation to the config file and notes that are displayed after installation for better understanding
* Introduced the new documentation page of the driver and reworked a great part of it for easier understanding

[<img src="https://github.md0.eu/uploads/donate-button.svg" width="178" />](https://www.paypal.com/donate/?hosted_button_id=3NEVZBDM5KABW)

## Requirements

* GX device or Raspberry Pi running Venus OS version `v2.80` or later.
Expand Down
Loading

0 comments on commit 86a6b95

Please sign in to comment.