vivintpy


Namevivintpy JSON
Version 2023.4.0 PyPI version JSON
download
home_pagehttps://github.com/natekspencer/vivintpy
SummaryPython library for interacting with a Vivint security and smart home system.
upload_time2024-04-26 18:36:58
maintainerNone
docs_urlNone
authorNathan Spencer
requires_python<4.0.0,>=3.9.0
licenseMIT
keywords vivint alarm system security smart home home automation asynchronous
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![pypi](https://img.shields.io/pypi/v/vivintpy?style=for-the-badge)](https://pypi.org/project/vivintpy)
[![downloads](https://img.shields.io/pypi/dm/vivintpy?style=for-the-badge)](https://pypi.org/project/vivintpy)
[![Buy Me A Coffee/Beer](https://img.shields.io/badge/Buy_Me_A_☕/🍺-F16061?style=for-the-badge&logo=ko-fi&logoColor=white&labelColor=grey)](https://ko-fi.com/natekspencer)

# vivintpy

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

This was built to support the `Vivint` integration in [Home-Assistant](https://www.home-assistant.io/) but _should_ work outside of it too. Currently, it can be utilized via [HACS](https://hacs.xyz/) by adding the [hacs-vivint](https://github.com/natekspencer/hacs-vivint) custom repository.

## Credit

This was inspired by the great work done by [Mike Reibard](https://github.com/Riebart/vivint.py) to reverse engineer the Vivint Sky API and [Ovidiu Stateina](https://github.com/ovirs/pyvivint) 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)](https://www.vivint.com/get?refCode=kaf164&exid=165211vivint.com/get?refCode=kaf164&exid=165211) 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:

<a href='https://ko-fi.com/natekspencer' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/natekspencer/vivintpy",
    "name": "vivintpy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0.0,>=3.9.0",
    "maintainer_email": null,
    "keywords": "Vivint, alarm system, security, smart home, home automation, asynchronous",
    "author": "Nathan Spencer",
    "author_email": "natekspencer@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bd/8d/4e21a0ccd34c64c3dc996c54bac5c1159c4e612bc7e50c808115388d43c0/vivintpy-2023.4.0.tar.gz",
    "platform": null,
    "description": "[![pypi](https://img.shields.io/pypi/v/vivintpy?style=for-the-badge)](https://pypi.org/project/vivintpy)\n[![downloads](https://img.shields.io/pypi/dm/vivintpy?style=for-the-badge)](https://pypi.org/project/vivintpy)\n[![Buy Me A Coffee/Beer](https://img.shields.io/badge/Buy_Me_A_\u2615/\ud83c\udf7a-F16061?style=for-the-badge&logo=ko-fi&logoColor=white&labelColor=grey)](https://ko-fi.com/natekspencer)\n\n# vivintpy\n\nPython library for interacting with a Vivint security and smart home system.\n\nThis was built to support the `Vivint` integration in [Home-Assistant](https://www.home-assistant.io/) but _should_ work outside of it too. Currently, it can be utilized via [HACS](https://hacs.xyz/) by adding the [hacs-vivint](https://github.com/natekspencer/hacs-vivint) custom repository.\n\n## Credit\n\nThis was inspired by the great work done by [Mike Reibard](https://github.com/Riebart/vivint.py) to reverse engineer the Vivint Sky API and [Ovidiu Stateina](https://github.com/ovirs/pyvivint) for the repository from which this is forked and expanded on.\n\n## Features\n\nIt currently has support for the following device types:\n\n- alarm panels\n- cameras\n- door locks\n- garage doors\n- switches\n  - binary\n  - multilevel\n- thermostats\n- wireless sensors\n  - carbon monoxide\n  - door/window\n  - flood\n  - glass break\n  - motion\n  - smoke/fire\n  - etc\n\nIn 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.\n\n## Usage\n\nSee demo.py for a demonstration on how to use this library.\n\n## TODO:\n\n- write a better readme\n- write some documentation\n- add advanced support for:\n  - thermostats\n- add tests\n\n---\n\n## Support Me\n\nI'm not employed by Vivint, and provide this python package as-is.\n\nIf you don't already own a Vivint system, please consider using [my referal code (kaf164)](https://www.vivint.com/get?refCode=kaf164&exid=165211vivint.com/get?refCode=kaf164&exid=165211) to get $50 off your bill (as well as a tip to me in appreciation)!\n\nIf you already own a Vivint system and still want to donate, consider buying me a coffee \u2615 (or beer \ud83c\udf7a) instead by using the link below:\n\n<a href='https://ko-fi.com/natekspencer' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python library for interacting with a Vivint security and smart home system.",
    "version": "2023.4.0",
    "project_urls": {
        "Homepage": "https://github.com/natekspencer/vivintpy",
        "Repository": "https://github.com/natekspencer/vivintpy"
    },
    "split_keywords": [
        "vivint",
        " alarm system",
        " security",
        " smart home",
        " home automation",
        " asynchronous"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b8c9ad6c4bc1d58796ff82bc7a697138f9ed9de2bd2e37db20ea9b48af15aff3",
                "md5": "7e2c537c746e061d4cb8d686670d6b72",
                "sha256": "6fa3ba4f540e2b3f248352db6d9cc467fffb4a8ffa943dcc8e348a6bcdd7233f"
            },
            "downloads": -1,
            "filename": "vivintpy-2023.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7e2c537c746e061d4cb8d686670d6b72",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.9.0",
            "size": 119945,
            "upload_time": "2024-04-26T18:36:56",
            "upload_time_iso_8601": "2024-04-26T18:36:56.945066Z",
            "url": "https://files.pythonhosted.org/packages/b8/c9/ad6c4bc1d58796ff82bc7a697138f9ed9de2bd2e37db20ea9b48af15aff3/vivintpy-2023.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd8d4e21a0ccd34c64c3dc996c54bac5c1159c4e612bc7e50c808115388d43c0",
                "md5": "72fc24204e132b1dbea897c076fc6d9e",
                "sha256": "0ca57cf87f2baf5d68b1099e39fb599cd25ad688ec311abe01826479f368a572"
            },
            "downloads": -1,
            "filename": "vivintpy-2023.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "72fc24204e132b1dbea897c076fc6d9e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0.0,>=3.9.0",
            "size": 110772,
            "upload_time": "2024-04-26T18:36:58",
            "upload_time_iso_8601": "2024-04-26T18:36:58.707738Z",
            "url": "https://files.pythonhosted.org/packages/bd/8d/4e21a0ccd34c64c3dc996c54bac5c1159c4e612bc7e50c808115388d43c0/vivintpy-2023.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-26 18:36:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "natekspencer",
    "github_project": "vivintpy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "vivintpy"
}
        
Elapsed time: 0.31339s