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()
#start auth
await api.async_login('username','password')
# 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(device_info, user_info)
# Set led status
led = await api.device.set_ledstatus(device_info, "false")
# Set audio status
audio = await api.device.set_audiostatus(device_info, "false")
# Set secure screen status
screen = await api.device.set_securescreenstatus(device_info, "false")
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.3.0a7.tar.gz
(10.1 kB
view details)
Built Distribution
File details
Details for the file aiokwikset-0.3.0a7.tar.gz
.
File metadata
- Download URL: aiokwikset-0.3.0a7.tar.gz
- Upload date:
- Size: 10.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 815dc499ebfb14e24ad13983246f8b6ac897b505e0d6fa8c5efd569e2f8e2222 |
|
MD5 | 69207c643c6e3b0ec9be1c4ff21d61fc |
|
BLAKE2b-256 | 094001f4f1875945a7dc7e2e19517e03eb34929f50f799aa5d02e22c104da738 |
File details
Details for the file aiokwikset-0.3.0a7-py3-none-any.whl
.
File metadata
- Download URL: aiokwikset-0.3.0a7-py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee12da4d6887a4fe0650adc07c7d5f6340d68b60ae56214af335f0f2bd9e859f |
|
MD5 | 22ed02bcb14995f3a3ef0d3f5ece8ce1 |
|
BLAKE2b-256 | 89c48a7ca3bd3906ac71126f175d70b486b1fff187c10c25b3ea563a6561429e |