pypetkitapi 1.15.0__tar.gz → 1.16.0__tar.gz

{pypetkitapi-1.15.0 → pypetkitapi-1.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pypetkitapi
-Version: 1.15.0
+Version: 1.16.0
 Summary: Python client for PetKit API
 License: MIT
 Author: Jezza34000
@@ -52,6 +52,12 @@ Description-Content-Type: text/markdown
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [black]: https://github.com/psf/black
 
+### Enjoying this library?
+
+[![Sponsor Jezza34000][github-sponsor-shield]][github-sponsor] [![Static Badge][buymeacoffee-shield]][buymeacoffee]
+
+---
+
 ## Overview
 
 PetKit Client is a Python library for interacting with the PetKit API. It allows you to manage your PetKit devices, retrieve account data, and control devices through the API.
@@ -62,6 +68,7 @@ PetKit Client is a Python library for interacting with the PetKit API. It allows
 - Fetch account and device data
 - Control PetKit devices (Feeder, Litter Box, Water Fountain, Purifiers)
 - Fetch images & videos produced by devices
+  > Pictures are available **with or without** Care+ subscription, Videos are only available **with** Care+ subscription
 
 ## Installation
 
@@ -136,7 +143,9 @@ Check at the usage in the Home Assistant integration : [here](https://github.com
 
 ## Help and Support
 
-A discord server is available for support and help, check here: [here](https://github.com/Jezza34000/homeassistant_petkit)
+Developers? Want to help? Join us on our Discord channel dedicated to developers and contributors.
+
+[![Discord][discord-shield]][discord]
 
 ## Contributing
 
@@ -147,3 +156,21 @@ Please open an issue or submit a pull request.
 
 This project is licensed under the MIT License. See the LICENSE file for details.
 
+---
+
+[homeassistant_petkit]: https://github.com/Jezza34000/py-petkit-api
+[commits-shield]: https://img.shields.io/github/commit-activity/y/Jezza34000/py-petkit-api.svg?style=flat
+[commits]: https://github.com/Jezza34000/py-petkit-api/commits/main
+[discord]: https://discord.gg/Va8DrmtweP
+[discord-shield]: https://img.shields.io/discord/1318098700379361362.svg?style=for-the-badge&label=Discord&logo=discord&color=5865F2
+[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge&label=Home%20Assistant%20Community&logo=homeassistant&color=18bcf2
+[forum]: https://community.home-assistant.io/t/petkit-integration/834431
+[license-shield]: https://img.shields.io/github/license/Jezza34000/py-petkit-api.svg??style=flat
+[maintenance-shield]: https://img.shields.io/badge/maintainer-Jezza34000-blue.svg?style=flat
+[releases-shield]: https://img.shields.io/github/release/Jezza34000/py-petkit-api.svg?style=for-the-badge&color=41BDF5
+[releases]: https://github.com/Jezza34000/py-petkit-api/releases
+[github-sponsor-shield]: https://img.shields.io/badge/sponsor-Jezza34000-blue.svg?style=for-the-badge&logo=githubsponsors&color=EA4AAA
+[github-sponsor]: https://github.com/sponsors/Jezza34000
+[buymeacoffee-shield]: https://img.shields.io/badge/Donate-buy_me_a_coffee-yellow.svg?style=for-the-badge&logo=buy-me-a-coffee
+[buymeacoffee]: https://www.buymeacoffee.com/jezza
+

{pypetkitapi-1.15.0 → pypetkitapi-1.16.0}/README.md

@@ -31,6 +31,12 @@
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [black]: https://github.com/psf/black
 
+### Enjoying this library?
+
+[![Sponsor Jezza34000][github-sponsor-shield]][github-sponsor] [![Static Badge][buymeacoffee-shield]][buymeacoffee]
+
+---
+
 ## Overview
 
 PetKit Client is a Python library for interacting with the PetKit API. It allows you to manage your PetKit devices, retrieve account data, and control devices through the API.
@@ -41,6 +47,7 @@ PetKit Client is a Python library for interacting with the PetKit API. It allows
 - Fetch account and device data
 - Control PetKit devices (Feeder, Litter Box, Water Fountain, Purifiers)
 - Fetch images & videos produced by devices
+  > Pictures are available **with or without** Care+ subscription, Videos are only available **with** Care+ subscription
 
 ## Installation
 
@@ -115,7 +122,9 @@ Check at the usage in the Home Assistant integration : [here](https://github.com
 
 ## Help and Support
 
-A discord server is available for support and help, check here: [here](https://github.com/Jezza34000/homeassistant_petkit)
+Developers? Want to help? Join us on our Discord channel dedicated to developers and contributors.
+
+[![Discord][discord-shield]][discord]
 
 ## Contributing
 
@@ -125,3 +134,21 @@ Please open an issue or submit a pull request.
 ## License
 
 This project is licensed under the MIT License. See the LICENSE file for details.
+
+---
+
+[homeassistant_petkit]: https://github.com/Jezza34000/py-petkit-api
+[commits-shield]: https://img.shields.io/github/commit-activity/y/Jezza34000/py-petkit-api.svg?style=flat
+[commits]: https://github.com/Jezza34000/py-petkit-api/commits/main
+[discord]: https://discord.gg/Va8DrmtweP
+[discord-shield]: https://img.shields.io/discord/1318098700379361362.svg?style=for-the-badge&label=Discord&logo=discord&color=5865F2
+[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge&label=Home%20Assistant%20Community&logo=homeassistant&color=18bcf2
+[forum]: https://community.home-assistant.io/t/petkit-integration/834431
+[license-shield]: https://img.shields.io/github/license/Jezza34000/py-petkit-api.svg??style=flat
+[maintenance-shield]: https://img.shields.io/badge/maintainer-Jezza34000-blue.svg?style=flat
+[releases-shield]: https://img.shields.io/github/release/Jezza34000/py-petkit-api.svg?style=for-the-badge&color=41BDF5
+[releases]: https://github.com/Jezza34000/py-petkit-api/releases
+[github-sponsor-shield]: https://img.shields.io/badge/sponsor-Jezza34000-blue.svg?style=for-the-badge&logo=githubsponsors&color=EA4AAA
+[github-sponsor]: https://github.com/sponsors/Jezza34000
+[buymeacoffee-shield]: https://img.shields.io/badge/Donate-buy_me_a_coffee-yellow.svg?style=for-the-badge&logo=buy-me-a-coffee
+[buymeacoffee]: https://www.buymeacoffee.com/jezza

{pypetkitapi-1.15.0 → pypetkitapi-1.16.0}/pypetkitapi/__init__.py

@@ -51,7 +51,7 @@ from .media import DownloadDecryptMedia, MediaCloud, MediaFile, MediaManager
 from .purifier_container import Purifier
 from .water_fountain_container import WaterFountain
 
-__version__ = "1.15.0"
+__version__ = "1.16.0"
 
 __all__ = [
     "CTW3",

{pypetkitapi-1.15.0 → pypetkitapi-1.16.0}/pypetkitapi/command.py

@@ -57,7 +57,8 @@ class FeederCommand(StrEnum):
 class LitterCommand(StrEnum):
     """Specific LitterCommand"""
 
-    RESET_DEODORIZER = "reset_deodorizer"
+    RESET_N50_DEODORIZER = "reset_deodorizer"
+    # T5/T6 N60 does not have this command, must use control_device
 
 
 class PetCommand(StrEnum):
@@ -71,14 +72,15 @@ class LBCommand(IntEnum):
 
     CLEANING = 0
     DUMPING = 1
-    ODOR_REMOVAL = 2
+    ODOR_REMOVAL = 2  # For T4=K3 spray, for T5/T6=N60 fan
     RESETTING = 3
     LEVELING = 4
     CALIBRATING = 5
     RESET_DEODOR = 6
     LIGHT = 7
-    RESET_MAX_DEODOR = 8
+    RESET_N50_DEODOR = 8
     MAINTENANCE = 9
+    RESET_N60_DEODOR = 10
 
 
 class PurMode(IntEnum):
@@ -251,7 +253,7 @@ ACTIONS_MAP = {
         },
         supported_device=DEVICES_FEEDER,
     ),
-    LitterCommand.RESET_DEODORIZER: CmdData(
+    LitterCommand.RESET_N50_DEODORIZER: CmdData(
         endpoint=PetkitEndpoint.DEODORANT_RESET,
         params=lambda device: {
             "deviceId": device.id,

{pypetkitapi-1.15.0 → pypetkitapi-1.16.0}/pypetkitapi/const.py

@@ -166,7 +166,7 @@ class PetkitEndpoint(StrEnum):
     GET_WORK_RECORD = "getWorkRecord"
 
     # Litter Box
-    DEODORANT_RESET = "deodorantReset"
+    DEODORANT_RESET = "deodorantReset"  # For N50 only
     STATISTIC = "statistic"
     STATISTIC_RELEASE = "statisticRelease"
     GET_PET_OUT_GRAPH = "getPetOutGraph"

{pypetkitapi-1.15.0 → pypetkitapi-1.16.0}/pypetkitapi/litter_container.py

@@ -30,12 +30,21 @@ class SettingsLitter(BaseModel):
     """
 
     auto_interval_min: int | None = Field(None, alias="autoIntervalMin")
+    auto_interval_spray: int | None = Field(None, alias="autoIntervalSpray")
+    auto_product: int | None = Field(None, alias="autoProduct")
+    auto_spray: int | None = Field(None, alias="autoSpray")
     auto_work: int | None = Field(None, alias="autoWork")
     avoid_repeat: int | None = Field(None, alias="avoidRepeat")
     bury: int | None = None
+    camera: int | None = None
+    camera_config: int | None = Field(None, alias="cameraConfig")
+    camera_light: int | None = Field(None, alias="cameraLight")
+    cleanning_notify: int | None = Field(None, alias="cleanningNotify")
+    click_ok_enable: int | None = Field(None, alias="clickOkEnable")
     control_settings: int | None = Field(None, alias="controlSettings")
     deep_clean: int | None = Field(None, alias="deepClean")
     deep_refresh: int | None = Field(None, alias="deepRefresh")
+    deep_spray: int | None = Field(None, alias="deepSpray")
     deodorant_notify: int | None = Field(None, alias="deodorantNotify")
     distrub_multi_range: list[list[int]] | None = Field(None, alias="distrubMultiRange")
     disturb_config: int | None = Field(None, alias="disturbConfig")
@@ -44,6 +53,9 @@ class SettingsLitter(BaseModel):
     downpos: int | None = None
     dump_switch: int | None = Field(None, alias="dumpSwitch")
     fixed_time_clear: int | None = Field(None, alias="fixedTimeClear")
+    fixed_time_spray: int | None = Field(None, alias="fixedTimeSpray")
+    garbage_notify: int | None = Field(None, alias="garbageNotify")
+    highlight: int | None = Field(None, alias="highlight")
     kitten: int | None = None
     kitten_percent: float | None = Field(None, alias="kittenPercent")
     kitten_tips_time: int | None = Field(None, alias="kittenTipsTime")
@@ -52,39 +64,30 @@ class SettingsLitter(BaseModel):
     language: str | None = None
     language_follow: int | None = Field(None, alias="languageFollow")
     languages: list[str] | None = None
+    light_assist: int | None = Field(None, alias="lightAssist")
     light_config: int | None = Field(None, alias="lightConfig")
     light_mode: int | None = Field(None, alias="lightMode")
     light_multi_range: list[Any] | None = Field(None, alias="lightMultiRange")
     light_range: list[int] | None = Field(None, alias="lightRange")
     lightest: int | None = Field(None, alias="lightest")
     litter_full_notify: int | None = Field(None, alias="litterFullNotify")
-    manual_lock: int | None = Field(None, alias="manualLock")
-    no_remind: int | None = Field(None, alias="noRemind")
-    pet_in_notify: int | None = Field(None, alias="petInNotify")
-    relate_k3_switch: int | None = Field(None, alias="relateK3Switch")
-    sand_type: int | None = Field(None, alias="sandType")
-    soft_mode: int | None = Field(None, alias="softMode")
-    still_time: int | None = Field(None, alias="stillTime")
-    stop_time: int | None = Field(None, alias="stopTime")
-    underweight: int | None = Field(None, alias="underweight")
-    unit: int | None = None
-    weight_popup: int | None = Field(None, alias="weightPopup")
-    work_notify: int | None = Field(None, alias="workNotify")
-    auto_product: int | None = Field(None, alias="autoProduct")
-    camera: int | None = None
-    camera_config: int | None = Field(None, alias="cameraConfig")
-    cleanning_notify: int | None = Field(None, alias="cleanningNotify")
-    garbage_notify: int | None = Field(None, alias="garbageNotify")
-    highlight: int | None = Field(None, alias="highlight")
-    light_assist: int | None = Field(None, alias="lightAssist")
     live_encrypt: int | None = Field(None, alias="liveEncrypt")
+    manual_lock: int | None = Field(None, alias="manualLock")
     microphone: int | None = None
     move_notify: int | None = Field(None, alias="moveNotify")
     night: int | None = None
+    no_remind: int | None = Field(None, alias="noRemind")
     package_standard: list[int] | None = Field(None, alias="packageStandard")
     pet_detection: int | None = Field(None, alias="petDetection")
+    pet_in_notify: int | None = Field(None, alias="petInNotify")
     pet_notify: int | None = Field(None, alias="petNotify")
     pre_live: int | None = Field(None, alias="preLive")
+    relate_k3_switch: int | None = Field(None, alias="relateK3Switch")
+    sand_type: int | None = Field(None, alias="sandType")
+    soft_mode: int | None = Field(None, alias="softMode")
+    spray_notify: int | None = Field(None, alias="sprayNotify")
+    still_time: int | None = Field(None, alias="stillTime")
+    stop_time: int | None = Field(None, alias="stopTime")
     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")
@@ -93,9 +96,13 @@ class SettingsLitter(BaseModel):
     tone_mode: int | None = Field(None, alias="toneMode")
     tone_multi_range: list[list[int]] | None = Field(None, alias="toneMultiRange")
     tumbling: int | None = None
+    underweight: int | None = Field(None, alias="underweight")
+    unit: int | None = None
     upload: int | None = None
     volume: int | None = None
     wander_detection: int | None = Field(None, alias="wanderDetection")
+    weight_popup: int | None = Field(None, alias="weightPopup")
+    work_notify: int | None = Field(None, alias="workNotify")
 
 
 class WorkState(BaseModel):
@@ -114,51 +121,57 @@ class StateLitter(BaseModel):
     -> LitterData subclass.
     """
 
+    bagging_state: int | None = Field(None, alias="baggingState")
+    battery: int | None = None
     box: int | None = None
     box_full: bool | None = Field(None, alias="boxFull")
     box_state: int | None = Field(None, alias="boxState")
+    box_store_state: int | None = Field(None, alias="boxStoreState")
+    camera_status: int | None = Field(None, alias="cameraStatus")
     deodorant_left_days: int | None = Field(None, alias="deodorantLeftDays")
+    dump_state: int | None = Field(None, alias="dumpState")
     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")
     frequent_restroom: int | None = Field(None, alias="frequentRestroom")
+    liquid: int | None = None
     liquid_empty: bool | None = Field(None, alias="liquidEmpty")
     liquid_lack: bool | None = Field(None, alias="liquidLack")
     liquid_reset: int | None = Field(None, alias="liquidReset")
+    light_state: dict | None = Field(None, alias="lightState")
     low_power: bool | None = Field(None, alias="lowPower")
     offline_time: int | None = Field(None, alias="offlineTime")
     ota: int | None = None
     overall: int | None = None
+    pack_state: int | None = Field(None, alias="packState")
+    package_install: int | None = Field(None, alias="packageInstall")
+    package_secret: str | None = Field(None, alias="packageSecret")
+    package_sn: str | None = Field(None, alias="packageSn")
+    package_state: int | None = Field(None, alias="packageState")
     pet_error: bool | None = Field(None, alias="petError")
     pet_in_time: int | None = Field(None, alias="petInTime")
     pim: int | None = None
+    pi_ins: int | None = Field(None, alias="piIns")
     power: int | None = None
+    purification_left_days: int | None = Field(None, alias="purificationLeftDays")
+    refresh_state: WorkState | None = Field(None, alias="refreshState")
     sand_correct: int | None = Field(None, alias="sandCorrect")
     sand_lack: bool | None = Field(None, alias="sandLack")
     sand_percent: int | None = Field(None, alias="sandPercent")
     sand_status: int | None = Field(None, alias="sandStatus")
     sand_type: int | None = Field(None, alias="sandType")
     sand_weight: int | None = Field(None, alias="sandWeight")
-    used_times: int | None = Field(None, alias="usedTimes")
-    wifi: Wifi | None = None
-    bagging_state: int | None = Field(None, alias="baggingState")
-    battery: int | None = None
-    box_store_state: int | None = Field(None, alias="boxStoreState")
-    camera_status: int | None = Field(None, alias="cameraStatus")
-    dump_state: int | None = Field(None, alias="dumpState")
-    liquid: int | None = None
-    light_state: dict | None = Field(None, alias="lightState")
-    pack_state: int | None = Field(None, alias="packState")
-    package_install: int | None = Field(None, alias="packageInstall")
-    package_secret: str | None = Field(None, alias="packageSecret")
-    package_sn: str | None = Field(None, alias="packageSn")
-    package_state: int | None = Field(None, alias="packageState")
-    pi_ins: int | None = Field(None, alias="piIns")
-    purification_left_days: int | None = Field(None, alias="purificationLeftDays")
     seal_door_state: int | None = Field(None, alias="sealDoorState")
+    spray_days: int | None = Field(None, alias="sprayDays")
+    spray_left_days: int | None = Field(None, alias="sprayLeftDays")
+    spray_reset_time: int | None = Field(None, alias="sprayResetTime")
+    spray_state: int | None = Field(None, alias="sprayState")
     top_ins: int | None = Field(None, alias="topIns")
+    used_times: int | None = Field(None, alias="usedTimes")
     wander_time: int | None = Field(None, alias="wanderTime")
+    weight_state: int | None = Field(None, alias="weightState")
+    wifi: Wifi | None = None
     work_state: WorkState | None = Field(None, alias="workState")
 
 
@@ -396,44 +409,46 @@ class Litter(BaseModel):
 
     auto_upgrade: int | None = Field(None, alias="autoUpgrade")
     bt_mac: str | None = Field(None, alias="btMac")
+    cloud_product: CloudProduct | None = Field(None, alias="cloudProduct")  # For T5/T6
     created_at: str | None = Field(None, alias="createdAt")
+    deodorant_tip: int | None = Field(None, alias="deodorantTip")
+    device_nfo: Device | None = None
+    device_pet_graph_out: list[PetOutGraph] | None = None
+    device_records: list[LitterRecord] | None = None
+    device_stats: LitterStats | None = None
     firmware: float
     firmware_details: list[FirmwareDetail] = Field(alias="firmwareDetails")
     hardware: int
     id: int
-    k3_device: Purifier | None = Field(None, alias="k3Device")
+    in_times: int | None = None
     is_pet_out_tips: int | None = Field(None, alias="isPetOutTips")
+    k3_device: Purifier | None = Field(None, alias="k3Device")
+    last_out_time: int | None = None
     locale: str | None = None
     mac: str | None = None
     maintenance_time: int | None = Field(None, alias="maintenanceTime")
+    medias: list | None = None
     multi_config: bool | None = Field(None, alias="multiConfig")
     name: str | None = None
+    p2p_type: int | None = Field(None, alias="p2pType")
+    package_ignore_state: int | None = Field(None, alias="packageIgnoreState")
+    package_total_count: int | None = Field(None, alias="packageTotalCount")
+    package_used_count: int | None = Field(None, alias="packageUsedCount")
     pet_in_tip_limit: int | None = Field(None, alias="petInTipLimit")
+    pet_out_records: list[list[int]] | None = Field(None, alias="petOutRecords")
     pet_out_tips: list[Any] | None = Field(None, alias="petOutTips")
+    purification_tip: int | None = Field(None, alias="purificationTip")
     secret: str | None = None
+    service_status: int | None = None
     settings: SettingsLitter | None = None
     share_open: int | None = Field(None, alias="shareOpen")
     signup_at: str | None = Field(None, alias="signupAt")
     sn: str
     state: StateLitter | None = None
     timezone: float | None = None
-    cloud_product: CloudProduct | None = Field(None, alias="cloudProduct")  # For T5/T6
-    in_times: int | None = Field(None, alias="inTimes")
-    last_out_time: int | None = Field(None, alias="lastOutTime")
-    p2p_type: int | None = Field(None, alias="p2pType")
-    package_ignore_state: int | None = Field(None, alias="packageIgnoreState")
-    package_total_count: int | None = Field(None, alias="packageTotalCount")
-    package_used_count: int | None = Field(None, alias="packageUsedCount")
-    pet_out_records: list[list[int]] | None = Field(None, alias="petOutRecords")
-    service_status: int | None = Field(None, alias="serviceStatus")
-    total_time: int | None = Field(None, alias="totalTime")
-    with_k3: int | None = Field(None, alias="withK3")
+    total_time: int | None = None
     user: UserDevice | None = None
-    device_records: list[LitterRecord] | None = None
-    device_stats: LitterStats | None = None
-    device_pet_graph_out: list[PetOutGraph] | None = None
-    device_nfo: Device | None = None
-    medias: list | None = None
+    with_k3: int | None = Field(None, alias="withK3")
 
     @classmethod
     def get_endpoint(cls, device_type: str) -> str:

{pypetkitapi-1.15.0 → pypetkitapi-1.16.0}/pyproject.toml

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