Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.
/ pykevoplus Public archive

Python module for controlling Kwikset Kevo locks

License

Notifications You must be signed in to change notification settings

cseelye/pykevoplus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pykevoplus

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. This is broken as of 9 Sep 2019 due to recent CAPTCHA changes on the Kevo web site, however the KevoLock.FromLockID() method still works.

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

About

Python module for controlling Kwikset Kevo locks

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages