aiobmsble 0.1.0__tar.gz

aiobmsble-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

aiobmsble-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

aiobmsble-0.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: aiobmsble
+Version: 0.1.0
+Summary: Asynchronous Python library to query battery management systems via Bluetooth Low Energy.
+Author: Patrick Loschmidt
+Maintainer: Patrick Loschmidt
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/patman15/aiobmsble/
+Project-URL: Documentation, https://github.com/patman15/aiobmsble/
+Keywords: BMS,BLE,battery,bluetooth
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bleak~=0.22.3
+Requires-Dist: bleak-retry-connector~=3.8.1
+Requires-Dist: asyncio
+Requires-Dist: logging
+Requires-Dist: statistics
+Requires-Dist: typing
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+[![License][license-shield]](LICENSE)
+
+# Aiobmsble
+Requires Python 3 and uses [asyncio](https://pypi.org/project/asyncio/) and [bleak](https://pypi.org/project/bleak/)
+> [!IMPORTANT]
+> At the moment the library is under development and not all BMS classes have been ported over from the [BMS_BLE-HA integration](https://github.com/patman15/BMS_BLE-HA/)!
+> Please do not (yet) report missing BMS support or bugs here. Instead please raise an issue at the integration till the library reached at least development status *beta*.
+> Plan is to support all BMSs that are listed [here](https://github.com/patman15/BMS_BLE-HA/edit/main/README.md#supported-devices).
+
+## Asynchronous Library to Query Battery Management Systems via Bluetooth LE
+This library is intended to query data from battery management systems that use Bluetooth LE. It is developed to support [BMS_BLE-HA integration](https://github.com/patman15/BMS_BLE-HA/) that was written to make BMS data available to Home Assistant. While the integration depends on Home Assistant, this library can be used stand-alone in any Python environment (with necessary dependencies installed).
+
+## Usage
+In order to identify all devices that are reachable and supported by the library, simply run
+```bash
+aiobmsble
+```
+from the command line after [installation](#installation). In case you need the code as reference, please see [\_\_main\_\_.py](/aiobmsble/__main__.py).
+
+### From a Script
+This example can also be found as an [example](/examples/minimal.py) in the respective [folder](/main/examples).
+```python
+"""Example of using the aiobmsble library to find a BLE device by name and print its senosr data."""
+
+import asyncio
+from typing import Final
+
+from bleak import BleakScanner
+from bleak.backends.device import BLEDevice
+from bleak.exc import BleakError
+
+from aiobmsble import BMSsample
+from aiobmsble.bms.ogt_bms import BMS  # use the right BMS class for your device
+
+NAME: Final[str] = "BT Device Name"  # Replace with the name of your BLE device
+
+
+async def main(dev_name) -> None:
+    """Main function to find a BLE device by name and update its sensor data."""
+
+    device: BLEDevice | None = await BleakScanner.find_device_by_name(dev_name)
+    if device is None:
+        print(f"Device '{dev_name}' not found.")
+        return
+
+    print(f"Found device: {device.name} ({device.address})")
+    bms = BMS(ble_device=device, reconnect=True)
+    try:
+        print("Updating BMS data...")
+        data: BMSsample = await bms.async_update()
+        print("BMS data: ", repr(data).replace(", ", ",\n\t"))
+    except BleakError as ex:
+        print(f"Failed to update BMS: {ex}")
+
+
+asyncio.run(main(NAME))
+```
+
+## Installation
+Install python and pip if you have not already, then run:
+```bash
+pip3 install pip --upgrade
+pip3 install wheel
+```
+
+### For Production:
+
+```bash
+pip3 install aiobmsble
+```
+This will install the latest library release and all of it's python dependencies.
+
+### For Development:
+```bash
+git clone https://github.com/patman15/aiobmsble.git
+cd aiobmsble
+pip3 install -e .[dev]
+```
+This gives you the latest library code from the main branch.
+
+[license-shield]: https://img.shields.io/github/license/patman15/aiobmsble.svg?style=for-the-badge&cacheSeconds=86400

aiobmsble-0.1.0/README.md

@@ -0,0 +1,81 @@
+[![License][license-shield]](LICENSE)
+
+# Aiobmsble
+Requires Python 3 and uses [asyncio](https://pypi.org/project/asyncio/) and [bleak](https://pypi.org/project/bleak/)
+> [!IMPORTANT]
+> At the moment the library is under development and not all BMS classes have been ported over from the [BMS_BLE-HA integration](https://github.com/patman15/BMS_BLE-HA/)!
+> Please do not (yet) report missing BMS support or bugs here. Instead please raise an issue at the integration till the library reached at least development status *beta*.
+> Plan is to support all BMSs that are listed [here](https://github.com/patman15/BMS_BLE-HA/edit/main/README.md#supported-devices).
+
+## Asynchronous Library to Query Battery Management Systems via Bluetooth LE
+This library is intended to query data from battery management systems that use Bluetooth LE. It is developed to support [BMS_BLE-HA integration](https://github.com/patman15/BMS_BLE-HA/) that was written to make BMS data available to Home Assistant. While the integration depends on Home Assistant, this library can be used stand-alone in any Python environment (with necessary dependencies installed).
+
+## Usage
+In order to identify all devices that are reachable and supported by the library, simply run
+```bash
+aiobmsble
+```
+from the command line after [installation](#installation). In case you need the code as reference, please see [\_\_main\_\_.py](/aiobmsble/__main__.py).
+
+### From a Script
+This example can also be found as an [example](/examples/minimal.py) in the respective [folder](/main/examples).
+```python
+"""Example of using the aiobmsble library to find a BLE device by name and print its senosr data."""
+
+import asyncio
+from typing import Final
+
+from bleak import BleakScanner
+from bleak.backends.device import BLEDevice
+from bleak.exc import BleakError
+
+from aiobmsble import BMSsample
+from aiobmsble.bms.ogt_bms import BMS  # use the right BMS class for your device
+
+NAME: Final[str] = "BT Device Name"  # Replace with the name of your BLE device
+
+
+async def main(dev_name) -> None:
+    """Main function to find a BLE device by name and update its sensor data."""
+
+    device: BLEDevice | None = await BleakScanner.find_device_by_name(dev_name)
+    if device is None:
+        print(f"Device '{dev_name}' not found.")
+        return
+
+    print(f"Found device: {device.name} ({device.address})")
+    bms = BMS(ble_device=device, reconnect=True)
+    try:
+        print("Updating BMS data...")
+        data: BMSsample = await bms.async_update()
+        print("BMS data: ", repr(data).replace(", ", ",\n\t"))
+    except BleakError as ex:
+        print(f"Failed to update BMS: {ex}")
+
+
+asyncio.run(main(NAME))
+```
+
+## Installation
+Install python and pip if you have not already, then run:
+```bash
+pip3 install pip --upgrade
+pip3 install wheel
+```
+
+### For Production:
+
+```bash
+pip3 install aiobmsble
+```
+This will install the latest library release and all of it's python dependencies.
+
+### For Development:
+```bash
+git clone https://github.com/patman15/aiobmsble.git
+cd aiobmsble
+pip3 install -e .[dev]
+```
+This gives you the latest library code from the main branch.
+
+[license-shield]: https://img.shields.io/github/license/patman15/aiobmsble.svg?style=for-the-badge&cacheSeconds=86400

aiobmsble-0.1.0/aiobmsble/__init__.py

@@ -0,0 +1,54 @@
+"""Package for battery management systems (BMS) via Bluetooth LE."""
+
+from typing import Literal, TypedDict
+
+type BMSvalue = Literal[
+    "battery_charging",
+    "battery_level",
+    "current",
+    "power",
+    "temperature",
+    "voltage",
+    "cycles",
+    "cycle_capacity",
+    "cycle_charge",
+    "delta_voltage",
+    "problem",
+    "runtime",
+    "cell_voltages",
+    "design_capacity",
+    "temp_values",
+    "problem_code",
+]
+
+
+class BMSsample(TypedDict, total=False):
+    """Dictionary representing a sample of battery management system (BMS) data."""
+
+    battery_charging: bool
+    battery_level: int | float  # [%]
+    current: float  # [A]
+    power: float  # [W]
+    temperature: int | float  # [°C]
+    voltage: float  # [V]
+    cycle_capacity: int | float  # [Wh]
+    cycles: int  # [#]
+    delta_voltage: float  # [V]
+    problem: bool
+    runtime: int  # [s]
+    # internal
+    cell_voltages: list[float]  # [V]
+    cycle_charge: int | float  # [Ah]
+    design_capacity: int  # [Ah]
+    temp_values: list[int | float]  # [°C]
+    problem_code: int
+
+
+class AdvertisementPattern(TypedDict, total=False):
+    """Optional patterns that can match Bleak advertisement data."""
+
+    local_name: str  # name pattern that supports Unix shell-style wildcards
+    service_uuid: str  # 128-bit UUID that the device must advertise
+    service_data_uuid: str  # service data for the service UUID
+    manufacturer_id: int  # required manufacturer ID
+    manufacturer_data_start: list[int]  # required starting bytes of manufacturer data

aiobmsble-0.1.0/aiobmsble/__main__.py

@@ -0,0 +1,69 @@
+"""Example function for package usage."""
+
+import asyncio
+import logging
+from types import ModuleType
+
+from bleak import BleakScanner
+from bleak.backends.device import BLEDevice
+from bleak.backends.scanner import AdvertisementData
+from bleak.exc import BleakError
+
+from aiobmsble import BMSsample
+from aiobmsble.bms import ogt_bms
+from aiobmsble.utils import bms_supported
+
+bms_plugins: list[ModuleType] = [ogt_bms]
+
+logging.basicConfig(
+    format="%(levelname)s: %(message)s",
+    level=logging.INFO,
+)
+logger: logging.Logger = logging.getLogger(__name__)
+
+logger.info(
+    "loaded BMS types: %s", [key.__name__.rsplit(".", 1)[-1] for key in bms_plugins]
+)
+
+
+async def detect_bms() -> None:
+    """Query a Bluetooth device based on the provided arguments."""
+
+    logger.info("starting scan...")
+    scan_result: dict[str, tuple[BLEDevice, AdvertisementData]] = (
+        await BleakScanner.discover(return_adv=True)
+    )
+    logger.info("%i BT devices in range.", len(scan_result))
+
+    for ble_dev, advertisement in scan_result.values():
+        logger.info(
+            "%s\nBT device '%s' (%s)\n\t%s",
+            "-" * 72,
+            ble_dev.name,
+            ble_dev.address,
+            repr(advertisement).replace(", ", ",\n\t"),
+        )
+        for bms_module in bms_plugins:
+            if bms_supported(bms_module.BMS, advertisement):
+                logger.info(
+                    "Found matching BMS type: %s",
+                    bms_module.__name__.rsplit(".", maxsplit=1)[-1],
+                )
+                bms = bms_module.BMS(ble_device=ble_dev, reconnect=True)
+                try:
+                    logger.info("Updating BMS data...")
+                    data: BMSsample = await bms.async_update()
+                    logger.info("BMS data: %s", repr(data).replace(", ", ",\n\t"))
+                except BleakError as ex:
+                    logger.error("Failed to update BMS: %s", ex)
+
+    logger.info("done.")
+
+
+def main() -> None:
+    """Entry point for the script to run the BMS detection."""
+    asyncio.run(detect_bms())
+
+
+if __name__ == "__main__":
+    main()