From bd51143ac193780b8d08d5058b452c8d53b60c33 Mon Sep 17 00:00:00 2001
From: David Broadfoot <dbroadfoot@gmail.com>
Date: Fri, 6 Apr 2018 23:53:00 +1000
Subject: [PATCH] Added gogogate2 cover (#13467)
* Added gogogate2 cover
* Hound fixes
* PR feedback
* Hound comments
* Bump gogogate2 version
* Update requirements all
* Add device_class and features
* Fix lint issues
* Again lint
* Fix imports
* Fix end of file
---
.coveragerc | 1 +
homeassistant/components/cover/gogogate2.py | 120 ++++++++++++++++++++
requirements_all.txt | 3 +
3 files changed, 124 insertions(+)
create mode 100644 homeassistant/components/cover/gogogate2.py
diff --git a/.coveragerc b/.coveragerc
index a84a739151c..e9c69d137e2 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -352,6 +352,7 @@ omit =
homeassistant/components/climate/touchline.py
homeassistant/components/climate/venstar.py
homeassistant/components/cover/garadget.py
+ homeassistant/components/cover/gogogate2.py
homeassistant/components/cover/homematic.py
homeassistant/components/cover/knx.py
homeassistant/components/cover/myq.py
diff --git a/homeassistant/components/cover/gogogate2.py b/homeassistant/components/cover/gogogate2.py
new file mode 100644
index 00000000000..c2bdc9c5472
--- /dev/null
+++ b/homeassistant/components/cover/gogogate2.py
@@ -0,0 +1,120 @@
+"""
+Support for Gogogate2 Garage Doors.
+
+For more details about this platform, please refer to the documentation
+https://home-assistant.io/components/cover.gogogate2/
+"""
+import logging
+
+import voluptuous as vol
+
+from homeassistant.components.cover import (
+ CoverDevice, SUPPORT_OPEN, SUPPORT_CLOSE)
+from homeassistant.const import (
+ CONF_USERNAME, CONF_PASSWORD, STATE_CLOSED, STATE_UNKNOWN,
+ CONF_IP_ADDRESS, CONF_NAME)
+import homeassistant.helpers.config_validation as cv
+
+REQUIREMENTS = ['pygogogate2==0.0.3']
+
+_LOGGER = logging.getLogger(__name__)
+
+DEFAULT_NAME = 'gogogate2'
+
+NOTIFICATION_ID = 'gogogate2_notification'
+NOTIFICATION_TITLE = 'Gogogate2 Cover Setup'
+
+COVER_SCHEMA = vol.Schema({
+ vol.Required(CONF_USERNAME): cv.string,
+ vol.Required(CONF_PASSWORD): cv.string,
+ vol.Required(CONF_IP_ADDRESS): cv.string,
+ vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
+})
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+ """Set up the Gogogate2 component."""
+ from pygogogate2 import Gogogate2API as pygogogate2
+
+ username = config.get(CONF_USERNAME)
+ password = config.get(CONF_PASSWORD)
+ ip_address = config.get(CONF_IP_ADDRESS)
+ name = config.get(CONF_NAME)
+ mygogogate2 = pygogogate2(username, password, ip_address)
+
+ try:
+ devices = mygogogate2.get_devices()
+ if devices is False:
+ raise ValueError(
+ "Username or Password is incorrect or no devices found")
+
+ add_devices(MyGogogate2Device(
+ mygogogate2, door, name) for door in devices)
+ return
+
+ except (TypeError, KeyError, NameError, ValueError) as ex:
+ _LOGGER.error("%s", ex)
+ hass.components.persistent_notification.create(
+ 'Error: {}<br />'
+ 'You will need to restart hass after fixing.'
+ ''.format(ex),
+ title=NOTIFICATION_TITLE,
+ notification_id=NOTIFICATION_ID)
+ return
+
+
+class MyGogogate2Device(CoverDevice):
+ """Representation of a Gogogate2 cover."""
+
+ def __init__(self, mygogogate2, device, name):
+ """Initialize with API object, device id."""
+ self.mygogogate2 = mygogogate2
+ self.device_id = device['door']
+ self._name = name or device['name']
+ self._status = device['status']
+ self.available = None
+
+ @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
+
+ @property
+ def device_class(self):
+ """Return the class of this device, from component DEVICE_CLASSES."""
+ return 'garage'
+
+ @property
+ def supported_features(self):
+ """Flag supported features."""
+ return SUPPORT_OPEN | SUPPORT_CLOSE
+
+ @property
+ def available(self):
+ """Could the device be accessed during the last update call."""
+ return self.available
+
+ def close_cover(self, **kwargs):
+ """Issue close command to cover."""
+ self.mygogogate2.close_device(self.device_id)
+ self.schedule_update_ha_state(True)
+
+ def open_cover(self, **kwargs):
+ """Issue open command to cover."""
+ self.mygogogate2.open_device(self.device_id)
+ self.schedule_update_ha_state(True)
+
+ def update(self):
+ """Update status of cover."""
+ try:
+ self._status = self.mygogogate2.get_status(self.device_id)
+ self.available = True
+ except (TypeError, KeyError, NameError, ValueError) as ex:
+ _LOGGER.error("%s", ex)
+ self._status = STATE_UNKNOWN
+ self.available = False
diff --git a/requirements_all.txt b/requirements_all.txt
index d2c56e74d97..da2373443cb 100644
--- a/requirements_all.txt
+++ b/requirements_all.txt
@@ -764,6 +764,9 @@ pyflexit==0.3
# homeassistant.components.ifttt
pyfttt==0.3
+# homeassistant.components.cover.gogogate2
+pygogogate2==0.0.3
+
# homeassistant.components.remote.harmony
pyharmony==1.0.20
--
GitLab