Python interface for Kwikset Smart Locks
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
#<CODE_TYPE> = [phone, email]
pre_auth = await api.authenticate('<PASSWORD>','<CODE_TYPE>')
#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_info, 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.1.0.tar.gz
(17.9 kB
view hashes)
Built Distribution
aiokwikset-0.1.0-py3-none-any.whl
(20.5 kB
view hashes)
Close
Hashes for aiokwikset-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a56db443c9a7cb197ccab044f4dd6732bbb09474578586e3b914a1ca15594eca |
|
MD5 | a0d10e03481674b29854340e70b4fadd |
|
BLAKE2b-256 | aa30acb97f3dfe87dd2cd58927e955e422c0f416be4afbde3e15e4ee83e0a4eb |