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

Uploaded Source

Built Distribution

vivintpy-2025.0.1-py3-none-any.whl (122.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vivintpy-2025.0.1.tar.gz
  • Upload date:
  • Size: 112.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.0 Linux/6.11.0-1014-azure

File hashes

Hashes for vivintpy-2025.0.1.tar.gz
Algorithm Hash digest
SHA256 0c4d2e70b166f649df7db17a6a6267044b3ea2ae75e1b00edea500e7e03da0b2
MD5 1d272b0e8ca589b863eb573b7886422b
BLAKE2b-256 1640701cefe1d9e22cf64ff310ff68c8c2cc75df805fef6e43964a0f5d8691a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vivintpy-2025.0.1-py3-none-any.whl
  • Upload date:
  • Size: 122.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.0 Linux/6.11.0-1014-azure

File hashes

Hashes for vivintpy-2025.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5cfec14b5dc529c242085138cc65685eb3c927f8bedc64efdfefd1acfb68a0cb
MD5 65ae8132ec0020b716a0b1d723c4fe57
BLAKE2b-256 1f3c2ad870f1823499680761f848917fb0291f8d872011bf1c0762541f6b5326

See more details on using hashes here.

Supported by

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