pypetkitapi 1.6.3__tar.gz → 1.7.1__tar.gz

{pypetkitapi-1.6.3 → pypetkitapi-1.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pypetkitapi
-Version: 1.6.3
+Version: 1.7.1
 Summary: Python client for PetKit API
 Home-page: https://github.com/Jezza34000/pypetkit
 License: MIT
@@ -12,8 +12,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: aiohttp (>=3.11.0,<4.0.0)
-Requires-Dist: pycryptodome (>=3.21.0,<4.0.0)
+Requires-Dist: aiohttp (>=3.11.11,<4.0.0)
+Requires-Dist: pycryptodome (>=3.19.1,<4.0.0)
+Requires-Dist: pydantic (>=1.10.19,<2.0.0)
 Description-Content-Type: text/markdown
 
 # Petkit API Client
@@ -82,11 +83,13 @@ async def main():
 
         await client.get_devices_data()
 
-        # Read the account data
-        print(client.account_data)
+        # Lists all devices and pet from account
 
-        # Read the devices data
-        print(client.petkit_entities)
+        for key, value in client.petkit_entities.items():
+            print(f"{key}: {type(value).__name__} - {value.name}")
+
+        # Read devices or pet information
+        print(client.petkit_entities[123456789])
 
         # Send command to the devices
         ### Example 1 : Turn on the indicator light

{pypetkitapi-1.6.3 → pypetkitapi-1.7.1}/README.md

@@ -64,11 +64,13 @@ async def main():
 
         await client.get_devices_data()
 
-        # Read the account data
-        print(client.account_data)
+        # Lists all devices and pet from account
 
-        # Read the devices data
-        print(client.petkit_entities)
+        for key, value in client.petkit_entities.items():
+            print(f"{key}: {type(value).__name__} - {value.name}")
+
+        # Read devices or pet information
+        print(client.petkit_entities[123456789])
 
         # Send command to the devices
         ### Example 1 : Turn on the indicator light

{pypetkitapi-1.6.3 → pypetkitapi-1.7.1}/pypetkitapi/client.py

@@ -21,7 +21,6 @@ from pypetkitapi.const import (
     ERR_KEY,
     LOGIN_DATA,
     RES_KEY,
-    SUCCESS_KEY,
     T4,
     T6,
     Header,
@@ -38,7 +37,7 @@ from pypetkitapi.exceptions import (
     PypetkitError,
 )
 from pypetkitapi.feeder_container import Feeder, FeederRecord
-from pypetkitapi.litter_container import Litter, LitterRecord, LitterStats, PetOuGraph
+from pypetkitapi.litter_container import Litter, LitterRecord, LitterStats, PetOutGraph
 from pypetkitapi.water_fountain_container import WaterFountain, WaterFountainRecord
 
 _LOGGER = logging.getLogger(__name__)
@@ -200,6 +199,7 @@ class PetKitClient:
         main_tasks = []
         record_tasks = []
         device_list: list[Device] = []
+        stats_tasks = []
 
         for account in self.account_data:
             _LOGGER.debug("List devices data for account: %s", account)
@@ -221,7 +221,7 @@ class PetKitClient:
                 if device_type == T4:
                     record_tasks.append(self._fetch_device_data(device, LitterStats))
                 if device_type == T6:
-                    record_tasks.append(self._fetch_device_data(device, PetOuGraph))
+                    record_tasks.append(self._fetch_device_data(device, PetOutGraph))
 
             elif device_type in DEVICES_WATER_FOUNTAIN:
                 main_tasks.append(self._fetch_device_data(device, WaterFountain))
@@ -235,6 +235,16 @@ class PetKitClient:
         # Then execute record tasks
         await asyncio.gather(*record_tasks)
 
+        # Add populate_pet_stats tasks
+        stats_tasks = [
+            self.populate_pet_stats(self.petkit_entities[device.device_id])
+            for device in device_list
+            if device.device_type.lower() in DEVICES_LITTER_BOX
+        ]
+
+        # Execute stats tasks
+        await asyncio.gather(*stats_tasks)
+
         end_time = datetime.now()
         total_time = end_time - start_time
         _LOGGER.debug("Petkit data fetched successfully in: %s", total_time)
@@ -311,6 +321,69 @@ class PetKitClient:
         else:
             _LOGGER.error("Unknown data type: %s", data_class.data_type)
 
+    async def get_pets_list(self) -> list[Pet]:
+        """Extract and return the list of pets."""
+        return [
+            entity
+            for entity in self.petkit_entities.values()
+            if isinstance(entity, Pet)
+        ]
+
+    @staticmethod
+    def get_safe_value(value: int | None, default: int = 0) -> int:
+        """Return the value if not None, otherwise return the default."""
+        return value if value is not None else default
+
+    @staticmethod
+    def calculate_duration(start: int | None, end: int | None) -> int:
+        """Calculate the duration, ensuring both start and end are not None."""
+        if start is None or end is None:
+            return 0
+        return end - start
+
+    async def populate_pet_stats(self, stats_data: Litter | None) -> None:
+        """Collect data from litter data to populate pet stats."""
+        if stats_data is None:
+            return
+
+        pets_list = await self.get_pets_list()
+        for pet in pets_list:
+            if stats_data.device_records:
+                await self._process_t4(pet, stats_data.device_records)
+            elif stats_data.device_pet_graph_out:
+                await self._process_t6(pet, stats_data.device_pet_graph_out)
+
+    async def _process_t4(self, pet, device_records):
+        """Process T4 device records."""
+        for stat in device_records:
+            if stat.pet_id == pet.pet_id and (
+                pet.last_litter_usage is None
+                or self.get_safe_value(stat.timestamp) > pet.last_litter_usage
+            ):
+                pet.last_litter_usage = stat.timestamp
+                pet.last_measured_weight = self.get_safe_value(
+                    stat.content.pet_weight if stat.content else None
+                )
+                pet.last_duration_usage = self.calculate_duration(
+                    stat.content.time_in if stat.content else None,
+                    stat.content.time_out if stat.content else None,
+                )
+                pet.last_device_used = "Pura Max"
+
+    async def _process_t6(self, pet, pet_graphs):
+        """Process T6 pet graphs."""
+        for graph in pet_graphs:
+            if graph.pet_id == pet.pet_id and (
+                pet.last_litter_usage is None
+                or self.get_safe_value(graph.time) > pet.last_litter_usage
+            ):
+                pet.last_litter_usage = graph.time
+                pet.last_measured_weight = self.get_safe_value(
+                    graph.content.pet_weight if graph.content else None
+                )
+                pet.last_duration_usage = self.get_safe_value(graph.toilet_time)
+                pet.last_device_used = "Purobot Ultra"
+
     async def send_api_request(
         self,
         device_id: int,
@@ -371,12 +444,8 @@ class PetKitClient:
             data=params,
             headers=await self.get_session_id(),
         )
-
-        if res in [RES_KEY, SUCCESS_KEY]:
-            _LOGGER.debug("Command executed successfully")
-            return True
-        _LOGGER.error("Command execution failed")
-        return False
+        _LOGGER.debug("Command execution success, API response : %s", res)
+        return True
 
     async def close(self) -> None:
         """Close the aiohttp session if it was created by the client."""

{pypetkitapi-1.6.3 → pypetkitapi-1.7.1}/pypetkitapi/containers.py

@@ -68,13 +68,19 @@ class Pet(BaseModel):
     avatar: str | None = None
     created_at: int = Field(alias="createdAt")
     pet_id: int = Field(alias="petId")
+    pet_name: str | None = Field(None, alias="petName")
     id: int | None = None  # Fictive field (for HA compatibility) copied from id
     sn: int | None = None  # Fictive field (for HA compatibility) copied from id
-    pet_name: str | None = Field(None, alias="petName")
     name: str | None = None  # Fictive field (for HA compatibility) copied from pet_name
     device_type: str = "pet"  # Fictive field (for HA compatibility) fixed
     firmware: str | None = None  # Fictive field (for HA compatibility) fixed
 
+    # Got from Litter stats
+    last_litter_usage: int = 0
+    last_device_used: str | None = None
+    last_duration_usage: int = 0
+    last_measured_weight: int = 0
+
     @root_validator(pre=True)
     def populate_fictive_fields(cls, values):  # noqa: N805
         """Populate fictive fields based on other fields."""

{pypetkitapi-1.6.3 → pypetkitapi-1.7.1}/pypetkitapi/litter_container.py

@@ -220,7 +220,7 @@ class LitterRecord(BaseModel):
     mark: int | None = None
     media: int | None = None
     media_api: str | None = Field(None, alias="mediaApi")
-    pet_id: str | None = Field(None, alias="petId")
+    pet_id: int | None = Field(None, alias="petId")
     pet_name: str | None = Field(None, alias="petName")
     preview: str | None = None
     related_event: str | None = Field(None, alias="relatedEvent")
@@ -268,12 +268,12 @@ class StatisticInfo(BaseModel):
     Subclass of LitterStats.
     """
 
-    pet_id: str | None = Field(None, alias="petId")
+    pet_id: int | None = Field(None, alias="petId")
     pet_name: str | None = Field(None, alias="petName")
     pet_times: int | None = Field(None, alias="petTimes")
     pet_total_time: int | None = Field(None, alias="petTotalTime")
     pet_weight: int | None = Field(None, alias="petWeight")
-    statistic_date: str | None = Field(None, alias="statisticDate")
+    statistic_date: int | None = Field(None, alias="statisticDate")
     x_time: int | None = Field(None, alias="xTime")
 
 
@@ -334,8 +334,10 @@ class PetGraphContent(BaseModel):
     time_out: int | None = Field(None, alias="timeOut")
 
 
-class PetOuGraph(BaseModel):
-    """Dataclass for event data."""
+class PetOutGraph(BaseModel):
+    """Dataclass for event data.
+    Main Dataclass
+    """
 
     data_type: ClassVar[str] = DEVICE_STATS
 
@@ -346,7 +348,7 @@ class PetOuGraph(BaseModel):
     expire: int | None = None
     is_need_upload_video: int | None = Field(None, alias="isNeedUploadVideo")
     media_api: str | None = Field(None, alias="mediaApi")
-    pet_id: str | None = Field(None, alias="petId")
+    pet_id: int | None = Field(None, alias="petId")
     pet_name: str | None = Field(None, alias="petName")
     preview: str | None = None
     storage_space: int | None = Field(None, alias="storageSpace")
@@ -418,7 +420,7 @@ class Litter(BaseModel):
     device_type: str | None = Field(None, alias="deviceType")
     device_records: list[LitterRecord] | None = None
     device_stats: LitterStats | None = None
-    device_pet_graph_out: list[PetOuGraph] | None = None
+    device_pet_graph_out: list[PetOutGraph] | None = None
 
     @classmethod
     def get_endpoint(cls, device_type: str) -> str:

{pypetkitapi-1.6.3 → pypetkitapi-1.7.1}/pypetkitapi/medias.py

@@ -71,10 +71,13 @@ class MediaHandler:
         """Process individual records and return media info."""
         media_files = []
 
-        async def process_item(record_items, reversed_order=False):
-            items = reversed(record_items) if reversed_order else record_items
+        async def process_item(record_items):
             last_item = next(
-                (item for item in items if item.preview and item.aes_key),
+                (
+                    item
+                    for item in reversed(record_items)
+                    if item.preview and item.aes_key
+                ),
                 None,
             )
             if last_item:
@@ -82,14 +85,12 @@ class MediaHandler:
                 await self.media_download_decode.get_file(
                     last_item.preview, last_item.aes_key
                 )
-
                 timestamp = (
                     last_item.eat_start_time
                     or last_item.completed_at
                     or last_item.timestamp
                     or None
                 )
-
                 media_files.append(
                     MediasFiles(
                         record_type=record_type,
@@ -100,16 +101,9 @@ class MediaHandler:
                     )
                 )
 
-        if record_type == "feed":
-            for record in reversed(records):
-                if record.items:
-                    await process_item(record.items, reversed_order=True)
-                    if media_files:  # Stop processing if a media file is added
-                        return media_files
-        else:
-            for record in records:
-                if record.items:
-                    await process_item(record.items)
+        for record in records:
+            if record.items:
+                await process_item(record.items)
 
         return media_files
 
@@ -162,11 +156,22 @@ class MediaDownloadDecode:
         """Save content to a file asynchronously and return the file path."""
         file_path = Path(self.download_path) / filename
         try:
+            # Ensure the directory exists
+            file_path.parent.mkdir(parents=True, exist_ok=True)
+
             async with aio_open(file_path, "wb") as file:
                 await file.write(content)
-            _LOGGER.debug("Saved file: %s", file_path)
+            _LOGGER.debug("Save file OK : %s", file_path)
+        except PermissionError as e:
+            _LOGGER.error("Save file, permission denied %s: %s", file_path, e)
+        except FileNotFoundError as e:
+            _LOGGER.error("Save file, file/folder not found %s: %s", file_path, e)
         except OSError as e:
-            _LOGGER.error("Error saving file %s: %s", file_path, e)
+            _LOGGER.error("Save file, error saving file %s: %s", file_path, e)
+        except Exception as e:  # noqa: BLE001
+            _LOGGER.error(
+                "Save file, unexpected error saving file %s: %s", file_path, e
+            )
         return file_path
 
     async def _decrypt_image_from_file(

{pypetkitapi-1.6.3 → pypetkitapi-1.7.1}/pyproject.toml

@@ -187,7 +187,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pypetkitapi"
-version = "1.6.3"
+version = "1.7.1"
 description = "Python client for PetKit API"
 authors = ["Jezza34000 <info@mail.com>"]
 readme = "README.md"
@@ -196,8 +196,9 @@ license = "MIT"
 
 [tool.poetry.dependencies]
 python = ">=3.11"
-aiohttp = "^3.11.0"
-pycryptodome = "^3.21.0"
+aiohttp = "^3.11.11"
+pycryptodome = "^3.19.1"
+pydantic = "^1.10.19"
 
 [tool.poetry.dev-dependencies]
 pre-commit = "^4.0.1"
@@ -206,7 +207,7 @@ ruff = "^0.8.1"
 types-aiofiles = "^24.1.0.20240626"
 
 [tool.bumpver]
-current_version = "1.6.3"
+current_version = "1.7.1"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"