Added component named switcher_kis switcher water heater integration.

.coveragerc

@@ -565,6 +565,7 @@ omit =
     homeassistant/components/swiss_public_transport/sensor.py
     homeassistant/components/swisscom/device_tracker.py
     homeassistant/components/switchbot/switch.py
+    homeassistant/components/switcher_kis/switch.py
     homeassistant/components/switchmate/switch.py
     homeassistant/components/syncthru/sensor.py
     homeassistant/components/synology/camera.py

CODEOWNERS

@@ -199,6 +199,7 @@ homeassistant/components/sun/* @home-assistant/core
 homeassistant/components/swiss_hydrological_data/* @fabaff
 homeassistant/components/swiss_public_transport/* @fabaff
 homeassistant/components/switchbot/* @danielhiversen
+homeassistant/components/switcher_kis/* @tomerfi
 homeassistant/components/switchmate/* @danielhiversen
 homeassistant/components/synology_srm/* @aerialls
 homeassistant/components/syslog/* @fabaff

homeassistant/components/switcher_kis/__init__.py

@@ -0,0 +1,91 @@
+"""Home Assistant Switcher Component."""
+
+from asyncio import QueueEmpty, TimeoutError as Asyncio_TimeoutError, wait_for
+from datetime import datetime, timedelta
+from logging import getLogger
+from typing import Dict, Optional
+
+import voluptuous as vol
+
+from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
+from homeassistant.const import EVENT_HOMEASSISTANT_STOP
+from homeassistant.helpers import config_validation as cv
+from homeassistant.helpers.discovery import async_load_platform
+from homeassistant.helpers.dispatcher import async_dispatcher_send
+from homeassistant.helpers.event import async_track_time_interval
+from homeassistant.helpers.typing import EventType, HomeAssistantType
+
+_LOGGER = getLogger(__name__)
+
+DOMAIN = 'switcher_kis'
+
+CONF_DEVICE_ID = 'device_id'
+CONF_DEVICE_PASSWORD = 'device_password'
+CONF_PHONE_ID = 'phone_id'
+
+DATA_DEVICE = 'device'
+
+SIGNAL_SWITCHER_DEVICE_UPDATE = 'switcher_device_update'
+
+ATTR_AUTO_OFF_SET = 'auto_off_set'
+ATTR_ELECTRIC_CURRNET = 'electric_current'
+ATTR_REMAINING_TIME = 'remaining_time'
+
+CONFIG_SCHEMA = vol.Schema({
+    DOMAIN: vol.Schema({
+        vol.Required(CONF_PHONE_ID): cv.string,
+        vol.Required(CONF_DEVICE_ID): cv.string,
+        vol.Required(CONF_DEVICE_PASSWORD): cv.string
+    })
+}, extra=vol.ALLOW_EXTRA)
+
+
+async def async_setup(hass: HomeAssistantType, config: Dict) -> bool:
+    """Set up the switcher component."""
+    from aioswitcher.bridge import SwitcherV2Bridge
+
+    phone_id = config[DOMAIN][CONF_PHONE_ID]
+    device_id = config[DOMAIN][CONF_DEVICE_ID]
+    device_password = config[DOMAIN][CONF_DEVICE_PASSWORD]
+
+    v2bridge = SwitcherV2Bridge(
+        hass.loop, phone_id, device_id, device_password)
+
+    await v2bridge.start()
+
+    async def async_stop_bridge(event: EventType) -> None:
+        """On homeassistant stop, gracefully stop the bridge if running."""
+        await v2bridge.stop()
+
+    hass.async_add_job(hass.bus.async_listen_once(
+        EVENT_HOMEASSISTANT_STOP, async_stop_bridge))
+
+    try:
+        device_data = await wait_for(
+            v2bridge.queue.get(), timeout=5.0, loop=hass.loop)
+    except (Asyncio_TimeoutError, RuntimeError):
+        _LOGGER.exception("failed to get response from device")
+        await v2bridge.stop()
+        return False
+
+    hass.data[DOMAIN] = {
+        DATA_DEVICE: device_data
+    }
+
+    hass.async_create_task(async_load_platform(
+        hass, SWITCH_DOMAIN, DOMAIN, None, config))
+
+    async def device_updates(timestamp: Optional[datetime]) -> None:
+        """Use for updating the device data from the queue."""
+        if v2bridge.running:
+            try:
+                device_new_data = v2bridge.queue.get_nowait()
+                if device_new_data:
+                    async_dispatcher_send(
+                        hass, SIGNAL_SWITCHER_DEVICE_UPDATE, device_new_data)
+            except QueueEmpty:
+                pass
+
+    async_track_time_interval(hass, device_updates, timedelta(seconds=4))
+
+    return True

homeassistant/components/switcher_kis/manifest.json

@@ -0,0 +1,12 @@
+{
+  "domain": "switcher_kis",
+  "name": "Switcher",
+  "documentation": "https://www.home-assistant.io/components/switcher_kis/",
+  "codeowners": [
+    "@tomerfi"
+  ],
+  "requirements": [
+    "aioswitcher==2019.3.21"
+  ],
+  "dependencies": []
+}

homeassistant/components/switcher_kis/switch.py

@@ -0,0 +1,157 @@
+"""Home Assistant Switcher Component Switch platform."""
+
+from logging import getLogger
+from typing import Callable, Dict, TYPE_CHECKING
+
+from homeassistant.components.switch import ATTR_CURRENT_POWER_W, SwitchDevice
+from homeassistant.helpers.dispatcher import async_dispatcher_connect
+from homeassistant.helpers.typing import HomeAssistantType
+
+from . import (
+    ATTR_AUTO_OFF_SET, ATTR_ELECTRIC_CURRNET, ATTR_REMAINING_TIME,
+    DATA_DEVICE, DOMAIN, SIGNAL_SWITCHER_DEVICE_UPDATE)
+
+if TYPE_CHECKING:
+    from aioswitcher.devices import SwitcherV2Device
+    from aioswitcher.api.messages import SwitcherV2ControlResponseMSG
+
+
+_LOGGER = getLogger(__name__)
+
+PROPERTIES_TO_DEVICE_ATTRIBUTES = {
+    'current_power_w': ATTR_CURRENT_POWER_W,
+    'electric_current': ATTR_ELECTRIC_CURRNET,
+    'remaining_time': ATTR_REMAINING_TIME,
+    'auto_off_set': ATTR_AUTO_OFF_SET
+}
+
+
+async def async_setup_platform(hass: HomeAssistantType, config: Dict,
+                               async_add_entities: Callable,
+                               discovery_info: Dict) -> None:
+    """Set up the switcher platform for the switch component."""
+    assert DOMAIN in hass.data
+    async_add_entities([SwitcherControl(hass.data[DOMAIN][DATA_DEVICE])])
+
+
+class SwitcherControl(SwitchDevice):
+    """Home Assistant switch entity."""
+
+    def __init__(self, device_data: 'SwitcherV2Device') -> None:
+        """Initialize the entity."""
+        self._self_initiated = False
+        self._device_data = device_data
+        self._state = device_data.state
+
+    @property
+    def electric_current(self) -> float:
+        """Return the electric current."""
+        return self._device_data.electric_current
+
+    @property
+    def remaining_time(self) -> str:
+        """Return the remaining time to off command."""
+        return self._device_data.remaining_time
+
+    @property
+    def auto_off_set(self) -> str:
+        """Return the auto off configuration set."""
+        return self._device_data.auto_off_set
+
+    @property
+    def name(self) -> str:
+        """Return the device's name."""
+        return self._device_data.name
+
+    @property
+    def should_poll(self) -> bool:
+        """Return False, entity pushes its state to HA."""
+        return False
+
+    @property
+    def unique_id(self) -> str:
+        """Return a unique ID."""
+        return "{}-{}".format(
+            self._device_data.device_id, self._device_data.mac_addr)
+
+    @property
+    def is_on(self) -> bool:
+        """Return True if entity is on."""
+        from aioswitcher.consts import STATE_ON as SWITCHER_STATE_ON
+        return self._state == SWITCHER_STATE_ON
+
+    @property
+    def current_power_w(self) -> int:
+        """Return the current power usage in W."""
+        return self._device_data.power_consumption
+
+    @property
+    def device_state_attributes(self) -> Dict:
+        """Return the optional state attributes."""
+        from aioswitcher.consts import WAITING_TEXT
+
+        attribs = {}
+
+        for prop, attr in PROPERTIES_TO_DEVICE_ATTRIBUTES.items():
+            value = getattr(self, prop)
+            if value and value is not WAITING_TEXT:
+                attribs[attr] = value
+
+        return attribs
+
+    @property
+    def available(self) -> bool:
+        """Return True if entity is available."""
+        from aioswitcher.consts import (STATE_OFF as SWITCHER_STATE_OFF,
+                                        STATE_ON as SWITCHER_STATE_ON)
+        return self._state in [SWITCHER_STATE_ON, SWITCHER_STATE_OFF]
+
+    async def async_added_to_hass(self) -> None:
+        """Run when entity about to be added to hass."""
+        async_dispatcher_connect(
+            self.hass, SIGNAL_SWITCHER_DEVICE_UPDATE, self.async_update_data)
+
+    async def async_update_data(self, device_data: 'SwitcherV2Device') -> None:
+        """Update the entity data."""
+        if device_data:
+            if self._self_initiated:
+                self._self_initiated = False
+            else:
+                self._device_data = device_data
+                self._state = self._device_data.state
+                self.async_schedule_update_ha_state()
+
+    async def async_turn_on(self, **kwargs: Dict) -> None:
+        """Turn the entity on.
+
+        This method must be run in the event loop and returns a coroutine.
+        """
+        await self._control_device(True)
+
+    async def async_turn_off(self, **kwargs: Dict) -> None:
+        """Turn the entity off.
+
+        This method must be run in the event loop and returns a coroutine.
+        """
+        await self._control_device(False)
+
+    async def _control_device(self, send_on: bool) -> None:
+        """Turn the entity on or off."""
+        from aioswitcher.api import SwitcherV2Api
+        from aioswitcher.consts import (COMMAND_OFF, COMMAND_ON,
+                                        STATE_OFF as SWITCHER_STATE_OFF,
+                                        STATE_ON as SWITCHER_STATE_ON)
+
+        response = None  # type: SwitcherV2ControlResponseMSG
+        async with SwitcherV2Api(
+                self.hass.loop, self._device_data.ip_addr,
+                self._device_data.phone_id, self._device_data.device_id,
+                self._device_data.device_password) as swapi:
+            response = await swapi.control_device(
+                COMMAND_ON if send_on else COMMAND_OFF)
+
+        if response and response.successful:
+            self._self_initiated = True
+            self._state = \
+                SWITCHER_STATE_ON if send_on else SWITCHER_STATE_OFF
+            self.async_schedule_update_ha_state()

homeassistant/helpers/typing.py

@@ -7,6 +7,7 @@
 
 GPSType = Tuple[float, float]
 ConfigType = Dict[str, Any]
+EventType = homeassistant.core.Event
 HomeAssistantType = homeassistant.core.HomeAssistant
 ServiceDataType = Dict[str, Any]
 TemplateVarsType = Optional[Dict[str, Any]]

mypy.ini

@@ -19,4 +19,3 @@ disallow_untyped_defs = false
 [mypy-homeassistant.util.yaml]
 warn_return_any = false
 disallow_untyped_calls = false
-

requirements_all.txt

@@ -142,6 +142,9 @@ aiolifx_effects==0.2.1
 # homeassistant.components.hunterdouglas_powerview
 aiopvapi==1.6.14
 
+# homeassistant.components.switcher_kis
+aioswitcher==2019.3.21
+
 # homeassistant.components.unifi
 aiounifi==4
 

requirements_test_all.txt

@@ -51,6 +51,9 @@ aiohttp_cors==0.7.0
 # homeassistant.components.hue
 aiohue==1.9.1
 
+# homeassistant.components.switcher_kis
+aioswitcher==2019.3.21
+
 # homeassistant.components.unifi
 aiounifi==4
 

script/gen_requirements_all.py

@@ -48,6 +48,7 @@
     'aiohttp_cors',
     'aiohue',
     'aiounifi',
+    'aioswitcher',
     'apns2',
     'av',
     'axis',

tests/components/switcher_kis/__init__.py

@@ -0,0 +1 @@
+"""Test cases and object for the Switcher integration tests."""