myq.py

# Support for MyQ garage doors.
#
# For more details about this platform, please refer to the forum at
# https://community.home-assistant.io/t/myq-componenet-issues/1860/195

import logging
import requests

from homeassistant.components.cover import CoverDevice
from homeassistant.const import CONF_USERNAME, CONF_PASSWORD, STATE_OPEN, STATE_CLOSED

DEPENDENCIES = []

CONF_BRAND = 'brand'

DEFAULT_NAME = 'myq'

LIFTMASTER = 'liftmaster'
CHAMBERLAIN = 'chamberlain'
CRAFTSMAN = 'craftsman'
MERLIN = 'merlin'

SUPPORTED_BRANDS = [LIFTMASTER, CHAMBERLAIN, CRAFTSMAN, MERLIN]
SUPPORTED_DEVICE_TYPE_NAMES = ['GarageDoorOpener', 'Garage Door Opener WGDO', 'VGDO']

APP_ID = 'app_id'
HOST_URI = 'myqexternal.myqdevice.com'

BRAND_MAPPINGS = {
    LIFTMASTER: {
        APP_ID: 'Vj8pQggXLhLy0WHahglCD4N1nAkkXQtGYpq2HrHD7H1nvmbT55KqtN6RSF4ILB/i'
    },
    CHAMBERLAIN: {
        APP_ID: 'OA9I/hgmPHFp9RYKJqCKfwnhh28uqLJzZ9KOJf1DXoo8N2XAaVX6A1wcLYyWsnnv'
    },
    CRAFTSMAN: {
        APP_ID: 'YmiMRRS1juXdSd0KWsuKtHmQvh5RftEp5iewHdCvsNB77FnQbY+vjCVn2nMdIeN8'
    },
    MERLIN: {
        APP_ID: '3004cac4e920426c823fa6c2ecf0cc28ef7d4a7b74b6470f8f0d94d6c39eb718'
    }
}

def setup_platform(hass, config, add_devices, discovery_info=None):
    """Set up the MyQ garage door."""

    username = config.get(CONF_USERNAME)
    password = config.get(CONF_PASSWORD)

    logger = logging.getLogger(__name__)

    if username is None or password is None:
        logger.error("MyQ Cover - Missing username or password.")
        return

    try:
        brand = BRAND_MAPPINGS[config.get(CONF_BRAND)];
    except KeyError:
        logger.error("MyQ Cover - Missing or unsupported brand. Supported brands: %s", ', '.join(SUPPORTED_BRANDS))
        return

    myq = MyQAPI(username, password, brand, logger)

    add_devices(MyQCoverDevice(myq, door) for door in myq.get_garage_doors())


class MyQAPI(object):
    """Class for interacting with the MyQ iOS App API."""

    LOGIN_ENDPOINT = "api/v4/User/Validate"
    DEVICE_LIST_ENDPOINT = "api/v4/UserDeviceDetails/Get"
    DEVICE_SET_ENDPOINT = "api/v4/DeviceAttribute/PutDeviceAttribute"
    USERAGENT = "Chamberlain/3773 (iPhone; iOS 10.0.1; Scale/2.00)"

    DOOR_STATE = {
        '1': STATE_OPEN, #'open',
        '2': STATE_CLOSED, #'close',
        '4': STATE_OPEN, #'opening',
        '5': STATE_CLOSED, #'closing',
        '8': STATE_OPEN, #'in_transition',
        '9': STATE_OPEN, #'open'
    }

    def __init__(self, username, password, brand, logger):
        """Initialize the API object."""
        self.username = username
        self.password = password
        self.brand = brand
        self._logger = logger;
        self.security_token = None
        self._logged_in = False

    def login(self):
        """Log in to the MyQ service."""

        params = {
            'username': self.username,
            'password': self.password
        }

        login = requests.post(
            'https://{host_uri}/{login_endpoint}'.format(
                host_uri=HOST_URI,
                login_endpoint=self.LOGIN_ENDPOINT),
                json=params,
                headers={
                    'MyQApplicationId': self.brand[APP_ID],
                    'User-Agent': self.USERAGENT
                }
        )

        auth = login.json()
        self.security_token = auth['SecurityToken']
        self._logger.debug('Logged in to MyQ API')
        return True

    def get_devices(self):
        """List all MyQ devices."""

        if not self._logged_in:
            self._logged_in = self.login()

        devices = requests.get(
            'https://{host_uri}/{device_list_endpoint}'.format(
                host_uri=HOST_URI,
                device_list_endpoint=self.DEVICE_LIST_ENDPOINT),
                headers={
                    'MyQApplicationId': self.brand[APP_ID],
                    'SecurityToken': self.security_token,
                    'User-Agent': self.USERAGENT
                }
        )

        devices = devices.json()['Devices']

        return devices

    def get_garage_doors(self):
        """List only MyQ garage door devices."""

        devices = self.get_devices()

        garage_doors = []

        for device in devices:
            if device['MyQDeviceTypeName'] in SUPPORTED_DEVICE_TYPE_NAMES:
                dev = {}
                for attribute in device['Attributes']:
                    if attribute['AttributeDisplayName'] == 'desc':
                        dev['deviceid'] = device['MyQDeviceId']
                        dev['name'] = attribute['Value']
                        garage_doors.append(dev)

        return garage_doors

    def get_status(self, device_id):
        """List only MyQ garage door devices."""

        devices = self.get_devices()

        for device in devices:
            if device['MyQDeviceTypeName'] in SUPPORTED_DEVICE_TYPE_NAMES and device['MyQDeviceId'] == device_id:
                dev = {}
                for attribute in device['Attributes']:
                   if attribute['AttributeDisplayName'] == 'doorstate':
                        garage_state = attribute['Value']

        garage_state = self.DOOR_STATE[garage_state]
        return garage_state

    def close_device(self, device_id):
        """Close MyQ Device."""
        return self.set_state(device_id, '0')

    def open_device(self, device_id):
        """Open MyQ Device."""
        return self.set_state(device_id, '1')

    def set_state(self, device_id, state):
        """Set device state."""
        payload = {
            'attributeName': 'desireddoorstate',
            'myQDeviceId': device_id,
            'AttributeValue': state,
        }
        device_action = requests.put(
            'https://{host_uri}/{device_set_endpoint}'.format(
                host_uri=HOST_URI,
                device_set_endpoint=self.DEVICE_SET_ENDPOINT),
                data=payload,
                headers={
                    'MyQApplicationId': self.brand[APP_ID],
                    'SecurityToken': self.security_token,
                    'User-Agent': self.USERAGENT
                }
        )

        return device_action.status_code == 200


class MyQCoverDevice(CoverDevice):
    """Representation of a MyQ cover."""

    def __init__(self, myq, device):
        """Initialize with API object, device id"""
        self.myq = myq
        self.device_id = device['deviceid']
        self._name = device['name']
        self._status = STATE_CLOSED

    @property
    def should_poll(self):
        """Poll for state."""
        return True

    @property
    def name(self):
        """Return the name of the garage door if any."""
        return self._name if self._name else DEFAULT_NAME

    @property
    def is_closed(self):
        """Return True if cover is closed, else False."""
        return self._status == STATE_CLOSED

    def close_cover(self):
        """Issue close command to cover."""
        self.myq.close_device(self.device_id)

    def open_cover(self):
        """Issue open command to cover."""
        self.myq.open_device(self.device_id)

    def update(self):
        self._status = self.myq.get_status(self.device_id)