aiobmsble 0.2.3__py3-none-any.whl → 0.4__py3-none-any.whl

aiobmsble/bms/roypow_bms.py

@@ -47,9 +47,9 @@ class BMS(BaseBMS):
     )
     _CMDS: Final[set[int]] = set({field.idx for field in _FIELDS})
 
-    def __init__(self, ble_device: BLEDevice, reconnect: bool = False) -> None:
+    def __init__(self, ble_device: BLEDevice, keep_alive: bool = True) -> None:
         """Initialize BMS."""
-        super().__init__(ble_device, reconnect)
+        super().__init__(ble_device, keep_alive)
         self._data_final: dict[int, bytearray] = {}
         self._exp_len: int = 0
 

aiobmsble/bms/seplos_bms.py

@@ -57,9 +57,9 @@ class BMS(BaseBMS):
         field[2] for field in PQUERY.values()
     }
 
-    def __init__(self, ble_device: BLEDevice, reconnect: bool = False) -> None:
+    def __init__(self, ble_device: BLEDevice, keep_alive: bool = True) -> None:
         """Intialize private BMS members."""
-        super().__init__(ble_device, reconnect)
+        super().__init__(ble_device, keep_alive)
         self._data_final: dict[int, bytearray] = {}
         self._pack_count: int = 0  # number of battery packs
         self._pkglen: int = 0  # expected packet length
@@ -73,7 +73,7 @@ class BMS(BaseBMS):
                 "service_uuid": BMS.uuid_services()[0],
                 "connectable": True,
             }
-            for pattern in {f"SP{num}?B*" for num in range(10)} | {"CSY*"}
+            for pattern in {f"SP{num}?B*" for num in range(10)} | {"CSY*"} | {"SP1??B*"}
         ]
 
     @staticmethod

aiobmsble/bms/seplos_v2_bms.py

@@ -36,9 +36,9 @@ class BMS(BaseBMS):
     _GSMD_LEN: Final[int] = _CELL_POS + max((dp.pos + dp.size) for dp in _PFIELDS) + 3
     _CMDS: Final[list[tuple[int, bytes]]] = [(0x51, b""), (0x61, b"\x00"), (0x62, b"")]
 
-    def __init__(self, ble_device: BLEDevice, reconnect: bool = False) -> None:
+    def __init__(self, ble_device: BLEDevice, keep_alive: bool = True) -> None:
         """Initialize BMS."""
-        super().__init__(ble_device, reconnect)
+        super().__init__(ble_device, keep_alive)
         self._data_final: dict[int, bytearray] = {}
         self._exp_len: int = BMS._MIN_LEN
         self._exp_reply: set[int] = set()

aiobmsble/bms/tdt_bms.py

@@ -41,9 +41,9 @@ class BMS(BaseBMS):
     )  # problem code is not included in the list, but extra
     _CMDS: Final[list[int]] = [*list({field.idx for field in _FIELDS}), 0x8D]
 
-    def __init__(self, ble_device: BLEDevice, reconnect: bool = False) -> None:
+    def __init__(self, ble_device: BLEDevice, keep_alive: bool = True) -> None:
         """Initialize BMS."""
-        super().__init__(ble_device, reconnect)
+        super().__init__(ble_device, keep_alive)
         self._data_final: dict[int, bytearray] = {}
         self._cmd_heads: list[int] = BMS._CMD_HEADS
         self._exp_len: int = 0

aiobmsble/bms/tianpwr_bms.py

@@ -37,9 +37,9 @@ class BMS(BaseBMS):
     )
     _CMDS: Final[set[int]] = set({field.idx for field in _FIELDS}) | set({0x87})
 
-    def __init__(self, ble_device: BLEDevice, reconnect: bool = False) -> None:
+    def __init__(self, ble_device: BLEDevice, keep_alive: bool = True) -> None:
         """Initialize BMS."""
-        super().__init__(ble_device, reconnect)
+        super().__init__(ble_device, keep_alive)
         self._data_final: dict[int, bytearray] = {}
 
     @staticmethod

aiobmsble/test_data/__init__.py

@@ -0,0 +1,95 @@
+"""Test advertisements for aiobmsble package."""
+
+from importlib import resources
+import json
+from typing import Any
+
+from bleak.backends.scanner import AdvertisementData
+import pytest
+
+from tests.bluetooth import generate_advertisement_data
+
+type BmsAdvList = list[tuple[AdvertisementData, str, list[str]]]
+
+
+def _json_dict_to_advdata(json_dict: dict[str, Any]) -> AdvertisementData:
+    """Generate an AdvertisementData instance from a JSON dictionary."""
+
+    if "manufacturer_data" in json_dict:
+        json_dict["manufacturer_data"] = {
+            int(k): bytes.fromhex(v) for k, v in json_dict["manufacturer_data"].items()
+        }
+    if "service_data" in json_dict:
+        json_dict["service_data"] = {
+            k: bytes.fromhex(v) for k, v in json_dict["service_data"].items()
+        }
+    if "platform_data" in json_dict:
+        json_dict["platform_data"] = tuple(json_dict.get("platform_data", []))
+
+    return generate_advertisement_data(**json_dict)
+
+
+@pytest.fixture
+def bms_advertisements() -> BmsAdvList:
+    """Provide all available BMS advertisements from test data directory.
+
+    Load all *_bms.json files from the packaged test data directory.
+    """
+    all_data: BmsAdvList = []
+
+    for resource in resources.files(__package__).iterdir():
+        if resource.name.endswith("_bms.json"):
+            with resource.open("r", encoding="UTF-8") as f:
+                raw_data: Any = json.load(f)
+                assert isinstance(raw_data, list)
+
+                for entry in raw_data:
+                    assert isinstance(entry, dict)
+                    assert {"advertisement", "type"}.issubset(set(entry.keys()))
+                    adv: AdvertisementData = _json_dict_to_advdata(
+                        entry["advertisement"]
+                    )
+                    bms_type: str = entry["type"]
+                    comments: list[str] = entry["_comments"]
+
+                    assert isinstance(adv, AdvertisementData)
+                    assert isinstance(bms_type, str)
+                    assert isinstance(comments, list)
+                    assert all(isinstance(c, str) for c in comments)
+                    assert resource.name == f"{bms_type}.json"
+
+                    all_data.append((adv, bms_type, comments))
+    return all_data
+
+
+@pytest.fixture
+def ignore_advertisements() -> BmsAdvList:
+    """Provide a list of advertisements that shall not be identified as a valid BMS.
+
+    Load ignore.json files from the packaged test data directory.
+    """
+    data: BmsAdvList = []
+
+    with (
+        resources.files(__package__)
+        .joinpath("ignore.json")
+        .open("r", encoding="UTF-8") as f
+    ):
+        raw_data: Any = json.load(f)
+        assert isinstance(raw_data, list)
+
+        for entry in raw_data:
+            assert isinstance(entry, dict)
+            assert {"advertisement", "reason"}.issubset(set(entry.keys()))
+            adv: AdvertisementData = _json_dict_to_advdata(entry["advertisement"])
+            reason: str = entry["reason"]
+            comments: list[str] = entry["_comments"]
+
+            assert isinstance(adv, AdvertisementData)
+            assert isinstance(reason, str)
+            assert isinstance(comments, list)
+            assert all(isinstance(c, str) for c in comments)
+
+            data.append((adv, reason, comments))
+
+    return data

aiobmsble/test_data/abc_bms.json

@@ -0,0 +1,34 @@
+[
+  {
+    "advertisement": {
+      "local_name": "SOK-24V1127",
+      "service_uuids": [
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -94
+    },
+    "type": "abc_bms",
+    "_comments": [
+      "source pcap (https://github.com/patman15/BMS_BLE-HA/issues/168)"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "SOK-AA02120",
+      "service_uuids": [
+        "00001800-0000-1000-8000-00805f9b34fb",
+        "00001801-0000-1000-8000-00805f9b34fb",
+        "0000180a-0000-1000-8000-00805f9b34fb",
+        "0000180f-0000-1000-8000-00805f9b34fb",
+        "0000ffe0-0000-1000-8000-00805f9b34fb",
+        "0000fff0-0000-1000-8000-00805f9b34fb",
+        "f000ffc0-0451-4000-b000-000000000000"
+      ],
+      "rssi": -62
+    },
+    "type": "abc_bms",
+    "_comments": [
+      "source log (https://github.com/patman15/BMS_BLE-HA/issues/394)"
+    ]
+  }
+]

aiobmsble/test_data/ant_bms.json

@@ -0,0 +1,18 @@
+[
+  {
+    "advertisement": {
+      "local_name": "ANT-BLE24C-001",
+      "manufacturer_data": {
+        "8979": "88a0aabbcc900001"
+      },
+      "service_uuids": [
+        "0000ffe0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -70
+    },
+    "type": "ant_bms",
+    "_comments": [
+      "source advmon (https://github.com/patman15/BMS_BLE-HA/issues/366)"
+    ]
+  }
+]

aiobmsble/test_data/ant_leg_bms.json

@@ -0,0 +1,19 @@
+[
+  {
+    "advertisement": {
+      "local_name": "ANT-BLE16S",
+      "manufacturer_data": {
+        "1623": "88a0aabbcca12345"
+      },
+      "service_uuids": [
+        "0000ffe0-0000-1000-8000-00805f9b34fb",
+        "0000fee7-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -31
+    },
+    "type": "ant_leg_bms",
+    "_comments": [
+      "source HA Bluetooth"
+    ]
+  }
+]

aiobmsble/test_data/braunpwr_bms.json

@@ -0,0 +1,34 @@
+[
+  {
+    "advertisement": {
+      "local_name": "HSKS-25A-118",
+      "manufacturer_data": {
+        "123": "02ffff7b"
+      },
+      "service_uuids": [
+        "0000ff00-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -70
+    },
+    "type": "braunpwr_bms",
+    "_comments": [
+      "source pcap (https://github.com/patman15/BMS_BLE-HA/issues/303)"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "BL-25F-170-118",
+      "manufacturer_data": {
+        "123": "02ffff7d"
+      },
+      "service_uuids": [
+        "0000ff00-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -76
+    },
+    "type": "braunpwr_bms",
+    "_comments": [
+      "source LOG (https://github.com/patman15/BMS_BLE-HA/issues/303)"
+    ]
+  }
+]

aiobmsble/test_data/cbtpwr_bms.json

@@ -0,0 +1,90 @@
+[
+  {
+    "advertisement": {
+      "local_name": "170R000121",
+      "manufacturer_data": {
+        "21330": "2134ba03ec110cb4010500010000"
+      },
+      "service_uuids": [
+        "00001800-0000-1000-8000-00805f9b34fb",
+        "00001801-0000-1000-8000-00805f9b34fb",
+        "0000180a-0000-1000-8000-00805f9b34fb",
+        "0000fd00-0000-1000-8000-00805f9b34fb",
+        "0000ff90-0000-1000-8000-00805f9b34fb",
+        "0000ffb0-0000-1000-8000-00805f9b34fb",
+        "0000ffc0-0000-1000-8000-00805f9b34fb",
+        "0000ffd0-0000-1000-8000-00805f9b34fb",
+        "0000ffe0-0000-1000-8000-00805f9b34fb",
+        "0000ffe5-0000-1000-8000-00805f9b34fb",
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "tx_power": 0,
+      "rssi": -75
+    },
+    "type": "cbtpwr_bms",
+    "_comments": [
+      "source LOG, https://github.com/patman15/BMS_BLE-HA/issues/59"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "170R000086",
+      "manufacturer_data": {
+        "21330": "2134ba03ec110cf8010500010000"
+      },
+      "service_uuids": [
+        "00001800-0000-1000-8000-00805f9b34fb",
+        "00001801-0000-1000-8000-00805f9b34fb",
+        "0000180a-0000-1000-8000-00805f9b34fb",
+        "0000fd00-0000-1000-8000-00805f9b34fb",
+        "0000ff90-0000-1000-8000-00805f9b34fb",
+        "0000ffb0-0000-1000-8000-00805f9b34fb",
+        "0000ffc0-0000-1000-8000-00805f9b34fb",
+        "0000ffd0-0000-1000-8000-00805f9b34fb",
+        "0000ffe0-0000-1000-8000-00805f9b34fb",
+        "0000ffe5-0000-1000-8000-00805f9b34fb",
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "tx_power": 0,
+      "rssi": -73
+    },
+    "type": "cbtpwr_bms",
+    "_comments": [
+      "source LOG"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "140R000288",
+      "manufacturer_data": {
+        "0": "ffffffff6400ff000000000000000000"
+      },
+      "service_uuids": [
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -82
+    },
+    "type": "cbtpwr_bms",
+    "_comments": [
+      "source BT monitor (https://github.com/patman15/BMS_BLE-HA/issues/176)"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "100R0002E3",
+      "manufacturer_data": {
+        "21330": "2134ba03ec110909010500010000"
+      },
+      "service_uuids": [
+        "000003c1-0000-1000-8000-00805f9b34fb"
+      ],
+      "tx_power": 0,
+      "rssi": -76
+    },
+    "type": "cbtpwr_bms",
+    "_comments": [
+      "source advmon (https://github.com/patman15/BMS_BLE-HA/issues/197)",
+      "Creabest"
+    ]
+  }
+]

aiobmsble/test_data/cbtpwr_vb_bms.json

@@ -0,0 +1,20 @@
+[
+  {
+    "advertisement": {
+      "local_name": "VB024000390",
+      "manufacturer_data": {
+        "16963": "545e0211f82e0ca88942"
+      },
+      "service_uuids": [
+        "0000fff0-0000-1000-8000-00805f9b34fb",
+        "0000ffb0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -73
+    },
+    "type": "cbtpwr_vb_bms",
+    "_comments": [
+      "source advmon (https://github.com/patman15/BMS_BLE-HA/issues/240)",
+      "Creabest"
+    ]
+  }
+]

aiobmsble/test_data/daly_bms.json

@@ -0,0 +1,100 @@
+[
+  {
+    "advertisement": {
+      "local_name": "DL-46640102XXXX",
+      "manufacturer_data": {
+        "25670": "010209ac"
+      },
+      "service_uuids": [
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -58
+    },
+    "type": "daly_bms",
+    "_comments": [
+      "source LOG (https://github.com/patman15/BMS_BLE-HA/issues/89)"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "DL-401710015C9B",
+      "manufacturer_data": {
+        "770": "16401710015c9b444c"
+      },
+      "rssi": -36
+    },
+    "type": "daly_bms",
+    "_comments": [
+      "source LOG, proxy (https://github.com/patman15/BMS_BLE-HA/issues/160)"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "JHB-501812XXXXXX",
+      "manufacturer_data": {
+        "260": "0150181201a3b34a4842"
+      },
+      "rssi": -46
+    },
+    "type": "daly_bms",
+    "_comments": [
+      "source BTctl (https://github.com/patman15/BMS_BLE-HA/issues/145)"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "Randomname",
+      "manufacturer_data": {
+        "260": "0150181201a4944a4842"
+      },
+      "rssi": -36
+    },
+    "type": "daly_bms",
+    "_comments": [
+      "source LOG (https://github.com/patman15/BMS_BLE-HA/issues/160#issuecomment-2629318416)",
+      "JHB-50181201A494"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "BT270-2",
+      "manufacturer_data": {
+        "770": "16401712011197444c"
+      },
+      "rssi": -60
+    },
+    "type": "daly_bms",
+    "_comments": [
+      "source BTctl (https://github.com/patman15/BMS_BLE-HA/issues/174#issuecomment-2637936795)"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "DL-40160901534C",
+      "manufacturer_data": {
+        "258": "04"
+      },
+      "rssi": -87
+    },
+    "type": "daly_bms",
+    "_comments": [
+      "source advmon (https://github.com/patman15/BMS_BLE-HA/issues/204)",
+      "16S LiFePo 250A BMS"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "DL-FB4C2E0000000",
+      "manufacturer_data": {
+        "771": "00b4c2e0000000444c00"
+      },
+      "rssi": -81
+    },
+    "type": "daly_bms",
+    "_comments": [
+      "proxy LOG (https://github.com/patman15/BMS_BLE-HA/issues/85)",
+      "Bulltron battery",
+      "MAC address (Bouffalo Lab)"
+    ]
+  }
+]

aiobmsble/test_data/dpwrcore_bms.json

@@ -0,0 +1,18 @@
+[
+  {
+    "advertisement": {
+      "local_name": "TBA-13500277",
+      "service_uuids": [
+        "00001800-0000-1000-8000-00805f9b34fb",
+        "00001801-0000-1000-8000-00805f9b34fb",
+        "0000180a-0000-1000-8000-00805f9b34fb",
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -72
+    },
+    "type": "dpwrcore_bms",
+    "_comments": [
+      "source BTctl (https://github.com/patman15/BMS_BLE-HA/issues/52#issuecomment-2390048120)"
+    ]
+  }
+]

aiobmsble/test_data/ecoworthy_bms.json

@@ -0,0 +1,100 @@
+[
+  {
+    "advertisement": {
+      "local_name": "ECO-WORTHY 02_B8EF",
+      "manufacturer_data": {
+        "49844": "e0fab8f0"
+      },
+      "service_uuids": [
+        "00001800-0000-1000-8000-00805f9b34fb",
+        "00001801-0000-1000-8000-00805f9b34fb",
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -50
+    },
+    "type": "ecoworthy_bms",
+    "_comments": [
+      "source LOG, proxy (https://github.com/patman15/BMS_BLE-HA/issues/164#issue-2825586172)",
+      "MAC address, correct, public"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "ECO-WORTHY 02_50DB",
+      "manufacturer_data": {
+        "47912": "ed0050dc"
+      },
+      "rssi": -49
+    },
+    "type": "ecoworthy_bms",
+    "_comments": [
+      "source BTctl (https://github.com/patman15/BMS_BLE-HA/issues/253)",
+      "MAC address, correct, public"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "ECO-WORTHY 0B_5AD4",
+      "manufacturer_data": {
+        "57570": "5a783c31"
+      },
+      "service_uuids": [
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -86
+    },
+    "type": "ecoworthy_bms",
+    "_comments": [
+      "source advmon (https://github.com/patman15/BMS_BLE-HA/issues/286)",
+      "MAC address, correct, private"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "ECO-WORTHY 02_3DDF",
+      "manufacturer_data": {
+        "15996": "821c3de0"
+      },
+      "rssi": -49
+    },
+    "type": "ecoworthy_bms",
+    "_comments": [
+      "source proxy LOG (https://github.com/patman15/BMS_BLE-HA/issues/295)",
+      "MAC address, correct, public"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "DCHOUSE 01_4F9F",
+      "manufacturer_data": {
+        "57570": "5a72a745"
+      },
+      "service_uuids": [
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -68
+    },
+    "type": "ecoworthy_bms",
+    "_comments": [
+      "source advmon (https://github.com/patman15/BMS_BLE-HA/issues/326)",
+      "MAC address correct"
+    ]
+  },
+  {
+    "advertisement": {
+      "local_name": "ECO-WORTHY 0B_198D",
+      "manufacturer_data": {
+        "59362": "798e373d"
+      },
+      "service_uuids": [
+        "0000fff0-0000-1000-8000-00805f9b34fb"
+      ],
+      "rssi": -50
+    },
+    "type": "ecoworthy_bms",
+    "_comments": [
+      "source advmon (https://github.com/patman15/BMS_BLE-HA/issues/386)",
+      "MAC address, correct, private"
+    ]
+  }
+]