pypetkitapi 1.7.9__tar.gz → 1.7.10__tar.gz

{pypetkitapi-1.7.9 → pypetkitapi-1.7.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pypetkitapi
-Version: 1.7.9
+Version: 1.7.10
 Summary: Python client for PetKit API
 Home-page: https://github.com/Jezza34000/pypetkit
 License: MIT
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: aiofiles (>=24.1.0,<25.0.0)
 Requires-Dist: aiohttp (>=3.10.10,<4.0.0)
 Requires-Dist: pycryptodome (>=3.19.1,<4.0.0)
-Requires-Dist: pydantic (>=1.10.18,<2.0.0)
+Requires-Dist: pydantic (>=1.10.18,<3.0.0)
 Description-Content-Type: text/markdown
 
 # Petkit API Client

pypetkitapi-1.7.10/pypetkitapi/__init__.py

@@ -0,0 +1,56 @@
+"""Pypetkit: A Python library for interfacing with PetKit"""
+
+from .client import PetKitClient
+from .command import FeederCommand, LBAction, LBCommand, LitterCommand, PetCommand
+from .const import (
+    CTW3,
+    D3,
+    D4,
+    D4H,
+    D4S,
+    DEVICES_FEEDER,
+    DEVICES_LITTER_BOX,
+    DEVICES_WATER_FOUNTAIN,
+    FEEDER,
+    FEEDER_MINI,
+    K2,
+    K3,
+    T3,
+    T4,
+    T5,
+    T6,
+    W5,
+    RecordType,
+)
+from .medias import MediaHandler, MediasFiles
+
+__version__ = "1.7.10"
+
+__all__ = [
+    "MediasFiles",
+    "MediaHandler",
+    "D3",
+    "D4",
+    "D4H",
+    "D4S",
+    "FEEDER",
+    "FEEDER_MINI",
+    "T3",
+    "T4",
+    "T5",
+    "T6",
+    "W5",
+    "CTW3",
+    "K2",
+    "K3",
+    "DEVICES_FEEDER",
+    "DEVICES_LITTER_BOX",
+    "DEVICES_WATER_FOUNTAIN",
+    "RecordType",
+    "PetKitClient",
+    "FeederCommand",
+    "LitterCommand",
+    "PetCommand",
+    "LBCommand",
+    "LBAction",
+]

{pypetkitapi-1.7.9 → pypetkitapi-1.7.10}/pypetkitapi/const.py

@@ -29,6 +29,7 @@ T6 = "t6"
 W5 = "w5"
 CTW3 = "ctw3"
 K2 = "k2"
+K3 = "k3"
 
 DEVICES_LITTER_BOX = [T3, T4, T5, T6]
 DEVICES_FEEDER = [FEEDER, FEEDER_MINI, D3, D4, D4S, D4H, D4SH]
@@ -86,6 +87,18 @@ LOGIN_DATA = {
 }
 
 
+class RecordType(StrEnum):
+    """Record Type constants"""
+
+    EAT = "eat"
+    FEED = "feed"
+    MOVE = "move"
+    PET = "pet"
+
+
+RecordTypeLST = [RecordType.EAT, RecordType.FEED, RecordType.MOVE, RecordType.PET]
+
+
 class PetkitEndpoint(StrEnum):
     """Petkit Endpoint constants"""
 
@@ -119,6 +132,11 @@ class PetkitEndpoint(StrEnum):
     STATISTIC_RELEASE = "statisticRelease"
     GET_PET_OUT_GRAPH = "getPetOutGraph"
 
+    # Video features
+    CLOUD_VIDEO = "cloud/video"
+    GET_DOWNLOAD_M3U8 = "getDownloadM3u8"
+    GET_M3U8 = "getM3u8"
+
     # Feeders
     REPLENISHED_FOOD = "added"
     FRESH_ELEMENT_CALIBRATION = "food_reset"

{pypetkitapi-1.7.9 → pypetkitapi-1.7.10}/pypetkitapi/containers.py

@@ -1,6 +1,6 @@
 """Dataclasses container for petkit API."""
 
-from pydantic import BaseModel, Field, root_validator
+from pydantic import BaseModel, Field
 
 
 class RegionInfo(BaseModel):
@@ -69,25 +69,28 @@ class Pet(BaseModel):
     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: str  # Fictive field (for HA compatibility) copied from id
-    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
+    id: int | None = None  # Fictive field copied from id (for HA compatibility)
+    sn: str | None = None  # Fictive field copied from id (for HA compatibility)
+    name: str | None = None  # Fictive field copied from pet_name (for HA compatibility)
+    device_type: str = "pet"  # Fictive fixed field (for HA compatibility)
+    firmware: str | None = None  # Fictive fixed field (for HA compatibility)
 
-    # Got from Litter stats
+    # 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."""
-        values["id"] = values.get("id") or values.get("petId")
-        values["sn"] = values.get("sn") or values.get("id")
-        values["name"] = values.get("name") or values.get("petName")
-        return values
+    def __init__(self, **data):
+        """Initialize the Pet dataclass.
+        This method is used to fill the fictive fields after the standard initialization.
+        """
+        # Appeler l'initialisation standard de Pydantic
+        super().__init__(**data)
+        # Remplir les champs fictifs après l'initialisation
+        self.id = self.id or self.pet_id
+        self.sn = self.sn or str(self.id)
+        self.name = self.name or self.pet_name
 
 
 class User(BaseModel):

{pypetkitapi-1.7.9 → pypetkitapi-1.7.10}/pypetkitapi/feeder_container.py

@@ -12,12 +12,12 @@ from pypetkitapi.containers import CloudProduct, Device, FirmwareDetail, Wifi
 class FeedItem(BaseModel):
     """Dataclass for feed item data."""
 
-    id: str | None = None
-    name: str | None = None
-    time: int | None = None
     amount: int | None = None
     amount1: int | None = Field(None, alias="amount1")
     amount2: int | None = Field(None, alias="amount2")
+    id: str | None = None
+    name: str | None = None
+    time: int | None = None
 
 
 class FeedDailyList(BaseModel):
@@ -50,9 +50,14 @@ class SettingsFeeder(BaseModel):
     attire_id: int | None = Field(None, alias="attireId")
     attire_switch: int | None = Field(None, alias="attireSwitch")
     auto_product: int | None = Field(None, alias="autoProduct")
+    bucket_name1: str | None = Field(None, alias="bucketName1")
+    bucket_name2: str | None = Field(None, alias="bucketName2")
     camera: int | None = None
     camera_config: int | None = Field(None, alias="cameraConfig")
+    camera_multi_new: list[CameraMultiNew] | None = Field(None, alias="cameraMultiNew")
     camera_multi_range: list | None = Field(None, alias="cameraMultiRange")
+    color_setting: int | None = None
+    conservation: int | None = None
     control_settings: int | None = Field(None, alias="controlSettings")
     desiccant_notify: int | None = Field(None, alias="desiccantNotify")
     detect_config: int | None = Field(None, alias="detectConfig")
@@ -62,8 +67,10 @@ class SettingsFeeder(BaseModel):
     eat_notify: int | None = Field(None, alias="eatNotify")
     eat_sensitivity: int | None = Field(None, alias="eatSensitivity")
     eat_video: int | None = Field(None, alias="eatVideo")
+    factor: int | None = None
     feed_notify: int | None = Field(None, alias="feedNotify")
     feed_picture: int | None = Field(None, alias="feedPicture")
+    feed_sound: int | None = Field(None, alias="feedSound")
     food_notify: int | None = Field(None, alias="foodNotify")
     food_warn: int | None = Field(None, alias="foodWarn")
     food_warn_range: list[int] | None = Field(None, alias="foodWarnRange")
@@ -87,6 +94,7 @@ class SettingsFeeder(BaseModel):
     pet_sensitivity: int | None = Field(None, alias="petSensitivity")
     pre_live: int | None = Field(None, alias="preLive")
     selected_sound: int | None = Field(None, alias="selectedSound")
+    shortest: int | None = None  # D4S
     smart_frame: int | None = Field(None, alias="smartFrame")
     sound_enable: int | None = Field(None, alias="soundEnable")
     surplus: int | None = None  # D3
@@ -99,35 +107,29 @@ class SettingsFeeder(BaseModel):
     tone_multi_range: list[tuple[int, int]] | None = Field(None, alias="toneMultiRange")
     upload: int | None = None
     volume: int | None = None
-    feed_sound: int | None = Field(None, alias="feedSound")
-    factor: int | None = None
-    color_setting: int | None = Field(None, alias="colorSetting")
-    conservation: int | None = None
-    bucket_name1: str | None = Field(None, alias="bucketName1")
-    bucket_name2: str | None = Field(None, alias="bucketName2")
-    camera_multi_new: list[CameraMultiNew] | None = Field(None, alias="cameraMultiNew")
 
 
 class FeedState(BaseModel):
     """Dataclass for feed state data."""
 
+    add_amount_total: int | None = Field(None, alias="addAmountTotal")
+    add_amount_total1: int | None = Field(None, alias="addAmountTotal1")
+    add_amount_total2: int | None = Field(None, alias="addAmountTotal2")
+    eat_amount_total: int | None = Field(None, alias="eatAmountTotal")  # D3
     eat_avg: int | None = Field(None, alias="eatAvg")
     eat_count: int | None = Field(None, alias="eatCount")
     eat_times: list[int] | None = Field(None, alias="eatTimes")
     feed_times: dict | list | None = Field(None, alias="feedTimes")
-    times: int | None = None
-    add_amount_total: int | None = Field(None, alias="addAmountTotal")
     plan_amount_total: int | None = Field(None, alias="planAmountTotal")
-    plan_real_amount_total: int | None = Field(None, alias="planRealAmountTotal")
-    real_amount_total: int | None = Field(None, alias="realAmountTotal")
-    add_amount_total1: int | None = Field(None, alias="addAmountTotal1")
-    add_amount_total2: int | None = Field(None, alias="addAmountTotal2")
     plan_amount_total1: int | None = Field(None, alias="planAmountTotal1")
     plan_amount_total2: int | None = Field(None, alias="planAmountTotal2")
+    plan_real_amount_total: int | None = Field(None, alias="planRealAmountTotal")
     plan_real_amount_total1: int | None = Field(None, alias="planRealAmountTotal1")
     plan_real_amount_total2: int | None = Field(None, alias="planRealAmountTotal2")
+    real_amount_total: int | None = Field(None, alias="realAmountTotal")
     real_amount_total1: int | None = Field(None, alias="realAmountTotal1")
     real_amount_total2: int | None = Field(None, alias="realAmountTotal2")
+    times: int | None = None
 
 
 class StateFeeder(BaseModel):
@@ -135,31 +137,31 @@ class StateFeeder(BaseModel):
 
     battery_power: int | None = Field(None, alias="batteryPower")
     battery_status: int | None = Field(None, alias="batteryStatus")
-    bowl: int | None = None
     block: int | None = None
+    bowl: int | None = None
     broadcast: dict | None = None
     camera_status: int | None = Field(None, alias="cameraStatus")
     charge: int | None = None
+    conservation_status: int | None = Field(None, alias="conservationStatus")
     desiccant_left_days: int | None = Field(None, alias="desiccantLeftDays")
     desiccant_time: int | None = Field(None, alias="desiccantTime")
     door: int | None = None
-    feed_state: FeedState | None = Field(None, alias="feedState")
-    feeding: int | None = None
+    eating: int | None = None
     error_code: str | None = Field(None, alias="errorCode")
     error_detail: str | None = Field(None, alias="errorDetail")
     error_level: int | None = Field(None, alias="errorLevel")
     error_msg: str | None = Field(None, alias="errorMsg")
+    feed_state: FeedState | None = Field(None, alias="feedState")
+    feeding: int | None = None
+    food: int | None = None
+    food1: int | None = Field(None, alias="food1")
+    food2: int | None = Field(None, alias="food2")
     ota: int | None = None
     overall: int | None = None
     pim: int | None = None
     runtime: int | None = None
     weight: int | None = None
     wifi: Wifi | None = None
-    eating: int | None = None
-    food: int | None = None
-    food1: int | None = Field(None, alias="food1")
-    food2: int | None = Field(None, alias="food2")
-    conservation_status: int | None = Field(None, alias="conservationStatus")
 
 
 class ManualFeed(BaseModel):
@@ -302,15 +304,20 @@ class Feeder(BaseModel):
     bt_mac: str | None = Field(None, alias="btMac")
     cloud_product: CloudProduct | None = Field(None, alias="cloudProduct")
     created_at: str | None = Field(None, alias="createdAt")
+    device_records: FeederRecord | None = None
+    device_type: str | None = Field(None, alias="deviceType")
     firmware: float
     firmware_details: list[FirmwareDetail] | None = Field(None, alias="firmwareDetails")
     hardware: int
     id: int
     locale: str | None = None
     mac: str | None = None
+    manual_feed: ManualFeed | None = None
     model_code: int | None = Field(None, alias="modelCode")
+    multi_config: bool | None = Field(None, alias="multiConfig")
     multi_feed_item: MultiFeedItem | None = Field(None, alias="multiFeedItem")
     name: str | None = None
+    p2p_type: int | None = Field(None, alias="p2pType")
     secret: str | None = None
     service_status: int | None = Field(None, alias="serviceStatus")
     settings: SettingsFeeder | None = None
@@ -319,11 +326,6 @@ class Feeder(BaseModel):
     sn: str
     state: StateFeeder | None = None
     timezone: float | None = None
-    p2p_type: int | None = Field(None, alias="p2pType")
-    multi_config: bool | None = Field(None, alias="multiConfig")
-    device_type: str | None = Field(None, alias="deviceType")
-    manual_feed: ManualFeed | None = None
-    device_records: FeederRecord | None = None
 
     @classmethod
     def get_endpoint(cls, device_type: str) -> str:

{pypetkitapi-1.7.9 → pypetkitapi-1.7.10}/pypetkitapi/litter_container.py

@@ -10,6 +10,7 @@ from pypetkitapi.const import (
     DEVICE_RECORDS,
     DEVICE_STATS,
     T4,
+    T5,
     T6,
     PetkitEndpoint,
 )
@@ -77,7 +78,6 @@ class SettingsLitter(BaseModel):
     pet_detection: int | None = Field(None, alias="petDetection")
     pet_notify: int | None = Field(None, alias="petNotify")
     pre_live: int | None = Field(None, alias="preLive")
-    shortest: int | None = None
     system_sound_enable: int | None = Field(None, alias="systemSoundEnable")
     time_display: int | None = Field(None, alias="timeDisplay")
     toilet_detection: int | None = Field(None, alias="toiletDetection")
@@ -242,7 +242,7 @@ class LitterRecord(BaseModel):
         """Get the endpoint URL for the given device type."""
         if device_type == T4:
             return PetkitEndpoint.GET_DEVICE_RECORD
-        if device_type == T6:
+        if device_type in [T5, T6]:
             return PetkitEndpoint.GET_DEVICE_RECORD_RELEASE
         raise ValueError(f"Invalid device type: {device_type}")
 
@@ -259,7 +259,7 @@ class LitterRecord(BaseModel):
             if request_date is None:
                 request_date = datetime.now().strftime("%Y%m%d")
             return {"date": int(request_date), "deviceId": device.device_id}
-        if device_type == T6:
+        if device_type in [T5, T6]:
             return {
                 "timestamp": int(datetime.now().timestamp()),
                 "deviceId": device.device_id,

{pypetkitapi-1.7.9 → pypetkitapi-1.7.10}/pyproject.toml

@@ -187,7 +187,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pypetkitapi"
-version = "1.7.9"
+version = "1.7.10"
 description = "Python client for PetKit API"
 authors = ["Jezza34000 <info@mail.com>"]
 readme = "README.md"
@@ -199,7 +199,7 @@ python = ">=3.11"
 aiohttp = "^3.10.10"
 aiofiles = "^24.1.0"
 pycryptodome = "^3.19.1"
-pydantic = "^1.10.18"
+pydantic = ">=1.10.18,<3.0.0"
 
 [tool.poetry.dev-dependencies]
 pre-commit = "^4.0.1"
@@ -208,7 +208,7 @@ ruff = "^0.8.1"
 types-aiofiles = "^24.1.0.20240626"
 
 [tool.bumpver]
-current_version = "1.7.9"
+current_version = "1.7.10"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"
@@ -224,6 +224,9 @@ push = true
     '^version = "{version}"',
     '^current_version = "{version}"',
 ]
+"pypetkitapi/__init__.py" = [
+    '^__version__ = "{version}"',
+]
 
 [tool.tox]
 envlist = ["pre-commit"]

pypetkitapi-1.7.9/pypetkitapi/__init__.py

@@ -1 +0,0 @@
-"""Pypetkit: A Python library for interfacing with PetKit"""