Switch to aiobmsble library usage (#477)

* migrate to aiobmsble

* disable mypy

* fix device discovery for aiobmsble

* add test for v2 config entry

not yet correct

* complete test coverage

* Update aiobmsble to 0.2.2

* disable fuzz tests

* update for new retry-connector

* update requirements

* Update fuzzing.yaml

* Update manifest.json

* Update README.md

* Feature align aiobmsble (#488)

* adapt naming

- `AdvertisementPattern` to `MatcherPattern`
- `reconnect` to `keep_alive`

* remove dummy example

* fix removal of 0 values in _temp_values() (#480)

* Add Seplos `SP1??B*` pattern (#482)

* Feature align aiobmsble (#481)

* adapt naming

- `AdvertisementPattern` to `MatcherPattern`
- `reconnect` to `keep_alive`

* remove dummy example

* Add detection of LiTime 24V BMS type based on serial number (#484)

* Fix operator precedence (#485)

* fix removal of 0 values in _temp_values()

* fix operator precedence

* Support ANT BMS (legacy BLE protocol) (#468)

* Support ANT BMS (legacy BLE protocol)

* Refine frame parsing for ant_bms_legacy

* Add basic testing for ant_bms_legacy

* Rename plugin ant_bms_legacy to ant_legacy_bms to comply with component conventions

* Fix ant_legacy_bms test coverage

* Fix compliancy with bms_ble repository design

* Add 'total_charge' value (#476) to results

* Remove 'dead' code

* Remove unused import

* Fix temperature sensors count

* Remove cell high/low voltage parsing and calc 'delta_voltage' from internal '_add_missing_values'

* Remove local reference to self._data in member function body

* Fix 'BaseBMS._temp_values' operator precedence

* Fix imported symbol

* Fix missing comma after manual merge

* fix pylint issues

* fix design_capacity / temp sensors

* add typing

* Update ant_legacy_bms.py

* align constants

* test to check design capacity provision

* rename legacy bms

* Update README.md

---------

Co-authored-by: patman15 <14628713+patman15@users.noreply.github.com>

* update to 1.21.0

---------

Co-authored-by: krahabb <13969600+krahabb@users.noreply.github.com>

* fix ant_leg_bms inclusion

* Update CONTRIBUTING.md

* Update README.md

---------

Co-authored-by: krahabb <13969600+krahabb@users.noreply.github.com>

Author: patman15

.github/workflows/fuzzing.yaml

@@ -3,10 +3,10 @@ permissions:
   contents: read
 
 on:
-  pull_request:
+#  pull_request:
   workflow_dispatch:
-  schedule:
-    - cron:  '1 5 * * *'
+#  schedule:
+#    - cron:  '1 5 * * *'
 
 jobs:
   validate:

.pre-commit-config.yaml

@@ -3,9 +3,10 @@ repos:
     rev: v0.11.0  # ruff version, needs to match installed version
     hooks:
       - id: ruff
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.17.0  # Use the latest stable version of mypy
-    hooks:
-      - id: mypy
-        args: ["--allow-subclassing-any"]  # avoid HA dependency installation
-        # args: [--ignore-missing-imports]  # Optional: customize your mypy flags
+  # - repo: https://github.com/pre-commit/mirrors-mypy
+  #   rev: v1.17.0  # Use the latest stable version of mypy
+  #   hooks:
+  #     - id: mypy
+  #       additional_dependencies: [homeassistant==2025.7.0] # takes long thus mypy disabled here
+  #       args: ["--allow-subclassing-any"]  # avoid HA dependency installation
+  #       # args: [--ignore-missing-imports]  # Optional: customize your mypy flags

CONTRIBUTING.md

@@ -3,14 +3,13 @@
 ## Issues
 In case you have troubles, please [enable the debug protocol](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics) for the [integration](https://my.home-assistant.io/redirect/integration/?domain=bms_ble) and [open an issue](https://github.com/patman15/BMS_BLE-HA/issues) with a good description of what happened and attach the log **as a file**.
 
-## Architecture Guidelines
-- The integration shall not use persistent information. That means all necessary info shall be determined on connecting the device.
-- The BT pattern matcher shall be unique to allow auto-detecting devices.
-- Frame parsing shall check the validity of a frame according to the protocol type, e.g. CRC, length, allowed type
-- All plugin classes shall inherit from `BaseBMS` and use the functions from there before overriding or replacing.
-- If available the data shall be read from the device, the `BaseBMS._add_missing_values()` functionality is only to have consistent data over all BMS types.
+## Adding a new battery management system
 
-to be extended ...
+The handling of the BMS types is done by the external library [aiobmsble](https://github.com/patman15/aiobmsble). To add a new type, please see the [CONTRIBUTING](https://github.com/patman15/aiobmsble?tab=contributing-ov-file) guidelines of this repository.
+ 
+### Any contributions you make will be under the Apache-2.0 License
+
+In short, when you submit code changes, your submissions are understood to be under the same [Apache-2.0](LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
 
 ## Coding Style Guidelines
 
@@ -19,22 +18,10 @@ In general I use guidelines very close to the ones that Home Assistant uses for
 - `ruff check .`
 - `mypy .`
 
-## Adding a new battery management system
-
- 1. Fork the repository and create a branch with the name of the new BMS to add.
- 2. Add a new file to the `plugins` folder called, e.g. `my_bms.py`
- 3. Populate the file with class called `BMS` derived from `BaseBMS`(see basebms.py). A dummy implementation without the actual functionality to query the BMS can befound below in section _Dummy BMS Example_
- 4. Make sure that the dictionary returned by `async_update()` has (all) keys listed in `SENSOR_TYPES` (see `sensor.py`), __except__ for `ATTR_LQ` and `ATTR_RSSI` which are automatically handled. To make it simple, just follow the `ATTR_*` import in the example code below.
- 5. In `const.py` add the filename (without extention), e.g. `my_bms`, to the constant `BMS_TYPES`.
- 6. Add an appropriate [bluetooth device matcher](https://developers.home-assistant.io/docs/creating_integration_manifest#bluetooth) to `manifest.json`. Note that this is required to match the implementation of `match_dict_list()` in the new BMS class.
- 7. Test and commit the changes to the branch and create a pull request to the main repository.
-
 > [!NOTE]
 > In order to keep maintainability of this integration, pull requests are required to pass standard Home Assistant checks for integrations, [coding style guidelines](#coding-style-guidelines), Python linting, and 100% [branch test coverage](https://coverage.readthedocs.io/en/latest/branch.html#branch).
 
-### Any contributions you make will be under the Apache-2.0 License
-
-In short, when you submit code changes, your submissions are understood to be under the same [Apache-2.0](LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
+## Architecture Guidelines
+- The integration shall not use persistent information. That means all necessary info shall be determined on connecting the device.
 
-### Dummy BMS Example
-Note: In order for the [example](custom_components/bms_ble/plugins/dummy_bms.py) to work, you need to set the UUIDs of the service, the characteristic providing notifications, and the characteristic for sending commands to. While the device must be in Bluetooth range, the actual communication does not matter. Always the fixed values in the code will be shown.
+to be extended ...

README.md

@@ -30,7 +30,7 @@ This integration allows to monitor Bluetooth Low Energy (BLE) battery management
 - Any number of batteries in parallel
 - Native Home Assistant integration (works with all [HA installation methods](https://www.home-assistant.io/installation/#advanced-installation-methods))
 - Readout of individual cell voltages to be able to judge battery health
-- 100% test coverage plus fuzz tests for BLE data
+- 100% test coverage
 
 ### Supported Devices
 - ABC/SOK BMS (show up as `ABC-`…, `SOK-`…)
@@ -69,9 +69,6 @@ This integration allows to monitor Bluetooth Low Energy (BLE) battery management
     - Wattcycle batteries
 - TianPower BMS (show up as `TP_`…)
 
-> [!TIP]
-> New device types can be easily added via the plugin architecture of this integration. See the [contribution guidelines](CONTRIBUTING.md) for details.
-
 ### Provided Information
 > [!CAUTION]
 > This integration (including Home Assistant) **shall not be used for safety relevant operations**! The correctness or availability of data cannot be guaranteed (see [warranty section of the license](LICENSE)),

custom_components/bms_ble/__init__.py

@@ -78,16 +78,18 @@ async def async_migrate_entry(
     hass: HomeAssistant, config_entry: BTBmsConfigEntry
 ) -> bool:
     """Migrate old entry."""
+    _latest_version: Final[int] = 2
 
-    if config_entry.version > 1:
+    if config_entry.version > _latest_version:
         # This means the user has downgraded from a future version
         LOGGER.debug("Cannot downgrade from version %s", config_entry.version)
         return False
 
     LOGGER.debug("Migrating from version %s", config_entry.version)
 
     if config_entry.version == 0:
-        bms_type = config_entry.data["type"]
+        bms_type: str = str(config_entry.data["type"])
+        new: dict[str, str] = {}
         if bms_type == "OGTBms":
             new = {"type": "custom_components.bms_ble.plugins.ogt_bms"}
         elif bms_type == "DalyBms":
@@ -105,6 +107,13 @@ async def async_migrate_entry(
             config_entry, data=new, minor_version=0, version=1
         )
 
+    if config_entry.version == 1:
+        bms_type = str(config_entry.data["type"])
+        new = {"type": f"aiobmsble.bms.{bms_type.rsplit(".", 1)[-1]}"}
+        hass.config_entries.async_update_entry(
+            config_entry, data=new, minor_version=0, version=2
+        )
+
     LOGGER.debug(
         "Migration to version %s.%s successful",
         config_entry.version,

custom_components/bms_ble/binary_sensor.py

@@ -2,7 +2,9 @@
 
 from collections.abc import Callable
 
-from custom_components.bms_ble.plugins.basebms import BMSmode, BMSsample
+from aiobmsble import BMSmode
+from aiobmsble.basebms import BMSsample
+
 from homeassistant.components.binary_sensor import (
     BinarySensorDeviceClass,
     BinarySensorEntity,

custom_components/bms_ble/config_flow.py

@@ -1,11 +1,12 @@
 """Config flow for BLE Battery Management System integration."""
 
 from dataclasses import dataclass
-from types import ModuleType
 from typing import Any, Final
 
+from aiobmsble.utils import bms_identify
 import voluptuous as vol
 
+from custom_components.bms_ble.const import DOMAIN, LOGGER
 from homeassistant import config_entries
 from homeassistant.components.bluetooth import (
     BluetoothServiceInfoBleak,
@@ -14,20 +15,17 @@
 from homeassistant.config_entries import ConfigFlowResult
 from homeassistant.const import CONF_ADDRESS, CONF_ID, CONF_MODEL, CONF_NAME
 from homeassistant.helpers.device_registry import format_mac
-from homeassistant.helpers.importlib import async_import_module
 from homeassistant.helpers.selector import (
     SelectOptionDict,
     SelectSelector,
     SelectSelectorConfig,
 )
 
-from .const import BMS_TYPES, DOMAIN, LOGGER
-
 
 class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
     """Handle a config flow for BT Battery Management System."""
 
-    VERSION = 1
+    VERSION = 2
     MINOR_VERSION = 0
 
     @dataclass
@@ -52,22 +50,15 @@ async def _async_device_supported(
         self, discovery_info: BluetoothServiceInfoBleak
     ) -> str | None:
         """Check if device is supported by an available BMS class."""
-        for bms_type in BMS_TYPES:
-            bms_plugin: ModuleType = await async_import_module(
-                self.hass, f"custom_components.bms_ble.plugins.{bms_type}"
-            )
-            try:
-                if bms_plugin.BMS.supported(discovery_info):
-                    LOGGER.debug(
-                        "Device %s (%s) detected as '%s'",
-                        discovery_info.name,
-                        format_mac(discovery_info.address),
-                        bms_plugin.BMS.device_id(),
-                    )
-                    return bms_plugin.__name__
-            except AttributeError:
-                LOGGER.error("Invalid BMS plugin %s", bms_type)
-        return None
+        if not (bms_class := bms_identify(discovery_info.advertisement)):
+            return None
+        LOGGER.debug(
+            "Device %s (%s) detected as '%s'",
+            discovery_info.name,
+            format_mac(discovery_info.address),
+            bms_class.device_id(),
+        )
+        return str(bms_class.get_bms_module())
 
     async def async_step_bluetooth(
         self, discovery_info: BluetoothServiceInfoBleak
@@ -78,14 +69,11 @@ async def async_step_bluetooth(
         await self.async_set_unique_id(discovery_info.address)
         self._abort_if_unique_id_configured()
 
-        device_class: Final[str | None] = await self._async_device_supported(
-            discovery_info
-        )
-        if device_class is None:
+        if not (bms_module := await self._async_device_supported(discovery_info)):
             return self.async_abort(reason="not_supported")
 
         self._disc_dev = ConfigFlow.DiscoveredDevice(
-            discovery_info.name, discovery_info, device_class
+            discovery_info.name, discovery_info, bms_module
         )
         self.context["title_placeholders"] = {
             CONF_NAME: self._disc_dev.name,
@@ -136,14 +124,11 @@ async def async_step_user(
             address = discovery_info.address
             if address in current_addresses or address in self._disc_devs:
                 continue
-            device_class: str | None = await self._async_device_supported(
-                discovery_info
-            )
-            if not device_class:
+            if not (bms_module := await self._async_device_supported(discovery_info)):
                 continue
 
             self._disc_devs[address] = ConfigFlow.DiscoveredDevice(
-                discovery_info.name, discovery_info, device_class
+                discovery_info.name, discovery_info, bms_module
             )
 
         if not self._disc_devs:

custom_components/bms_ble/coordinator.py

@@ -5,6 +5,8 @@
 from time import monotonic
 from typing import Final
 
+from aiobmsble import BMSsample
+from aiobmsble.basebms import BaseBMS
 from bleak.backends.device import BLEDevice
 from bleak.exc import BleakError
 from habluetooth import BluetoothServiceInfoBleak
@@ -17,7 +19,6 @@
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from .const import DOMAIN, LOGGER, UPDATE_INTERVAL
-from .plugins.basebms import BaseBMS, BMSsample
 
 
 class BTBmsCoordinator(DataUpdateCoordinator[BMSsample]):
@@ -40,7 +41,9 @@ def __init__(
             config_entry=config_entry,
         )
         self._device: Final[BaseBMS] = bms_device
-        self._link_q: deque[bool] = deque([False], maxlen=100)  # track BMS update issues
+        self._link_q: deque[bool] = deque(
+            [False], maxlen=100
+        )  # track BMS update issues
         self._mac: Final[str] = ble_device.address
         self._stale: bool = False  # indicates no BMS response for significant time
 

custom_components/bms_ble/manifest.json

@@ -336,9 +336,10 @@
   "iot_class": "local_polling",
   "issue_tracker": "https://github.com/patman15/BMS_BLE-HA/issues",
   "loggers": [
-    "bleak_retry_connector"
+    "bleak_retry_connector",
+    "aiobmsble"
   ],
   "quality_scale": "silver",
-  "requirements": [],
-  "version": "1.21.0"
+  "requirements": ["aiobmsble==0.2.3"],
+  "version": "2.0.0-beta.2"
 }