Louisvdw · mr-manuel · May 23, 2023 · Dec 10, 2022 · Dec 25, 2022 · Dec 25, 2022
diff --git a/.flake8 b/.flake8
@@ -1,23 +1,17 @@
 [flake8]
 max-line-length = 120
+per-file-ignores =
+          ./etc/dbus-serialbattery/utils.py: E501
 exclude =
-          ./etc/dbus-serialbattery/ant.py,
-          ./etc/dbus-serialbattery/battery_template.py,
-          ./etc/dbus-serialbattery/daly.py,
-          ./etc/dbus-serialbattery/dbus-serialbattery.py,
-          ./etc/dbus-serialbattery/dbushelper.py,
-          ./etc/dbus-serialbattery/ecs.py,
-          ./etc/dbus-serialbattery/lifepower.py,
-          ./etc/dbus-serialbattery/lltjbd.py,
+          ./etc/dbus-serialbattery/bms/battery_template.py,
+          ./etc/dbus-serialbattery/bms/mnb_test_max17853.py,
+          ./etc/dbus-serialbattery/bms/mnb_utils_max17853.py,
+          ./etc/dbus-serialbattery/bms/revov.py,
+          #./etc/dbus-serialbattery/dbus-serialbattery.py,
+          #./etc/dbus-serialbattery/dbushelper.py,
           ./etc/dbus-serialbattery/minimalmodbus.py,
-          ./etc/dbus-serialbattery/mnb.py,
-          ./etc/dbus-serialbattery/renogy.py,
-          ./etc/dbus-serialbattery/revov.py,
-          ./etc/dbus-serialbattery/sinowealth.py,
-          ./etc/dbus-serialbattery/test_max17853.py,
-          ./etc/dbus-serialbattery/util_max17853.py,
           ./velib_python
           venv
 extend-ignore:
- # E203 whitespace fefore ':' conflicts with black code formatting. Will be ignored in flake8
+ # E203 whitespace before ':' conflicts with black code formatting. Will be ignored in flake8
  E203
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -5,7 +5,9 @@ on:
   # Runs on pushes targeting the default branch
   push:
     # Run on changes in the master branch
-    #branches: [master]:
+    branches:
+      - master
+      - docusaurus
 
     # Run on changes in the docs folder
     paths:
@@ -37,6 +39,9 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
 
+    # execute only in Louisvdw repository
+    if: github.repository_owner == 'Louisvdw'
+
     #defaults:
     #  run:
     #    working-directory: 'docs' # Here the path to the folder where package-lock.json is located.

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,18 +11,20 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+
       - name: build release archive
         run: |
+          find . -type f -name "*.py" -exec chmod +x {} \;
           find . -type f -name "*.sh" -exec chmod +x {} \;
+          find . -type f -name "run" -exec chmod +x {} \;
           tar -czvf venus-data.tar.gz \
             --mode='a+rwX' \
-            --exclude battery_template.py \
             --exclude __pycache__ \
-            --exclude restartservice.sh \
-            --exclude revov.py \
-            --exclude test_max17853.py \
-            conf/serial-starter.d \
+            --exclude bms/battery_template.py \
+            --exclude bms/revov.py \
+            --exclude bms/test_max17853.py \
             etc/dbus-serialbattery/
+
       - name: Release
         uses: softprops/action-gh-release@v1
         with:

diff --git a/.gitignore b/.gitignore
@@ -151,13 +151,17 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
+# VS Code
+.vscode/
+
 # Custom for this repo
 venus-data.tar.gz
 BMS-trials
 .DS_Store
 .project
 .pydevproject
 *.prefs
+etc/dbus-serialbattery/config.ini
 
 # Local Clone of velib_python
-velib_python
+velib_python
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,79 @@
+# Changelog
+
+## v1.0.0-jkbms_ble
+
+### ATTENTION: Breaking changes! The config is now done in the `config.ini`. All values from the `utils.py` gets lost. The changes in the `config.ini` will persists future updates.
+
+* Added: `self.unique_identifier` to the battery class. Used to identify a BMS when multiple BMS are connected - planned for future use by @mr-manuel
+* Added: Alert is triggered, when BMS communication is lost by @mr-manuel
+* Added: Apply max voltage, if `CVCM_ENABLE` is `False`. Before float voltage was applied by @mr-manuel
+* Added: Balancing status for JKBMS by @mr-manuel
+* Added: Balancing switch status for JKBMS by @mr-manuel
+* 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: 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 read capacity https://github.com/Louisvdw/dbus-serialbattery/pull/594 by @transistorgit
+* 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: HighInternalTemperature alarm (MOSFET) for JKBMS by @mr-manuel
+* 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
+* Added: JKBMS BLE - Balancing switch status by @mr-manuel
+* Added: JKBMS BLE - Capacity by @mr-manuel
+* Added: JKBMS BLE - Cell imbalance alert by @mr-manuel
+* Added: JKBMS BLE - Charging switch status by @mr-manuel
+* Added: JKBMS BLE - Discharging switch status by @mr-manuel
+* Added: JKBMS BLE - MOS temperature by @mr-manuel
+* Added: JKBMS BLE - Show if balancing is active and which cells are balancing 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: Reset values to None, if battery goes offline (not reachable for 10s) by @transistorgit
+* Added: Script to install directly from repository by @mr-manuel
+* Added: Show charge mode (absorption, bulk, ...) in Parameters page by @mr-manuel
+* Added: Show charge/discharge limitation reason by @mr-manuel
+* Added: Show MOSFET temperature for JKBMS https://github.com/Louisvdw/dbus-serialbattery/pull/440 by @baphomett
+* Added: Show specific TimeToSoC points in GUI, if 0%, 10%, 20%, 80%, 90% and/or 100% are selected by @mr-manuel
+* 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 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: Default config file by @mr-manuel
+  * 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
+  * Changed TimeToSoc default value `TIME_TO_SOC_VALUE_TYPE` from `Both seconds and time string "<seconds> [<days>d <hours>h <minutes>m <seconds>s]"` to `1 Seconds` by @mr-manuel
+  * Changed TimeToSoc description by @mr-manuel
+  * Changed value positions, added groups and much clearer descriptions by @mr-manuel
+* Changed: Default FLOAT_CELL_VOLTAGE from 3.350 V to 3.375 V by @mr-manuel
+* 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: 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: Fixed black lint errors by @mr-manuel
+* Changed: Fixed cell balancing background for cells 17-24 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 JBD BMS soc calculation https://github.com/Louisvdw/dbus-serialbattery/pull/439 by @aaronreek
+* Changed: Logging to get relevant data by @mr-manuel
+* Changed: Moved Bluetooth part to `reinstall-local.sh` by @mr-manuel
+* Changed: Moved BMS scripts to subfolder 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: Removed all wildcard imports and fixed black lint errors 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
+* Changed: Serial-Starter file is now created from `reinstall-local.sh`. Fixes also https://github.com/Louisvdw/dbus-serialbattery/issues/520 by @mr-manuel
+* Changed: Temperature alarm changed in order to not trigger all in the same condition for JKBMS by @mr-manuel
+* Changed: Time-To-Soc repetition from cycles to seconds. Minimum value is every 5 seconds. This prevents CPU overload and ensures system stability. Renamed `TIME_TO_SOC_LOOP_CYCLES` to `TIME_TO_SOC_RECALCULATE_EVERY` by @mr-manuel
+* Changed: Time-To-Soc string from `days, HR:MN:SC` to `<days>d <hours>h <minutes>m <seconds>s` (same as Time-To-Go) by @mr-manuel
+* Changed: Uninstall also installed Bluetooth modules on uninstall by @mr-manuel
diff --git a/conf/serial-starter.d b/conf/serial-starter.d
diff --git a/docs/docs/general/install.md b/docs/docs/general/install.md
@@ -74,9 +74,9 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
 2. Run these commands to install or update to the latest release version.
 
   ```bash
-  wget -O /tmp/installrelease.sh https://raw.githubusercontent.com/Louisvdw/dbus-serialbattery/master/etc/dbus-serialbattery/installrelease.sh
+  wget -O /tmp/install-release.sh https://raw.githubusercontent.com/Louisvdw/dbus-serialbattery/master/etc/dbus-serialbattery/install-release.sh
 
-  bash /tmp/installrelease.sh
+  bash /tmp/install-release.sh
 
   reboot
   ```
@@ -138,7 +138,7 @@ If you use the cell voltage limits, temperature limits or SoC limits you also ne
 
 ### Settings location/path
 
-💡 After updating the settings reboot the device or run `/data/etc/dbus-serialbattery/reinstalllocal.sh` to apply the changes.
+💡 After updating the settings reboot the device or run `/data/etc/dbus-serialbattery/reinstall-local.sh` to apply the changes.
 
 #### Driver version `<= v0.14.3`
 Edit `/data/etc/dbus-serialbattery/utils.py` to update the constants.
@@ -204,7 +204,7 @@ Edit `/data/etc/dbus-serialbattery/dbus-serialbattery.py` and uncommented (witho
 You can disable the driver so that it will not be run by the GX device. To do that run the following command in SSH.
 
 ```bash
-bash /data/etc/dbus-serialbattery/disabledriver.sh
+bash /data/etc/dbus-serialbattery/disable.sh
 ```
 
 You also need to configure your MPPTs to run in `Stand alone mode` again. Follow the Victron guide for [Err 67 - BMS Connection lost](https://www.victronenergy.com/live/mppt-error-codes#err_67_-_bms_connection_lost).
@@ -213,7 +213,7 @@ You also need to configure your MPPTs to run in `Stand alone mode` again. Follow
 To enable the driver again you can run the installer.
 
 ```bash
-bash /data/etc/dbus-serialbattery/reinstalllocal.sh
+bash /data/etc/dbus-serialbattery/reinstall-local.sh
 ```
 
 ## Uninstall/remove the driver
@@ -236,11 +236,11 @@ rm -rf /opt/victronenergy/service/dbus-serialbattery
 rm -rf /opt/victronenergy/service-templates/dbus-serialbattery
 rm -rf /opt/victronenergy/dbus-serialbattery
 
-# kill if running
+# kill driver, if running
 pkill -f "python .*/dbus-serialbattery.py"
 
 # remove install-script from rc.local
-sed -i "/sh \/data\/etc\/dbus-serialbattery\/reinstalllocal.sh/d" /data/rc.local
+sed -i "/sh \/data\/etc\/dbus-serialbattery\/reinstall-local.sh/d" /data/rc.local
 ```
 
 > If after the uninstall for some reason several items in the GUI were red, DO NOT reboot your GX device. See [Uninstalling driver bricked my cerbo #576](https://github.com/Louisvdw/dbus-serialbattery/issues/576)