pyyaledoorman

Python library for the Yale Doorman Smart API


License
MIT
Install
pip install pyyaledoorman==1.0.9

Documentation

Pyyaledoorman

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.