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.3.8.tar.gz (109.2 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.3.8-py3-none-any.whl (118.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vivintpy-2023.3.8.tar.gz
Algorithm Hash digest
SHA256 441dbd4bec0f9d2b65c8a7eeea8eef04c55923c1c3d677ca6900f27a6b73a6f6
MD5 4ec92db50af3d827484c784f01607588
BLAKE2b-256 3fd93fedf2aa62813c782431ab8edbc52a5316213910c480bae14aee2477592f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for vivintpy-2023.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e61247cd7a91143b88d1cf8ad4afec9eb3f101df4b8796645a840846c27fe036
MD5 c9b3d135c9690a345c0d3db4f51ee401
BLAKE2b-256 a668b9818c1c36b635323f352f06664f6e2c687937e7fa636d01f8e6b4cb9d17

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