Skip to content

Commit

Permalink
Prepare for beta release
Browse files Browse the repository at this point in the history
  • Loading branch information
@mr-manuel
mr-manuel committed Nov 19, 2024
1 parent 2bd8700 commit 78016ae
Showing 1 changed file with 83 additions and 63 deletions.
146 changes: 83 additions & 63 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,67 +2,17 @@

## Notes

* The Bluetooth and CAN connections are still not stable on some systems. If you want to have a stable connection use the serial connection.
* The Bluetooth connection is still not stable on some systems. If you want to have a stable connection use the serial connection.

## Breaking changes
GitHub: https://github.com/mr-manuel/venus-os_dbus-serialbattery

* Driver version greater or equal to `v1.4.20240714dev`

* Changes to `config.default.ini`: `HELTEC_MODBUS_ADDR` was replaced by `MODBUS_ADDRESSES`.

* Driver version greater or equal to `v1.3.20240625dev`

* `Lifepower` was renamed to `EG4_Lifepower`. You need to change it, if you have specified it in the `config.ini`.

* Driver version greater or equal to `v1.2.20240219dev`

* The temperature limitation variables where changed to match the other variable names.

**OLD**

`TEMPERATURE_LIMITS_WHILE_CHARGING`, `TEMPERATURE_LIMITS_WHILE_DISCHARGING`

**NEW**

`TEMPERATURES_WHILE_CHARGING`, `TEMPERATURES_WHILE_DISCHARGING`

* The SoC limitation variables where changed to match the cell voltage and temperature config.

**OLD**

`CC_SOC_LIMIT1`, `CC_SOC_LIMIT2`, `CC_SOC_LIMIT3`

`CC_CURRENT_LIMIT1_FRACTION`, `CC_CURRENT_LIMIT2_FRACTION`, `CC_CURRENT_LIMIT3_FRACTION`

`DC_SOC_LIMIT1`, `DC_SOC_LIMIT2`, `DC_SOC_LIMIT3`

`DC_CURRENT_LIMIT1_FRACTION`, `DC_CURRENT_LIMIT2_FRACTION`, `DC_CURRENT_LIMIT3_FRACTION`
Documentation: https://mr-manuel.github.io/venus-os_dbus-serialbattery_docs/

**NEW**

`SOC_WHILE_CHARGING`, `MAX_CHARGE_CURRENT_SOC_FRACTION`, `SOC_WHILE_DISCHARGING`, `MAX_DISCHARGE_CURRENT_SOC_FRACTION`


* Driver version greater or equal to `v1.1.20231223dev`

* `PUBLISH_CONFIG_VALUES` now has to be True or False


* Driver version greater or equal to `v1.0.20231128dev`

* The custom name is not saved to the config file anymore, but to the dbus service com.victronenergy.settings. You have to re-enter it once.

* If you selected a specific device in `Settings -> System setup -> Battery monitor` and/or `Settings -> DVCC -> Controlling BMS` you have to reselect it.


* Driver version greater or equal to `v1.0.20230629dev` and smaller or equal to `v1.0.20230926dev`:

With `v1.0.20230927beta` the following values changed names:
* `BULK_CELL_VOLTAGE` -> `SOC_RESET_VOLTAGE`
* `BULK_AFTER_DAYS` -> `SOC_RESET_AFTER_DAYS`
## v1.5.x

### What's Changed

## v1.5.x
* Added: Configurable threshold to prevent rapid switching (flapping) of `CCL` or `DCL` when 0 by @mr-manuel
* Added: Daly BMS - Connect multiple BMS to the same RS485 port by @CaptKrisp
* Added: EG LifePower - Connect multiple BMS to the same RS485 port by @mr-manuel
Expand All @@ -76,8 +26,17 @@
* Changed: Optimized auto increase of the polling time by @mr-manuel
* Changed: Rewritten code for external current sensor and fixed https://github.com/mr-manuel/venus-os_dbus-serialbattery/issues/60 by @mr-manuel


## v1.4.20240928

### Breaking Changes

* Driver version greater or equal to `v1.4.20240714dev`

* Changes to `config.default.ini`: `HELTEC_MODBUS_ADDR` was replaced by `MODBUS_ADDRESSES`.

### What's Changed

* Added: `History()` class that holds all BMS history values by @mr-manuel
* Added: Automatically increase polling time, if polling take too long by @mr-manuel
* Added: Connection Information field which was recently added by Victron on the details page by @mr-manuel
Expand All @@ -103,8 +62,17 @@
* Changed: The setting `HELTEC_MODBUS_ADDR` was replaced by `MODBUS_ADDRESSES` in the `config.default.ini` by @mr-manuel
* Changed: Updated `battery_template.py` and added tons of descriptions by @mr-manuel


## v1.3.20240705

### Breaking Changes

* Driver version greater or equal to `v1.3.20240625dev`

* `Lifepower` was renamed to `EG4_Lifepower`. You need to change it, if you have specified it in the `config.ini`.

### What's Changed

* Added: EG4 LL BMS by @tuxntoast
* Added: Fields for debugging switch to float/bulk by @mr-manuel
* Added: JKBMS PB Model with https://github.com/mr-manuel/venus-os_dbus-serialbattery/pull/39 by @KoljaWindeler
Expand All @@ -130,6 +98,38 @@

## v1.2.20240408

### Breaking Changes

* Driver version greater or equal to `v1.2.20240219dev`

* The temperature limitation variables where changed to match the other variable names.

**OLD**

`TEMPERATURE_LIMITS_WHILE_CHARGING`, `TEMPERATURE_LIMITS_WHILE_DISCHARGING`

**NEW**

`TEMPERATURES_WHILE_CHARGING`, `TEMPERATURES_WHILE_DISCHARGING`

* The SoC limitation variables where changed to match the cell voltage and temperature config.

**OLD**

`CC_SOC_LIMIT1`, `CC_SOC_LIMIT2`, `CC_SOC_LIMIT3`

`CC_CURRENT_LIMIT1_FRACTION`, `CC_CURRENT_LIMIT2_FRACTION`, `CC_CURRENT_LIMIT3_FRACTION`

`DC_SOC_LIMIT1`, `DC_SOC_LIMIT2`, `DC_SOC_LIMIT3`

`DC_CURRENT_LIMIT1_FRACTION`, `DC_CURRENT_LIMIT2_FRACTION`, `DC_CURRENT_LIMIT3_FRACTION`

**NEW**

`SOC_WHILE_CHARGING`, `MAX_CHARGE_CURRENT_SOC_FRACTION`, `SOC_WHILE_DISCHARGING`, `MAX_DISCHARGE_CURRENT_SOC_FRACTION`

### What's Changed

* Added: Check if the device instance is already used by @mr-manuel
* Added: Check if there is enough space on system and data partitions before installation by @mr-manuel
* Added: LLT/JBD BLE BMS - Added MAC address as unique identifier. Fixed https://github.com/Louisvdw/dbus-serialbattery/issues/970 by @mr-manuel
Expand Down Expand Up @@ -161,20 +161,32 @@

## v1.1.20240121

* Changed: Exit the driver with error, when port is excluded in config, else the serialstarter does not continue by @mr-manuel
* Changed: Fixed issue on first driver startup, when no device setting in dbus exists by @mr-manuel
* Changed: Fixed some smaller errors by @mr-manuel
* Changed: More detailed error output when an exception happens by @mr-manuel

### Known issues for v1.1.20240121
### Known issues

* If multiple batteries have the same `unique_identifier`, then they are displayed as one battery in the VRM portal and if you change the name,
it get changed for all dbus-serialbattries. Please change the capacity of the batteries to be unique (if the unique identifier ends with Ah)
or change the custom field on supported BMS.
E.g.: 278 Ah, 279 Ah,280 Ah,281 Ah and 282 Ah, if you have 5 batteries with 280 Ah.

### Breaking Changes

* Driver version greater or equal to `v1.1.20231223dev`

* `PUBLISH_CONFIG_VALUES` now has to be True or False

* Driver version greater or equal to `v1.0.20231128dev`

## v1.0.20240102beta
* The custom name is not saved to the config file anymore, but to the dbus service com.victronenergy.settings. You have to re-enter it once.

* If you selected a specific device in `Settings -> System setup -> Battery monitor` and/or `Settings -> DVCC -> Controlling BMS` you have to reselect it.

* Driver version greater or equal to `v1.0.20230629dev` and smaller or equal to `v1.0.20230926dev`:

With `v1.0.20230927beta` the following values changed names:
* `BULK_CELL_VOLTAGE` -> `SOC_RESET_VOLTAGE`
* `BULK_AFTER_DAYS` -> `SOC_RESET_AFTER_DAYS`

### What's Changed

* Added: Bluetooth: Show signal strength of BMS in log by @mr-manuel
* Added: Configure logging level in `config.ini` by @mr-manuel
Expand Down Expand Up @@ -205,9 +217,12 @@
* Changed: Daly BMS - Fixed https://github.com/Louisvdw/dbus-serialbattery/issues/837 by @mr-manuel
* Changed: Daly BMS - Fixed readsentence by @transistorgit
* Changed: Enable BMS that are disabled by default by specifying it in the config file. No more need to edit scripts by @mr-manuel
* Changed: Exit the driver with error, when port is excluded in config, else the serialstarter does not continue by @mr-manuel
* Changed: Fixed Building wheel for dbus-fast won't finish on weak systems https://github.com/Louisvdw/dbus-serialbattery/issues/785 by @mr-manuel
* Changed: Fixed error in `reinstall-local.sh` script for Bluetooth installation by @mr-manuel
* Changed: Fixed issue on first driver startup, when no device setting in dbus exists by @mr-manuel
* Changed: Fixed meaningless Time to Go values by @transistorgit
* Changed: Fixed some smaller errors by @mr-manuel
* Changed: Fixed typo in `config.ini` sample by @hoschult
* Changed: For BMS_TYPE now multiple BMS can be specified by @mr-manuel
* Changed: Improved battery error handling on connection loss by @mr-manuel
Expand All @@ -226,6 +241,7 @@
* Changed: LLT/JBD BMS - Improved error handling and automatical driver restart in case of error. Fixed https://github.com/Louisvdw/dbus-serialbattery/issues/777 by @mr-manuel
* Changed: LLT/JBD BMS - SOC different in Xiaoxiang app and dbus-serialbattery with https://github.com/Louisvdw/dbus-serialbattery/pull/760 by @idstein
* Changed: Make CCL and DCL limiting messages more clear by @mr-manuel
* Changed: More detailed error output when an exception happens by @mr-manuel
* Changed: Optimized CVL calculation on high cell voltage for smoother charging with https://github.com/Louisvdw/dbus-serialbattery/pull/882 by @cflenker
* Changed: Reduce the big inrush current if the CVL jumps from Bulk/Absorbtion to Float https://github.com/Louisvdw/dbus-serialbattery/issues/659 by @Rikkert-RS & @ogurevich
* Changed: Sinowealth BMS - Fixed not loading https://github.com/Louisvdw/dbus-serialbattery/issues/702 by @mr-manuel
Expand All @@ -236,7 +252,11 @@

## v1.0.20230531

### ATTENTION: Breaking changes! The config is now done in the `config.ini`. All values from the `utils.py` get lost. The changes in the `config.ini` will persists future updates.
### Breaking Changes

* The config is now done in the `config.ini`. All values from the `utils.py` get lost. The changes in the `config.ini` will persists future updates.

### What's Changed

* 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
Expand Down

0 comments on commit 78016ae

Please sign in to comment.