Skip to main content

Control Kwikset Kevo locks

Project description

Python module for controlling Kwikset Kevo locks

Kwikset does not provide an official API for their Kevo locks; I reverse engineered this module from the mykevo.com web app.

To use this module you will need to have a Kevo Plus installed and a registered account on mykevo.com. You will need your mykevo.com credentials to use this module.

This module is published to pypi so you can install it simply via pip install pykevoplus

Usage

The Kevo.GetLocks() function will attempt to scrape the mykevo.com web site to find your locks; as of this writing it can find all of your locks, but scraping the HTML might break at any time if Kwikset changes the website.

from pykevoplus import Kevo
locks = Kevo.GetLocks("username@email.com", "password123")
for lock in locks:
    print repr(lock)

Output:

KevoLock(name=Front Door, id=cca7cd1d-c1d5-43ce-a087-c73b974b3529, state=Locked)
KevoLock(name=Back Door, id=c60130cd-8139-4688-8ba3-199276a65ad6, state=Locked)

A better way is to explicitly instantiate a KevoLock object using the UUID of the lock. You can get the lock IDs manually by logging into mykevo.com, click Details for the lock, click Settings, the lock ID is on the right.

from pykevoplus import KevoLock
lock = KevoLock.FromLockID("cca7cd1d-c1d5-43ce-a087-c73b974b3529", "username@email.com", "password123")

Locking and Unlocking

from pykevoplus import KevoLock
lock = KevoLock.FromLockID(lock_id, username, password)
lock.Unlock()
print lock.GetBoltState()
lock.Lock()
print lock.GetBoltState()

Output:

Unlocked
Locked

Multiple operations in the same session

The KevoLockSession context manager allows you to perform multiple operations on a lock with a single auth session

from pykevoplus import KevoLock, KevoLockSession
lock = KevoLock.FromLockID(lock_id, username, password)
with KevoLockSession(lock):
    lock.Unlock()
    lock.Lock()

Known Issues

  • Error handling is extremely basic and needs much more work. Communication errors as well as lock bolt errors need to be addressed

  • No unit tests yet

  • Currently only python 2.7 support

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

pykevoplus-1.0.1.tar.gz (4.7 kB view details)

Uploaded Source

Built Distributions

pykevoplus-1.0.1-py2.7.egg (9.1 kB view details)

Uploaded Source

pykevoplus-1.0.1-py2-none-any.whl (6.9 kB view details)

Uploaded Python 2

File details

Details for the file pykevoplus-1.0.1.tar.gz.

File metadata

  • Download URL: pykevoplus-1.0.1.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pykevoplus-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ec847a92d0a3b89e4b32475915fd7b85f66b27fa22a8779d91913e7c8d2f3397
MD5 e5d5d18b2ad96489f162970b404478cb
BLAKE2b-256 3c7f84b59f43a2dbdcfebaf2ad6fb8cbb09c5dc8d1a33d9e4a08026ff99b5a53

See more details on using hashes here.

File details

Details for the file pykevoplus-1.0.1-py2.7.egg.

File metadata

File hashes

Hashes for pykevoplus-1.0.1-py2.7.egg
Algorithm Hash digest
SHA256 7ec9bad3df4a7b0b39e9d565ab40abe957f385b0babdb69b99e050cbddeddb37
MD5 bb617c34706580673abdb1e8de11f939
BLAKE2b-256 c8da86cbfb883c891040439e036edf0d0a9e146ac0dbf790755f8e6680bcda85

See more details on using hashes here.

File details

Details for the file pykevoplus-1.0.1-py2-none-any.whl.

File metadata

File hashes

Hashes for pykevoplus-1.0.1-py2-none-any.whl
Algorithm Hash digest
SHA256 496e0812fe751b71248a79854da12f4006f27cbbd6e5bc66040db15d339950dd
MD5 09025cad372e97f0d837823792c7cccb
BLAKE2b-256 f76cc532a2ec40693b96bd80cbed9ccce88f1a5b7acd1a5815720796d7a71403

See more details on using hashes here.

Supported by

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