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-2023.4.0.tar.gz (110.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-2023.4.0-py3-none-any.whl (119.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vivintpy-2023.4.0.tar.gz
  • Upload date:
  • Size: 110.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.0 Linux/6.5.0-1018-azure

File hashes

Hashes for vivintpy-2023.4.0.tar.gz
Algorithm Hash digest
SHA256 0ca57cf87f2baf5d68b1099e39fb599cd25ad688ec311abe01826479f368a572
MD5 72fc24204e132b1dbea897c076fc6d9e
BLAKE2b-256 bd8d4e21a0ccd34c64c3dc996c54bac5c1159c4e612bc7e50c808115388d43c0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for vivintpy-2023.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6fa3ba4f540e2b3f248352db6d9cc467fffb4a8ffa943dcc8e348a6bcdd7233f
MD5 7e2c537c746e061d4cb8d686670d6b72
BLAKE2b-256 b8c9ad6c4bc1d58796ff82bc7a697138f9ed9de2bd2e37db20ea9b48af15aff3

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