Merge master into dev

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -11,11 +11,19 @@ body:
 
         In the case you have difficulties to write in english, try the [deepl.com](https://www.deepl.com) translator.
 
+        ## 🚨 IMPORTANT 🚨
+
+        * Please carefully read all the instructions below including the descriptions! Very often we have to request the data again, because it was not provided in the first place.
+
+        * Please try the `nightly` build from the `dev` first, if you are not already using it. It's very likely that the bug is already fixed. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#nightly-build) how to install it.
+
   - type: textarea
     id: description
     attributes:
       label: Describe the bug
-      description: A clear and concise description of what the bug is. Paste also screenshots, if needed.
+      description: A clear and concise description of what the bug is. Paste also screenshots and pictures, if needed. The more informations you give, the faster we find a solution.
+      placeholder: |
+        NOTE: Paste the logfields in the appropriate field below.
     validations:
       required: true
 
@@ -24,7 +32,7 @@ body:
     attributes:
       label: How to reproduce
       description: Please describe in clear steps how to reproduce the issue. Paste also screenshots, if needed.
-      value: |
+      placeholder: |
         Steps to reproduce the behavior:
         1. Go to '...'
         2. Click on '....'
@@ -45,7 +53,11 @@ body:
     id: driver_version
     attributes:
       label: Driver version
-      description: Visible in the [driver log files](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) or in the remote console/GUI under `SerialBattery` -> `Device` -> `Firmware version`
+      description: |
+        Visible in the [driver log files](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) or in the remote console/GUI under `SerialBattery` -> `Device` -> `Firmware version`.
+
+        ⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
+      placeholder: e.g. v1.0.20230927beta
     validations:
       required: true
 
@@ -63,7 +75,9 @@ body:
         - Ekrano GX
         - GX Card (integrated in Victron device)
         - Octo GX
-        - Raspberry Pi
+        - Raspberry Pi 2
+        - Raspberry Pi 3
+        - Raspberry Pi 4
         - VANcu GX
         - Venus_GX
     validations:
@@ -73,7 +87,10 @@ body:
     id: venus_os_version
     attributes:
       label: Venus OS version
-      description: Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`
+      description: |
+        Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`
+
+        ⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
       placeholder: e.g. v2.94
     validations:
       required: true
@@ -128,7 +145,8 @@ body:
     id: config
     attributes:
       label: Config file
-      description: Paste your config file here. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#settings-locationpath) where you can find it. to get This will be automatically formatted into code, so no need for backticks.
+      description: |
+        Paste your config file here. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#settings-locationpath) where you can find it. The content will be automatically formatted into code, so no need for backticks.
       render: ini
     validations:
       required: true
@@ -137,7 +155,10 @@ body:
     id: logs
     attributes:
       label: Relevant log output
-      description: Please copy and paste any relevant log output here. See [here](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) how to get the driver log files. This will be automatically formatted into code, so no need for backticks.
+      description: |
+        Please copy and paste any relevant log output here. See [here](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) how to get the driver log files. The content will be automatically formatted into code, so no need for backticks.
+
+        ⚠️ **IMPORTANT:** Do not forget to pipe the output through `tai64nlocal`, if you don't copy the commands from the documentation.
       render: shell
     validations:
       required: true
@@ -146,3 +167,4 @@ body:
     id: other
     attributes:
       label: Any other information that may be helpful
+      description: Leave empty, if you already said all

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -11,6 +11,10 @@ body:
 
         In the case you have difficulties to write in english, try the [deepl.com](https://www.deepl.com) translator.
 
+        ## 🚨 IMPORTANT 🚨
+
+        * Please try the `nightly` build from the `dev` first, if you are not already using it. Maybe the feature was already developed. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#nightly-build) how to install it.
+
   - type: textarea
     id: idea
     attributes:

.github/ISSUE_TEMPLATE/support_request.yml

@@ -11,19 +11,31 @@ body:
 
         In the case you have difficulties to write in english, try the [deepl.com](https://www.deepl.com) translator.
 
+        ## 🚨 IMPORTANT 🚨
+
+        * Please carefully read all the instructions below including the descriptions! Very often we have to request the data again, because it was not provided in the first place.
+
+        * Please try the `nightly` build from the `dev` first, if you are not already using it. It's very likely that the bug is already fixed. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#nightly-build) how to install it.
+
   - type: textarea
     id: description
     attributes:
       label: Describe the problem
       description: A clear and concise description of what the problem is. Paste also screenshots and pictures, if needed. The more informations you give, the faster we find a solution.
+      placeholder: |
+        NOTE: Paste the logfields in the appropriate field below.
     validations:
       required: true
 
   - type: input
     id: driver_version
     attributes:
       label: Driver version
-      description: Visible in the [driver log files](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) or in the remote console/GUI under `SerialBattery` -> `Device` -> `Firmware version`
+      description: |
+        Visible in the [driver log files](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) or in the remote console/GUI under `SerialBattery` -> `Device` -> `Firmware version`.
+
+        ⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
+      placeholder: e.g. v1.0.20230927beta
     validations:
       required: true
 
@@ -51,7 +63,10 @@ body:
     id: venus_os_version
     attributes:
       label: Venus OS version
-      description: Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`
+      description: |
+        Visible in the remote console/GUI under `Settings` -> `Firmware` -> `Firmware version`
+
+        ⚠️ **IMPORTANT:** Do not write `latest` and specify the exact version number, else we cannot help you.
       placeholder: e.g. v2.94
     validations:
       required: true
@@ -97,6 +112,7 @@ body:
         - Please select
         - Serial USB adapter to TTL
         - Serial USB adapter to RS485
+        - Raspberry Pi RS485 HAT
         - Bluetooth
     validations:
       required: true
@@ -105,7 +121,8 @@ body:
     id: config
     attributes:
       label: Config file
-      description: Paste your config file here. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#settings-locationpath) where you can find it. to get This will be automatically formatted into code, so no need for backticks.
+      description: |
+        Paste your config file here. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#settings-locationpath) where you can find it. The content will be automatically formatted into code, so no need for backticks.
       render: ini
     validations:
       required: true
@@ -114,7 +131,9 @@ body:
     id: logs
     attributes:
       label: Relevant log output
-      description: Please copy and paste any relevant log output here. See [here](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) how to get the driver log files. This will be automatically formatted into code, so no need for backticks.
+      description: |
+        Please copy and paste any relevant log output here. See [here](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/#driver-log-files) how to get the driver log files. The content will be automatically formatted into code, so no need for backticks.
+        ⚠️ **IMPORTANT:** Do not forget to pipe the output through `tai64nlocal`, if you don't copy the commands from the documentation.
       render: shell
     validations:
       required: true
@@ -123,3 +142,4 @@ body:
     id: other
     attributes:
       label: Any other information that may be helpful
+      description: Leave empty, if you already said all

.github/workflows/github-pages.yml

@@ -53,7 +53,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 21.x
           cache: yarn
           cache-dependency-path: './docs/yarn.lock' # THIS PATTERN did the trick for me.
 

README.md

@@ -23,12 +23,12 @@ If you find this driver helpful please consider supporting this project. You can
 
 ### Support [mr-manuel](https://github.com/mr-manuel)
 * Added a lot of features, optimizations and improvements with `v1.0.x`
+* Assistance with the issues and discussions of forum
 * 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" height="38">](https://www.paypal.com/donate/?hosted_button_id=3NEVZBDM5KABW)
 
-
 ### Developer Remarks
 To develop this project, install the requirements. This project makes use of velib_python which is pre-installed on
 Venus-OS Devices under `/opt/victronenergy/dbus-systemcalc-py/ext/velib_python`. To use the python files locally,

docs/README.md

@@ -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.
@@ -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
+```

docs/docs/faq/index.md

@@ -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).
 
@@ -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)
 
@@ -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).
@@ -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.
 
@@ -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).