python-ember-mug 1.4.0b2__tar.gz → 1.5.0__tar.gz

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: python-ember-mug
-Version: 1.4.0b2
+Version: 1.5.0
 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/
@@ -121,7 +121,7 @@ await mug.disconnect()
 # You can also use connection as a context manager
 # if you want to ensure connection before starting and cleanup on exit
 async with mug.connection():
-    print('Connected.\nFetching Info')
+    print("Connected.\nFetching Info")
     await mug.update_all()
     print(mug.data.formatted)
 ```

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/README.md

@@ -80,7 +80,7 @@ await mug.disconnect()
 # You can also use connection as a context manager
 # if you want to ensure connection before starting and cleanup on exit
 async with mug.connection():
-    print('Connected.\nFetching Info')
+    print("Connected.\nFetching Info")
     await mug.update_all()
     print(mug.data.formatted)
 ```

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/ember_mug/__init__.py

@@ -6,4 +6,4 @@ __all__ = ("EmberMug",)
 
 __author__ = """Jesse Sopel"""
 __email__ = "jesse@sopelj.ca"
-__version__ = "1.4.0b2"
+__version__ = "1.5.0"

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/ember_mug/cli/commands.py

@@ -8,10 +8,11 @@ import logging
 import re
 import sys
 from argparse import ArgumentParser, ArgumentTypeError, Namespace
+from datetime import datetime
 from pathlib import Path
 from typing import IO, TYPE_CHECKING, ClassVar
 
-from bleak import BleakError
+from bleak.exc import BleakError
 
 from ember_mug.consts import ATTR_LABELS, EMBER_BLE_SIG, EXTRA_ATTRS, IS_LINUX, TESTING_BLE_SIG, VolumeLevel
 from ember_mug.data import Colour, DeviceModel
@@ -26,11 +27,12 @@ from .helpers import CommandLoop, print_changes, print_info, print_table, valida
 if TYPE_CHECKING:
     from collections.abc import Awaitable, Callable
 
-    from bleak import AdvertisementData
     from bleak.backends.device import BLEDevice
+    from bleak.backends.scanner import AdvertisementData
 
 all_attrs = list(ATTR_LABELS) + list(EXTRA_ATTRS)
 get_attribute_names = [n.replace("_", "-") for n in all_attrs]
+SetValues = str | float | Colour | datetime
 
 
 async def get_device(args: Namespace) -> EmberMug:
@@ -86,7 +88,7 @@ async def discover_cmd(args: Namespace) -> list[tuple[BLEDevice, AdvertisementDa
             model_info = get_model_info_from_advertiser_data(advertisement)
             model_number = model_info.model.value if model_info.model else "Unknown Model"
             print(f"Found {model_info.device_type.value}:", mug)
-            print("Name:", advertisement.local_name)
+            print("Name:", advertisement.local_name or "Ember Mug")
             print("Model:", f"{model_info.name} [{model_number}]")
             print("Colour:", model_info.colour.value if model_info.colour else "Unknown")
             print("Capacity:", format_capacity(model_info.capacity))
@@ -143,8 +145,10 @@ async def get_device_value_cmd(args: Namespace) -> None:
 
 async def set_device_value_cmd(args: Namespace) -> None:
     """Set one or more values on the device."""
-    attrs = ("name", "target_temp", "temperature_unit", "led_colour", "volume_level")
-    values = [(attr, value) for attr in attrs if (value := getattr(args, attr, None))]
+    attrs = ("name", "target_temp", "temperature_unit", "led_colour", "volume_level", "date_time_zone")
+    values: list[tuple[str, SetValues | None]] = [
+        (attr, value) for attr in attrs if (value := getattr(args, attr, None))
+    ]
     if not values:
         print("Please specify at least one attribute and value to set.")
         options = [f"--{a.replace('_', '-')}" for a in attrs]
@@ -186,6 +190,14 @@ def colour_type(value: str) -> Colour:
     raise ArgumentTypeError(msg)
 
 
+def dt_zone_type(value: str) -> datetime:
+    """Convert date/time string into datetime object."""
+    try:
+        return datetime.fromisoformat(value)
+    except ValueError as e:
+        raise ArgumentTypeError(f'"{value}" is not a valid ISO datetime string') from e
+
+
 class EmberMugCli:
     """Very simple CLI Interface to interact with a mug."""
 
@@ -246,6 +258,7 @@ class EmberMugCli:
         set_parser.add_argument("--target-temp", help="Target Temperature", type=float, required=False)
         set_parser.add_argument("--temperature-unit", help="Temperature Unit", choices=["C", "F"], required=False)
         set_parser.add_argument("--led-colour", help="LED Colour", type=colour_type, required=False)
+        set_parser.add_argument("--date-time-zone", help="Internal Date/Time+Zone", type=dt_zone_type, required=False)
         set_parser.add_argument(
             "--volume-level",
             help="Volume Level",

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/ember_mug/consts.py

@@ -98,9 +98,9 @@ class MugCharacteristic(IntEnum):
     TARGET_TEMPERATURE = 3
     # Unit (0 -> Celsius, 1 -> Fahrenheit) (Read/Write)
     TEMPERATURE_UNIT = 4
-    # Level (Between 0 -> 30 ?) 30 100% ?
+    # Level (Between 0 -> 30 for mug and 0-100 for travel mug
     LIQUID_LEVEL = 5
-    # Current date and time zone? (Read/Write)
+    # Current date and time zone (Write only)
     DATE_TIME_AND_ZONE = 6
     # Battery Info (Read)
     BATTERY = 7

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/ember_mug/data.py

@@ -76,18 +76,29 @@ class BatteryInfo(AsDict):
 
     percent: float
     on_charging_base: bool
+    temperature: float | None = None
+    """Battery temperature in °C (bytes 2-3 of the characteristic), or None if the mug did not report one."""
 
     @classmethod
     def from_bytes(cls, data: bytes) -> BatteryInfo:
         """Initialize from raw bytes."""
+        temperature: float | None = None
+        if len(data) >= 4:
+            raw = bytes_to_little_int(data[2:4])
+            if 0 < raw < 10000:
+                temperature = round(raw * 0.01, 2)
         return cls(
             percent=round(float(data[0]), 2),
             on_charging_base=data[1] == 1,
+            temperature=temperature,
         )
 
     def __str__(self) -> str:
         """Format nicely for printing."""
-        return f"{self.percent}%, {'' if self.on_charging_base else 'not '}on charging base"
+        text = f"{self.percent}%, {'' if self.on_charging_base else 'not '}on charging base"
+        if self.temperature is not None:
+            text += f", {self.temperature:.1f}°C"
+        return text
 
 
 @dataclass

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/ember_mug/mug.py

@@ -12,7 +12,8 @@ from functools import cached_property
 from time import time
 from typing import TYPE_CHECKING, Any, Concatenate, Literal, ParamSpec, TypeVar
 
-from bleak import AdvertisementData, BleakClient, BleakError
+from bleak import BleakClient
+from bleak.exc import BleakError
 from bleak_retry_connector import establish_connection
 
 from .consts import (
@@ -34,8 +35,10 @@ from .utils import (
     convert_temp_to_celsius,
     convert_temp_to_fahrenheit,
     decode_byte_string,
+    decode_date_time,
     discover_services,
     encode_byte_string,
+    encode_date_time,
     get_model_info_from_advertiser_data,
     temp_from_bytes,
 )
@@ -45,6 +48,7 @@ if TYPE_CHECKING:
 
     from bleak.backends.characteristic import BleakGATTCharacteristic
     from bleak.backends.device import BLEDevice
+    from bleak.backends.scanner import AdvertisementData
 
     TempUnitType = Literal["°C", "°F"] | TemperatureUnit | StrEnum
 
@@ -414,8 +418,16 @@ class EmberMug:
     async def get_date_time_zone(self) -> datetime | None:
         """Get date and time zone."""
         date_time_zone_bytes = await self._read(MugCharacteristic.DATE_TIME_AND_ZONE)
-        time_value = bytes_to_big_int(date_time_zone_bytes[:4])
-        return datetime.fromtimestamp(time_value, UTC) if time_value > 0 else None
+        return decode_date_time(date_time_zone_bytes)
+
+    async def set_date_time_zone(self, date_time: datetime | None = None) -> None:
+        """Get date and time zone."""
+        if not date_time:
+            date_time = datetime.now()
+        if date_time.tzinfo is None:
+            date_time = date_time.replace(tzinfo=UTC)
+        encoded_date = encode_date_time(date_time)
+        await self._write(MugCharacteristic.DATE_TIME_AND_ZONE, bytearray(encoded_date))
 
     async def get_firmware(self) -> MugFirmwareInfo:
         """Get firmware info."""
@@ -435,9 +447,19 @@ class EmberMug:
         """Update a list of attributes from the mug."""
         logger.debug("Updating the following attributes: %s", attrs)
         await self._ensure_connection()
-        changes = self.data.update_info(**{attr: await getattr(self, f"get_{attr}")() for attr in attrs})
+        updates = {}
+        failed_attrs = set()
+        for attr in attrs:
+            try:
+                updates[attr] = await getattr(self, f"get_{attr}")()
+            except BleakError as e:
+                failed_attrs |= {attr}
+                logger.debug("Failed to fetch %s: %s", attr, e)
+        changes = self.data.update_info(**updates)
         if changes:
             self._fire_callbacks()
+        if failed_attrs:
+            logger.warning("Failed to fetch some attributes: %s", failed_attrs)
         logger.debug("Attributes updated: %s", changes)
         return changes
 
@@ -457,15 +479,16 @@ class EmberMug:
     def _notify_callback(self, characteristic: BleakGATTCharacteristic, data: bytearray) -> None:
         """Push events from the mug to indicate changes."""
         event_id = data[0]
-        now = time()
-        if (last_time := self._latest_events.get(event_id)) and now - last_time < 5:
-            return
-        self._latest_events[event_id] = now
 
         if characteristic.uuid == MugCharacteristic.STATISTICS.uuid:
             logger.info("Statistics received from %s (%s) - Data: %s.", self.model_name, event_id, data)
             return
 
+        now = time()
+        if (last_time := self._latest_events.get(event_id)) and now - last_time < 5:
+            return
+        self._latest_events[event_id] = now
+
         logger.debug("Push event received from %s (%s) - Data: %s.", self.model_name, event_id, data)
 
         # Check known IDs
@@ -478,6 +501,7 @@ class EmberMug:
                 self.data.battery = BatteryInfo(
                     percent=self.data.battery.percent if self.data.battery else 0,
                     on_charging_base=event_id == PushEvent.CHARGER_CONNECTED,
+                    temperature=self.data.battery.temperature if self.data.battery else None,
                 )
                 self._fire_callbacks()
             # All indicate changes in battery

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/ember_mug/scanner.py

@@ -14,7 +14,7 @@ from .consts import DEVICE_SERVICE_UUIDS, IS_LINUX
 if TYPE_CHECKING:
     from typing import NotRequired, TypedDict
 
-    from bleak import BlueZScannerArgs
+    from bleak.args.bluez import BlueZScannerArgs
     from bleak.backends.device import BLEDevice
     from bleak.backends.scanner import AdvertisementData
 

{python_ember_mug-1.4.0b2 → python_ember_mug-1.5.0}/ember_mug/utils.py

@@ -6,14 +6,16 @@ import base64
 import contextlib
 import logging
 import re
+from datetime import UTC, datetime, timedelta, timezone
 from typing import TYPE_CHECKING, Any
 
-from bleak import AdvertisementData, BleakError
+from bleak.exc import BleakError
 
 from ember_mug.consts import EMBER_BLE_SIG, TESTING_BLE_SIG, TRAVEL_MUG_SERVICE_UUIDS, DeviceColour, DeviceModel
 
 if TYPE_CHECKING:
     from bleak import BleakClient
+    from bleak.backends.scanner import AdvertisementData
 
     from ember_mug.data import ModelInfo
 
@@ -61,6 +63,30 @@ def temp_from_bytes(temp_bytes: bytearray) -> float:
     return float(bytes_to_little_int(temp_bytes)) * 0.01
 
 
+def encode_date_time(date_time: datetime) -> bytes:
+    """Encode datetime with timezone as the mug expects."""
+    offset_hours = 0
+    if offset := date_time.utcoffset():
+        offset_hours = int(offset.total_seconds() / 60 / 60)
+
+    timestamp = int(date_time.timestamp())
+    timestamp_bytes = timestamp.to_bytes(4, byteorder="little", signed=False)
+    offset_byte = offset_hours.to_bytes(1, byteorder="big", signed=True)
+
+    return timestamp_bytes + offset_byte
+
+
+def decode_date_time(data: bytes | bytearray) -> datetime:
+    """Extract date time with timezone from bytes."""
+    timestamp = int.from_bytes(data[:4], "little", signed=False)
+    offset_hours = int.from_bytes(data[4:5], "little", signed=True)
+
+    utc_datetime = datetime.fromtimestamp(timestamp, UTC)
+    local_timezone = timezone(timedelta(hours=offset_hours))
+
+    return utc_datetime.astimezone(local_timezone)
+
+
 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):