Merge pull request #680 from Louisvdw/master

Merge master into docusaurus

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -119,6 +119,7 @@ body:
         - Please select
         - Serial USB adapter to TTL
         - Serial USB adapter to RS485
+        - Raspberry Pi RS485 HAT
         - Bluetooth
     validations:
       required: true

.github/workflows/release-beta.yml

@@ -17,6 +17,16 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Replace version string
+        run: |
+          echo $GITHUB_REF_NAME
+          VERSION=$(echo $GITHUB_REF_NAME | sed 's/^v//')
+          echo $VERSION
+          echo
+          head -n 39 etc/dbus-serialbattery/utils.py | tail -n 3
+          sed -i --regexp-extended --expression="s/[0-9]+\.[0-9]+\.[0-9a-z\_\-]+/$VERSION/" "etc/dbus-serialbattery/utils.py"
+          head -n 39 etc/dbus-serialbattery/utils.py | tail -n 3
+
       - name: build release archive
         run: |
           find . -type f -name "*.py" -exec chmod +x {} \;

.github/workflows/release.yml

@@ -16,6 +16,16 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Replace version string
+        run: |
+          echo $GITHUB_REF_NAME
+          VERSION=$(echo $GITHUB_REF_NAME | sed 's/^v//')
+          echo $VERSION
+          echo
+          head -n 39 etc/dbus-serialbattery/utils.py | tail -n 3
+          sed -i --regexp-extended --expression="s/[0-9]+\.[0-9]+\.[0-9a-z\_\-]+/$VERSION/" "etc/dbus-serialbattery/utils.py"
+          head -n 39 etc/dbus-serialbattery/utils.py | tail -n 3
+
       - name: build release archive
         run: |
           find . -type f -name "*.py" -exec chmod +x {} \;

CHANGELOG.md

@@ -12,18 +12,22 @@
 * Added: Balancing switch status to the GUI -> SerialBattery -> IO by @mr-manuel
 * Added: Block charge/discharge when BMS communication is lost. Can be enabled trough the config file by @mr-manuel
 * Added: Charge Mode display by @mr-manuel
+* Added: Check minimum required Venus OS version before installing by @mr-manuel
 * Added: Choose how battery temperature is assembled (mean temp 1 & 2, only temp 1 or only temp 2) by @mr-manuel
 * Added: Config file by @ppuetsch
 * Added: Create empty `config.ini` for easier user usage by @mr-manuel
 * Added: Cronjob to restart Bluetooth service every 12 hours by @mr-manuel
+* Added: Daly BMS - Discharge / Charge Mosfet switching over remote console/GUI https://github.com/Louisvdw/dbus-serialbattery/issues/26 by @transistorgit
 * Added: Daly BMS - Read capacity https://github.com/Louisvdw/dbus-serialbattery/pull/594 by @transistorgit
 * Added: Daly BMS - Read production date and build unique identifier by @transistorgit
 * Added: Daly BMS - Set SoC by @transistorgit
 * Added: Daly BMS - Show "battery code" field that can be set in the Daly app by @transistorgit
 * Added: Device name field (found in the GUI -> SerialBattery -> Device), that show a custom string that can be set in some BMS, if available by @mr-manuel
 * Added: Driver uninstall script by @mr-manuel
 * Added: Fix for Venus OS >= v3.00~14 showing unused items https://github.com/Louisvdw/dbus-serialbattery/issues/469 by @mr-manuel
+* Added: HeltecSmartBMS driver by @ramack
 * Added: HighInternalTemperature alarm (MOSFET) for JKBMS by @mr-manuel
+* Added: HLPdata BMS driver by @ peterohman
 * Added: Improved maintainability (flake8, black lint), introduced code checks and automate release build https://github.com/Louisvdw/dbus-serialbattery/pull/386 by @ppuetsch
 * Added: Install needed Bluetooth components automatically after a Venus OS upgrade by @mr-manuel
 * Added: JKBMS - MOS temperature https://github.com/Louisvdw/dbus-serialbattery/pull/440 by @baphomett
@@ -37,12 +41,16 @@
 * Added: JKBMS BLE - Show if balancing is active and which cells are balancing by @mr-manuel
 * Added: JKBMS BLE - Show serial number and "User Private Data" field that can be set in the JKBMS App to identify the BMS in a multi battery environment by @mr-manuel
 * Added: JKBMS BLE driver by @baranator
+* Added: LLT/JBD BMS BLE driver by @idstein
 * Added: Possibility to add `config.ini` to the root of a USB flash drive on install via the USB method by @mr-manuel
+* Added: Possibility to configure a `VOLTAGE_DROP` voltage, if you are using a SmartShunt as battery monitor as there is a little voltage difference https://github.com/Louisvdw/dbus-serialbattery/discussions/632 by @mr-manuel
 * Added: Post install notes by @mr-manuel
 * Added: Read charge/discharge limits from JKBMS by @mr-manuel
 * Added: Recalculation interval in linear mode for CVL, CCL and DCL by @mr-manuel
+* Added: Rename TAR file after USB/SD card install to not overwrite the data on every reboot https://github.com/Louisvdw/dbus-serialbattery/issues/638 by @mr-manuel
 * Added: Reset values to None, if battery goes offline (not reachable for 10s). Fixes https://github.com/Louisvdw/dbus-serialbattery/issues/193 https://github.com/Louisvdw/dbus-serialbattery/issues/64 by @transistorgit
 * Added: Script to install directly from repository by @mr-manuel
+* Added: Seplos BMS driver by @wollew
 * Added: Serial number field (found in the GUI -> SerialBattery -> Device), that show the serial number or a unique identifier for the BMS, if available by @mr-manuel
 * Added: Show charge mode (absorption, bulk, ...) in Parameters page by @mr-manuel
 * Added: Show charge/discharge limitation reason by @mr-manuel
@@ -52,11 +60,15 @@
 * Added: Show TimeToGo in GUI only, if enabled by @mr-manuel
 * Added: Support for HLPdata BMS4S https://github.com/Louisvdw/dbus-serialbattery/pull/505 by @peterohman
 * Added: Support for Seplos BMS https://github.com/Louisvdw/dbus-serialbattery/pull/530 by @wollew
+* Added: Temperature 1-4 are now also available on the dbus and MQTT by @idstein
 * Added: Temperature name for temperature sensor 1 & 2. This allows to see which sensor is low and high (e.g. battery and cable) by @mr-manuel
 * Changed: `reinstall-local.sh` to recreate `/data/conf/serial-starter.d`, if deleted by `disable.sh` --> to check if the file `conf/serial-starter.d` could now be removed from the repository by @mr-manuel
 * Changed: Added QML to `restore-gui.sh` by @mr-manuel
 * Changed: Bash output by @mr-manuel
+* Changed: CVL calculation improvement. Removed cell voltage penalty. Replaced by automatic voltage calculation. Max voltage is kept until cells are balanced and reset when cells are inbalanced or SoC is below threshold by @mr-manuel
+* Changed: Daly BMS - Fixed BMS alerts by @mr-manuel
 * Changed: Daly BMS - Improved driver stability by @transistorgit & @mr-manuel
+* Changed: Daly BMS - Reworked serial parser by @transistorgit
 * Changed: Default config file by @ppuetsch
   * Added missing descriptions to make it much clearer to understand by @mr-manuel
   * Changed name from `default_config.ini` to `config.default.ini` https://github.com/Louisvdw/dbus-serialbattery/pull/412#issuecomment-1434287942 by @mr-manuel
@@ -67,14 +79,17 @@
 * Changed: Default LINEAR_LIMITATION_ENABLE from False to True by @mr-manuel
 * Changed: Disabled ANT BMS by default https://github.com/Louisvdw/dbus-serialbattery/issues/479 by @mr-manuel
 * Changed: Driver can now also start without serial adapter attached for Bluetooth BMS by @seidler2547
+* Changed: Feedback from BMS driver to know, if BMS is found or not by @mr-manuel
 * Changed: Fix for https://github.com/Louisvdw/dbus-serialbattery/issues/239 by @mr-manuel
 * Changed: Fix for https://github.com/Louisvdw/dbus-serialbattery/issues/311 by @mr-manuel
 * Changed: Fix for https://github.com/Louisvdw/dbus-serialbattery/issues/351 by @mr-manuel
 * Changed: Fix for https://github.com/Louisvdw/dbus-serialbattery/issues/397 by @transistorgit
 * Changed: Fix for https://github.com/Louisvdw/dbus-serialbattery/issues/421 by @mr-manuel
 * Changed: Fix for https://github.com/Louisvdw/dbus-serialbattery/issues/450 by @mr-manuel
+* Changed: Fix for https://github.com/Louisvdw/dbus-serialbattery/issues/648 by @mr-manuel
 * Changed: Fixed black lint errors by @mr-manuel
 * Changed: Fixed cell balancing background for cells 17-24 by @mr-manuel
+* Changed: Fixed cell balancing display for JBD/LLT BMS https://github.com/Louisvdw/dbus-serialbattery/issues/359 by @mr-manuel
 * Changed: Fixed Time-To-Go is not working, if `TIME_TO_SOC_VALUE_TYPE` is set to other than `1` https://github.com/Louisvdw/dbus-serialbattery/pull/424#issuecomment-1440511018 by @mr-manuel
 * Changed: Improved install workflow via USB flash drive by @mr-manuel
 * Changed: Improved JBD BMS soc calculation https://github.com/Louisvdw/dbus-serialbattery/pull/439 by @aaronreek
@@ -83,7 +98,6 @@
 * Changed: Moved Bluetooth part to `reinstall-local.sh` by @mr-manuel
 * Changed: Moved BMS scripts to subfolder by @mr-manuel
 * Changed: Removed all wildcard imports and fixed black lint errors by @mr-manuel
-* Changed: Removed cell voltage penalty. Replaced by automatic voltage calculation. Max voltage is kept until cells are balanced and reset when cells are inbalanced by @mr-manuel
 * Changed: Renamed scripts for better reading #532 by @mr-manuel
 * Changed: Reworked and optimized installation scripts by @mr-manuel
 * Changed: Separate Time-To-Go and Time-To-SoC activation by @mr-manuel

README.md

@@ -1,25 +1,44 @@
 # 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](https://louisvdw.github.io/dbus-serialbattery/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.
 
- * [BMS Types supported](https://github.com/Louisvdw/dbus-serialbattery/wiki/BMS-types-supported)
- * [FAQ](https://github.com/Louisvdw/dbus-serialbattery/wiki/FAQ)
- * [Features](https://github.com/Louisvdw/dbus-serialbattery/wiki/Features)
- * [How to install](https://github.com/Louisvdw/dbus-serialbattery/wiki/How-to-install)
- * [Troubleshoot](https://github.com/Louisvdw/dbus-serialbattery/wiki/Troubleshoot)
+## Documentation
 
-### Supporting this project:
-If you find this driver helpful please considder supporting this project. You can buy me a Ko-Fi or get in contact if you would like to donate hardware.
+* [Introduction](https://louisvdw.github.io/dbus-serialbattery/)
+* [Features](https://louisvdw.github.io/dbus-serialbattery/general/features)
+* [Supported BMS](https://louisvdw.github.io/dbus-serialbattery/general/supported-bms)
+* [How to install, update, disable, enable and uninstall](https://louisvdw.github.io/dbus-serialbattery/general/install)
+* [How to troubleshoot](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/)
+* [FAQ](https://louisvdw.github.io/dbus-serialbattery/faq/)
+
+### 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.
+
+### 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" 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,
 `git clone` the [velib_python](https://github.com/victronenergy/velib_python) project to velib_python and add
 velib_python to the `PYTHONPATH` environment variable.
 
+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. 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.
+
+See this checklist, if you want to [add a new BMS](https://louisvdw.github.io/dbus-serialbattery/general/supported-bms#add-by-opening-a-pull-request)
+
 #### How it works
 * Each supported BMS needs to implement the abstract base class `Battery` from `battery.py`.
 * `dbus-serialbattery.py` tries to figure out the correct connected BMS by looping through all known implementations of

docs/docs/general/supported-bms.md

@@ -22,6 +22,9 @@ Disabled by default since driver version `v0.14.0` as it causes other issues. Se
 
 ### • ECS GreenMeter with LiPro
 
+### • HeltecModbus SmartBMS (YanYang BMS)
+Communication to the Heltec SmartBMS (which is a rebranded YYBMS) via Modbus/RS485.
+
 ### • HLPdataBMS4S
 
 ### &bull; [JKBMS](https://www.jkbms.com/products/) / Heltec BMS <img src="../img/bluetooth.svg" className="h-1em" />