Python package for controlling MyQ-Enabled Garage Door
Project description
# Introduction
This is a Python 3.5+ module aiming to interact with the Chamberlain MyQ API.
Code is licensed under the MIT license.
# Getting Started
## Installation
```python
pip install pymyq
```
## Usage
`pymyq` starts within an [aiohttp](https://aiohttp.readthedocs.io/en/stable/)
`ClientSession`:
```python
import asyncio
from aiohttp import ClientSession
async def main() -> None:
"""Create the aiohttp session and run."""
async with ClientSession() as websession:
# YOUR CODE HERE
asyncio.get_event_loop().run_until_complete(main())
```
To get all MyQ devices associated with an account:
```python
import asyncio
from aiohttp import ClientSession
import pymyq
async def main() -> None:
"""Create the aiohttp session and run."""
async with ClientSession() as websession:
# Valid Brands: 'chamberlain', 'craftsman', 'liftmaster', 'merlin'
myq = await pymyq.login('<EMAIL>', '<PASSWORD>', '<BRAND>', websession)
# Return only cover devices:
devices = await myq.get_devices()
# Return *all* devices:
devices = await myq.get_devices(covers_only=False)
asyncio.get_event_loop().run_until_complete(main())
```
## Device Properties
* `brand`: the brand of the device
* `device_id`: the device's MyQ ID
* `parent_id`: the device's parent device's MyQ ID
* `name`: the name of the device
* `available`: if device is online
* `serial`: the serial number of the device
* `state`: the device's current state
* `type`: the type of MyQ device
* `open_allowed`: if device can be opened unattended
* `close_allowed`: if device can be closed unattended
## Methods
All of the routines on the `MyQDevice` class are coroutines and need to be
`await`ed.
* `close`: close the device
* `open`: open the device
* `update`: get the latest device state (which can then be accessed via the
`state` property). Retrieval of state from cloud is will only be done if more then 5 seconds has elapsed since last
request. State for all devices is retrieved through (1) request.
# Disclaimer
The code here is based off of an unsupported API from
[Chamberlain](http://www.chamberlain.com/) and is subject to change without
notice. The authors claim no responsibility for damages to your garage door or
property by use of the code within.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pymyq-1.1.0.tar.gz
(7.8 kB
view hashes)
Built Distribution
Close
Hashes for pymyq-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c91008632535a4dd4707aabf7268f6d9c83f3060a8336f3fed0618c567701a72 |
|
MD5 | 68773b08a1b3821b6976d7e458904259 |
|
BLAKE2b-256 | 051102118a08beadd3b80ef9f95ef125d94881cd2ed0db3b7ce97711de748b56 |