Skip to main content

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
    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_info, user_info)


asyncio.run(main())

Known Issues

  • not all APIs supported

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

aiokwikset-0.1.0b4.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiokwikset-0.1.0b4-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file aiokwikset-0.1.0b4.tar.gz.

File metadata

  • Download URL: aiokwikset-0.1.0b4.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for aiokwikset-0.1.0b4.tar.gz
Algorithm Hash digest
SHA256 c835bada827e41f35963f699a66e28983b3dfa79974db90ebc7d2bba15638196
MD5 e1bbf6f02b3b7cfd5768efc19bde33b8
BLAKE2b-256 4975d938dc776507d780e661fdf099b0e18ec185e96241769a73f93f40b9c7dc

See more details on using hashes here.

File details

Details for the file aiokwikset-0.1.0b4-py3-none-any.whl.

File metadata

  • Download URL: aiokwikset-0.1.0b4-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for aiokwikset-0.1.0b4-py3-none-any.whl
Algorithm Hash digest
SHA256 268be63144e03e96be39837047a787d162a99599b102308dbdbc72b877651df0
MD5 d799d1345038faf995ab964ae080c13f
BLAKE2b-256 753efa44eb6b10f75eb18db9abe59a524433cec007c9dbc06090d74faa6f0a68

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page