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.6.tar.gz (70.6 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.6-py3-none-any.whl (78.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vivintpy-2021.9.6.tar.gz
  • Upload date:
  • Size: 70.6 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.6.tar.gz
Algorithm Hash digest
SHA256 9db5909ab7fe8f77a701eb8d4d6562f96be8179a7eff08e709fa8f4679e9f32b
MD5 7b6bb774fd5378f4a976ba1846033cc5
BLAKE2b-256 2aeaf8ef2d53d84c5182aec963098a1efcdbf17bf40faf34627c67a798fac966

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vivintpy-2021.9.6-py3-none-any.whl
  • Upload date:
  • Size: 78.8 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 460b7246dcc8eb9c85eb205a61a7a315793b32967e51036804b38651714065ef
MD5 1fa38cad6108d7f92e215d774917adc8
BLAKE2b-256 2d753aed5f58cc67c10b6facddeccfe359cb649a0b2d5fad7a082c5029c399f3

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