Skip to main content

Python library for the Yale Doorman Smart API

Project description

PyPI Python Version License

Read the documentation at https://pyyaledoorman.readthedocs.io/ Tests Codecov

pre-commit Black

A Python library for interfacing with the Yale Doorman Home API.

Features

  • Read whether lock is unlocked, locked, or door open

  • Locking / Unlocking

  • Enabling / Disabling auto lock

  • Reading Volume level, Language, Auto lock disabled/enabled

Requirements

  • Yale Doorman home user account.

Installation

You can install Pyyaledoorman via pip from PyPI:

$ pip install pyyaledoorman

Usage

Please see Usage for details.

import pyyaledoorman
import aiohttp
import asyncio
import pyyaledoorman


async def main():
    async with aiohttp.ClientSession() as session:
        client = pyyaledoorman.Client(
            "username",
            "password",
            session=session,
        )
        assert await client.login() == True
        await client.update_devices()

        for device in client.devices:
            print(device.name)
            await device.disable_autolock()
            await device.unlock(pincode="123456")


loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Pyyaledoorman is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.

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

pyyaledoorman-1.0.9.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

pyyaledoorman-1.0.9-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file pyyaledoorman-1.0.9.tar.gz.

File metadata

  • Download URL: pyyaledoorman-1.0.9.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for pyyaledoorman-1.0.9.tar.gz
Algorithm Hash digest
SHA256 1de21caa10ce91b7bb1dad5aa3af4236bf23a7b395602d064cad3a544a5e7593
MD5 25c8218fd1f36f8ec752f0eec004b2e8
BLAKE2b-256 89538e557c372612ff47a867a2ca6c7ebc2ce87bc46ffdcd9542abe88b1005ce

See more details on using hashes here.

File details

Details for the file pyyaledoorman-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: pyyaledoorman-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for pyyaledoorman-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e518ee4a6007e118cb9bf2a64b941a0b154710761447a7cc126da804f08f7c76
MD5 a41bf3b951be57aef8d0bb0677f759fd
BLAKE2b-256 d7a78ec5e5c96c818903c1342aeeab222e75e9757fa5146dc0dd98d1995cebf7

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