aiobmsble 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
aiobmsble/__init__.py ADDED
@@ -0,0 +1,54 @@
1
+ """Package for battery management systems (BMS) via Bluetooth LE."""
2
+
3
+ from typing import Literal, TypedDict
4
+
5
+ type BMSvalue = Literal[
6
+ "battery_charging",
7
+ "battery_level",
8
+ "current",
9
+ "power",
10
+ "temperature",
11
+ "voltage",
12
+ "cycles",
13
+ "cycle_capacity",
14
+ "cycle_charge",
15
+ "delta_voltage",
16
+ "problem",
17
+ "runtime",
18
+ "cell_voltages",
19
+ "design_capacity",
20
+ "temp_values",
21
+ "problem_code",
22
+ ]
23
+
24
+
25
+ class BMSsample(TypedDict, total=False):
26
+ """Dictionary representing a sample of battery management system (BMS) data."""
27
+
28
+ battery_charging: bool
29
+ battery_level: int | float # [%]
30
+ current: float # [A]
31
+ power: float # [W]
32
+ temperature: int | float # [°C]
33
+ voltage: float # [V]
34
+ cycle_capacity: int | float # [Wh]
35
+ cycles: int # [#]
36
+ delta_voltage: float # [V]
37
+ problem: bool
38
+ runtime: int # [s]
39
+ # internal
40
+ cell_voltages: list[float] # [V]
41
+ cycle_charge: int | float # [Ah]
42
+ design_capacity: int # [Ah]
43
+ temp_values: list[int | float] # [°C]
44
+ problem_code: int
45
+
46
+
47
+ class AdvertisementPattern(TypedDict, total=False):
48
+ """Optional patterns that can match Bleak advertisement data."""
49
+
50
+ local_name: str # name pattern that supports Unix shell-style wildcards
51
+ service_uuid: str # 128-bit UUID that the device must advertise
52
+ service_data_uuid: str # service data for the service UUID
53
+ manufacturer_id: int # required manufacturer ID
54
+ manufacturer_data_start: list[int] # required starting bytes of manufacturer data
aiobmsble/__main__.py ADDED
@@ -0,0 +1,69 @@
1
+ """Example function for package usage."""
2
+
3
+ import asyncio
4
+ import logging
5
+ from types import ModuleType
6
+
7
+ from bleak import BleakScanner
8
+ from bleak.backends.device import BLEDevice
9
+ from bleak.backends.scanner import AdvertisementData
10
+ from bleak.exc import BleakError
11
+
12
+ from aiobmsble import BMSsample
13
+ from aiobmsble.bms import ogt_bms
14
+ from aiobmsble.utils import bms_supported
15
+
16
+ bms_plugins: list[ModuleType] = [ogt_bms]
17
+
18
+ logging.basicConfig(
19
+ format="%(levelname)s: %(message)s",
20
+ level=logging.INFO,
21
+ )
22
+ logger: logging.Logger = logging.getLogger(__name__)
23
+
24
+ logger.info(
25
+ "loaded BMS types: %s", [key.__name__.rsplit(".", 1)[-1] for key in bms_plugins]
26
+ )
27
+
28
+
29
+ async def detect_bms() -> None:
30
+ """Query a Bluetooth device based on the provided arguments."""
31
+
32
+ logger.info("starting scan...")
33
+ scan_result: dict[str, tuple[BLEDevice, AdvertisementData]] = (
34
+ await BleakScanner.discover(return_adv=True)
35
+ )
36
+ logger.info("%i BT devices in range.", len(scan_result))
37
+
38
+ for ble_dev, advertisement in scan_result.values():
39
+ logger.info(
40
+ "%s\nBT device '%s' (%s)\n\t%s",
41
+ "-" * 72,
42
+ ble_dev.name,
43
+ ble_dev.address,
44
+ repr(advertisement).replace(", ", ",\n\t"),
45
+ )
46
+ for bms_module in bms_plugins:
47
+ if bms_supported(bms_module.BMS, advertisement):
48
+ logger.info(
49
+ "Found matching BMS type: %s",
50
+ bms_module.__name__.rsplit(".", maxsplit=1)[-1],
51
+ )
52
+ bms = bms_module.BMS(ble_device=ble_dev, reconnect=True)
53
+ try:
54
+ logger.info("Updating BMS data...")
55
+ data: BMSsample = await bms.async_update()
56
+ logger.info("BMS data: %s", repr(data).replace(", ", ",\n\t"))
57
+ except BleakError as ex:
58
+ logger.error("Failed to update BMS: %s", ex)
59
+
60
+ logger.info("done.")
61
+
62
+
63
+ def main() -> None:
64
+ """Entry point for the script to run the BMS detection."""
65
+ asyncio.run(detect_bms())
66
+
67
+
68
+ if __name__ == "__main__":
69
+ main()
aiobmsble/basebms.py ADDED
@@ -0,0 +1,313 @@
1
+ """Base class defintion for battery management systems (BMS)."""
2
+
3
+ from abc import ABC, abstractmethod
4
+ import asyncio
5
+ from collections.abc import Callable
6
+ import logging
7
+ from statistics import fmean
8
+ from typing import Any, Final
9
+
10
+ from bleak import BleakClient
11
+ from bleak.backends.characteristic import BleakGATTCharacteristic
12
+ from bleak.backends.device import BLEDevice
13
+ from bleak.exc import BleakError
14
+ from bleak_retry_connector import establish_connection
15
+
16
+ from aiobmsble import AdvertisementPattern, BMSsample, BMSvalue
17
+
18
+ KEY_CELL_VOLTAGE: Final[str] = "cell#" # [V]
19
+
20
+
21
+ class BaseBMS(ABC):
22
+ """Abstract base class for battery management system."""
23
+
24
+ TIMEOUT = 5.0
25
+ _MAX_CELL_VOLT: Final[float] = 5.906 # max cell potential
26
+ _HRS_TO_SECS: Final[int] = 60 * 60 # seconds in an hour
27
+
28
+ def __init__(
29
+ self,
30
+ logger_name: str,
31
+ ble_device: BLEDevice,
32
+ reconnect: bool = False,
33
+ ) -> None:
34
+ """Intialize the BMS.
35
+
36
+ notification_handler: the callback function used for notifications from 'uuid_rx()'
37
+ characteristic. Not defined as abstract in this base class, as it can be both,
38
+ a normal or async function
39
+
40
+ Args:
41
+ logger_name (str): name of the logger for the BMS instance (usually file name)
42
+ ble_device (BLEDevice): the Bleak device to connect to
43
+ reconnect (bool): if true, the connection will be closed after each update
44
+
45
+ """
46
+ assert (
47
+ getattr(self, "_notification_handler", None) is not None
48
+ ), "BMS class must define _notification_handler method"
49
+ self._ble_device: Final[BLEDevice] = ble_device
50
+ self._reconnect: Final[bool] = reconnect
51
+ self.name: Final[str] = self._ble_device.name or "undefined"
52
+ self._log: Final[logging.Logger] = logging.getLogger(
53
+ f"{logger_name.replace('.plugins', '')}::{self.name}:"
54
+ f"{self._ble_device.address[-5:].replace(':','')})"
55
+ )
56
+
57
+ self._log.debug(
58
+ "initializing %s, BT address: %s", self.device_id(), ble_device.address
59
+ )
60
+ self._client: BleakClient = BleakClient(
61
+ self._ble_device,
62
+ disconnected_callback=self._on_disconnect,
63
+ services=[*self.uuid_services()],
64
+ )
65
+ self._data: bytearray = bytearray()
66
+ self._data_event: Final[asyncio.Event] = asyncio.Event()
67
+
68
+ @staticmethod
69
+ @abstractmethod
70
+ def matcher_dict_list() -> list[AdvertisementPattern]:
71
+ """Return a list of Bluetooth advertisement matchers."""
72
+
73
+ @staticmethod
74
+ @abstractmethod
75
+ def device_info() -> dict[str, str]:
76
+ """Return a dictionary of device information.
77
+
78
+ keys: manufacturer, model
79
+ """
80
+
81
+ @classmethod
82
+ def device_id(cls) -> str:
83
+ """Return device information as string."""
84
+ return " ".join(cls.device_info().values())
85
+
86
+ @staticmethod
87
+ @abstractmethod
88
+ def uuid_services() -> list[str]:
89
+ """Return list of 128-bit UUIDs of services required by BMS."""
90
+
91
+ @staticmethod
92
+ @abstractmethod
93
+ def uuid_rx() -> str:
94
+ """Return 16-bit UUID of characteristic that provides notification/read property."""
95
+
96
+ @staticmethod
97
+ @abstractmethod
98
+ def uuid_tx() -> str:
99
+ """Return 16-bit UUID of characteristic that provides write property."""
100
+
101
+ @staticmethod
102
+ def _calc_values() -> frozenset[BMSvalue]:
103
+ """Return values that the BMS cannot provide and need to be calculated.
104
+
105
+ See _add_missing_values() function for the required input to actually do so.
106
+ """
107
+ return frozenset()
108
+
109
+ @staticmethod
110
+ def _add_missing_values(data: BMSsample, values: frozenset[BMSvalue]) -> None:
111
+ """Calculate missing BMS values from existing ones.
112
+
113
+ Args:
114
+ data: data dictionary with values received from BMS
115
+ values: list of values to calculate and add to the dictionary
116
+
117
+ Returns:
118
+ None
119
+
120
+ """
121
+ if not values or not data:
122
+ return
123
+
124
+ def can_calc(value: BMSvalue, using: frozenset[BMSvalue]) -> bool:
125
+ """Check value to add does not exist, is requested, and needed data is available."""
126
+ return (value in values) and (value not in data) and using.issubset(data)
127
+
128
+ cell_voltages: Final[list[float]] = data.get("cell_voltages", [])
129
+ design_capacity: Final[int | float] = data.get("design_capacity", 0)
130
+ battery_level: Final[int | float] = data.get("battery_level", 0)
131
+ voltage: Final[float] = data.get("voltage", 0)
132
+ cycle_charge: Final[int | float] = data.get("cycle_charge", 0)
133
+ current: Final[float] = data.get("current", 0)
134
+
135
+ calculations: dict[BMSvalue, tuple[set[BMSvalue], Callable[[], Any]]] = {
136
+ "voltage": ({"cell_voltages"}, lambda: round(sum(cell_voltages), 3)),
137
+ "delta_voltage": (
138
+ {"cell_voltages"},
139
+ lambda: round(max(cell_voltages) - min(cell_voltages), 3),
140
+ ),
141
+ "cycle_charge": (
142
+ {"design_capacity", "battery_level"},
143
+ lambda: (design_capacity * battery_level) / 100,
144
+ ),
145
+ "cycle_capacity": (
146
+ {"voltage", "cycle_charge"},
147
+ lambda: voltage * cycle_charge,
148
+ ),
149
+ "power": ({"voltage", "current"}, lambda: round(voltage * current, 3)),
150
+ "battery_charging": ({"current"}, lambda: current > 0),
151
+ "runtime": (
152
+ {"current", "cycle_charge"},
153
+ lambda: (
154
+ int(cycle_charge / abs(current) * BaseBMS._HRS_TO_SECS)
155
+ if current < 0
156
+ else None
157
+ ),
158
+ ),
159
+ "temperature": (
160
+ {"temp_values"},
161
+ lambda: round(fmean(data.get("temp_values", [])), 3),
162
+ ),
163
+ }
164
+
165
+ for attr, (required, calc_func) in calculations.items():
166
+ if can_calc(attr, frozenset(required)):
167
+ data[attr] = calc_func()
168
+
169
+ # do sanity check on values to set problem state
170
+ data["problem"] = any(
171
+ [
172
+ data.get("problem", False),
173
+ data.get("problem_code", False),
174
+ voltage <= 0,
175
+ any(v <= 0 or v > BaseBMS._MAX_CELL_VOLT for v in cell_voltages),
176
+ data.get("delta_voltage", 0) > BaseBMS._MAX_CELL_VOLT,
177
+ cycle_charge <= 0,
178
+ battery_level > 100,
179
+ ]
180
+ )
181
+
182
+ def _on_disconnect(self, _client: BleakClient) -> None:
183
+ """Disconnect callback function."""
184
+
185
+ self._log.debug("disconnected from BMS")
186
+
187
+ async def _init_connection(self) -> None:
188
+ # reset any stale data from BMS
189
+ self._data.clear()
190
+ self._data_event.clear()
191
+
192
+ await self._client.start_notify(
193
+ self.uuid_rx(), getattr(self, "_notification_handler")
194
+ )
195
+
196
+ async def _connect(self) -> None:
197
+ """Connect to the BMS and setup notification if not connected."""
198
+
199
+ if self._client.is_connected:
200
+ self._log.debug("BMS already connected")
201
+ return
202
+
203
+ self._log.debug("connecting BMS")
204
+ self._client = await establish_connection(
205
+ client_class=BleakClient,
206
+ device=self._ble_device,
207
+ name=self._ble_device.address,
208
+ disconnected_callback=self._on_disconnect,
209
+ services=[*self.uuid_services()],
210
+ )
211
+
212
+ try:
213
+ await self._init_connection()
214
+ except Exception as err:
215
+ self._log.info(
216
+ "failed to initialize BMS connection (%s)", type(err).__name__
217
+ )
218
+ await self.disconnect()
219
+ raise
220
+
221
+ async def _await_reply(
222
+ self,
223
+ data: bytes,
224
+ char: BleakGATTCharacteristic | int | str | None = None,
225
+ wait_for_notify: bool = True,
226
+ ) -> None:
227
+ """Send data to the BMS and wait for valid reply notification."""
228
+
229
+ self._log.debug("TX BLE data: %s", data.hex(" "))
230
+ self._data_event.clear() # clear event before requesting new data
231
+ await self._client.write_gatt_char(char or self.uuid_tx(), data, response=False)
232
+ if wait_for_notify:
233
+ await asyncio.wait_for(self._wait_event(), timeout=self.TIMEOUT)
234
+
235
+ async def disconnect(self) -> None:
236
+ """Disconnect the BMS, includes stoping notifications."""
237
+
238
+ if self._client.is_connected:
239
+ self._log.debug("disconnecting BMS")
240
+ try:
241
+ self._data_event.clear()
242
+ await self._client.disconnect()
243
+ except BleakError:
244
+ self._log.warning("disconnect failed!")
245
+
246
+ async def _wait_event(self) -> None:
247
+ """Wait for data event and clear it."""
248
+ await self._data_event.wait()
249
+ self._data_event.clear()
250
+
251
+ @abstractmethod
252
+ async def _async_update(self) -> BMSsample:
253
+ """Return a dictionary of BMS values (keys need to come from the SENSOR_TYPES list)."""
254
+
255
+ async def async_update(self, raw: bool = False) -> BMSsample:
256
+ """Retrieve updated values from the BMS using method of the subclass.
257
+
258
+ Args:
259
+ raw (bool): if true, the raw data from the BMS is returned without
260
+ any calculations or missing values added
261
+
262
+ Returns:
263
+ BMSsample: dictionary with BMS values
264
+
265
+ """
266
+ await self._connect()
267
+
268
+ data: BMSsample = await self._async_update()
269
+ if not raw:
270
+ self._add_missing_values(data, self._calc_values())
271
+
272
+ if self._reconnect:
273
+ # disconnect after data update to force reconnect next time (slow!)
274
+ await self.disconnect()
275
+
276
+ return data
277
+
278
+
279
+ def crc_modbus(data: bytearray) -> int:
280
+ """Calculate CRC-16-CCITT MODBUS."""
281
+ crc: int = 0xFFFF
282
+ for i in data:
283
+ crc ^= i & 0xFF
284
+ for _ in range(8):
285
+ crc = (crc >> 1) ^ 0xA001 if crc % 2 else (crc >> 1)
286
+ return crc & 0xFFFF
287
+
288
+
289
+ def crc_xmodem(data: bytearray) -> int:
290
+ """Calculate CRC-16-CCITT XMODEM."""
291
+ crc: int = 0x0000
292
+ for byte in data:
293
+ crc ^= byte << 8
294
+ for _ in range(8):
295
+ crc = (crc << 1) ^ 0x1021 if (crc & 0x8000) else (crc << 1)
296
+ return crc & 0xFFFF
297
+
298
+
299
+ def crc8(data: bytearray) -> int:
300
+ """Calculate CRC-8/MAXIM-DOW."""
301
+ crc: int = 0x00 # Initialwert für CRC
302
+
303
+ for byte in data:
304
+ crc ^= byte
305
+ for _ in range(8):
306
+ crc = (crc >> 1) ^ 0x8C if crc & 0x1 else crc >> 1
307
+
308
+ return crc & 0xFF
309
+
310
+
311
+ def crc_sum(frame: bytearray) -> int:
312
+ """Calculate frame CRC."""
313
+ return sum(frame) & 0xFF
aiobmsble/utils.py ADDED
@@ -0,0 +1,73 @@
1
+ """Utilitiy/Support functions for aiobmsble."""
2
+
3
+ from fnmatch import translate
4
+ import re
5
+
6
+ from bleak.backends.scanner import AdvertisementData
7
+
8
+ from aiobmsble import AdvertisementPattern
9
+ from aiobmsble.basebms import BaseBMS
10
+
11
+
12
+ def advertisement_matches(
13
+ matcher: AdvertisementPattern,
14
+ adv_data: AdvertisementData,
15
+ ) -> bool:
16
+ """Determine whether the given advertisement data matches the specified pattern.
17
+
18
+ Args:
19
+ matcher (AdvertisementPattern): A dictionary containing the matching criteria.
20
+ Possible keys include:
21
+ - "service_uuid" (str): A specific service 128-bit UUID to match.
22
+ - "service_data_uuid" (str): A specific service data UUID to match.
23
+ - "manufacturer_id" (int): A manufacturer ID to match.
24
+ - "manufacturer_data_start" (bytes): A byte sequence that the data should start with.
25
+ - "local_name" (str): A pattern supporting Unix shell-style wildcards to match
26
+
27
+ adv_data (AdvertisementData): An object containing the advertisement data to be checked.
28
+
29
+ Returns:
30
+ bool: True if the advertisement data matches the specified pattern, False otherwise.
31
+
32
+ """
33
+ if (
34
+ service_uuid := matcher.get("service_uuid")
35
+ ) and service_uuid not in adv_data.service_uuids:
36
+ return False
37
+
38
+ if (
39
+ service_data_uuid := matcher.get("service_data_uuid")
40
+ ) and service_data_uuid not in adv_data.service_data:
41
+ return False
42
+
43
+ if (manufacturer_id := matcher.get("manufacturer_id")) is not None:
44
+ if manufacturer_id not in adv_data.manufacturer_data:
45
+ return False
46
+
47
+ if manufacturer_data_start := matcher.get("manufacturer_data_start"):
48
+ if not adv_data.manufacturer_data[manufacturer_id].startswith(
49
+ bytes(manufacturer_data_start)
50
+ ):
51
+ return False
52
+
53
+ return not (
54
+ (local_name := matcher.get("local_name"))
55
+ and not re.compile(translate(local_name)).match(adv_data.local_name or "")
56
+ )
57
+
58
+
59
+ def bms_supported(bms: BaseBMS, adv_data: AdvertisementData) -> bool:
60
+ """Determine if the given BMS is supported based on advertisement data.
61
+
62
+ Args:
63
+ bms (BaseBMS): The BMS class to check.
64
+ adv_data (AdvertisementData): The advertisement data to match against.
65
+
66
+ Returns:
67
+ bool: True if the BMS is supported, False otherwise.
68
+
69
+ """
70
+ for matcher in bms.matcher_dict_list():
71
+ if advertisement_matches(matcher, adv_data):
72
+ return True
73
+ return False
@@ -0,0 +1,113 @@
1
+ Metadata-Version: 2.4
2
+ Name: aiobmsble
3
+ Version: 0.1.0
4
+ Summary: Asynchronous Python library to query battery management systems via Bluetooth Low Energy.
5
+ Author: Patrick Loschmidt
6
+ Maintainer: Patrick Loschmidt
7
+ License-Expression: Apache-2.0
8
+ Project-URL: Homepage, https://github.com/patman15/aiobmsble/
9
+ Project-URL: Documentation, https://github.com/patman15/aiobmsble/
10
+ Keywords: BMS,BLE,battery,bluetooth
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
16
+ Requires-Python: >=3.12
17
+ Description-Content-Type: text/markdown
18
+ License-File: LICENSE
19
+ Requires-Dist: bleak~=0.22.3
20
+ Requires-Dist: bleak-retry-connector~=3.8.1
21
+ Requires-Dist: asyncio
22
+ Requires-Dist: logging
23
+ Requires-Dist: statistics
24
+ Requires-Dist: typing
25
+ Provides-Extra: dev
26
+ Requires-Dist: pytest; extra == "dev"
27
+ Requires-Dist: pytest-asyncio; extra == "dev"
28
+ Requires-Dist: pytest-cov; extra == "dev"
29
+ Requires-Dist: mypy; extra == "dev"
30
+ Requires-Dist: ruff; extra == "dev"
31
+ Dynamic: license-file
32
+
33
+ [![License][license-shield]](LICENSE)
34
+
35
+ # Aiobmsble
36
+ Requires Python 3 and uses [asyncio](https://pypi.org/project/asyncio/) and [bleak](https://pypi.org/project/bleak/)
37
+ > [!IMPORTANT]
38
+ > 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/)!
39
+ > 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*.
40
+ > Plan is to support all BMSs that are listed [here](https://github.com/patman15/BMS_BLE-HA/edit/main/README.md#supported-devices).
41
+
42
+ ## Asynchronous Library to Query Battery Management Systems via Bluetooth LE
43
+ 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).
44
+
45
+ ## Usage
46
+ In order to identify all devices that are reachable and supported by the library, simply run
47
+ ```bash
48
+ aiobmsble
49
+ ```
50
+ from the command line after [installation](#installation). In case you need the code as reference, please see [\_\_main\_\_.py](/aiobmsble/__main__.py).
51
+
52
+ ### From a Script
53
+ This example can also be found as an [example](/examples/minimal.py) in the respective [folder](/main/examples).
54
+ ```python
55
+ """Example of using the aiobmsble library to find a BLE device by name and print its senosr data."""
56
+
57
+ import asyncio
58
+ from typing import Final
59
+
60
+ from bleak import BleakScanner
61
+ from bleak.backends.device import BLEDevice
62
+ from bleak.exc import BleakError
63
+
64
+ from aiobmsble import BMSsample
65
+ from aiobmsble.bms.ogt_bms import BMS # use the right BMS class for your device
66
+
67
+ NAME: Final[str] = "BT Device Name" # Replace with the name of your BLE device
68
+
69
+
70
+ async def main(dev_name) -> None:
71
+ """Main function to find a BLE device by name and update its sensor data."""
72
+
73
+ device: BLEDevice | None = await BleakScanner.find_device_by_name(dev_name)
74
+ if device is None:
75
+ print(f"Device '{dev_name}' not found.")
76
+ return
77
+
78
+ print(f"Found device: {device.name} ({device.address})")
79
+ bms = BMS(ble_device=device, reconnect=True)
80
+ try:
81
+ print("Updating BMS data...")
82
+ data: BMSsample = await bms.async_update()
83
+ print("BMS data: ", repr(data).replace(", ", ",\n\t"))
84
+ except BleakError as ex:
85
+ print(f"Failed to update BMS: {ex}")
86
+
87
+
88
+ asyncio.run(main(NAME))
89
+ ```
90
+
91
+ ## Installation
92
+ Install python and pip if you have not already, then run:
93
+ ```bash
94
+ pip3 install pip --upgrade
95
+ pip3 install wheel
96
+ ```
97
+
98
+ ### For Production:
99
+
100
+ ```bash
101
+ pip3 install aiobmsble
102
+ ```
103
+ This will install the latest library release and all of it's python dependencies.
104
+
105
+ ### For Development:
106
+ ```bash
107
+ git clone https://github.com/patman15/aiobmsble.git
108
+ cd aiobmsble
109
+ pip3 install -e .[dev]
110
+ ```
111
+ This gives you the latest library code from the main branch.
112
+
113
+ [license-shield]: https://img.shields.io/github/license/patman15/aiobmsble.svg?style=for-the-badge&cacheSeconds=86400
@@ -0,0 +1,10 @@
1
+ aiobmsble/__init__.py,sha256=qEmiX9i7aKK7lYl7zrTgNFblb3-WJYTG22tTmAO_uC4,1541
2
+ aiobmsble/__main__.py,sha256=ycvwDkcph4M1UzsBGJzkQWkLS6CW5sPfEG9QK-Q691I,2102
3
+ aiobmsble/basebms.py,sha256=ZHG34fmDQ5wz58GpS7yI09ICdot7iyvdhPg6zt9U6vw,10699
4
+ aiobmsble/utils.py,sha256=BGcwcfOpS5KW942J7uHRrBkmh9rdMW64OvDRyHIP9lQ,2535
5
+ aiobmsble-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
6
+ aiobmsble-0.1.0.dist-info/METADATA,sha256=THqATDPH5bBlgIb363ZpqCkOh5S4FPYkQSPnPDW4xdE,4395
7
+ aiobmsble-0.1.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
8
+ aiobmsble-0.1.0.dist-info/entry_points.txt,sha256=HSC_C3nQikc3nk0a6mcG92RuIM7wAzozjBVfDojJceo,54
9
+ aiobmsble-0.1.0.dist-info/top_level.txt,sha256=YHBVzg45mJ3vPz0sl_TpMB0edMqqhD61kwJj4EPAk9g,10
10
+ aiobmsble-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (80.4.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ aiobmsble = aiobmsble.__main__:main
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1 @@
1
+ aiobmsble