Skip to content

Commit

Permalink
Merge docusaurus into master (#871)
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

* fix typo

* updated checklist for adding new BMS

* added troubleshooting tips

* added downgrade info

* added tail info

* updated how to enable disabled BMS

* added troubleshooting serial starter info

* added Daly standby informations

* update packages solves #747

* added info

* moved paragraph and updated

* update packages, fix #779

* fixes 788

* Added FAQ and update packages

* Add Daly high voltage alarm info

* fix typo

* updated docusaurus to v2.4.3

* Added install info

* updated "supporting this project" section

* Updated docusaurus to v3

* added info about config files

* Merge master into docusaurus

* Added info for Bluetooth and CAN

---------

Co-authored-by: Raphael Mack <[email protected]>
  • Loading branch information
@mr-manuel @ramack
mr-manuel and ramack authored Nov 25, 2023
1 parent 4617419 commit 1db4f32
Show file tree
Hide file tree
Showing 10 changed files with 3,802 additions and 2,701 deletions.
19 changes: 17 additions & 2 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ To contribute to the documentation you have to fork this repository, edit/add th
## Local Development

```bash
$ yarn
yarn
```

This command installs all missing dependencies.

### Build

```bash
$ yarn build
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
Expand All @@ -29,3 +29,18 @@ npm run serve
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.


## Upgrade Docusaurus to the latest version

```bash
yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest
```

This command updates Docusaurus to the latest version.

## Install yarn if not installed

```bash
npm install --global yarn
```
37 changes: 33 additions & 4 deletions docs/docs/faq/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ sidebar_position: 3
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.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.

* Click [here](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini` of the `master` branch, which is the latest stable version.
* Click [here](https://github.com/Louisvdw/dbus-serialbattery/blob/dev/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini` of the `dev` branch, which is the most up to date version containing new fixes and features.


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

Expand Down Expand Up @@ -154,7 +164,7 @@ Check in the `utils.py`, if you have set one of this to true. If yes, then you a
* `DCCM_T_ENABLE = True` then modify `MAX_DISCHARGE_CURRENT_T = [0, 28, 60, 60, 28, 0]`

### Driver version `>= v1.0.0`
The limits are based on percentages of `MAX_CHARGE_CURRENT_CV` and `MAX_DISCHARGE_CURRENT_CV` values, so there is no need for additional modifications. Additionaly you see in the remote console/GUI under `SerialBattery` &rarr; `Parameters` why it's limited.
The limits are based on percentages of `MAX_BATTERY_CHARGE_CURRENT` and `MAX_BATTERY_DISCHARGE_CURRENT` values, so there is no need for additional modifications. Additionaly you see in the remote console/GUI under `SerialBattery` &rarr; `Parameters` why it's limited.

![VenusOS](../../screenshots/venus-os_013.png)

Expand Down Expand Up @@ -195,23 +205,29 @@ Important!!! - When the ESS asisstant is activated, all the 3 "DC input low volt
2. Reducing the ESS "Cut-off voltage" like I mentioned above


## Why do I get a High Voltage alarm?
If you receive High Voltage alarms that would indicate your battery is:
## Why do I get a high voltage alarm?
If you receive high voltage alarms that would indicate your battery is:

1. Not set up correctly and you are using the wrong charge voltages
2. It has cell imbalance issues

So asuming you have set the max battery voltage for what the battery require, you then need to help the battery to get the cells balanced. You do that by lowering the max voltage to a level where you don’t get high voltage alarms anymore and then slowly over a few weeks you can increase the max voltage to where it should be. This will give the balancers time to work.

In your GX settings go to the DVCC menu and activate the "Limit managed battery charge voltage" feature and lower the "Maximum Charge Voltage".
Drop your voltage to `0.2V` lees that normal and then increase it every day by `0.05V` if you did not get a High Voltage alarm during the previous day. If you did get an alarm leave it unchanged for another day.
Drop your voltage to `0.2V` lees that normal and then increase it every day by `0.05V` if you did not get a high voltage alarm during the previous day. If you did get an alarm leave it unchanged for another day.

Do this until you get to the original max charge voltage for your battery.

This will be much faster to do if you use the Keep Batteries changed in ESS option while you are doing this.

Balancing works when ever 1 cell go above the balance threshold, so you are trying to find the battery voltage where that one cell is above the threshold but below the high voltage alarm (e.g. `3.45V - 3.65V`) and then giving the balancers time to work down the high cell with the small balance currents (`50mA` to `200mA`).

### Daly BMS - High voltage alarm

For a high voltage alarm on Daly BMS check also [Daly BMS - High voltage alarm](https://github.com/Louisvdw/dbus-serialbattery/issues/653).

The Daly BMS alarms did not work in driver versions before `v1.0.20230531` and therefore in 99% of the cases the BMS is not setup correctly.


## 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).
Expand All @@ -232,6 +248,15 @@ Most unstable communications arise due to:
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`.


## Why is the custom name lost after a reboot?

This feature is only available in and after `v1.0.20230724beta`.

## 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 Down Expand Up @@ -290,3 +315,7 @@ sed -i 's/\r//' /data/etc/dbus-serialbattery/service/log/run
```

Now reboot the device. If this doesn't help, then download/unpack and reinstall the driver again.

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

See [this page](../general/install#downgrade-from--v100-to--v0143).
47 changes: 25 additions & 22 deletions docs/docs/general/features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,28 +121,29 @@ 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 |
| Bluetooth connection <img src="../img/bluetooth.svg" className="h-1em" /> | No | No | No | No | No | Yes | No | Yes | No | No | No | No |
| 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 <sup>(3)</sup> <img src="../img/bluetooth.svg" className="h-1em" /> | No | No | No | No | No | Yes | No | Yes | No | No | No | No |
| CAN connection <sup>(3)</sup> | No | Yes | No | No | No | Yes | No | No | No | No | No | No |


`Calc` means that the value is calculated by the driver.
Expand All @@ -152,3 +153,5 @@ If the `MAX_CELL_VOLTAGE` \* `cell count` is reached for `MAX_VOLTAGE_TIME_SEC`
(1) Disabled by default. They can be enabled by uncommenting in `dbus-serialbattery.py`.

(2) No cells yet.

(3) The Bluetooth and CAN connections are still not stable on some systems. If you want to have a stable connection use the serial connection.
Loading

0 comments on commit 1db4f32

Please sign in to comment.