Skip to main content

Python library for interacting with Vivint Sky API

Project description

pyVivintSky

A Python library for interacting with Vivint Sky API.

I own a system by Vivint and was annoyed when I found they didn't post any information about how the API works. After looking over the internet I was able to find a few pieces of information and one gem written by Tim Harper. The homebridge site makes a claim that Tim used to be a Vivint employee which I have no reason to doubt and honestly his work would require some type of inside knowledge to the API.

My intent here was to combine all the work that has been done over the last couple of years and combine them into a working library so I can add an integration to the Home Automation System called Home Assistant (https://www.home-assistant.io/).

Credit

Name Description Link
Tim Harper Tim released a version for Homebridge with very useful information on how the API works. This served as the main basis for how I wrote the integration. https://github.com/timcharper/homebridge-vivint
Reibart Reibart did a lot work trying to reverse the API via browser calls. I used the information from this project to enhance this one. https://github.com/Riebart/vivint.py
Ovirs Ovirs has some additions he made to Reibart work above and it contains information on other devices. https://github.com/ovirs/pyvivint
jhutchins JHutchins did a homework project using the devices and his site contains some infmormatio on the thermostat API calls. https://github.com/jhutchins/vivint

Features

Authentication

Authentication is handled currently via username and password. I would recommend setting up a user on Vivint for just this purpose. This makes it easy to distinguish when events are coming from automation.

This does direct calls to the Vivint API and stores a session key that last 20 mins by default. I then check for the expiration of this key on each call in the future login again if its expired.

PubNub

Message states and changes to devices are handled by PubNub. This API subscribes to the panels PubNub channel and is able to handle messages like doors opening and closing.

Devices

Panel

This is the root device and all child devices are attached to it. Looking at the API its possible for an account to have more than one panel and this makes attempts to handle that.

Feature Status
Armed State In Progress
Update State Not Implemented Yet
PubNub Not Implemented Yet

Wireless Sensors

These are any device that remotely connect to the sytem via wifi. This includes door sensors, break glass, and motion detectors.

Feature Status
Name Working
State Working
PubNub Working

Thermostat

I don't own one of these yet but there is enough information on the other sites I think to implement the features.

Feature Status

Door Locks

I don't own any of these but there is enough information on the other sites I think to implement the features.

Feature Status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyVivintSky, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size pyVivintSky-0.0.2-py3-none-any.whl (9.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyVivintSky-0.0.2.tar.gz (7.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page