Skip to main content

Python library for interacting with the Vivint Sky API.

Project description

pypi Buy Me A Coffee/Beer

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 at ko-fi.com

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-2022.6.0.tar.gz (73.7 kB view details)

Uploaded Source

Built Distribution

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

vivintpy-2022.6.0-py3-none-any.whl (81.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vivintpy-2022.6.0.tar.gz
  • Upload date:
  • Size: 73.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.0

File hashes

Hashes for vivintpy-2022.6.0.tar.gz
Algorithm Hash digest
SHA256 01182c3fbdfac7dccdb9e12c3659028ff9c6ffa107a62b6f8255734df43853f1
MD5 7ccea1426b34fbaa2f10eaf0c1d0a0ac
BLAKE2b-256 9bfe70b6cf61ef798407315136ce9758ef35ff8c4d66c7703a543bdb54a7c906

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vivintpy-2022.6.0-py3-none-any.whl
  • Upload date:
  • Size: 81.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.0

File hashes

Hashes for vivintpy-2022.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b345e562bb621c80fb3c245591e5cb5d1e317e350a655976be69a6573035dbed
MD5 1e42f6714c894e2dffb13eb359f61e2e
BLAKE2b-256 92a9ac644dc9c36ecfb85c9ecc4afaeaac039a0ce910e136b8c8dad8d739baf9

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