Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/benleb/surepy

🐾 Library & CLI to monitor and control the Pet Door & Cat Flap Connect 🚪 the Pet Feeder Connect 🍽 and the Felaqua 💦 sold by Sure Petcare
https://github.com/benleb/surepy

appdaemon cat cat-lover-developer catflap cats cli flap flaps hacktoberfest home-assistant monitor pet-door pypi python3 sureflap surepet surepetcare

Last synced: 5 days ago
JSON representation

🐾 Library & CLI to monitor and control the Pet Door & Cat Flap Connect 🚪 the Pet Feeder Connect 🍽 and the Felaqua 💦 sold by Sure Petcare

Host: GitHub
URL: https://github.com/benleb/surepy
Owner: benleb
License: mit
Created: 2019-03-16T19:07:09.000Z (almost 6 years ago)
Default Branch: dev
Last Pushed: 2024-07-20T22:59:50.000Z (5 months ago)
Last Synced: 2024-12-20T07:04:20.933Z (12 days ago)
Topics: appdaemon, cat, cat-lover-developer, catflap, cats, cli, flap, flaps, hacktoberfest, home-assistant, monitor, pet-door, pypi, python3, sureflap, surepet, surepetcare
Language: Python
Homepage: https://pypi.org/project/surepy/
Size: 367 KB
Stars: 80
Watchers: 15
Forks: 39
Open Issues: 36
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # [![surepy](https://socialify.git.ci/benleb/surepy/image?description=1&descriptionEditable=Library%20%26%20CLI%20to%20interact%20with%20the%20Sure%20Petcare%20API%20to%20monitor%20and%20control%20the%20Sure%20Petcare%20Pet%20Door%2FCat%20Flap%20Connect%20%F0%9F%9A%AA%20and%20the%20Pet%20Feeder%20Connect%20%F0%9F%8D%BD&font=KoHo&forks=1&language=1&logo=https%3A%2F%2Femojipedia-us.s3.dualstack.us-west-1.amazonaws.com%2Fthumbs%2F240%2Fapple%2F237%2Fpaw-prints_1f43e.png&pulls=1&stargazers=1)](https://github.com/benleb/surepy)

Library & CLI to interact with the Sure Petcare API. [**surepy**](https://github.com/benleb/surepy) lets you monitor and control the Pet Door/Cat Flap Connect 🚪 and the Pet Feeder Connect 🍽 by [Sure Petcare](https://www.surepetcare.com).

---

[**surepy**](https://github.com/benleb/surepy) features:

🔑 **get an api token** with your account credentials  

🚪 **lock/unlock** a door or flap  

🐾 get the **location** of **pets** & **devices**  

🐈 get the **state** and more attributes of **pets** & **devices**  

🕰️ get **historic** data & events of pets & devices  

📬 get a list of (past) **notifications**  

## Getting Started

[**surepy**](https://github.com/benleb/surepy) is available via [pypi.org](https://pypi.org)

```bash

python3 -m pip install --upgrade surepy

# or

pip install --upgrade surepy

```

there is also a small cli available

```bash

$ surepy --help

Usage: surepy [OPTIONS] COMMAND [ARGS]...

  surepy cli 🐾

  https://github.com/benleb/surepy

Options:

  --version         show surepy version

  -j, --json        enable json api response output

  -t, --token TEXT  api token

  --help            Show this message and exit.

Commands:

  devices       get devices

  locking       lock control

  notification  get notifications

  pets          get pets

  position      set pet position

  report        get pet/household report

  token         get a token

```

>*the cli **is mainly intended for developing & debugging purposes** and probably has bugs - be careful* 🐾

## Library example

```python

import asyncio

from os import environ

from pprint import pprint

from typing import Dict, List

from surepy import Surepy

from surepy.entities import SurepyEntity

from surepy.entities.devices import SurepyDevice

from surepy.entities.pet import Pet

async def main():

    # # user/password authentication (gets a token in background)

    # surepy = Surepy(email=user, password=password)

    # token authentication (token supplied via SUREPY_TOKEN env var)

    token = environ.get("SUREPY_TOKEN")

    surepy = Surepy(auth_token=token)

    # list with all pets

    pets: List[Pet] = await surepy.get_pets()

    for pet in pets:

        print(f"\n\n{pet.name}: {pet.state} | {pet.location}\n")

        pprint(pet.raw_data())

    print(f"\n\n - - - - - - - - - - - - - - - - - - - -\n\n")

    # all entities as id-indexed dict

    entities: Dict[int, SurepyEntity] = await surepy.get_entities()

    # list with alldevices

    devices: List[SurepyDevice] = await surepy.get_devices()

    for device in devices:

        print(f"{device.name = } | {device.serial = } | {device.battery_level = }")

        print(f"{device.type = } | {device.unique_id = } | {device.id = }")

        print(f"{entities[device.parent_id].full_name = } | {entities[device.parent_id] = }\n")

asyncio.run(main())

```

---

## Naming confusion for *surepetcarebeta* users 🐾 🤪 🤦

Sorry for the bad naming and resulting confusion and chaos 🙄 To "fix" this, I **renamed *surepetcarebeta* to *sureha***.

| Name | Repo | Type | Description | Need Help?

|---|---|---|---|---|

| **[surepy](https://github.com/benleb/surepy) 🐾** | [github.com/benleb/surepy](https://github.com/benleb/surepy) | Python Library | Library to interact with the API of Sure Petcare. Also provides Classes for the various Sure Petcare Devicess. Use this if you write an own python tool/app and want to interact with the Sure Petcare API | [Issues](https://github.com/benleb/surepy/issues) |

| **[surepetcare](https://www.home-assistant.io/integrations/surepetcare)** ![HA Favicon](https://www.home-assistant.io/images/favicon.ico) | [github.com/home-assistant/core](https://github.com/home-assistant/core) | [Home Assistant](https://github.com/home-assistant/core) Integration | **Official Home Assistant Integration** for the Sure Petcare Devices like Doors, Flaps, Feeders, ...  | [Issues](https://github.com/home-assistant/core/issues), [HA Forum](https://community.home-assistant.io) |

| | | | | |

| **[sureha](https://github.com/benleb/sureha)** ~~surepetcarebeta~~ ~~[benleb/surepetcare](https://github.com/benleb/sureha)~~ | [github.com/benleb/sureha](https://github.com/benleb/sureha) | [Home Assistant](https://github.com/home-assistant/core) Integration | Home Assistant Integration developed in my own repo without reviews from the HA Team. This can be installed via [HACS](https://hacs.xyz/) and is something like a preview integration **for advanced users**. Usually this provides more (experimental) features and faster fixes but lacks the code quality (reviews) and such from HA | [Issues](https://github.com/benleb/sureha/issues) |

| | | | | |

| **[pethublocal](https://github.com/plambrechtsen/pethublocal)** | [github.com/plambrechtsen/pethublocal](https://github.com/plambrechtsen/pethublocal) | [Home Assistant](https://github.com/home-assistant/core) Integration | Home Assistant Integration developed by [@plambrechtsen](https://github.com/plambrechtsen) which works **completely independent from Sure Petcare**. Check outs his repo for more information! | [Issues](https://github.com/plambrechtsen/pethublocal/issues), [HA Forum](https://community.home-assistant.io) |

---

## Used by

* [Sure Petcare](https://www.home-assistant.io/integrations/surepetcare/) integration in [Home Assistant](https://www.home-assistant.io/)

Feel free to add you project!

## Acknowledgments

* Thanks to all the people who provided information about devices I do not own myself, thanks!

* Thanks to [@rcastberg](https://github.com/rcastberg) for hist previous work on the [Sure Petcare](https://www.surepetcare.com) API ([github.com/rcastberg/sure_petcare](https://github.com/rcastberg/sure_petcare))

* Thanks to [@wei](https://github.com/wei) for the  header image generator ([github.com/wei/socialify](https://github.com/wei/socialify))

## Meta

**Ben Lebherz**: *cat lover 🐾 developer & maintainer* - [@benleb](https://github.com/benleb) | [@ben_leb](https://twitter.com/ben_leb)

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details