Skip to main content

Python module to interact with VivintSky API.

Project description

pyvivint

python library for interacting with vivintsky API

This was built to support the Vivint integration in home-assistant but should work outside of it too. It can run on an existing ioloop or create its own if one is not provided.

Credit

This was inspired by the great work done by Mike Reibard to reverse engineer the VivintSky API and it shamelessly reuses most of his code.

Features

It currently has support for the following device types:

  • alarm panels
  • cameras
  • door locks
  • garage doors
  • 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 the devices. This subscription stops receiving notifications around 15-20 minutes unless a call is made to the VivintSky 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
  • add tests
  • write some documentation
  • add device support for:
    • multi-level switches
    • thermostats
  • implement 2FA

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

pyvivint-2021.1.1.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

pyvivint-2021.1.1-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file pyvivint-2021.1.1.tar.gz.

File metadata

  • Download URL: pyvivint-2021.1.1.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5

File hashes

Hashes for pyvivint-2021.1.1.tar.gz
Algorithm Hash digest
SHA256 1b24f9b7ca3982406204e2af6cffa8b54b0fbfd0ed0cf4576026755d51b329b1
MD5 6c614a4f35811d86c304412c046ea491
BLAKE2b-256 fe8594eac728970c148b4d8790df5015c93ce06c89b8e84965de8fd8b2612b5d

See more details on using hashes here.

File details

Details for the file pyvivint-2021.1.1-py3-none-any.whl.

File metadata

  • Download URL: pyvivint-2021.1.1-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5

File hashes

Hashes for pyvivint-2021.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 42d78d148d965c0107ad7f8269caf8f5a040cdcf8c96fe0408200232cd072803
MD5 437d756819fd1c1e8ba716a3eccfa2e7
BLAKE2b-256 93551d8c53f9d7374720761f470b13da6519e439422ba3f8be4025298870a705

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