Skip to main content

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

pip install pymyq

Usage

pymyq starts within an aiohttp ClientSession:

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:

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 awaited.

  • 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.
  • close_connection: close web session connection, will only close the web session if none was provided initially

Disclaimer

The code here is based off of an unsupported API from Chamberlain 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pymyq, version 1.2.1
Filename, size File type Python version Upload date Hashes
Filename, size pymyq-1.2.1-py2.py3-none-any.whl (9.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size pymyq-1.2.1.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page