pypetwalk


Namepypetwalk JSON
Version 1.1.2 PyPI version JSON
download
home_pagehttps://github.com/p0l0/pypetwalk
SummaryPython library to communicate with the petWALK.control module
upload_time2024-01-17 11:19:05
maintainer
docs_urlNone
authorMarco Neumann
requires_python>=3.11
licenseMIT License
keywords petwalk petwalk.control home automation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage 
            # pypetwalk

<p align="center">
    <a href="https://www.petwalk.at" target="_blank"><img src="https://www.petwalk.at/downloads_public/press/pics/petWALK-logo_(en).jpg" alt="PetWALK" /></a>
</p>

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypetwalk?logo=python)
[![PyPI release](https://img.shields.io/pypi/v/pypetwalk)](https://pypi.org/project/pypetwalk/)
![Release status](https://img.shields.io/pypi/status/pypetwalk)
![Build Pipeline](https://img.shields.io/github/actions/workflow/status/p0l0/pypetwalk/ci.yml)
[![codecov](https://codecov.io/gh/p0l0/pypetwalk/branch/main/graph/badge.svg?token=V5C2O6SK2O)](https://codecov.io/gh/p0l0/pypetwalk)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=f8b424)](https://github.com/pre-commit/pre-commit)
![License](https://img.shields.io/github/license/p0l0/pypetwalk)

`pypetwalk` is a Python 3 (>= 3.11) library to communicate with the petWALK.control module.

It is intended to be used in custom_component [hapetwalk](https://github.com/p0l0/hapetwalk) for [Home Assistant](https://www.home-assistant.io/).

Implementation is based on the [petWALK.control local API (beta) (1.0.0)](https://control.petwalk.solutions/doc/api/) and some reverse engineering of the internal Websocket and AWS communication.

Available functions and their implementation status:

- [x] Activate/deactivate Brightness sensor (API)
- [x] Activate/deactivate Motion In (API)
- [x] Activate/deactivate Motion Out (API)
- [x] Activate/deactivate Rfid (API)
- [x] Activate/deactivate Time (API)
- [x] Open/close door (API)
- [x] Turn on/off the door (API)
- [x] Get Device Info (Websocket)
- [ ] Factory reset (Websocket)
- [ ] _Init drive start_ (Websocket)
- [ ] Delete RFID tag (Websocket)
- [ ] Delete all RFID tags (Websocket)
- [ ] Delete Pet RFID tag (Websocket)
- [ ] Start RFID tag Learning (Websocket)
- [ ] Stop RFID tag Learning (Websocket)
- [ ] Check if RFID Tag exists (Websocket)
- [ ] Get RFID tag list (Websocket)
- [ ] Set system time (Websocket)
- [ ] Get Wlan network list (Websocket)
- [ ] Set Wlan network (Websocket)
- [ ] Scan for Wlan networks (Websocket)
- [ ] ZigBee join allowed (Websocket)
- [ ] ZigBee confirm join (Websocket)
- [ ] ZigBee list devices (Websocket)
- [ ] ZigBee name device (Websocket)
- [ ] ZigBee remove device (Websocket)
- [ ] ZigBee update (Websocket)
- [x] Update Infos (AWS)
- [x] Get Notification Settings (AWS)
- [x] Get Timeline (AWS)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/p0l0/pypetwalk",
    "name": "pypetwalk",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "",
    "keywords": "petwalk,petwalk.control,home,automation",
    "author": "Marco Neumann",
    "author_email": "pypetwalk@binware.dev",
    "download_url": "https://files.pythonhosted.org/packages/12/4f/c7c70e4e967ea4a656eb5f6b2245e25998047d8fe6d45238d29b82ac9795/pypetwalk-1.1.2.tar.gz",
    "platform": "any",
    "description": "# pypetwalk\n\n<p align=\"center\">\n    <a href=\"https://www.petwalk.at\" target=\"_blank\"><img src=\"https://www.petwalk.at/downloads_public/press/pics/petWALK-logo_(en).jpg\" alt=\"PetWALK\" /></a>\n</p>\n\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypetwalk?logo=python)\n[![PyPI release](https://img.shields.io/pypi/v/pypetwalk)](https://pypi.org/project/pypetwalk/)\n![Release status](https://img.shields.io/pypi/status/pypetwalk)\n![Build Pipeline](https://img.shields.io/github/actions/workflow/status/p0l0/pypetwalk/ci.yml)\n[![codecov](https://codecov.io/gh/p0l0/pypetwalk/branch/main/graph/badge.svg?token=V5C2O6SK2O)](https://codecov.io/gh/p0l0/pypetwalk)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=f8b424)](https://github.com/pre-commit/pre-commit)\n![License](https://img.shields.io/github/license/p0l0/pypetwalk)\n\n`pypetwalk` is a Python 3 (>= 3.11) library to communicate with the petWALK.control module.\n\nIt is intended to be used in custom_component [hapetwalk](https://github.com/p0l0/hapetwalk) for [Home Assistant](https://www.home-assistant.io/).\n\nImplementation is based on the [petWALK.control local API (beta) (1.0.0)](https://control.petwalk.solutions/doc/api/) and some reverse engineering of the internal Websocket and AWS communication.\n\nAvailable functions and their implementation status:\n\n- [x] Activate/deactivate Brightness sensor (API)\n- [x] Activate/deactivate Motion In (API)\n- [x] Activate/deactivate Motion Out (API)\n- [x] Activate/deactivate Rfid (API)\n- [x] Activate/deactivate Time (API)\n- [x] Open/close door (API)\n- [x] Turn on/off the door (API)\n- [x] Get Device Info (Websocket)\n- [ ] Factory reset (Websocket)\n- [ ] _Init drive start_ (Websocket)\n- [ ] Delete RFID tag (Websocket)\n- [ ] Delete all RFID tags (Websocket)\n- [ ] Delete Pet RFID tag (Websocket)\n- [ ] Start RFID tag Learning (Websocket)\n- [ ] Stop RFID tag Learning (Websocket)\n- [ ] Check if RFID Tag exists (Websocket)\n- [ ] Get RFID tag list (Websocket)\n- [ ] Set system time (Websocket)\n- [ ] Get Wlan network list (Websocket)\n- [ ] Set Wlan network (Websocket)\n- [ ] Scan for Wlan networks (Websocket)\n- [ ] ZigBee join allowed (Websocket)\n- [ ] ZigBee confirm join (Websocket)\n- [ ] ZigBee list devices (Websocket)\n- [ ] ZigBee name device (Websocket)\n- [ ] ZigBee remove device (Websocket)\n- [ ] ZigBee update (Websocket)\n- [x] Update Infos (AWS)\n- [x] Get Notification Settings (AWS)\n- [x] Get Timeline (AWS)\n\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Python library to communicate with the petWALK.control module",
    "version": "1.1.2",
    "project_urls": {
        "Download": "https://github.com/p0l0/pypetwalk/tarball/1.1.2",
        "Homepage": "https://github.com/p0l0/pypetwalk"
    },
    "split_keywords": [
        "petwalk",
        "petwalk.control",
        "home",
        "automation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "346d8c6f6ee5ad0ad8804afbcee8d3e158fc865713ecda35a02ced7bdb46580f",
                "md5": "82932ee7b7eec5288a2af24e7b274b0e",
                "sha256": "b5a17464f1802231039540af22d111299f1c8e4536f337d40963da2f74c684e4"
            },
            "downloads": -1,
            "filename": "pypetwalk-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "82932ee7b7eec5288a2af24e7b274b0e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 17054,
            "upload_time": "2024-01-17T11:19:03",
            "upload_time_iso_8601": "2024-01-17T11:19:03.370405Z",
            "url": "https://files.pythonhosted.org/packages/34/6d/8c6f6ee5ad0ad8804afbcee8d3e158fc865713ecda35a02ced7bdb46580f/pypetwalk-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "124fc7c70e4e967ea4a656eb5f6b2245e25998047d8fe6d45238d29b82ac9795",
                "md5": "adc55a838c19c2f74b0a14aaf2888b5c",
                "sha256": "d03144440c7d00c293d205c32d2974bf8fb85a299c19cfd51b426a675845680c"
            },
            "downloads": -1,
            "filename": "pypetwalk-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "adc55a838c19c2f74b0a14aaf2888b5c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 15263,
            "upload_time": "2024-01-17T11:19:05",
            "upload_time_iso_8601": "2024-01-17T11:19:05.234276Z",
            "url": "https://files.pythonhosted.org/packages/12/4f/c7c70e4e967ea4a656eb5f6b2245e25998047d8fe6d45238d29b82ac9795/pypetwalk-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-17 11:19:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "p0l0",
    "github_project": "pypetwalk",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "pypetwalk"
}
Marco Neumann
Elapsed time: 0.17549s