Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge docusaurus into master #871

Merged
merged 46 commits into from
Nov 25, 2023
Merged

Merge docusaurus into master #871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
e91fde7
update faq
mr-manuel May 6, 2023
b725324
Improved install doc
mr-manuel May 8, 2023
5a6919c
Merge 'master' into docusaurus
mr-manuel May 8, 2023
4a2c18e
Modified installation documentation
mr-manuel May 8, 2023
96d0b2b
fix broken link
mr-manuel May 12, 2023
588d080
added faq
mr-manuel May 12, 2023
766395a
Update install info
mr-manuel May 12, 2023
fe2b5f3
Updated docusaurus to the latest version
mr-manuel May 22, 2023
7c32cfc
Added checklist for new BMS
mr-manuel May 22, 2023
43da0e7
fix typo in file reference
ramack May 22, 2023
59d6b37
Merge pull request #661 from ramack/patch-1
mr-manuel May 23, 2023
68d10cc
fixed links
mr-manuel May 23, 2023
9164a08
Merge branch 'docusaurus' of https://github.com/Louisvdw/dbus-serialb…
mr-manuel May 23, 2023
8e40721
Improved documentation
mr-manuel May 24, 2023
009b0f5
added donation notes for mr-manuel
mr-manuel May 26, 2023
ebb5f05
fix error
mr-manuel May 26, 2023
61f1228
added bluetooth info
mr-manuel May 26, 2023
97353ec
updated introduction
mr-manuel May 26, 2023
5ab8921
added how the driver works
mr-manuel May 31, 2023
2a7d14c
solve merge conflicts
mr-manuel May 31, 2023
5d65648
Merge pull request #680 from Louisvdw/master
mr-manuel May 31, 2023
0ee3273
revert changes
mr-manuel May 31, 2023
14ce88b
fix typo
mr-manuel Jun 1, 2023
f5f8ca6
updated checklist for adding new BMS
mr-manuel Jun 6, 2023
44b66c9
added troubleshooting tips
mr-manuel Jun 9, 2023
15c3483
added downgrade info
mr-manuel Jun 10, 2023
5ee5779
added tail info
mr-manuel Jun 10, 2023
627aa74
updated how to enable disabled BMS
mr-manuel Jun 11, 2023
00562e1
added troubleshooting serial starter info
mr-manuel Jun 11, 2023
79ac245
added Daly standby informations
mr-manuel Jun 29, 2023
25a45b0
update packages solves #747
mr-manuel Jul 18, 2023
24e6c71
added info
mr-manuel Jul 22, 2023
c934cdb
moved paragraph and updated
mr-manuel Jul 31, 2023
bdae640
update packages, fix #779
mr-manuel Aug 16, 2023
d89fb9a
fixes 788
mr-manuel Aug 27, 2023
69c7e83
Added FAQ and update packages
mr-manuel Sep 4, 2023
ce2cc93
Add Daly high voltage alarm info
mr-manuel Sep 4, 2023
4bc265c
fix typo
mr-manuel Sep 4, 2023
0b7dc80
updated docusaurus to v2.4.3
mr-manuel Oct 10, 2023
377d92d
Added install info
mr-manuel Nov 2, 2023
6e749d6
updated "supporting this project" section
mr-manuel Nov 19, 2023
5cf356e
Updated docusaurus to v3
mr-manuel Nov 19, 2023
1487914
added info about config files
mr-manuel Nov 20, 2023
9e05cee
Merge master into docusaurus
mr-manuel Nov 25, 2023
87ca111
Merge branch 'master' into docusaurus
mr-manuel Nov 25, 2023
d3fb4fe
Added info for Bluetooth and CAN
mr-manuel Nov 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions docs/README.md
View file
Open in desktop
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
Open in desktop
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` → `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` → `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
Open in desktop
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
Loading