pypetkitapi 0.3.0__tar.gz → 0.5.0__tar.gz

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pypetkitapi
-Version: 0.3.0
+Version: 0.5.0
 Summary: Python client for PetKit API
 Home-page: https://github.com/Jezza34000/pypetkit
 License: MIT

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/pypetkitapi/client.py

@@ -46,6 +46,7 @@ class PetKitClient:
     _session: SessionInfo | None = None
     _servers_list: list[RegionInfo] = []
     account_data: list[AccountData] = []
+    # TODO : Adding pet as entity ?
     device_list: dict[int, Feeder | Litter | WaterFountain] = {}
 
     def __init__(
@@ -101,6 +102,7 @@ class PetKitClient:
         await self._get_api_server_list()
         _LOGGER.debug("Finding region server for region: %s", self.region)
 
+        # TODO : Improve this
         if self.region == "china":
             self._base_url = PetkitURL.CHINA_SRV
             return
@@ -117,7 +119,7 @@ class PetKitClient:
 
         if regional_server:
             _LOGGER.debug(
-                "Found server %s for region : %s", regional_server, self.region
+                "Using server %s for region : %s", regional_server, self.region
             )
             self._base_url = regional_server.gateway
             return
@@ -278,7 +280,7 @@ class PetKitClient:
         self,
         device_id: int,
         action: StrEnum,
-        setting: dict | None = None,
+        setting: dict | StrEnum | None = None,
     ) -> None:
         """Control the device using the PetKit API."""
         device = self.device_list.get(device_id)
@@ -330,7 +332,8 @@ class PetKitClient:
             data=params,
             headers=headers,
         )
-        if res == SUCCESS_KEY:
+        if res in (SUCCESS_KEY, RES_KEY):
+            # TODO : Manage to get the response from manul feeding
             _LOGGER.info("Command executed successfully")
         else:
             _LOGGER.error("Command execution failed")

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/pypetkitapi/command.py

@@ -9,6 +9,7 @@ import json
 from pypetkitapi.const import (
     ALL_DEVICES,
     D3,
+    D4,
     D4H,
     D4S,
     D4SH,
@@ -44,6 +45,7 @@ class FeederCommand(StrEnum):
 class LitterCommand(StrEnum):
     """LitterCommand"""
 
+    POWER = "power"
     CONTROL_DEVICE = "control_device"
     RESET_DEODORIZER = "reset_deodorizer"
 
@@ -54,6 +56,12 @@ class PetCommand(StrEnum):
     UPDATE_SETTING = "update_setting"
 
 
+class FountainCommand(StrEnum):
+    """Fountain Command"""
+
+    CONTROL_DEVICE = "control_device"
+
+
 class LitterBoxCommand(StrEnum):
     """LitterBoxCommand"""
 
@@ -148,6 +156,43 @@ LB_CMD_TO_VALUE = {
 }
 
 
+class FountainAction(StrEnum):
+    """Fountain Action"""
+
+    PAUSE = "Pause"
+    NORMAL_TO_PAUSE = "Normal To Pause"
+    SMART_TO_PAUSE = "Smart To Pause"
+    NORMAL = "Normal"
+    SMART = "Smart"
+    RESET_FILTER = "Reset Filter"
+    DO_NOT_DISTURB = "Do Not Disturb"
+    DO_NOT_DISTURB_OFF = "Do Not Disturb Off"
+    FIRST_BLE_CMND = "First BLE Command"
+    SECOND_BLE_CMND = "Second BLE Command"
+    LIGHT_LOW = "Light Low"
+    LIGHT_MEDIUM = "Light Medium"
+    LIGHT_HIGH = "Light High"
+    LIGHT_ON = "Light On"
+    LIGHT_OFF = "Light Off"
+
+
+FOUNTAIN_COMMAND_TO_CODE = {
+    FountainAction.DO_NOT_DISTURB: "221",
+    FountainAction.DO_NOT_DISTURB_OFF: "221",
+    FountainAction.LIGHT_ON: "221",
+    FountainAction.LIGHT_OFF: "221",
+    FountainAction.LIGHT_LOW: "221",
+    FountainAction.LIGHT_MEDIUM: "221",
+    FountainAction.LIGHT_HIGH: "221",
+    FountainAction.PAUSE: "220",
+    FountainAction.RESET_FILTER: "222",
+    FountainAction.NORMAL: "220",
+    FountainAction.NORMAL_TO_PAUSE: "220",
+    FountainAction.SMART: "220",
+    FountainAction.SMART_TO_PAUSE: "220",
+}
+
+
 @dataclass
 class CmdData:
     """Command Info"""
@@ -160,10 +205,10 @@ class CmdData:
 def get_endpoint_manual_feed(device):
     """Get the endpoint for the device"""
     if device.device_type == FEEDER_MINI:
-        return PetkitEndpoint.MINI_MANUAL_FEED
+        return PetkitEndpoint.MANUAL_FEED_MINI
     if device.device_type == FEEDER:
-        return PetkitEndpoint.FRESH_ELEMENT_MANUAL_FEED
-    return PetkitEndpoint.MANUAL_FEED
+        return PetkitEndpoint.MANUAL_FEED_FRESH_ELEMENT
+    return PetkitEndpoint.MANUAL_FEED_DUAL
 
 
 def get_endpoint_reset_desiccant(device):
@@ -192,10 +237,10 @@ ACTIONS_MAP = {
             "time": "-1",
             **setting,
         },
-        supported_device=DEVICES_FEEDER,  # TODO: Check if this is correct
+        supported_device=[FEEDER, FEEDER_MINI, D3, D4, D4H],
     ),
     FeederCommand.MANUAL_FEED_DUAL: CmdData(
-        endpoint=PetkitEndpoint.UPDATE_SETTING,
+        endpoint=PetkitEndpoint.MANUAL_FEED_DUAL,
         params=lambda device, setting: {
             "day": datetime.datetime.now().strftime("%Y%m%d"),
             "deviceId": device.id,
@@ -203,7 +248,7 @@ ACTIONS_MAP = {
             "time": "-1",
             **setting,
         },
-        supported_device=ALL_DEVICES,
+        supported_device=[D4S, D4SH],
     ),
     FeederCommand.CANCEL_MANUAL_FEED: CmdData(
         endpoint=lambda device: (
@@ -259,7 +304,15 @@ ACTIONS_MAP = {
         },
         supported_device=[D3],
     ),
-    # TODO : Find how to support power ON/OFF
+    LitterCommand.POWER: CmdData(
+        endpoint=PetkitEndpoint.CONTROL_DEVICE,
+        params=lambda device, setting: {
+            "id": device.id,
+            "kv": json.dumps(setting),
+            "type": "power",
+        },
+        supported_device=[T3, T4, T5, T6],
+    ),
     LitterCommand.CONTROL_DEVICE: CmdData(
         endpoint=PetkitEndpoint.CONTROL_DEVICE,
         params=lambda device, command: {
@@ -269,22 +322,21 @@ ACTIONS_MAP = {
         },
         supported_device=[T3, T4, T5, T6],
     ),
-    # TODO : Find how to support Pet Setting with send_api_request
-    # PetCommand.UPDATE_SETTING: CmdData(
-    #     endpoint=PetkitEndpoint.CONTROL_DEVICE,
-    #     params=lambda pet, setting: {
-    #         "petId": pet,
-    #         "kv": json.dumps(setting),
-    #     },
-    #     supported_device=ALL_DEVICES,
-    # ),
+    PetCommand.UPDATE_SETTING: CmdData(
+        endpoint=PetkitEndpoint.CONTROL_DEVICE,
+        params=lambda pet, setting: {
+            "petId": pet,
+            "kv": json.dumps(setting),
+        },
+        supported_device=ALL_DEVICES,
+    ),
     # FountainCommand.CONTROL_DEVICE: CmdData(
     #     endpoint=PetkitEndpoint.CONTROL_DEVICE,
     #     params=lambda device, setting: {
-    #         "bleId": water_fountain.data["id"],
+    #         "bleId": device.id,
     #         "cmd": cmnd_code,
     #         "data": ble_data,
-    #         "mac": water_fountain.data["mac"],
+    #         "mac": device.mac,
     #         "type": water_fountain.ble_relay,
     #     },
     #     supported_device=[CTW3],

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/pypetkitapi/const.py

@@ -95,9 +95,17 @@ class PetkitEndpoint(StrEnum):
     GET_DEVICE_RECORD_RELEASE = "getDeviceRecordRelease"
     UPDATE_SETTING = "updateSettings"
 
+    # Bluetooth relay
+    BLE_AS_RELAY = "ble/ownSupportBleDevices"
+    BLE_CONNECT = "ble/connect"
+    BLE_POLL = "ble/poll"
+    BLE_CANCEL = "ble/cancel"
+
+    # Fountain & Litter Box
+    CONTROL_DEVICE = "controlDevice"
+
     # Litter Box
     DEODORANT_RESET = "deodorantReset"
-    CONTROL_DEVICE = "controlDevice"
 
     # Feeders
     REPLENISHED_FOOD = "added"
@@ -108,6 +116,6 @@ class PetkitEndpoint(StrEnum):
     FRESH_ELEMENT_DESICCANT_RESET = "feeder/desiccant_reset"
     CALL_PET = "callPet"
     CANCEL_FEED = "cancelRealtimeFeed"
-    MINI_MANUAL_FEED = "feedermini/save_dailyfeed"
-    FRESH_ELEMENT_MANUAL_FEED = "feeder/save_dailyfeed"
-    MANUAL_FEED = "saveDailyFeed"
+    MANUAL_FEED_MINI = "feedermini/save_dailyfeed"
+    MANUAL_FEED_FRESH_ELEMENT = "feeder/save_dailyfeed"
+    MANUAL_FEED_DUAL = "saveDailyFeed"

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/pypetkitapi/containers.py

@@ -15,6 +15,21 @@ class RegionInfo(BaseModel):
     name: str
 
 
+class BleRelay(BaseModel):
+    """Dataclass for BLE relay devices
+    Fetched from the API endpoint :
+        - ble/ownSupportBleDevices
+    """
+
+    id: int
+    low_version: int = Field(alias="lowVersion")
+    mac: str
+    name: str
+    pim: int
+    sn: str
+    type_id: int = Field(alias="typeId")
+
+
 class SessionInfo(BaseModel):
     """Dataclass for session data.
     Fetched from the API endpoint :

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/pypetkitapi/exceptions.py

@@ -22,8 +22,8 @@ class PetkitRegionalServerNotFoundError(PypetkitError):
         """Initialize the exception."""
         self.region = region
         self.message = (
-            f"Region you provided: '{region}' was not found in the server list. "
-            f"Are you sure you provided the correct region?"
+            f"Region you provided: '{region}' was not found in the Petkit's server list. "
+            f"Are you sure you provided the correct region ?"
         )
         super().__init__(self.message)
 

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/pypetkitapi/feeder_container.py

@@ -154,6 +154,19 @@ class StateFeeder(BaseModel):
     conservation_status: int | None = Field(None, alias="conservationStatus")
 
 
+class ManualFeed(BaseModel):
+    """Dataclass for result data."""
+
+    amount1: int | None = None
+    amount2: int | None = None
+    id: str | None = None
+    is_executed: int | None = Field(None, alias="isExecuted")
+    is_need_upload_video: int | None = Field(None, alias="isNeedUploadVideo")
+    src: int | None = None
+    status: int | None = None
+    time: int | None = None
+
+
 class Feeder(BaseModel):
     """Dataclass for feeder data."""
 
@@ -184,7 +197,7 @@ class Feeder(BaseModel):
     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_id: int = 0
+    manual_feed: ManualFeed | None = None
 
     @classmethod
     def get_endpoint(cls, device_type: str) -> str:

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/pypetkitapi/litter_container.py

@@ -130,6 +130,15 @@ class StateLitter(BaseModel):
     wander_time: int | None = Field(None, alias="wanderTime")
 
 
+class WorkState(BaseModel):
+    """Dataclass for work state data."""
+
+    stop_time: int = Field(alias="stopTime")
+    work_mode: int = Field(alias="workMode")
+    work_process: int = Field(alias="workProcess")
+    work_reason: int = Field(alias="workReason")
+
+
 class Litter(BaseModel):
     """Dataclass for Litter Data.
     Supported devices = T4, T6
@@ -171,6 +180,7 @@ class Litter(BaseModel):
     service_status: int | None = Field(None, alias="serviceStatus")
     total_time: int | None = Field(None, alias="totalTime")
     device_type: str | None = Field(None, alias="deviceType")
+    work_state: WorkState | None = Field(None, alias="workState")
 
     @classmethod
     def get_endpoint(cls, device_type: str) -> str:

{pypetkitapi-0.3.0 → pypetkitapi-0.5.0}/pyproject.toml

@@ -187,7 +187,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pypetkitapi"
-version = "0.3.0"
+version = "0.5.0"
 description = "Python client for PetKit API"
 authors = ["Jezza34000 <info@mail.com>"]
 readme = "README.md"
@@ -204,7 +204,7 @@ black = "^24.10.0"
 ruff = "^0.8.1"
 
 [tool.bumpver]
-current_version = "0.3.0"
+current_version = "0.5.0"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"