Add Support for VeSync Devices - Outlets and Switches

.coveragerc

@@ -667,6 +667,9 @@ omit =
     homeassistant/components/venstar/climate.py
     homeassistant/components/vera/*
     homeassistant/components/verisure/*
+    homeassistant/components/vesync/__init__.py
+    homeassistant/components/vesync/common.py
+    homeassistant/components/vesync/const.py
     homeassistant/components/vesync/switch.py
     homeassistant/components/viaggiatreno/sensor.py
     homeassistant/components/vizio/media_player.py

CODEOWNERS

@@ -280,6 +280,7 @@ homeassistant/components/uptimerobot/* @ludeeus
 homeassistant/components/utility_meter/* @dgomes
 homeassistant/components/velux/* @Julius2342
 homeassistant/components/version/* @fabaff
+homeassistant/components/vesync/* @markperdue @webdjoe
 homeassistant/components/vizio/* @raman325
 homeassistant/components/vlc_telnet/* @rodripf
 homeassistant/components/waqi/* @andrey-git

homeassistant/components/vesync/.translations/en.json

@@ -0,0 +1,20 @@
+{
+    "config": {
+        "title": "VeSync",
+        "step": {
+            "user": {
+                "title": "Enter Username and Password",
+                "data": {
+                    "username": "Email Address",
+                    "password": "Password"
+                }
+            }
+        },
+        "error": {
+            "invalid_login": "Invalid username or password"
+        },
+        "abort": {
+            "already_setup": "Only one Vesync instance is allow"
+        }
+    }
+}

homeassistant/components/vesync/__init__.py

@@ -1 +1,114 @@
-"""The vesync component."""
+"""Etekcity VeSync integration."""
+import logging
+import voluptuous as vol
+from pyvesync import VeSync
+from homeassistant.const import CONF_USERNAME, CONF_PASSWORD
+from homeassistant.helpers import config_validation as cv
+from homeassistant.helpers.dispatcher import async_dispatcher_send
+from homeassistant.config_entries import SOURCE_IMPORT
+from .common import async_process_devices
+from .config_flow import configured_instances
+from .const import (DOMAIN, VS_DISPATCHERS, VS_DISCOVERY, VS_SWITCHES,
+                    SERVICE_UPDATE_DEVS, VS_MANAGER)
+
+_LOGGER = logging.getLogger(__name__)
+
+CONFIG_SCHEMA = vol.Schema({
+    DOMAIN: vol.Schema({
+        vol.Required(CONF_USERNAME): cv.string,
+        vol.Required(CONF_PASSWORD): cv.string,
+    }),
+}, extra=vol.ALLOW_EXTRA)
+
+
+async def async_setup(hass, config):
+    """Set up the VeSync component."""
+    conf = config.get(DOMAIN)
+
+    if conf is None:
+        return True
+
+    if not configured_instances(hass):
+        hass.async_create_task(
+            hass.config_entries.flow.async_init(
+                DOMAIN,
+                context={'source': SOURCE_IMPORT},
+                data={
+                    CONF_USERNAME: conf[CONF_USERNAME],
+                    CONF_PASSWORD: conf[CONF_PASSWORD]
+                }))
+
+    return True
+
+
+async def async_setup_entry(hass, config_entry):
+    """Set up Vesync as config entry."""
+    username = config_entry.data[CONF_USERNAME]
+    password = config_entry.data[CONF_PASSWORD]
+
+    time_zone = str(hass.config.time_zone)
+
+    manager = VeSync(username, password, time_zone)
+
+    login = await hass.async_add_executor_job(manager.login)
+
+    if not login:
+        _LOGGER.error("Unable to login to the VeSync server")
+        return False
+
+    device_dict = await async_process_devices(hass, manager)
+
+    forward_setup = hass.config_entries.async_forward_entry_setup
+
+    hass.data[DOMAIN] = {}
+    hass.data[DOMAIN][VS_MANAGER] = manager
+
+    switches = hass.data[DOMAIN][VS_SWITCHES] = []
+
+    hass.data[DOMAIN][VS_DISPATCHERS] = []
+
+    if device_dict[VS_SWITCHES]:
+        switches.extend(device_dict[VS_SWITCHES])
+        hass.async_create_task(forward_setup(config_entry, 'switch'))
+
+    async def async_new_device_discovery(service):
+        """Discover if new devices should be added."""
+        manager = hass.data[DOMAIN][VS_MANAGER]
+        switches = hass.data[DOMAIN][VS_SWITCHES]
+
+        dev_dict = await async_process_devices(hass, manager)
+        switch_devs = dev_dict.get(VS_SWITCHES, [])
+
+        switch_set = set(switch_devs)
+        new_switches = list(switch_set.difference(switches))
+        if new_switches and switches:
+            switches.extend(new_switches)
+            async_dispatcher_send(hass,
+                                  VS_DISCOVERY.format(VS_SWITCHES),
+                                  new_switches)
+            return
+        if new_switches and not switches:
+            switches.extend(new_switches)
+            hass.async_create_task(forward_setup(config_entry, 'switch'))
+
+    hass.services.async_register(DOMAIN,
+                                 SERVICE_UPDATE_DEVS,
+                                 async_new_device_discovery
+                                 )
+
+    return True
+
+
+async def async_unload_entry(hass, entry):
+    """Unload a config entry."""
+    forward_unload = hass.config_entries.async_forward_entry_unload
+    remove_switches = False
+    if hass.data[DOMAIN][VS_SWITCHES]:
+        remove_switches = await forward_unload(entry, 'switch')
+
+    if remove_switches:
+        hass.services.async_remove(DOMAIN, SERVICE_UPDATE_DEVS)
+        del hass.data[DOMAIN]
+        return True
+
+    return False

homeassistant/components/vesync/common.py

@@ -0,0 +1,70 @@
+"""Common utilities for VeSync Component."""
+import logging
+from homeassistant.helpers.entity import ToggleEntity
+from .const import VS_SWITCHES
+
+_LOGGER = logging.getLogger(__name__)
+
+
+async def async_process_devices(hass, manager):
+    """Assign devices to proper component."""
+    devices = {}
+    devices[VS_SWITCHES] = []
+
+    await hass.async_add_executor_job(manager.update)
+
+    if manager.outlets:
+        devices[VS_SWITCHES].extend(manager.outlets)
+        _LOGGER.info("%d VeSync outlets found", len(manager.outlets))
+
+    if manager.switches:
+        for switch in manager.switches:
+            if not switch.is_dimmable():
+                devices[VS_SWITCHES].append(switch)
+        _LOGGER.info(
+            "%d VeSync standard switches found", len(manager.switches))
+
+    return devices
+
+
+class VeSyncDevice(ToggleEntity):
+    """Base class for VeSync Device Representations."""
+
+    def __init__(self, device):
+        """Initialize the VeSync device."""
+        self.device = device
+
+    @property
+    def unique_id(self):
+        """Return the ID of this device."""
+        if isinstance(self.device.sub_device_no, int):
+            return ('{}{}'.format(
+                self.device.cid, str(self.device.sub_device_no)))
+        return self.device.cid
+
+    @property
+    def name(self):
+        """Return the name of the device."""
+        return self.device.device_name
+
+    @property
+    def is_on(self):
+        """Return True if switch is on."""
+        return self.device.device_status == "on"
+
+    @property
+    def available(self) -> bool:
+        """Return True if device is available."""
+        return self.device.connection_status == "online"
+
+    def turn_on(self, **kwargs):
+        """Turn the device on."""
+        self.device.turn_on()
+
+    def turn_off(self, **kwargs):
+        """Turn the device off."""
+        self.device.turn_off()
+
+    def update(self):
+        """Update vesync device."""
+        self.device.update()

homeassistant/components/vesync/config_flow.py

@@ -0,0 +1,71 @@
+"""Config flow utilities."""
+import logging
+from collections import OrderedDict
+import voluptuous as vol
+from pyvesync import VeSync
+from homeassistant import config_entries
+from homeassistant.core import callback
+from homeassistant.const import CONF_USERNAME, CONF_PASSWORD
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+
+@callback
+def configured_instances(hass):
+    """Return already configured instances."""
+    return hass.config_entries.async_entries(DOMAIN)
+
+
+@config_entries.HANDLERS.register(DOMAIN)
+class VeSyncFlowHandler(config_entries.ConfigFlow):
+    """Handle a config flow."""
+
+    VERSION = 1
+    CONNECTION_CLASS = config_entries.CONN_CLASS_CLOUD_POLL
+
+    def __init__(self):
+        """Instantiate config flow."""
+        self._username = None
+        self._password = None
+        self._time_zone = None
+        self.data_schema = OrderedDict()
+        self.data_schema[vol.Required(CONF_USERNAME)] = str
+        self.data_schema[vol.Required(CONF_PASSWORD)] = str
+
+    @callback
+    def _show_form(self, errors=None):
+        """Show form to the user."""
+        return self.async_show_form(
+            step_id='user',
+            data_schema=vol.Schema(self.data_schema),
+            errors=errors if errors else {},
+        )
+
+    async def async_step_import(self, import_config):
+        """Handle external yaml configuration."""
+        return await self.async_step_user(import_config)
+
+    async def async_step_user(self, user_input=None):
+        """Handle a flow start."""
+        if configured_instances(self.hass):
+            return self.async_abort(reason='already_setup')
+
+        if not user_input:
+            return self._show_form()
+
+        self._username = user_input[CONF_USERNAME]
+        self._password = user_input[CONF_PASSWORD]
+
+        manager = VeSync(self._username, self._password)
+        login = await self.hass.async_add_executor_job(manager.login)
+        if not login:
+            return self._show_form(errors={'base': 'invalid_login'})
+
+        return self.async_create_entry(
+            title=self._username,
+            data={
+                CONF_USERNAME: self._username,
+                CONF_PASSWORD: self._password,
+            },
+        )

homeassistant/components/vesync/const.py

@@ -0,0 +1,9 @@
+"""Constants for VeSync Component."""
+
+DOMAIN = 'vesync'
+VS_DISPATCHERS = 'vesync_dispatchers'
+VS_DISCOVERY = 'vesync_discovery_{}'
+SERVICE_UPDATE_DEVS = 'update_devices'
+
+VS_SWITCHES = 'switches'
+VS_MANAGER = 'manager'

homeassistant/components/vesync/manifest.json

@@ -1,10 +1,9 @@
 {
   "domain": "vesync",
-  "name": "Vesync",
+  "name": "VeSync",
   "documentation": "https://www.home-assistant.io/components/vesync",
-  "requirements": [
-    "pyvesync_v2==0.9.7"
-  ],
   "dependencies": [],
-  "codeowners": []
+  "codeowners": ["@markperdue", "@webdjoe"],
+  "requirements": ["pyvesync==1.1.0"],
+  "config_flow": true
 }

homeassistant/components/vesync/services.yaml

@@ -0,0 +1,2 @@
+update_devices:
+  description: Add new VeSync devices to Home Assistant

homeassistant/components/vesync/strings.json

@@ -0,0 +1,20 @@
+{
+  "config": {
+    "title": "VeSync",
+    "step": {
+      "user": {
+        "title": "Enter Username and Password",
+        "data": {
+          "username": "Email Address",
+          "password": "Password"
+        }
+      }
+    },
+    "error": {
+      "invalid_login": "Invalid username or password"
+    },
+    "abort": {
+      "already_setup": "Only one Vesync instance is allow"
+    }
+  }
+}