Skip to main content

Python library for interacting with a Vivint security and smart home system.

Project description

pypi downloads Buy Me A Coffee/Beer

vivintpy

Python library for interacting with a Vivint security and smart home system.

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

Uploaded Source

Built Distribution

vivintpy-2024.2.1-py3-none-any.whl (122.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vivintpy-2024.2.1.tar.gz
  • Upload date:
  • Size: 112.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.0 Linux/6.5.0-1025-azure

File hashes

Hashes for vivintpy-2024.2.1.tar.gz
Algorithm Hash digest
SHA256 fe534459e31317930a7f086b1151800bded722bd018128861f52ae3eb789639b
MD5 f3303833843fcf21ecb29158a57de3f2
BLAKE2b-256 8e03186673e6295f27d36ddd7138460d716ad34b1b93316cbf2cdd699780b12f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vivintpy-2024.2.1-py3-none-any.whl
  • Upload date:
  • Size: 122.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.0 Linux/6.5.0-1025-azure

File hashes

Hashes for vivintpy-2024.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 829ebf407e67fd914847bc0b40ed9ed10e0afbb81e9c6bee6f778247b6b4dd41
MD5 c6efddbcfad78e653bb561a9831ff379
BLAKE2b-256 68b45053ce9d4983b4d8fb0bd45590ea840bac81596f74e27c685f5fe6b45356

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page