Merge branch 'main' into 509-eg4-ll-server-rack-battery

Author: patman15

.github/workflows/stale.yaml

@@ -12,11 +12,11 @@ jobs:
     steps:
       - uses: actions/stale@v9
         with:
-          stale-issue-message: 'This issue is stale because it has been open 32 days with no activity. Remove stale label or comment or this will be closed in 8 days.'
-          stale-pr-message: 'This PR is stale because it has been open 32 days with no activity.'
+          stale-issue-message: 'This issue is stale because it has been open 24 days with no activity. Remove stale label or comment or this will be closed in 8 days.'
+          stale-pr-message: 'This PR is stale because it has been open 24 days with no activity.'
           close-issue-message: 'This issue was closed because it has been stalled for 8 days with no activity.'
           exempt-issue-labels: 'bug'
           exempt-all-assignees: true
-          days-before-stale: 32
+          days-before-stale: 24
           days-before-close: 8
           days-before-pr-close: -1

README.md

@@ -26,7 +26,7 @@ This integration allows to monitor Bluetooth Low Energy (BLE) battery management
 ## Features
 - Zero configuration
 - Auto detects compatible batteries
-- Supports [ESPHome Bluetooth proxy][btproxy-url]  (limit: 3 devices/proxy)
+- Supports [ESPHome Bluetooth proxy][btproxy-url]
 - 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
@@ -50,6 +50,7 @@ This integration allows to monitor Bluetooth Low Energy (BLE) battery management
 - Ective, Startcraft, Topband batteries (show up as `$PFLAC`…, `NWJ20`…, `ZM20`…)
 - EG4 BMS
 - Felicity ESS (show up as `F10`…) and FLB batteries (show up as `F07`…)
+- Gobel Power BMS (show up as `BMS-`…)
 - HumsiENK Smart BMS (show up as `HS`…)
 - JBD BMS, Jiabaida, Xiaoxiang (show up as `JBD-`…)
     - accurat batteries, Aolithium batteries
@@ -59,6 +60,7 @@ This integration allows to monitor Bluetooth Low Energy (BLE) battery management
 - JK BMS, Jikong, (HW version ≥ 6 required)
 - LiTime, Power Queen, and Redodo batteries
 - LiPower BMS
+    - Ective batteries
 - NEEY balancer (4th gen) (show up as `GW-24S`…)
 - Offgridtec LiFePo4 Smart Pro: type A & B (show up as `SmartBat-A`… or `SmartBat-B`…)
 - PaceEX BMS (show up as `PC-`…)
@@ -73,6 +75,8 @@ This integration allows to monitor Bluetooth Low Energy (BLE) battery management
 - Super-B Epsilon BMS (show up as `Epsilon-`…)
 - TDT BMS
     - Wattcycle batteries
+- Topband BMS
+    - Ective, Startcraft, KiloVault batteries
 - TianPower BMS (show up as `TP_`…)
 - Vatrer BMS (show up as `YYMMDDVVVAAAAxx` (date, V, Ah))
 - Wattstunde Nova Core
@@ -162,15 +166,16 @@ These batteries need a shorter interval between queries. Be a bit patient to get
 The internal Bluetooth adapter issues <code>AT</code> commands in regular intervals which can interfere with BMS messages causing them to be corrupted. This impacts data availability (<code>link quality</code>).
 </details>
 
-### If your device is not recognized
+### If your device is not recognized / initialized
 
 1. Check that your BMS type is listed as [supported device](#supported-devices)
 1. If a name detection pattern is listed ("show up as"), make sure your device matches it.
 1. Check the [known issues](#known-issues) for an entry for your BMS.
 1. Make sure that no other device is connected to the BMS, e.g. app on your phone
 1. Check that your are running the [latest release](https://github.com//patman15/BMS_BLE-HA/releases) of the integration
 1. Go to the [advertisement monitor](https://my.home-assistant.io/redirect/bluetooth_advertisement_monitor/) and verify that your device shows up there. Also, please ensure that your `RSSI` value is `>= -75 dBm`. If your device is missing or the `RSSI` value is `-80 dBm`or worse, please check your BT setup (is the device in range?).
-1. If you use a BT proxy, make sure you have set `active: true` and that you do not exceed the [BT proxy limit][btproxy-url] of 3 devices/proxy; check the logs of the proxy if the device is recognized. Note: The [Bluetooth proxy of Shelly devices](https://www.home-assistant.io/integrations/shelly/#bluetooth-support) does not support active connections and thus cannot be used.
+1. If you use a BT proxy, make sure you have set `active: true`; check the logs of the proxy if the device is recognized. Note: The [Bluetooth proxy of Shelly devices](https://www.home-assistant.io/integrations/shelly/#bluetooth-support) does not support active connections and thus cannot be used.
+1. Check that you do not exceed the number of connections of your adapter, see **[Settings](https://my.home-assistant.io/redirect/config/) > Bluetooth**
 1. If above points did not help, please go to the [Bluetooth integration](https://my.home-assistant.io/redirect/integration/?domain=bluetooth). On your BT adapter select `configure`.
     1.  Verify that you have connection slots available.
     1.  Go to the [advertisement monitor](https://my.home-assistant.io/redirect/bluetooth_advertisement_monitor/) and click the device in question. Please provide the information via **`copy to clipboard`** to [a new issue](https://github.com/patman15/BMS_BLE-HA/issues/new?assignees=&labels=question&projects=&template=feature_request.yml) giving your BMS/battery type in the title.
@@ -306,7 +311,7 @@ all [contributors of aiobmsble](https://github.com/patman15/aiobmsble?tab=readme
 [license-shield]: https://img.shields.io/github/license/patman15/BMS_BLE-HA?style=for-the-badge&color=orange&cacheSeconds=86400
 [releases-shield]: https://img.shields.io/github/release/patman15/BMS_BLE-HA.svg?style=for-the-badge&cacheSeconds=14400
 [releases]: https://github.com//patman15/BMS_BLE-HA/releases
-[effort-shield]: https://img.shields.io/badge/Effort%20spent-840_hours-gold?style=for-the-badge&cacheSeconds=86400
+[effort-shield]: https://img.shields.io/badge/Effort%20spent-876_hours-gold?style=for-the-badge&cacheSeconds=86400
 [install-shield]: https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=green&label=HACS&suffix=%20Installs&cacheSeconds=15600&url=https://analytics.home-assistant.io/custom_integrations.json&query=$.bms_ble.total&cacheSeconds=14400
 [btproxy-url]: https://esphome.io/components/bluetooth_proxy
 [custint-url]: https://www.home-assistant.io/common-tasks/general/#defining-a-custom-polling-interval

custom_components/bms_ble/__init__.py

@@ -1,5 +1,6 @@
 """The BLE Battery Management System integration."""
 
+from dataclasses import dataclass
 from types import ModuleType
 from typing import Final
 
@@ -14,6 +15,7 @@
 from homeassistant.helpers.device_registry import format_mac
 from homeassistant.helpers.importlib import async_import_module
 
+from .config_flow import ConfigFlow
 from .const import DOMAIN, LOGGER
 from .coordinator import BTBmsCoordinator
 
@@ -78,22 +80,33 @@ async def async_migrate_entry(
     hass: HomeAssistant, config_entry: BTBmsConfigEntry
 ) -> bool:
     """Migrate old entry."""
-    _latest_version: Final[int] = 2
 
-    if config_entry.version > _latest_version:
-        # This means the user has downgraded from a future version
+    @dataclass(repr=False, eq=False, slots=True)
+    class EntryVersion:
+        major: int
+        minor: int
+
+    if config_entry.version > ConfigFlow.VERSION:
+        # This means the user has downgraded from a future major version (incompatible)
         LOGGER.debug("Cannot downgrade from version %s", config_entry.version)
         return False
 
-    LOGGER.debug("Migrating from version %s.%s", config_entry.version, config_entry.minor_version)
+    LOGGER.debug(
+        "Migrating from version %s.%s", config_entry.version, config_entry.minor_version
+    )
+
+    bms_type: Final[str] = str(config_entry.data["type"])
+    new_data: dict[str, str] = config_entry.data.copy()
+    entry_version: EntryVersion = EntryVersion(
+        config_entry.version,
+        config_entry.minor_version,
+    )
 
-    if config_entry.version == 0:
-        bms_type: str = str(config_entry.data["type"])
-        new: dict[str, str] = {}
+    if entry_version.major == 0:
         if bms_type == "OGTBms":
-            new = {"type": "custom_components.bms_ble.plugins.ogt_bms"}
+            new_data["type"] = "custom_components.bms_ble.plugins.ogt_bms"
         elif bms_type == "DalyBms":
-            new = {"type": "custom_components.bms_ble.plugins.daly_bms"}
+            new_data["type"] = "custom_components.bms_ble.plugins.daly_bms"
         else:
             LOGGER.debug("Entry: %s", config_entry.data)
             LOGGER.error(
@@ -102,17 +115,24 @@ async def async_migrate_entry(
                 config_entry.minor_version,
             )
             return False
-
-        hass.config_entries.async_update_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
-        )
+        entry_version = EntryVersion(1, 0)
+
+    if entry_version.major < 2:
+        new_data["type"] = f"aiobmsble.bms.{new_data["type"].rsplit('.', 1)[-1]}"
+        entry_version = EntryVersion(2, 0)
+
+    if config_entry.version < 3:
+        # rename Ective BMS to Topband BMS
+        if bms_type.endswith("ective_bms"):
+            new_data["type"] = "aiobmsble.bms.topband_bms"
+        entry_version = EntryVersion(3, 0)
+
+    hass.config_entries.async_update_entry(
+        config_entry,
+        data=new_data,
+        minor_version=entry_version.minor,
+        version=entry_version.major,
+    )
 
     LOGGER.debug(
         "Migration to version %s.%s successful",

custom_components/bms_ble/config_flow.py

@@ -26,7 +26,7 @@
 class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
     """Handle a config flow for BT Battery Management System."""
 
-    VERSION = 2
+    VERSION = 3
     MINOR_VERSION = 0
 
     @dataclass
@@ -39,7 +39,7 @@ class DiscoveredDevice:
 
         def model(self) -> str:
             """Return BMS type in capital letters, e.g. 'DUMMY BMS'."""
-            return self.type.rsplit(".", 1)[-1].replace("_", " ").upper()
+            return self.type.rsplit(".", 1)[1].replace("_", " ").upper()
 
     def __init__(self) -> None:
         """Initialize the config flow."""

custom_components/bms_ble/coordinator.py

@@ -24,6 +24,8 @@
 class BTBmsCoordinator(DataUpdateCoordinator[BMSSample]):
     """Update coordinator for a battery management system."""
 
+    _LOW_RSSI: Final = -75  # dBm considered low signal strength
+
     def __init__(
         self,
         hass: HomeAssistant,
@@ -74,10 +76,10 @@ def rssi(self) -> int | None:
         return service_info.rssi if service_info else None
 
     def _rssi_msg(self) -> str:
-        """Return check RSSI message if below -75dBm."""
+        """Return check RSSI message if below _LOW_RSSI dBm."""
         return (
             f", check signal strength ({self.rssi} dBm)"
-            if self.rssi and self.rssi < -75
+            if self.rssi and self.rssi < self._LOW_RSSI
             else ""
         )
 
@@ -142,7 +144,9 @@ async def _async_update_data(self) -> BMSSample:
             LOGGER.debug(
                 "%s: BMS communication timed out%s", self.name, self._rssi_msg()
             )
-            raise TimeoutError("BMS communication timed out") from err
+            raise UpdateFailed(
+                translation_domain=DOMAIN, translation_key=("bms_timeout")
+            ) from err
         except (BleakError, EOFError) as err:
             LOGGER.debug(
                 "%s: BMS communication failed%s: %s (%s)",
@@ -152,7 +156,11 @@ async def _async_update_data(self) -> BMSSample:
                 type(err).__name__,
             )
             raise UpdateFailed(
-                f"BMS communication failed{self._rssi_msg()}: {err!s} ({type(err).__name__})"
+                translation_domain=DOMAIN,
+                translation_key=("bms_com_fail"),
+                translation_placeholders={
+                    "err_msg": f"{err!s} ({type(err).__name__})",
+                },
             ) from err
         finally:
             self._link_q.extend(

custom_components/bms_ble/manifest.json

@@ -3,98 +3,98 @@
   "name": "BLE Battery Management System",
   "bluetooth": [
     {
-      "service_uuid": "00001000-0000-1000-8000-00805f9b34fb"
+      "local_name": "BMS-*"
     },
     {
-      "service_uuid": "0000af30-0000-1000-8000-00805f9b34fb"
+      "local_name": "DXB-*"
     },
     {
-      "service_uuid": "0000fee7-0000-1000-8000-00805f9b34fb"
+      "local_name": "ECO-WORTHY 02_*"
     },
     {
-      "service_uuid": "0000ff00-0000-1000-8000-00805f9b34fb"
+      "local_name": "Epsilon-*"
     },
     {
-      "service_uuid": "0000ffd0-0000-1000-8000-00805f9b34fb"
+      "local_name": "F07*"
     },
     {
-      "service_uuid": "0000ffe0-0000-1000-8000-00805f9b34fb"
+      "local_name": "F10*"
     },
     {
-      "service_uuid": "0000ffe5-0000-1000-8000-00805f9b34fb"
+      "local_name": "L-12V???AH-*"
     },
     {
-      "service_uuid": "0000fff0-0000-1000-8000-00805f9b34fb"
+      "local_name": "LT-*"
     },
     {
-      "service_uuid": "6e400001-b5a3-f393-e0a9-e50e24dcca9e"
+      "local_name": "PC-????"
     },
     {
-      "manufacturer_id": 770
+      "local_name": "TBA-*"
     },
     {
-      "manufacturer_id": 771
+      "local_name": "TP_*"
     },
     {
-      "manufacturer_id": 258
+      "local_name": "V-12V???Ah-*"
     },
     {
-      "manufacturer_id": 260
+      "local_name": "libatt*",
+      "manufacturer_id": 21320
     },
     {
-      "manufacturer_id": 1026
+      "local_name": "RNG*",
+      "manufacturer_id": 57676
     },
     {
-      "local_name": "ECO-WORTHY 02_*"
+      "local_name": "SV12V*",
+      "manufacturer_id": 33384
     },
     {
-      "local_name": "TBA-*"
+      "manufacturer_id": 258
     },
     {
-      "local_name": "DXB-*"
+      "manufacturer_id": 260
     },
     {
-      "local_name": "libatt*",
-      "manufacturer_id": 21320
+      "manufacturer_id": 770
     },
     {
-      "local_name": "LT-*"
+      "manufacturer_id": 771
     },
     {
-      "local_name": "SV12V*",
-      "manufacturer_id": 33384
+      "manufacturer_id": 1026
     },
     {
-      "local_name": "L-12V???AH-*"
+      "manufacturer_id": 54976
     },
     {
-      "local_name": "V-12V???Ah-*"
+      "manufacturer_id": 21330,
+      "service_uuid": "000003c1-0000-1000-8000-00805f9b34fb"
     },
     {
-      "manufacturer_id": 54976
+      "service_uuid": "0000af30-0000-1000-8000-00805f9b34fb"
     },
     {
-      "local_name": "F10*"
+      "service_uuid": "0000fee7-0000-1000-8000-00805f9b34fb"
     },
     {
-      "local_name": "F07*"
+      "service_uuid": "0000ff00-0000-1000-8000-00805f9b34fb"
     },
     {
-      "manufacturer_id": 21330,
-      "service_uuid": "000003c1-0000-1000-8000-00805f9b34fb"
+      "service_uuid": "0000ffd0-0000-1000-8000-00805f9b34fb"
     },
     {
-      "local_name": "RNG*",
-      "manufacturer_id": 57676
+      "service_uuid": "0000ffe0-0000-1000-8000-00805f9b34fb"
     },
     {
-      "local_name": "TP_*"
+      "service_uuid": "0000ffe5-0000-1000-8000-00805f9b34fb"
     },
     {
-      "local_name": "Epsilon-*"
+      "service_uuid": "0000fff0-0000-1000-8000-00805f9b34fb"
     },
     {
-      "local_name": "PC-????"
+      "service_uuid": "6e400001-b5a3-f393-e0a9-e50e24dcca9e"
     }
   ],
   "codeowners": ["@patman15"],
@@ -107,5 +107,5 @@
   "loggers": ["bleak_retry_connector", "aiobmsble"],
   "quality_scale": "silver",
   "requirements": ["aiobmsble@git+https://github.com/patman15/aiobmsble.git@48-eg4-bms-support"],
-  "version": "2.6.0-beta.1"
+  "version": "2.7.0"
 }

custom_components/bms_ble/strings.json

@@ -61,6 +61,12 @@
     }
   },
   "exceptions": {
+    "bms_com_fail": {
+      "message": "BMS communication failed: {err_msg}"
+    },
+    "bms_timeout": {
+      "message": "BMS communication timed out."
+    },
     "device_not_found": {
       "message": "Could not find BMS ({MAC}) via Bluetooth."
     },