pypetkitapi 0.1.0__py3-none-any.whl

pypetkitapi/water_fountain_container.py

@@ -0,0 +1,135 @@
+"""Dataclasses for Water Fountain."""
+
+from collections.abc import Callable
+from typing import Any, ClassVar
+
+from pydantic import BaseModel, Field
+
+from pypetkitapi.const import PetkitEndpoint
+
+
+class Electricity(BaseModel):
+    """Dataclass for electricity details.
+    -> WaterFountainData subclass.
+    """
+
+    battery_percent: int | None = Field(None, alias="batteryPercent")
+    battery_voltage: int | None = Field(None, alias="batteryVoltage")
+    supply_voltage: int | None = Field(None, alias="supplyVoltage")
+
+
+class Type(BaseModel):
+    """Dataclass for type details.
+    -> WaterFountainData subclass.
+    """
+
+    enable: int | None = None
+    id: str | None = None
+    img: str | None = None
+    is_custom: int | None = Field(None, alias="isCustom")
+    name: str | None = None
+    priority: int | None = None
+    with_device_type: str | None = Field(None, alias="withDeviceType")
+    with_pet: int | None = Field(None, alias="withPet")
+
+
+class Schedule(BaseModel):
+    """Dataclass for schedule details.
+    -> WaterFountainData subclass.
+    """
+
+    alarm_before: int | None = Field(None, alias="alarmBefore")
+    created_at: str | None = Field(None, alias="createdAt")
+    device_id: str | None = Field(None, alias="deviceId")
+    device_type: str | None = Field(None, alias="deviceType")
+    id: str | None = None
+    name: str | None = None
+    repeat: str | None = None
+    status: int | None = None
+    time: str | None = None
+    type: Type | None = None
+    user_custom_id: int | None = Field(None, alias="userCustomId")
+
+
+class SettingsFountain(BaseModel):
+    """Dataclass for settings.
+    -> WaterFountainData subclass.
+    """
+
+    battery_sleep_time: int | None = Field(None, alias="batterySleepTime")
+    battery_working_time: int | None = Field(None, alias="batteryWorkingTime")
+    distribution_diagram: int | None = Field(None, alias="distributionDiagram")
+    disturb_config: int | None = Field(None, alias="disturbConfig")
+    disturb_multi_time: list[dict[str, Any]] | None = Field(
+        None, alias="disturbMultiTime"
+    )
+    lamp_ring_brightness: int | None = Field(None, alias="lampRingBrightness")
+    lamp_ring_switch: int | None = Field(None, alias="lampRingSwitch")
+    light_config: int | None = Field(None, alias="lightConfig")
+    light_multi_time: list[dict[str, Any]] | None = Field(None, alias="lightMultiTime")
+    no_disturbing_switch: int | None = Field(None, alias="noDisturbingSwitch")
+    smart_sleep_time: int | None = Field(None, alias="smartSleepTime")
+    smart_working_time: int | None = Field(None, alias="smartWorkingTime")
+
+
+class Status(BaseModel):
+    """Dataclass for status details.
+    -> WaterFountainData subclass.
+    """
+
+    detect_status: int | None = Field(None, alias="detectStatus")
+    electric_status: int | None = Field(None, alias="electricStatus")
+    power_status: int | None = Field(None, alias="powerStatus")
+    run_status: int | None = Field(None, alias="runStatus")
+    suspend_status: int | None = Field(None, alias="suspendStatus")
+
+
+class WaterFountain(BaseModel):
+    """Dataclass for Water Fountain Data.
+    Supported devices = CTW3
+    """
+
+    url_endpoint: ClassVar[PetkitEndpoint] = PetkitEndpoint.DEVICE_DATA
+    query_param: ClassVar[Callable] = lambda device_id: {"id": device_id}
+
+    breakdown_warning: int | None = Field(None, alias="breakdownWarning")
+    created_at: str | None = Field(None, alias="createdAt")
+    electricity: Electricity | None = None
+    expected_clean_water: int | None = Field(None, alias="expectedCleanWater")
+    expected_use_electricity: float | None = Field(None, alias="expectedUseElectricity")
+    filter_expected_days: int | None = Field(None, alias="filterExpectedDays")
+    filter_percent: int | None = Field(None, alias="filterPercent")
+    filter_warning: int | None = Field(None, alias="filterWarning")
+    firmware: int | None = None
+    hardware: int | None = None
+    id: int | None = None
+    is_night_no_disturbing: int | None = Field(None, alias="isNightNoDisturbing")
+    lack_warning: int | None = Field(None, alias="lackWarning")
+    locale: str | None = None
+    low_battery: int | None = Field(None, alias="lowBattery")
+    mac: str | None = None
+    mode: int | None = None
+    module_status: int | None = Field(None, alias="moduleStatus")
+    name: str | None = None
+    record_automatic_add_water: int | None = Field(
+        None, alias="recordAutomaticAddWater"
+    )
+    schedule: Schedule | None = None
+    secret: str | None = None
+    settings: SettingsFountain | None = None
+    sn: str | None = None
+    status: Status | None = None
+    sync_time: str | None = Field(None, alias="syncTime")
+    timezone: float | None = None
+    today_clean_water: int | None = Field(None, alias="todayCleanWater")
+    today_pump_run_time: int | None = Field(None, alias="todayPumpRunTime")
+    today_use_electricity: float | None = Field(None, alias="todayUseElectricity")
+    update_at: str | None = Field(None, alias="updateAt")
+    user_id: str | None = Field(None, alias="userId")
+    water_pump_run_time: int | None = Field(None, alias="waterPumpRunTime")
+    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

pypetkitapi-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jezza34000
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pypetkitapi-0.1.0.dist-info/METADATA

@@ -0,0 +1,111 @@
+Metadata-Version: 2.1
+Name: pypetkitapi
+Version: 0.1.0
+Summary: Python client for PetKit API
+Home-page: https://github.com/Jezza34000/pypetkit
+License: MIT
+Author: Jezza34000
+Author-email: info@mail.com
+Requires-Python: >=3.11
+Classifier: License :: OSI Approved :: MIT License
+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)
+Description-Content-Type: text/markdown
+
+# Petkit API Client
+
+---
+
+# WIP - UNDER DEVELOPMENT
+
+---
+
+[![PyPI](https://img.shields.io/pypi/v/pypetkitapi.svg)][pypi_]
+[![Python Version](https://img.shields.io/pypi/pyversions/pypetkitapi)][python version]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+[![mypy](https://img.shields.io/badge/mypy-checked-blue)](https://mypy.readthedocs.io/en/stable/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Actions status](https://github.com/Jezza34000/py-petkit-api/workflows/CI/badge.svg)](https://github.com/Jezza34000/py-petkit-api/actions)
+
+---
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Jezza34000_py-petkit-api&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Jezza34000_py-petkit-api)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Jezza34000_py-petkit-api&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Jezza34000_py-petkit-api)
+
+[pypi_]: https://pypi.org/project/pypetkitapi/
+[python version]: https://pypi.org/project/pypetkitapi
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+
+## 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.
+
+## Features
+
+Login and session management
+Fetch account and device data
+Control PetKit devices (Feeder, Litter Box, Water Fountain)
+
+## Installation
+
+Install the library using pip:
+
+```bash
+pip install pypetkitapi
+```
+
+## Usage Example:
+
+```python
+import asyncio
+import logging
+from pypetkitapi.client import PetKitClient
+
+logging.basicConfig(level=logging.DEBUG)
+
+
+async def main():
+    client = PetKitClient(
+        username="username",  # Your PetKit account username
+        password="password",  # Your PetKit account password
+        region="France",  # Your region
+        timezone="Europe/Paris",  # Your timezone
+    )
+
+    # To get the account and devices data attached to the account
+    await client.get_devices_data()
+    # Read the account data
+    print(client.account_data)
+    # Read the devices data
+    print(client.device_list)
+
+    # client.device_list[0] is the first device in the list in this example it's a Feeder
+    # Get the Feeder from the device list
+    my_feeder = client.device_list[0]
+
+    # Send command to the devices
+    ### Example 1 : Turn on the indicator light
+    await client.send_api_request(my_feeder, DeviceCommand.UPDATE_SETTING, {"lightMode": 1})
+
+    ### Example 2 : Feed the pet
+    await client.send_api_request(my_feeder, FeederCommand.MANUAL_FEED, {"amount": 1})
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+

pypetkitapi-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+pypetkitapi/__init__.py,sha256=eVpyGMD3tkYtiHUkdKEeNSZhQlZ4woI2Y5oVoV7CwXM,61
+pypetkitapi/client.py,sha256=bqZv773AzwEKzwWN9xEQw0paR8FGVWKBrVFfdX4y4vE,12716
+pypetkitapi/command.py,sha256=ibJ0zenONy-FBvUvyIA_IvUnYEUezLpPxhC_9XZ6SwM,9282
+pypetkitapi/const.py,sha256=8V4t-_5TXiZpIz8l_7F28DFt4693O5vNJ8N9TDWvWG8,2818
+pypetkitapi/containers.py,sha256=GQqZKaDgemQM4UDnugWYDP7N01anpJwO4VjQy2Gla3E,3109
+pypetkitapi/exceptions.py,sha256=gjHswRYXSCTMy8_pu-Rzbt3gz2tdHDtP3j03lwuGirk,328
+pypetkitapi/feeder_container.py,sha256=5dCgXAHafl2kMk4jM4JGPgE0f48JBs0UkA1TvLPTfXU,10994
+pypetkitapi/litter_container.py,sha256=tKYd7iaj88TtR0W-wJ6U8PmsUzCcWg4ZisblOTKjKSg,8957
+pypetkitapi/water_fountain_container.py,sha256=g_J1nYuNTlDg-ltvo2FZRTxKWLgW9E0GVzbFKO6jpA8,5346
+pypetkitapi-0.1.0.dist-info/LICENSE,sha256=4FWnKolNLc1e3w6cVlT61YxfPh0DQNeQLN1CepKKSBg,1067
+pypetkitapi-0.1.0.dist-info/METADATA,sha256=jtiGGKyqYetPzdRoO70PiZFtYjSwzKDW3BJkuXF9eIE,3700
+pypetkitapi-0.1.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+pypetkitapi-0.1.0.dist-info/RECORD,,

pypetkitapi-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any