pypetkitapi 0.1.0__py3-none-any.whl

pypetkitapi/const.py

@@ -0,0 +1,112 @@
+"""Constants for the pypetkitapi library."""
+
+from enum import StrEnum
+
+MIN_FEED_AMOUNT = 0
+MAX_FEED_AMOUNT = 10
+
+RES_KEY = "result"
+ERR_KEY = "error"
+SUCCESS_KEY = "success"
+
+# PetKit Models
+FEEDER = "feeder"
+FEEDER_MINI = "feedermini"
+D3 = "d3"
+D4 = "d4"
+D4S = "d4s"
+D4H = "d4h"
+D4SH = "d4sh"
+T3 = "t3"
+T4 = "t4"
+T5 = "t5"
+T6 = "t6"
+W5 = "w5"
+CTW3 = "ctw3"
+K2 = "k2"
+
+DEVICES_LITTER_BOX = [T4, T5, T6]
+DEVICES_FEEDER = [FEEDER, FEEDER_MINI, D4, D4S, D4H, D4SH]
+DEVICES_WATER_FOUNTAIN = [W5, CTW3]
+ALL_DEVICES = [*DEVICES_LITTER_BOX, *DEVICES_FEEDER, *DEVICES_WATER_FOUNTAIN]
+
+
+class PetkitURL(StrEnum):
+    """Petkit URL constants"""
+
+    REGION_SRV = "https://passport.petkt.com/v1/regionservers"
+
+
+class Client(StrEnum):
+    """Platform constants"""
+
+    PLATFORM_TYPE = "android"
+    OS_VERSION = "15.1"
+    MODEL_NAME = "23127PN0CG"
+    SOURCE = "app.petkit-android"
+
+
+class Header(StrEnum):
+    """Header constants"""
+
+    ACCEPT = "*/*"
+    ACCEPT_LANG = "en-US;q=1, it-US;q=0.9"
+    ENCODING = "gzip, deflate"
+    API_VERSION = "11.3.1"
+    CONTENT_TYPE = "application/x-www-form-urlencoded"
+    AGENT = "okhttp/3.12.11"
+    CLIENT = f"{Client.PLATFORM_TYPE}({Client.OS_VERSION};{Client.MODEL_NAME})"
+    TIMEZONE = "1.0"
+    TIMEZONE_ID = "Europe/Paris"
+    LOCALE = "en-US"
+    IMG_VERSION = "1.0"
+    HOUR = "24"
+
+
+CLIENT_NFO = {
+    "locale": Header.LOCALE.value,
+    "name": Client.MODEL_NAME.value,
+    "osVersion": Client.OS_VERSION.value,
+    "platform": Client.PLATFORM_TYPE.value,
+    "source": Client.SOURCE.value,
+    "timezone": Header.TIMEZONE.value,
+    "timezoneId": Header.TIMEZONE_ID.value,
+    "version": Header.API_VERSION.value,
+}
+
+LOGIN_DATA = {
+    "client": str(CLIENT_NFO),
+    "oldVersion": Header.API_VERSION,
+}
+
+
+class PetkitEndpoint(StrEnum):
+    """Petkit Endpoint constants"""
+
+    LOGIN = "user/login"
+    GET_LOGIN_CODE = "user/sendcodeforquicklogin"
+    REFRESH_SESSION = "user/refreshsession"
+    FAMILY_LIST = "group/family/list"
+    REFRESH_HOME_V2 = "refreshHomeV2"
+    DEVICE_DETAIL = "device_detail"
+    DEVICE_DATA = "deviceData"
+    GET_DEVICE_RECORD = "getDeviceRecord"
+    GET_DEVICE_RECORD_RELEASE = "getDeviceRecordRelease"
+    UPDATE_SETTING = "updateSettings"
+
+    # Litter Box
+    DEODORANT_RESET = "deodorantReset"
+    CONTROL_DEVICE = "controlDevice"
+
+    # Feeders
+    REPLENISHED_FOOD = "added"
+    FRESH_ELEMENT_CALIBRATION = "food_reset"
+    FRESH_ELEMENT_CANCEL_FEED = "cancel_realtime_feed"
+    DESICCANT_RESET = "desiccantReset"
+    MINI_DESICCANT_RESET = "feedermini/desiccant_reset"
+    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"

pypetkitapi/containers.py

@@ -0,0 +1,116 @@
+"""Dataclasses container for petkit API."""
+
+from pydantic import BaseModel, Field
+
+
+class RegionInfo(BaseModel):
+    """Dataclass for region data.
+    Fetched from the API endpoint :
+        - /v1/regionservers.
+    """
+
+    account_type: str = Field(alias="accountType")
+    gateway: str
+    id: str
+    name: str
+
+
+class SessionInfo(BaseModel):
+    """Dataclass for session data.
+    Fetched from the API endpoint :
+        - user/login
+        - user/sendcodeforquicklogin
+        - user/refreshsession
+    """
+
+    id: str
+    user_id: str = Field(alias="userId")
+    expires_in: int = Field(alias="expiresIn")
+    region: str
+    created_at: str = Field(alias="createdAt")
+
+
+class Device(BaseModel):
+    """Dataclass for device data.
+    Subclass of AccountData.
+    """
+
+    created_at: int = Field(alias="createdAt")
+    device_id: int = Field(alias="deviceId")
+    device_name: str = Field(alias="deviceName")
+    device_type: str = Field(alias="deviceType")
+    group_id: int = Field(alias="groupId")
+    type: int
+    type_code: int = Field(alias="typeCode")
+    unique_id: str = Field(alias="uniqueId")
+
+
+class Pet(BaseModel):
+    """Dataclass for pet data.
+    Subclass of AccountData.
+    """
+
+    avatar: str | None = None
+    created_at: int | None = Field(None, alias="createdAt")
+    pet_id: int | None = Field(None, alias="petId")
+    pet_name: str | None = Field(None, alias="petName")
+
+
+class User(BaseModel):
+    """Dataclass for user data.
+    Subclass of AccountData.
+    """
+
+    avatar: str | None = None
+    created_at: int | None = Field(None, alias="createdAt")
+    is_owner: int | None = Field(None, alias="isOwner")
+    user_id: int | None = Field(None, alias="userId")
+    user_name: str | None = Field(None, alias="userName")
+
+
+class AccountData(BaseModel):
+    """Dataclass for account data.
+    Fetch from the API endpoint
+        - /group/family/list.
+    """
+
+    device_list: list[Device] | None = Field(None, alias="deviceList")
+    expired: bool | None = None
+    group_id: int | None = Field(None, alias="groupId")
+    name: str | None = None
+    owner: int | None = None
+    pet_list: list[Pet] | None = Field(None, alias="petList")
+    user_list: list[User] | None = Field(None, alias="userList")
+
+
+class CloudProduct(BaseModel):
+    """Dataclass for cloud product details.
+    Care+ Service for Smart devices with Camera.
+    Subclass of many other device dataclasses.
+    """
+
+    charge_type: str | None = Field(None, alias="chargeType")
+    name: str | None = None
+    service_id: int | None = Field(None, alias="serviceId")
+    subscribe: int | None = None
+    work_indate: int | None = Field(None, alias="workIndate")
+    work_time: int | None = Field(None, alias="workTime")
+
+
+class Wifi(BaseModel):
+    """Dataclass for Wi-Fi.
+    Subclass of many other device dataclasses.
+    """
+
+    bssid: str | None = None
+    rsq: int | None = None
+    ssid: str | None = None
+
+
+class FirmwareDetail(BaseModel):
+    """Dataclass for firmware details.
+    Subclass of many other device dataclasses.
+    """
+
+    module: str | None = None
+    version: int | None = None

pypetkitapi/exceptions.py

@@ -0,0 +1,15 @@
+"""PyPetkit exceptions."""
+
+from __future__ import annotations
+
+
+class PypetkitError(Exception):
+    """Class for PyPetkit exceptions."""
+
+
+class PetkitTimeoutError(PypetkitError):
+    """Class for PyPetkit timeout exceptions."""
+
+
+class PetkitConnectionError(PypetkitError):
+    """Class for PyPetkit connection exceptions."""

pypetkitapi/feeder_container.py

@@ -0,0 +1,247 @@
+"""Dataclasses for feeder data."""
+
+from collections.abc import Callable
+from typing import Any, ClassVar
+
+from pydantic import BaseModel, Field
+
+from pypetkitapi.const import PetkitEndpoint
+from pypetkitapi.containers import CloudProduct, 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")
+
+
+class FeedDailyList(BaseModel):
+    """Dataclass for feed daily list data."""
+
+    items: list[FeedItem] | None = None
+    repeats: int | None = None
+    suspended: int | None = None
+
+
+class MultiFeedItem(BaseModel):
+    """Dataclass for multi feed item data."""
+
+    feed_daily_list: list[FeedDailyList] | None = Field(None, alias="feedDailyList")
+    is_executed: int | None = Field(None, alias="isExecuted")
+    user_id: str | None = Field(None, alias="userId")
+
+
+class CameraMultiNew(BaseModel):
+    """Dataclass for camera multi new data."""
+
+    enable: int | None = None
+    rpt: str | None = None
+    time: list[tuple[int, int]] | None = None
+
+
+class SettingsFeeder(BaseModel):
+    """Dataclass for settings."""
+
+    attire_id: int | None = Field(None, alias="attireId")
+    attire_switch: int | None = Field(None, alias="attireSwitch")
+    auto_product: int | None = Field(None, alias="autoProduct")
+    camera: int | None = None
+    camera_config: int | None = Field(None, alias="cameraConfig")
+    camera_multi_range: list | None = Field(None, alias="cameraMultiRange")
+    control_settings: int | None = Field(None, alias="controlSettings")
+    desiccant_notify: int | None = Field(None, alias="desiccantNotify")
+    detect_config: int | None = Field(None, alias="detectConfig")
+    detect_interval: int | None = Field(None, alias="detectInterval")
+    detect_multi_range: list | None = Field(None, alias="detectMultiRange")
+    eat_detection: int | None = Field(None, alias="eatDetection")
+    eat_notify: int | None = Field(None, alias="eatNotify")
+    eat_sensitivity: int | None = Field(None, alias="eatSensitivity")
+    eat_video: int | None = Field(None, alias="eatVideo")
+    feed_notify: int | None = Field(None, alias="feedNotify")
+    feed_picture: int | None = Field(None, alias="feedPicture")
+    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")
+    highlight: int | None = None
+    light_config: int | None = Field(None, alias="lightConfig")
+    light_mode: int | None = Field(None, alias="lightMode")
+    light_multi_range: list[tuple[int, int]] | None = Field(
+        None, alias="lightMultiRange"
+    )
+    live_encrypt: int | None = Field(None, alias="liveEncrypt")
+    low_battery_notify: int | None = Field(None, alias="lowBatteryNotify")
+    manual_lock: int | None = Field(None, alias="manualLock")
+    microphone: int | None = None
+    move_detection: int | None = Field(None, alias="moveDetection")
+    move_notify: int | None = Field(None, alias="moveNotify")
+    move_sensitivity: int | None = Field(None, alias="moveSensitivity")
+    night: int | None = None
+    num_limit: int | None = Field(None, alias="numLimit")
+    pet_detection: int | None = Field(None, alias="petDetection")
+    pet_notify: int | None = Field(None, alias="petNotify")
+    pet_sensitivity: int | None = Field(None, alias="petSensitivity")
+    pre_live: int | None = Field(None, alias="preLive")
+    selected_sound: int | None = Field(None, alias="selectedSound")
+    smart_frame: int | None = Field(None, alias="smartFrame")
+    sound_enable: int | None = Field(None, alias="soundEnable")
+    surplus_control: int | None = Field(None, alias="surplusControl")
+    surplus_standard: int | None = Field(None, alias="surplusStandard")
+    system_sound_enable: int | None = Field(None, alias="systemSoundEnable")
+    time_display: int | None = Field(None, alias="timeDisplay")
+    tone_config: int | None = Field(None, alias="toneConfig")
+    tone_mode: int | None = Field(None, alias="toneMode")
+    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."""
+
+    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 | 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_total1: int | None = Field(None, alias="planRealAmountTotal1")
+    plan_real_amount_total2: int | None = Field(None, alias="planRealAmountTotal2")
+    real_amount_total1: int | None = Field(None, alias="realAmountTotal1")
+    real_amount_total2: int | None = Field(None, alias="realAmountTotal2")
+
+
+class StateFeeder(BaseModel):
+    """Dataclass for state data."""
+
+    battery_power: int | None = Field(None, alias="batteryPower")
+    battery_status: int | None = Field(None, alias="batteryStatus")
+    bowl: int | None = None
+    camera_status: int | None = Field(None, alias="cameraStatus")
+    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
+    ota: int | None = None
+    overall: int | None = None
+    pim: int | None = None
+    runtime: 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 Feeder(BaseModel):
+    """Dataclass for feeder data."""
+
+    url_endpoint: ClassVar[PetkitEndpoint] = PetkitEndpoint.DEVICE_DETAIL
+    query_param: ClassVar[Callable] = lambda device_id: {"id": device_id}
+
+    auto_upgrade: int | None = Field(None, alias="autoUpgrade")
+    bt_mac: str | None = Field(None, alias="btMac")
+    cloud_product: CloudProduct | None = Field(None, alias="cloudProduct")
+    created_at: str | None = Field(None, alias="createdAt")
+    firmware: str | None = None
+    firmware_details: list[FirmwareDetail] | None = Field(None, alias="firmwareDetails")
+    hardware: int | None = None
+    id: int | None = None
+    locale: str | None = None
+    mac: str | None = None
+    model_code: int | None = Field(None, alias="modelCode")
+    multi_feed_item: MultiFeedItem | None = Field(None, alias="multiFeedItem")
+    name: str | None = None
+    secret: str | None = None
+    service_status: int | None = Field(None, alias="serviceStatus")
+    settings: SettingsFeeder | None = None
+    share_open: int | None = Field(None, alias="shareOpen")
+    signup_at: str | None = Field(None, alias="signupAt")
+    sn: str | None = None
+    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_id: int = 0
+
+    @classmethod
+    def get_endpoint(cls, device_type: str) -> str:
+        """Get the endpoint URL for the given device type."""
+        return cls.url_endpoint.value
+
+
+class EventState(BaseModel):
+    """Dataclass for event state data."""
+
+    completed_at: str | None = Field(None, alias="completedAt")
+    err_code: int | None = Field(None, alias="errCode")
+    media: int | None = None
+    real_amount1: int | None = Field(None, alias="realAmount1")
+    real_amount2: int | None = Field(None, alias="realAmount2")
+    result: int | None = None
+    surplus_standard: int | None = Field(None, alias="surplusStandard")
+
+
+class FeederRecord(BaseModel):
+    """Dataclass for feeder record data."""
+
+    aes_key: str | None = Field(None, alias="aesKey")
+    duration: int | None = None
+    event_id: str | None = Field(None, alias="eventId")
+    expire: int | None = None
+    mark: int | None = None
+    media_api: str | None = Field(None, alias="mediaApi")
+    start_time: int | None = Field(None, alias="startTime")
+    storage_space: int | None = Field(None, alias="storageSpace")
+    eat_video: int | None = Field(None, alias="eatVideo")
+    is_need_upload_video: int | None = Field(None, alias="isNeedUploadVideo")
+    preview: str | None = None
+    time: int | None = None
+    timestamp: int | None = None
+    aes_key1: str | None = Field(None, alias="aesKey1")
+    aes_key2: str | None = Field(None, alias="aesKey2")
+    amount1: int | None = Field(None, alias="amount1")
+    amount2: int | None = Field(None, alias="amount2")
+    completed_at: int | None = Field(None, alias="completedAt")
+    content: dict[str, Any] | None = None
+    desc: str | None = None
+    device_id: int | None = Field(None, alias="deviceId")
+    eat_end_time: int | None = Field(None, alias="eatEndTime")
+    eat_start_time: int | None = Field(None, alias="eatStartTime")
+    empty: int | None = None
+    end_time: int | None = Field(None, alias="endTime")
+    enum_event_type: str | None = Field(None, alias="enumEventType")
+    event: str | None = None
+    event_type: int | None = Field(None, alias="eventType")
+    expire1: int | None = Field(None, alias="expire1")
+    expire2: int | None = Field(None, alias="expire2")
+    id: str | None = None
+    is_executed: int | None = Field(None, alias="isExecuted")
+    media_list: list[Any] | None = Field(None, alias="mediaList")
+    name: str | None = None
+    preview1: str | None = Field(None, alias="preview1")
+    preview2: str | None = Field(None, alias="preview2")
+    src: int | None = None
+    state: EventState | None = None
+    status: int | None = None

pypetkitapi/litter_container.py

@@ -0,0 +1,177 @@
+"""Dataclasses for Litter."""
+
+from collections.abc import Callable
+from typing import Any, ClassVar
+
+from pydantic import BaseModel, Field
+
+from pypetkitapi.const import PetkitEndpoint
+from pypetkitapi.containers import CloudProduct, FirmwareDetail, Wifi
+
+
+class SettingsLitter(BaseModel):
+    """Dataclass for settings.
+    -> LitterData subclass.
+    """
+
+    auto_interval_min: int | None = Field(None, alias="autoIntervalMin")
+    auto_work: int | None = Field(None, alias="autoWork")
+    avoid_repeat: int | None = Field(None, alias="avoidRepeat")
+    bury: int | None = None
+    control_settings: int | None = Field(None, alias="controlSettings")
+    deep_clean: int | None = Field(None, alias="deepClean")
+    deep_refresh: int | None = Field(None, alias="deepRefresh")
+    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")
+    disturb_mode: int | None = Field(None, alias="disturbMode")
+    disturb_range: list[int] | None = Field(None, alias="disturbRange")
+    downpos: int | None = None
+    dump_switch: int | None = Field(None, alias="dumpSwitch")
+    fixed_time_clear: int | None = Field(None, alias="fixedTimeClear")
+    kitten: int | None = None
+    kitten_percent: float | None = Field(None, alias="kittenPercent")
+    kitten_tips_time: int | None = Field(None, alias="kittenTipsTime")
+    lack_liquid_notify: int | None = Field(None, alias="lackLiquidNotify")
+    lack_sand_notify: int | None = Field(None, alias="lackSandNotify")
+    language: str | None = None
+    language_follow: int | None = Field(None, alias="languageFollow")
+    languages: list[str] | None = None
+    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")
+    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")
+    microphone: int | None = None
+    move_notify: int | None = Field(None, alias="moveNotify")
+    night: int | None = None
+    package_standard: list[int] | None = Field(None, alias="packageStandard")
+    pet_detection: int | None = Field(None, alias="petDetection")
+    pet_notify: int | None = Field(None, alias="petNotify")
+    pre_live: int | None = Field(None, alias="preLive")
+    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")
+    toilet_notify: int | None = Field(None, alias="toiletNotify")
+    tone_config: int | None = Field(None, alias="toneConfig")
+    tone_mode: int | None = Field(None, alias="toneMode")
+    tone_multi_range: list[list[int]] | None = Field(None, alias="toneMultiRange")
+    tumbling: int | None = None
+    upload: int | None = None
+    volume: int | None = None
+    wander_detection: int | None = Field(None, alias="wanderDetection")
+
+
+class StateLitter(BaseModel):
+    """Dataclass for state.
+    -> LitterData subclass.
+    """
+
+    box: int | None = None
+    box_full: bool | None = Field(None, alias="boxFull")
+    box_state: int | None = Field(None, alias="boxState")
+    deodorant_left_days: int | None = Field(None, alias="deodorantLeftDays")
+    frequent_restroom: int | None = Field(None, alias="frequentRestroom")
+    liquid_empty: bool | None = Field(None, alias="liquidEmpty")
+    liquid_lack: bool | None = Field(None, alias="liquidLack")
+    liquid_reset: int | None = Field(None, alias="liquidReset")
+    low_power: bool | None = Field(None, alias="lowPower")
+    offline_time: int | None = Field(None, alias="offlineTime")
+    ota: int | None = None
+    overall: int | None = None
+    pet_error: bool | None = Field(None, alias="petError")
+    pet_in_time: int | None = Field(None, alias="petInTime")
+    pim: int | None = None
+    power: int | None = None
+    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
+    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")
+    top_ins: int | None = Field(None, alias="topIns")
+    wander_time: int | None = Field(None, alias="wanderTime")
+
+
+class Litter(BaseModel):
+    """Dataclass for Litter Data.
+    Supported devices = T4, T6
+    """
+
+    url_endpoint: ClassVar[PetkitEndpoint] = PetkitEndpoint.DEVICE_DETAIL
+    query_param: ClassVar[Callable] = lambda device_id: {"id": device_id}
+
+    auto_upgrade: int | None = Field(None, alias="autoUpgrade")
+    bt_mac: str | None = Field(None, alias="btMac")
+    created_at: str | None = Field(None, alias="createdAt")
+    firmware: str | None = None
+    firmware_details: list[FirmwareDetail] | None = Field(None, alias="firmwareDetails")
+    hardware: int | None = None
+    id: int | None = None
+    is_pet_out_tips: int | None = Field(None, alias="isPetOutTips")
+    locale: str | None = None
+    mac: str | None = None
+    maintenance_time: int | None = Field(None, alias="maintenanceTime")
+    multi_config: bool | None = Field(None, alias="multiConfig")
+    name: str | None = None
+    pet_in_tip_limit: int | None = Field(None, alias="petInTipLimit")
+    pet_out_tips: list[Any] | None = Field(None, alias="petOutTips")
+    secret: str | None = None
+    settings: SettingsLitter | None = None
+    share_open: int | None = Field(None, alias="shareOpen")
+    signup_at: str | None = Field(None, alias="signupAt")
+    sn: str | None = None
+    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")
+    device_type: str | None = Field(None, alias="deviceType")
+
+    @classmethod
+    def get_endpoint(cls, device_type: str) -> str:
+        """Get the endpoint URL for the given device type."""
+        return cls.url_endpoint.value