Provides ability to connect and control a PetSafe Smart Feed and Scoopfree device using the PetSafe API.
Project description
PetSafe Smart Feed - Python API
Connect and control a PetSafe Smart Feed device using the PetSafe-SmartFeed API.
BREAKING CHANGE: Version 2.0 uses the new PetSafe API. You will need to request new tokens.
PetSafe will lock your account if you request data more often than once per 5 minutes.
Installation
pip install petsafe
If installing from source code,
python setup.py install
Login tokens
You must use tokens to interact with the PetSafe Smart-Feed API.
There are two methods to retrieve tokens:
Get tokens using command line
- Execute
python -m petsafe [email_address]
to request an email code. - Check your email for an email code from PetSafe.
- Enter your code to generate tokens.
Get tokens using Python
import petsafe as sf
# replace with your email address
client = sf.PetSafeClient(email="email@example.com")
client.request_code()
# check your email for a code
code = input("Enter email code: ")
token = client.request_tokens_from_code(code)
print("email:", client.email)
print("id_token:", client.id_token)
print("refresh_token:", client.refresh_token)
print("access_token:", client.access_token)
Example usage
List feeders
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_feeders(client)
# print all feeders
for device in devices:
print(device)
Feed 1/8 cup at normal speed
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_feeders(client)
# get the first feeder
feeder = devices[0]
feeder.feed(amount=1, slow_feed=False)
Get current battery level (0 - 100)
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_feeders(client)
# get the first feeder
feeder = devices[0]
print(feeder.battery_level)
Get current food level
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_feeders(client)
# get the first feeder
feeder = devices[0]
status = feeder.food_low_status
if status == 0:
print("Feeder has food.")
elif status == 1:
print("Feeder is low on food.")
elif status == 2:
print("Feeder is out of food.")
get litterboxes
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_litterboxes(client)
# print all litterboxes
for device in devices:
print(device)
get litterbox activity
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_litterboxes(client)
litterbox = devices[0]
print(litterbox.get_schedule())
rake the litterbox
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_litterboxes(client)
litterbox = devices[0]
litterbox.rake()
modify the litterbox rake timer
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_litterboxes(client)
litterbox = devices[0]
litterbox.modify_timer(15)
reset the litterbox rake count
import petsafe as sf
client = sf.PetSafeClient(email="email@example.com",
id_token="YOUR_ID_TOKEN",
refresh_token="YOUR_REFRESH_TOKEN",
access_token="YOUR_ACCESS_TOKEN")
devices = sf.devices.get_litterboxes(client)
litterbox = devices[0]
litterbox.reset()
Contributing
All contributions are welcome. Please, feel free to create a pull request!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
petsafe-2.0.7.tar.gz
(9.2 kB
view hashes)