Skip to main content

Python library for interacting with the Vivint Sky API.

Project description

vivintpy

Python library for interacting with the Vivint Sky API.

This was built to support the Vivint integration in Home-Assistant but should work outside of it too. Currently, it can be utilized via HACS by adding the hacs-vivint custom repository.

Credit

This was inspired by the great work done by Mike Reibard to reverse engineer the Vivint Sky API and Ovidiu Stateina for the repository from which this is forked and expanded on.

Features

It currently has support for the following device types:

  • alarm panels
  • cameras
  • door locks
  • garage doors
  • switches
    • binary
    • multilevel
  • thermostats
  • wireless sensors
    • carbon monoxide
    • door/window
    • flood
    • glass break
    • motion
    • smoke/fire
    • etc

In addition, it integrates with PubNub to receive real-time updates for devices. This subscription stops receiving notifications around 15-20 minutes unless a call is made to the Vivint Sky API periodically. This might be related to the cookie expiration since it expires 20 minutes after the last API call was received. If another client connects, however, the notifications start to stream again for all currently connected clients.

Usage

See demo.py for a demonstration on how to use this library.

TODO:

  • write a better readme
  • write some documentation
  • add advanced support for:
    • thermostats
  • add tests

Support Me

I'm not employed by Vivint, and provide this python package as-is.

If you don't already own a Vivint system, please consider using my referal code (kaf164) to get $50 off your bill (as well as a tip to me in appreciation)!

If you already own a Vivint system and still want to donate, consider buying me a coffee ☕ (or beer 🍺) instead by using the link below:

Buy Me A Coffee

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

vivintpy-2021.10.1.tar.gz (71.8 kB view details)

Uploaded Source

Built Distribution

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

vivintpy-2021.10.1-py3-none-any.whl (79.6 kB view details)

Uploaded Python 3

File details

Details for the file vivintpy-2021.10.1.tar.gz.

File metadata

  • Download URL: vivintpy-2021.10.1.tar.gz
  • Upload date:
  • Size: 71.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for vivintpy-2021.10.1.tar.gz
Algorithm Hash digest
SHA256 1780ed9621490284103a0e89ccc46e2671a730c440d890749a43d99c80117b77
MD5 4c1fd14d4a3ece302d9776a82b3489f3
BLAKE2b-256 592fa9d7a579981e10b87d9638215af7e68b94835cd3942dce634d0f324fbfb9

See more details on using hashes here.

File details

Details for the file vivintpy-2021.10.1-py3-none-any.whl.

File metadata

  • Download URL: vivintpy-2021.10.1-py3-none-any.whl
  • Upload date:
  • Size: 79.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for vivintpy-2021.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 75855340a9dfc87f6c8a06c27f3a8d8eff1927c8dc3188b15c3734a4907824bc
MD5 71cf0a97d8cd005766d654d71311ade1
BLAKE2b-256 a1f81a661f53204b5daee867727d29681c72d6622a9459173ccc2d67ff2c9d14

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