python-ember-mug 1.2.0b1__tar.gz → 1.3.0b1__tar.gz

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: python-ember-mug
-Version: 1.2.0b1
+Version: 1.3.0b1
 Summary: Python Library for Ember Mugs.
 Project-URL: Changelog, https://sopelj.github.io/python-ember-mug/changelog/
 Project-URL: Documentation, https://sopelj.github.io/python-ember-mug/
 Project-URL: Source code, https://github.com/sopelj/python-ember-mug/
 Project-URL: Bug Tracker, https://github.com/sopelj/python-ember-mug/issues
-Author-email: Jesse Sopel <jesse.sopel@gmail.com>
+Author-email: Jesse Sopel <jesse@sopelj.ca>
 License-Expression: MIT
 License-File: LICENSE
 Classifier: Intended Audience :: Developers
@@ -17,9 +17,8 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.11
-Requires-Dist: bleak-retry-connector>=3.5.0
-Requires-Dist: bleak>=0.22.2; python_version < '3.13'
-Requires-Dist: bleak>=0.22.3; python_version <= '3.13'
+Requires-Dist: bleak-retry-connector>=4.0.2
+Requires-Dist: bleak>=1.0.1
 Provides-Extra: dev
 Requires-Dist: ipython; extra == 'dev'
 Provides-Extra: docs
@@ -207,6 +206,9 @@ You may also need to re-add it to the app in order to make it writable again as
 This seems to be caused by the bluetooth adaptor being in some sort of passive mode. I have not yet figured out how to wake it programmatically so sadly, you need to manually open `bluetoothctl` to do so.
 Please ensure the device is in pairing mode (ie the light is flashing blue or says "PAIR") and run the `bluetoothctl` command. You don't need to type anything. run it and wait until the mug connects.
 
+### Model incorrect or not found
+
+I don't have a lot of these devices, so if this library does not correctly identify your device, please open and issue with the advertisement data of your device, so I can update the library to correctly identify it. Thanks!
 
 ## Development
 

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/README.md

@@ -166,6 +166,9 @@ You may also need to re-add it to the app in order to make it writable again as
 This seems to be caused by the bluetooth adaptor being in some sort of passive mode. I have not yet figured out how to wake it programmatically so sadly, you need to manually open `bluetoothctl` to do so.
 Please ensure the device is in pairing mode (ie the light is flashing blue or says "PAIR") and run the `bluetoothctl` command. You don't need to type anything. run it and wait until the mug connects.
 
+### Model incorrect or not found
+
+I don't have a lot of these devices, so if this library does not correctly identify your device, please open and issue with the advertisement data of your device, so I can update the library to correctly identify it. Thanks!
 
 ## Development
 

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/ember_mug/__init__.py

@@ -6,4 +6,4 @@ __all__ = ("EmberMug",)
 
 __author__ = """Jesse Sopel"""
 __email__ = "jesse.sopel@gmail.com"
-__version__ = "1.2.0b1"
+__version__ = "1.3.0b1"

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/ember_mug/cli/commands.py

@@ -12,8 +12,8 @@ from typing import TYPE_CHECKING, ClassVar
 
 from bleak import AdvertisementData, BleakError
 
-from ember_mug.consts import ATTR_LABELS, EXTRA_ATTRS, IS_LINUX, VolumeLevel
-from ember_mug.data import Colour
+from ember_mug.consts import ATTR_LABELS, EMBER_BLE_SIG, EXTRA_ATTRS, IS_LINUX, VolumeLevel
+from ember_mug.data import Colour, DeviceModel
 from ember_mug.mug import EmberMug
 from ember_mug.scanner import discover_devices, find_device
 
@@ -33,9 +33,14 @@ get_attribute_names = [n.replace("_", "-") for n in all_attrs]
 async def get_device(args: Namespace) -> EmberMug:
     """Help to get the devices based on command args."""
     device, advertisement = await find_device_cmd(args)
+    model_info = get_model_info_from_advertiser_data(advertisement)
+    if model_info.model == DeviceModel.UNKNOWN_DEVICE and not args.raw:
+        data = advertisement.manufacturer_data.get(EMBER_BLE_SIG, None)
+        print(f"Warning: No model found matching advertisement data: {data!r}")
+
     mug = EmberMug(
         device,
-        get_model_info_from_advertiser_data(advertisement),
+        model_info,
         use_metric=not args.imperial,
         debug=args.debug,
     )
@@ -139,13 +144,13 @@ async def set_device_value_cmd(args: Namespace) -> None:
     if not values:
         print("Please specify at least one attribute and value to set.")
         options = [f"--{a.replace('_', '-')}" for a in attrs]
-        print(f'Options: {", ".join(options)}')
+        print(f"Options: {', '.join(options)}")
         sys.exit(1)
 
     mug = await get_device(args)
     async with mug.connection(adapter=args.adapter):
         for attr, value in values:
-            method = getattr(mug, f'set_{attr.replace("-", "_")}')
+            method = getattr(mug, f"set_{attr.replace('-', '_')}")
             print(f"Setting {attr} to {value}")
             try:
                 await method(value)

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/ember_mug/cli/helpers.py

@@ -47,11 +47,11 @@ def print_table(data: list[tuple[str, ...]]) -> None:
     rows = [build_sub_rows(r) for r in data]
     num_columns = max(len(sr) for r in rows for sr in r.values())
     column_sizes = [max(len(sr[i]) for r in rows for sr in r.values()) + 2 for i in range(num_columns)]
-    vertical = f'+{"+".join("-" * i for i in column_sizes)}+'
+    vertical = f"+{'+'.join('-' * i for i in column_sizes)}+"
     print(vertical)
     for row in rows:
         for sub_row in row.values():
-            inner = "|".join(f" {sub_row[i]:<{width-2}} " for i, width in enumerate(column_sizes))
+            inner = "|".join(f" {sub_row[i]:<{width - 2}} " for i, width in enumerate(column_sizes))
             print(f"|{inner}|")
         print(vertical)
 

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/ember_mug/data.py

@@ -87,7 +87,7 @@ class BatteryInfo(AsDict):
 
     def __str__(self) -> str:
         """Format nicely for printing."""
-        return f'{self.percent}%, {"" if self.on_charging_base else "not "}on charging base'
+        return f"{self.percent}%, {'' if self.on_charging_base else 'not '}on charging base"
 
 
 @dataclass

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/ember_mug/mug.py

@@ -31,6 +31,7 @@ from .utils import (
     bytes_to_big_int,
     bytes_to_little_int,
     convert_temp_to_celsius,
+    convert_temp_to_fahrenheit,
     decode_byte_string,
     discover_services,
     encode_byte_string,
@@ -44,6 +45,8 @@ if TYPE_CHECKING:
     from bleak.backends.characteristic import BleakGATTCharacteristic
     from bleak.backends.device import BLEDevice
 
+    TempUnitType = Literal["°C", "°F"] | TemperatureUnit | Enum
+
 
 logger = logging.getLogger(__name__)
 
@@ -130,6 +133,22 @@ class EmberMug:
         """Check if the mug can support write operations."""
         return self.data.udsk is not None
 
+    def _convert_to_device_unit(self, value: float) -> float:
+        """Convert user value to the unit the device expects."""
+        if self.data.use_metric and self.data.temperature_unit != TemperatureUnit.CELSIUS:
+            return convert_temp_to_fahrenheit(value)
+        if not self.data.use_metric and self.data.temperature_unit != TemperatureUnit.FAHRENHEIT:
+            return convert_temp_to_celsius(value)
+        return value
+
+    def _convert_to_user_unit(self, value: float) -> float:
+        """Convert device value to the unit the user expects."""
+        if self.data.use_metric and self.data.temperature_unit != TemperatureUnit.CELSIUS:
+            return convert_temp_to_celsius(value)
+        if not self.data.use_metric and self.data.temperature_unit != TemperatureUnit.FAHRENHEIT:
+            return convert_temp_to_fahrenheit(value)
+        return value
+
     def has_attribute(self, attribute: str) -> bool:
         """Check whether the device has the given attribute."""
         return attribute in self.data.model_info.device_attributes
@@ -155,7 +174,7 @@ class EmberMug:
                     disconnected_callback=self._disconnect_callback,
                     ble_device_callback=lambda: self.device,
                 )
-                if self.debug is True:
+                if self.debug:
                     await discover_services(client)
                 self._expected_disconnect = False
             except (TimeoutError, BleakError) as error:
@@ -273,7 +292,7 @@ class EmberMug:
     async def get_target_temp(self) -> float:
         """Get target temp form mug gatt."""
         temp_bytes = await self._read(MugCharacteristic.TARGET_TEMPERATURE)
-        return temp_from_bytes(temp_bytes, self.data.use_metric)
+        return self._convert_to_user_unit(temp_from_bytes(temp_bytes))
 
     async def set_target_temp(self, target_temp: float) -> None:
         """Set new target temp for mug."""
@@ -282,17 +301,15 @@ class EmberMug:
         if target_temp != 0 and not (min_temp <= target_temp <= max_temp):
             raise ValueError(f"Temperature should be between {min_temp} and {max_temp} or 0.")
 
-        if self.data.use_metric is False:
-            target_temp = convert_temp_to_celsius(target_temp)
-
-        target = bytearray(int(target_temp / 0.01).to_bytes(2, "little"))
+        target_temp = self._convert_to_device_unit(target_temp)
+        target = bytearray(round(target_temp / 0.01).to_bytes(2, "little"))
         await self._write(MugCharacteristic.TARGET_TEMPERATURE, target)
         self.data.target_temp = target_temp
 
     async def get_current_temp(self) -> float:
         """Get current temp from mug gatt."""
         temp_bytes = await self._read(MugCharacteristic.CURRENT_TEMPERATURE)
-        return temp_from_bytes(temp_bytes, self.data.use_metric)
+        return self._convert_to_user_unit(temp_from_bytes(temp_bytes))
 
     async def get_liquid_level(self) -> int:
         """Get liquid level from mug gatt."""
@@ -368,7 +385,7 @@ class EmberMug:
             return TemperatureUnit.CELSIUS
         return TemperatureUnit.FAHRENHEIT
 
-    async def set_temperature_unit(self, unit: Literal["°C", "°F"] | TemperatureUnit | Enum) -> None:
+    async def set_temperature_unit(self, unit: TempUnitType) -> None:
         """Set mug unit."""
         text_unit = unit.value if isinstance(unit, Enum) else unit
         unit_bytes = bytearray([1 if text_unit == TemperatureUnit.FAHRENHEIT else 0])

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/ember_mug/utils.py

@@ -56,15 +56,12 @@ def convert_temp_to_celsius(temp: float) -> float:
     return (temp - 32) * 5 / 9
 
 
-def temp_from_bytes(temp_bytes: bytearray, metric: bool = True) -> float:
-    """Get temperature from bytearray and convert to Fahrenheit if needed."""
-    temp = float(bytes_to_little_int(temp_bytes)) * 0.01
-    if metric is False:
-        temp = convert_temp_to_fahrenheit(temp)
-    return round(temp, 2)
+def temp_from_bytes(temp_bytes: bytearray) -> float:
+    """Get temperature from bytearray."""
+    return float(bytes_to_little_int(temp_bytes)) * 0.01
 
 
-def get_colour_from_int(colour_id: int) -> DeviceColour | None:
+def get_colour_from_int(colour_id: int) -> DeviceColour | None:  # noqa: PLR0911
     """Extrapolate device colour from integer in advertiser data."""
     if colour_id in (-127, -63, 1, 14, 65):
         return DeviceColour.BLACK
@@ -76,13 +73,14 @@ def get_colour_from_int(colour_id: int) -> DeviceColour | None:
         return DeviceColour.COPPER
     if colour_id in (-124, -60):
         return DeviceColour.ROSE_GOLD
+    if colour_id in (-59, -123):
+        return DeviceColour.STAINLESS_STEEL
     return {
         -51: DeviceColour.SANDSTONE,
         -52: DeviceColour.SAGE_GREEN,
         -55: DeviceColour.GREY,
         -57: DeviceColour.BLUE,
         -122: DeviceColour.GOLD,
-        -123: DeviceColour.STAINLESS_STEEL,
     }.get(colour_id)
 
 
@@ -97,7 +95,7 @@ def get_model_from_single_int_and_services(  # noqa PLR0911
         return DeviceModel.MUG_1_10_OZ
     if model_id == 65:
         return DeviceModel.MUG_1_14_OZ
-    if model_id in (-51, -63, -61, -62):
+    if model_id in (-51, -59, -63, -61, -62):
         return DeviceModel.MUG_2_14_OZ
     if model_id == -60:
         return DeviceModel.CUP_6_OZ
@@ -150,7 +148,7 @@ def get_model_info_from_advertiser_data(advertisement: AdvertisementData) -> Mod
             get_colour_from_int(colour_id),
         )
     logger.debug(
-        "Unable to reliably determine model info from advertiser data." "Falling back to guessing based on name.",
+        "Unable to reliably determine model info from advertiser data.Falling back to guessing based on name.",
     )
     return ModelInfo(guess_model_from_name(advertisement.local_name))
 

{python_ember_mug-1.2.0b1 → python_ember_mug-1.3.0b1}/pyproject.toml

@@ -2,13 +2,11 @@
 name = "python-ember-mug"
 readme = "README.md"
 description = "Python Library for Ember Mugs."
-authors = [
-    { name = "Jesse Sopel", email = "jesse.sopel@gmail.com" },
-]
-license =  "MIT"
+authors = [{ name = "Jesse Sopel", email = "jesse@sopelj.ca" }]
+license = "MIT"
 requires-python = ">=3.11"
 dynamic = ["version"]
-classifiers=[
+classifiers = [
     'Intended Audience :: Developers',
     'License :: OSI Approved :: MIT License',
     'Natural Language :: English',
@@ -18,32 +16,25 @@ classifiers=[
     'Programming Language :: Python :: 3.13',
 ]
 dependencies = [
-    "bleak-retry-connector>=3.5.0",
-    "bleak>=0.22.2; python_version < '3.13'",
-    "bleak>=0.22.3; python_version <= '3.13'",
+    "bleak-retry-connector>=4.0.2",
+    "bleak>=1.0.1",
 ]
 
 [project.optional-dependencies]
-test = [
-  "pytest>=7.2.1",
-  "pytest-cov",
-  "pytest-asyncio",
-]
+test = ["pytest>=7.2.1", "pytest-cov", "pytest-asyncio"]
 docs = [
-  "mkdocs>=1.6.1",
-  "mkdocs-include-markdown-plugin>=7.0.0,<8.0.0",
-  "mkdocs-material>=9.5.44,<10.0.0",
-  "mkdocs-material-extensions",
-  "mkdocstrings-python>=1.12.0",
-  "mkdocs-autorefs",
-  "mkdocs-literate-nav",
-  "mkdocs-gen-files",
-  "black",
-  "termynal",
-]
-dev = [
-  "ipython",
+    "mkdocs>=1.6.1",
+    "mkdocs-include-markdown-plugin>=7.0.0,<8.0.0",
+    "mkdocs-material>=9.5.44,<10.0.0",
+    "mkdocs-material-extensions",
+    "mkdocstrings-python>=1.12.0",
+    "mkdocs-autorefs",
+    "mkdocs-literate-nav",
+    "mkdocs-gen-files",
+    "black",
+    "termynal",
 ]
+dev = ["ipython"]
 
 [project.urls]
 "Changelog" = "https://sopelj.github.io/python-ember-mug/changelog/"
@@ -63,16 +54,19 @@ build-backend = "hatchling.build"
 [tool.hatch.version]
 path = "ember_mug/__init__.py"
 
+[tool.hatch.build]
+exclude = ["/docs", "/tests"]
+
 [tool.hatch.build.targets.sdist]
-packages = ["ember_mug", "tests"]
+packages = ["ember_mug"]
 exclude = [".gitignore"]
 
 [tool.hatch.build.targets.wheel]
-packages = ["ember_mug", "tests"]
+packages = ["ember_mug"]
 exclude = [".gitignore"]
 
 [tool.hatch.envs.default]
-python = "3.12"
+python = "3.13"
 
 [tool.hatch.envs.test]
 features = ["test"]
@@ -85,7 +79,7 @@ cov = "pytest -vvv --asyncio-mode=auto --cov=ember_mug --cov-branch --cov-report
 no-cov = "cov --no-cov"
 
 [tool.hatch.envs.docs]
-python = "3.12"
+python = "3.13"
 features = ["docs"]
 
 [tool.hatch.envs.docs.scripts]
@@ -95,7 +89,7 @@ serve = "mkdocs serve --dev-addr localhost:8000"
 [tool.black]
 line-length = 120
 skip-string-normalization = true
-target-version = ["py311", "py312"]
+target-version = ["py311", "py312", "py313"]
 include = '\.pyi?$'
 exclude = '''
 /(
@@ -112,15 +106,15 @@ exclude = '''
 
 [tool.coverage.report]
 exclude_lines = [
-  "pragma: no cover",
-  "def __repr__",
-  "def __str__",
-  "def main",
-  "raise AssertionError",
-  "raise NotImplementedError",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
-  "if typing.TYPE_CHECKING:"
+    "pragma: no cover",
+    "def __repr__",
+    "def __str__",
+    "def main",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "if typing.TYPE_CHECKING:",
 ]
 
 [tool.ruff]
@@ -163,7 +157,7 @@ ignore = ["D203", "D212", "PLR2004"]
 
 [tool.ruff.lint.per-file-ignores]
 "tests/**/*.py" = [
-    "D103",  # No docstrings in tests needed
-    "S101",  # We needs asserts in tests
+    "D103",   # No docstrings in tests needed
+    "S101",   # We needs asserts in tests
     "SLF001",
 ]

python_ember_mug-1.2.0b1/tests/__init__.py

@@ -1 +0,0 @@
-"""Unit test package for python-ember-mug."""

python_ember_mug-1.2.0b1/tests/cli/__init__.py

@@ -1 +0,0 @@
-"""Tests for the CLI module."""