aiobmsble 0.2.1__tar.gz → 0.2.2__tar.gz

{aiobmsble-0.2.1/aiobmsble.egg-info → aiobmsble-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiobmsble
-Version: 0.2.1
+Version: 0.2.2
 Summary: Asynchronous Python library to query battery management systems via Bluetooth Low Energy.
 Author: Patrick Loschmidt
 Maintainer: Patrick Loschmidt

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/__init__.py

@@ -1,4 +1,8 @@
-"""Package for battery management systems (BMS) via Bluetooth LE."""
+"""Package for battery management systems (BMS) via Bluetooth LE (aiobmsble).
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from collections.abc import Callable
 from enum import IntEnum

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/__main__.py

@@ -1,4 +1,8 @@
-"""Example function for package usage."""
+"""Example script for aiobmsble package usage.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 import argparse
 import asyncio

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/basebms.py

@@ -1,4 +1,8 @@
-"""Base class defintion for battery management systems (BMS)."""
+"""Base class defintion for battery management systems (BMS).
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from abc import ABC, abstractmethod
 import asyncio
@@ -79,6 +83,11 @@ class BaseBMS(ABC):
         self._data: bytearray = bytearray()
         self._data_event: Final[asyncio.Event] = asyncio.Event()
 
+    @classmethod
+    def get_bms_module(cls) -> str:
+        """Return BMS module name, e.g. aiobmsble.bms.dummy_bms."""
+        return cls.__module__
+
     @staticmethod
     @abstractmethod
     def matcher_dict_list() -> list[MatcherPattern]:

aiobmsble-0.2.2/aiobmsble/bms/__init__.py

@@ -0,0 +1,5 @@
+"""Package for battery management systems (BMS) plugins.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/abc_bms.py

@@ -1,4 +1,8 @@
-"""Module to support ABC BMS."""
+"""Module to support ABC BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 import contextlib
 from typing import Final

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/ant_bms.py

@@ -1,4 +1,8 @@
-"""Module to support ANT BMS."""
+"""Module to support ANT BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/braunpwr_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Braun Power BMS."""
+"""Module to support Braun Power BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/cbtpwr_bms.py

@@ -1,4 +1,8 @@
-"""Module to support CBT Power Smart BMS."""
+"""Module to support CBT Power Smart BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/cbtpwr_vb_bms.py

@@ -1,4 +1,8 @@
-"""Module to support CBT Power VB series BMS."""
+"""Module to support CBT Power VB series BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from string import hexdigits
 from typing import Final

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/daly_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Daly Smart BMS."""
+"""Module to support Daly Smart BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/dpwrcore_bms.py

@@ -1,4 +1,8 @@
-"""Module to support D-powercore Smart BMS."""
+"""Module to support D-powercore Smart BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from enum import IntEnum
 from string import hexdigits

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/dummy_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Dummy BMS."""
+"""Module to support Dummy BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from bleak.backends.characteristic import BleakGATTCharacteristic
 from bleak.backends.device import BLEDevice

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/ecoworthy_bms.py

@@ -1,4 +1,8 @@
-"""Module to support ECO-WORTHY BMS."""
+"""Module to support ECO-WORTHY BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 import asyncio
 from typing import Final

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/ective_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Ective BMS."""
+"""Module to support Ective BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 import asyncio
 from string import hexdigits

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/ej_bms.py

@@ -1,4 +1,8 @@
-"""Module to support E&J Technology BMS."""
+"""Module to support E&J Technology BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from enum import IntEnum
 from string import hexdigits

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/felicity_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Felicity BMS."""
+"""Module to support Felicity BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from collections.abc import Callable
 from json import JSONDecodeError, loads

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/jbd_bms.py

@@ -1,4 +1,8 @@
-"""Module to support JBD Smart BMS."""
+"""Module to support JBD Smart BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/jikong_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Jikong Smart BMS."""
+"""Module to support Jikong Smart BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 import asyncio
 from typing import Final

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/neey_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Neey Smart BMS."""
+"""Module to support Neey Smart BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from collections.abc import Callable
 from struct import unpack_from

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/ogt_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Offgridtec Smart Pro BMS."""
+"""Module to support Offgridtec Smart Pro BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from collections.abc import Callable
 from string import digits, hexdigits

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/pro_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Pro BMS."""
+"""Module to support Pro BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 import asyncio
 from typing import Final

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/redodo_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Redodo BMS."""
+"""Module to support Redodo BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/renogy_bms.py

@@ -1,4 +1,7 @@
-"""Module to support Renogy BMS."""
+"""Module to support Renogy BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/renogy_pro_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Renogy Pro BMS."""
+"""Module to support Renogy Pro BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from bleak.backends.characteristic import BleakGATTCharacteristic
 from bleak.backends.device import BLEDevice

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/roypow_bms.py

@@ -1,4 +1,8 @@
-"""Module to support RoyPow BMS."""
+"""Module to support RoyPow BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/seplos_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Seplos V3 Smart BMS."""
+"""Module to support Seplos V3 Smart BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from collections.abc import Callable
 from typing import Any, Final

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/seplos_v2_bms.py

@@ -1,4 +1,8 @@
-"""Module to support Seplos v2 BMS."""
+"""Module to support Seplos v2 BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/tdt_bms.py

@@ -1,4 +1,8 @@
-"""Module to support TDT BMS."""
+"""Module to support TDT BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/bms/tianpwr_bms.py

@@ -1,4 +1,8 @@
-"""Module to support TianPwr BMS."""
+"""Module to support TianPwr BMS.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from typing import Final
 

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/aiobmsble/utils.py

@@ -1,4 +1,8 @@
-"""Utilitiy/Support functions for aiobmsble."""
+"""Utilitiy/Support functions for aiobmsble.
+
+Project: aiobmsble, https://pypi.org/p/aiobmsble/
+License: Apache-2.0, http://www.apache.org/licenses/
+"""
 
 from fnmatch import translate
 from functools import lru_cache
@@ -6,11 +10,15 @@ import importlib
 import pkgutil
 import re
 from types import ModuleType
+from typing import Final
 
 from bleak.backends.scanner import AdvertisementData
 
 from aiobmsble import MatcherPattern
 from aiobmsble.basebms import BaseBMS
+import aiobmsble.bms
+
+_MODULE_POSTFIX: Final[str] = "_bms"
 
 
 def _advertisement_matches(
@@ -78,8 +86,8 @@ def load_bms_plugins() -> set[ModuleType]:
     """
     return {
         importlib.import_module(f"aiobmsble.bms.{module_name}")
-        for _, module_name, _ in pkgutil.iter_modules(["aiobmsble/bms"])
-        if module_name.endswith("_bms")
+        for _, module_name, _ in pkgutil.iter_modules(aiobmsble.bms.__path__)
+        if module_name.endswith(_MODULE_POSTFIX)
     }
 
 
@@ -87,14 +95,16 @@ def bms_cls(name: str) -> type[BaseBMS] | None:
     """Return the BMS class that is defined by the name argument.
 
     Args:
-        name (str): The name of the BMS type
+        name (str): The name of the BMS type (filename of the module)
 
     Returns:
         type[BaseBMS] | None: If the BMS class defined by name is found, None otherwise.
 
     """
+    if not name.endswith(_MODULE_POSTFIX):
+        return None
     try:
-        bms_module: ModuleType = importlib.import_module(f"aiobmsble.bms.{name}_bms")
+        bms_module: ModuleType = importlib.import_module(f"aiobmsble.bms.{name}")
     except ModuleNotFoundError:
         return None
     return bms_module.BMS

{aiobmsble-0.2.1 → aiobmsble-0.2.2/aiobmsble.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiobmsble
-Version: 0.2.1
+Version: 0.2.2
 Summary: Asynchronous Python library to query battery management systems via Bluetooth Low Energy.
 Author: Patrick Loschmidt
 Maintainer: Patrick Loschmidt

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aiobmsble"
-version = "0.2.1"
+version = "0.2.2"
 requires-python = ">=3.12"
 description = "Asynchronous Python library to query battery management systems via Bluetooth Low Energy."
 readme = "README.md"

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/tests/test_basebms.py

@@ -14,6 +14,7 @@ import pytest
 
 from aiobmsble import BMSdp, BMSsample, MatcherPattern
 from aiobmsble.basebms import BaseBMS, crc8, crc_modbus, crc_sum, crc_xmodem, lrc_modbus
+from aiobmsble.bms.dummy_bms import BMS as DummyBMS
 
 from .bluetooth import generate_ble_device
 from .conftest import MockBleakClient
@@ -315,6 +316,12 @@ async def test_wr_mode_reset(
     assert bms._inv_wr_mode is None
 
 
+def test_get_bms_module() -> None:
+    """Check that basebms and dummy_bms return correct module name."""
+    assert BaseBMS.get_bms_module() == "aiobmsble.basebms"
+    assert DummyBMS.get_bms_module() == "aiobmsble.bms.dummy_bms"
+
+
 async def test_no_notify(
     patch_bleak_client: Callable[..., None], caplog: pytest.LogCaptureFixture
 ) -> None:

{aiobmsble-0.2.1 → aiobmsble-0.2.2}/tests/test_utils.py

@@ -55,15 +55,14 @@ def test_bms_identify(plugin: ModuleType) -> None:
 def test_bms_cls(plugin: ModuleType) -> None:
     """Test that a BMS class is correctly returned from its name."""
     # strip _bms to get only type
-    bms_type: str = getattr(plugin, "__name__", "").rsplit(".", 1)[-1][:-4]
+    bms_type: str = getattr(plugin, "__name__", "").rsplit(".", 1)[-1]
     bms_class: type[BaseBMS] | None = bms_cls(bms_type)
     assert bms_class == plugin.BMS
 
 
-def test_bms_cls_none() -> None:
-    """Test that a BMS class is correctly returned from its name."""
-    # strip _bms to get only type
-    bms_type: str = "unvailable_bms"
+@pytest.mark.parametrize("bms_type", ["unavailable_bms", "ignore_me"])
+def test_bms_cls_none(bms_type: str) -> None:
+    """Test that a BMS class is None when name is not correct."""
     bms_class: type[BaseBMS] | None = bms_cls(bms_type)
     assert bms_class is None
 

aiobmsble-0.2.1/aiobmsble/bms/__init__.py

@@ -1 +0,0 @@
-"""Package for battery management systems (BMS) plugins."""