Python interface for Kwikset Halo API
Project description
aiokwikset - Python interface for the Kwikset API
Python library for communicating with the Kwikset Smart Locks via the Kwikset cloud API.
WARNING
- This library only works if you have signed up for and created a home/had a home shared with you from the Kwikset Application.
- IOS
- Android
NOTE:
- This library is community supported, please submit changes and improvements.
- This is a very basic interface, not well thought out at this point, but works for the use cases that initially prompted spitting this out from.
Supports
- locking/unlocking
- retrieving basic information
Installation
pip install aiokwikset
Examples
import asyncio
from aiokwikset import API
async def main() -> None:
"""Run!"""
#initialize the API
api = API("<EMAIL>")
#start auth
pre_auth = await api.authenticate('<PASSWORD>')
#MFA verification
await api.verify_user(pre_auth, input("Code:"))
# Get user account information:
user_info = await api.user.get_info()
# Get the homes
homes = await api.user.get_homes()
# Get the devices for the first home
devices = await api.device.get_devices(homes[0]['homeid'])
# Get information for a specific device
device_info = await api.device.get_device_info(devices[0]['deviceid'])
# Lock the specific device
lock = await api.device.lock_device(devices[0], user_info)
asyncio.run(main())
Known Issues
- not all APIs supported
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
aiokwikset-0.0.5.tar.gz
(17.8 kB
view hashes)
Built Distribution
aiokwikset-0.0.5-py3-none-any.whl
(20.5 kB
view hashes)
Close
Hashes for aiokwikset-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d465065aa3d49a26e2715e1bd26cabd38ced43d846f3eced0424c1a87d50469d |
|
MD5 | abe2c2143d538cac01028e53d677253e |
|
BLAKE2b-256 | 5fae845c09b3ef24686f639e0fe0b9711f962878676a45cf358db5d4a601c898 |