pypetkitapi

Petkit API Client

Enjoying this library?

ℹ️ 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, Purifiers)
• Fetch images & videos produced by devices

  Pictures are available with or without Care+ subscription, Videos are only available with Care+ subscription

⬇️ Installation

Install the library using pip:

pip install pypetkitapi

💡 Usage Example:

Here is a simple example of how to use the library to interact with the PetKit API
This example is not an exhaustive list of all the features available in the library.

import asyncio
import logging
import aiohttp
from pypetkitapi.client import PetKitClient
from pypetkitapi.command import DeviceCommand, FeederCommand, LBCommand, DeviceAction, LitterCommand

logging.basicConfig(level=logging.DEBUG)

async def main():
    async with aiohttp.ClientSession() as session:
        client = PetKitClient(
            username="username",  # Your PetKit account username or id
            password="password",  # Your PetKit account password
            region="FR",  # Your region or country code (e.g. FR, US,CN etc.)
            timezone="Europe/Paris",  # Your timezone(e.g. "Asia/Shanghai")
            session=session,
        )

        await client.get_devices_data()

        # Lists all devices and pet from account

        for key, value in client.petkit_entities.items():
            print(f"{key}: {type(value).__name__} - {value.name}")

        # Select a device
        device_id = key
        # Read devices or pet information
        print(client.petkit_entities[device_id])

        # Send command to the devices
        ### Example 1 : Turn on the indicator light
        ### Device_ID, Command, Payload
        await client.send_api_request(device_id, DeviceCommand.UPDATE_SETTING, {"lightMode": 1})

        ### Example 2 : Feed the pet
        ### Device_ID, Command, Payload
        # simple hopper :
        await client.send_api_request(device_id, FeederCommand.MANUAL_FEED, {"amount": 1})
        # dual hopper :
        await client.send_api_request(device_id, FeederCommand.MANUAL_FEED, {"amount1": 2})
        # or
        await client.send_api_request(device_id, FeederCommand.MANUAL_FEED, {"amount2": 2})

        ### Example 3 : Start the cleaning process
        ### Device_ID, Command, Payload
        await client.send_api_request(device_id, LitterCommand.CONTROL_DEVICE, {DeviceAction.START: LBCommand.CLEANING})


if __name__ == "__main__":
    asyncio.run(main())

💡 More example usage

Check at the usage in the Home Assistant integration : here

☑️ Supported Devices

Category	Name	Device
🍗 Feeders	✅ Fresh Element
	✅ Fresh Element Mini Pro
	✅ Fresh Element Infinity
	✅ Fresh Element Solo
	✅ Fresh Element Gemini
	✅ YumShare Solo
	✅ YumShare Dual-hopper
🚽 Litters	✅ PuraX
	✅ PuraMax
	✅ PuraMax 2
	✅ Purobot Max Pro
	✅ Purobot Ultra
⛲ Fountains	✅ Eversweet Solo 2
	✅ Eversweet 3 Pro
	✅ Eversweet 3 Pro UVC
	✅ Eversweet 5 Mini
	✅ Eversweet Max
🧴 Purifiers	✅ Air Magicube
	✅ Air Smart Spray

🛟 Help and Support

Developers? Want to help? Join us on our Discord channel dedicated to developers and contributors.

👨‍💻 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.