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.9.7.tar.gz (70.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.9.7-py3-none-any.whl (79.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vivintpy-2021.9.7.tar.gz
  • Upload date:
  • Size: 70.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for vivintpy-2021.9.7.tar.gz
Algorithm Hash digest
SHA256 4d444a28ffb17215ad408f10edd6d9c1db83a7d41f8cec29a6eaf29240ddee28
MD5 6806431795dab2520221e6af5f131236
BLAKE2b-256 4265e24069eb29ab5c298c6459343a4f1360b65acdb9b4627803e5526889ea79

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vivintpy-2021.9.7-py3-none-any.whl
  • Upload date:
  • Size: 79.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for vivintpy-2021.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 5ea8d81c5eb5590c64db94d8a1cc01203104f5c29be838206a8a3a7a1f942035
MD5 2c259f3fd715b4c69776043eb8519d9a
BLAKE2b-256 4b8fe1ba93411d258c6fd90b13c9a36abfeb636e86d754ea44bd84c9bee25098

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